AutomaticSun#

class ansys.speos.core.source.BaseSourceAmbient.AutomaticSun(sun, default_parameters=None, stable_ctr=False)#

Sun type Automatic.

By default, user’s current time and Ansys France is used a time zone.

Parameters:
sunansys.api.speos.scene.v2.scene_pb2.AutomaticSun

Wavelengths range protobuf object to modify.

default_parametersOptional[ ansys.speos.core.generic.parameters.AutomaticSunParameters] = None,

If defined the values in the AutomaticSun instance will be overwritten by the values of the data class.

stable_ctrbool

Variable to indicate if usage is inside class scope

Parameters:

Notes

Do not instantiate this class yourself, use set_sun_automatic method available in source classes.

Overview#

year

Property of year info of the automatic sun.

month

Property of month info of the automatic sun.

day

Property of day info of the automatic sun.

hour

Get hour info of the automatic sun.

minute

Property of minute info of the automatic sun.

longitude

Property of longitude info of the automatic sun.

latitude

Property of latitude info of the automatic sun.

time_zone

Property of time zone info of the automatic sun.

Import detail#

from ansys.speos.core.source.BaseSourceAmbient import AutomaticSun

Property detail#

property AutomaticSun.year: int#

Property of year info of the automatic sun.

Parameters:
yearint

year information.

Returns:
int

year info.

property AutomaticSun.month: int#

Property of month info of the automatic sun.

Parameters:
monthint

month information.

Returns:
int

month information.

property AutomaticSun.day: int#

Property of day info of the automatic sun.

Parameters:
dayint

day information.

Returns:
int

day information.

property AutomaticSun.hour: int#

Get hour info of the automatic sun.

Parameters:
hourint

hour information.

Returns:
int

hour information.

property AutomaticSun.minute: int#

Property of minute info of the automatic sun.

Parameters:
minuteint

minute information.

Returns:
int

minute information.

property AutomaticSun.longitude: float#

Property of longitude info of the automatic sun.

Parameters:
longitudefloat

longitude information.

Returns:
float

longitude information.

property AutomaticSun.latitude: float#

Property of latitude info of the automatic sun.

Parameters:
latitudefloat

latitude information.

Returns:
float

latitude information.

property AutomaticSun.time_zone: str#

Property of time zone info of the automatic sun.

default value to be “CET”.

Parameters:
timezonestr

timezone abbreviation.

Returns:
str

time zone abbreviation.