DtGlobalEnvironmentActuatorDescriptor Class Reference

Instances of DtGlobalEnvironmentActuatorDescriptor are used to specify the parameters for a DtGlobalEnvironmentActuator component. More...

Inheritance diagram for DtGlobalEnvironmentActuatorDescriptor:

List of all members.

Public Member Functions
	DtGlobalEnvironmentActuatorDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=0)
	real constructor
	DtGlobalEnvironmentActuatorDescriptor (const DtGlobalEnvironmentActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtGlobalEnvironmentActuatorDescriptor ()
DtGlobalEnvironmentActuatorDescriptor &	operator= (const DtGlobalEnvironmentActuatorDescriptor &orig)
	assignment
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual void	setSunriseTime (double value)
virtual double	sunriseTime () const
virtual void	setSunsetTime (double value)
virtual double	sunsetTime () const
virtual void	setDaylightIllumination (double value)
virtual double	daylightIllumination () const
virtual void	setNightIllumination (double value)
virtual double	nightIllumination () const
virtual void	setDayNightTransitionTime (double value)
virtual double	dayNightTransitionTime () const
virtual double	sunriseStartTime () const
	Applies the myDayNightTransitionTime to mySunriseTime to calculate the start and end of the sunrise time.
virtual double	sunriseEndTime () const
	Applies the myDayNightTransitionTime to mySunriseTime to calculate the start and end of the sunrise time.
virtual double	sunsetStartTime () const
	Applies the myDayNightTransitionTime to mySunsetTime to calculate the start and end of the sunset time.
virtual double	sunsetEndTime () const
	Applies the myDayNightTransitionTime to mySunsetTime to calculate the start and end of the sunset time.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtGlobalEnvironmentActuatorDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	mySunriseTime
	Parameter Name: sunrise-time Parameter Description: Time at which the daylight model changes from night to day.
DtRwReal	mySunsetTime
	Parameter Name: sunset-time Parameter Description: Time at which the daylight model changes from day to night.
DtRwReal	myDaylightIllumination
	Parameter Name: daylight-illumination Parameter Description: The percent illumination during the full daylight hours.
DtRwReal	myNightIllumination
	Parameter Name: daylight-illumination Parameter Description: The percent illumination during the full night hours.
DtRwReal	myDayNightTransitionTime
	Parameter Name: day-night-transition-time Parameter Description: The period of time, centered on sunrise and sunset times, where the illumination value will be transitioning from daylight to night, or vice versa.

---

Detailed Description

Instances of DtGlobalEnvironmentActuatorDescriptor are used to specify the parameters for a DtGlobalEnvironmentActuator component.

---

Constructor & Destructor Documentation

DtGlobalEnvironmentActuatorDescriptor::DtGlobalEnvironmentActuatorDescriptor	(	const DtString &	componentName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

real constructor

DtGlobalEnvironmentActuatorDescriptor::DtGlobalEnvironmentActuatorDescriptor	(	const DtGlobalEnvironmentActuatorDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtGlobalEnvironmentActuatorDescriptor::~DtGlobalEnvironmentActuatorDescriptor

(

)

[virtual]

DtGlobalEnvironmentActuatorDescriptor::DtGlobalEnvironmentActuatorDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtGlobalEnvironmentActuatorDescriptor& DtGlobalEnvironmentActuatorDescriptor::operator=

(

const DtGlobalEnvironmentActuatorDescriptor &

orig

)

assignment

virtual DtString DtGlobalEnvironmentActuatorDescriptor::type

(

)

const [virtual]

Returns the type of component this descriptor describes.

Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns:

DtGlobalEnvironmentActuatorDescriptorType

Reimplemented from DtActuatorComponentDescriptor.

virtual DtComponentDescriptor* DtGlobalEnvironmentActuatorDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtActuatorComponentDescriptor.

static DtComponentDescriptor* DtGlobalEnvironmentActuatorDescriptor::creator

(

)

[static]

Returns:

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtActuatorComponentDescriptor.

virtual void DtGlobalEnvironmentActuatorDescriptor::setSunriseTime

(

double

value

)

[virtual]

See also:

mySunriseTime

virtual double DtGlobalEnvironmentActuatorDescriptor::sunriseTime

(

)

const [virtual]

See also:

mySunriseTime

virtual void DtGlobalEnvironmentActuatorDescriptor::setSunsetTime

(

double

value

)

[virtual]

See also:

mySunsetTime

virtual double DtGlobalEnvironmentActuatorDescriptor::sunsetTime

(

)

const [virtual]

See also:

mySunsetTime

virtual void DtGlobalEnvironmentActuatorDescriptor::setDaylightIllumination

(

double

value

)

[virtual]

See also:

myDaylightIllumination

virtual double DtGlobalEnvironmentActuatorDescriptor::daylightIllumination

(

)

const [virtual]

See also:

myDaylightIllumination

virtual void DtGlobalEnvironmentActuatorDescriptor::setNightIllumination

(

double

value

)

[virtual]

See also:

myNightIllumination

virtual double DtGlobalEnvironmentActuatorDescriptor::nightIllumination

(

)

const [virtual]

See also:

myNightIllumination

virtual void DtGlobalEnvironmentActuatorDescriptor::setDayNightTransitionTime

(

double

value

)

[virtual]

See also:

myDayNightTransitionTime

virtual double DtGlobalEnvironmentActuatorDescriptor::dayNightTransitionTime

(

)

const [virtual]

See also:

myDayNightTransitionTime

virtual double DtGlobalEnvironmentActuatorDescriptor::sunriseStartTime

(

)

const [virtual]

Applies the myDayNightTransitionTime to mySunriseTime to calculate the start and end of the sunrise time.

Value returned between 0 and 24*60*60.

virtual double DtGlobalEnvironmentActuatorDescriptor::sunriseEndTime

(

)

const [virtual]

Applies the myDayNightTransitionTime to mySunriseTime to calculate the start and end of the sunrise time.

Value returned between 0 and 24*60*60.

virtual double DtGlobalEnvironmentActuatorDescriptor::sunsetStartTime

(

)

const [virtual]

Applies the myDayNightTransitionTime to mySunsetTime to calculate the start and end of the sunset time.

Value returned between 0 and 24*60*60.

virtual double DtGlobalEnvironmentActuatorDescriptor::sunsetEndTime

(

)

const [virtual]

Applies the myDayNightTransitionTime to mySunsetTime to calculate the start and end of the sunset time.

Value returned between 0 and 24*60*60.

---

Member Data Documentation

DtRwReal DtGlobalEnvironmentActuatorDescriptor::mySunriseTime [protected]

Parameter Name: sunrise-time
Parameter Description: Time at which the daylight model changes from night to day.

Parameter Default Value: 21600 (06:00) Parameter Units: seconds past midnight

DtRwReal DtGlobalEnvironmentActuatorDescriptor::mySunsetTime [protected]

Parameter Name: sunset-time
Parameter Description: Time at which the daylight model changes from day to night.

Parameter Default Value: 64800 (18:00) Parameter Units: seconds past midnight

DtRwReal DtGlobalEnvironmentActuatorDescriptor::myDaylightIllumination [protected]

Parameter Name: daylight-illumination
Parameter Description: The percent illumination during the full daylight hours.

Parameter Default Value: 1.0 Parameter Range: 0.0 - 1.0.

DtRwReal DtGlobalEnvironmentActuatorDescriptor::myNightIllumination [protected]

Parameter Name: daylight-illumination
Parameter Description: The percent illumination during the full night hours.

Parameter Default Value: 0.1 Parameter Range: 0.0 - 1.0.

DtRwReal DtGlobalEnvironmentActuatorDescriptor::myDayNightTransitionTime [protected]

Parameter Name: day-night-transition-time
Parameter Description: The period of time, centered on sunrise and sunset times, where the illumination value will be transitioning from daylight to night, or vice versa.

During this time period, the illumination level will be a linear progression between the night and daylight illumination levels.
Parameter Default Value: 7200 (2 hours) Parameter Units: seconds

---

The documentation for this class was generated from the following file:

• include/vrfobjparam/globalEnvironmentActuatorDescriptor.h