DtGlobalEnvironmentActuatorDescriptor Class Reference

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

Inheritance diagram for DtGlobalEnvironmentActuatorDescriptor:

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.
Public Member Functions inherited from DtActuatorComponentDescriptor
	DtActuatorComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtActuatorComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtActuatorComponentDescriptor (const DtActuatorComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtActuatorComponentDescriptor &	operator= (const DtActuatorComponentDescriptor &orig)
	assignment
virtual	~DtActuatorComponentDescriptor ()
	destructor
virtual void	setArtPartDescriptorList (const DtSimArtPartDescriptorList &artPartDescriptorList)
	Accessor/mutator for myArtPartDescriptorList.
virtual const DtSimArtPartDescriptorList &	artPartDescriptorList () const
	Accessor/mutator for myArtPartDescriptorList.
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
	assignment
virtual	~DtComponentDescriptor ()
virtual void	putData (FILE *fp, int indentLevel=0)
	Overrides base class putData to output our type.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored.
virtual bool	init ()
	Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary.
	DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
virtual void	setComponentType (const DtString &componentType)
	Type of DtSimComponent this descriptor is associated with.
virtual const DtString &	componentType () const
	Type of DtSimComponent this descriptor is associated with.
virtual void	setMinTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTickPeriod () const
virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)
virtual DtReal	minTickPeriodVariance () const
virtual void	setTickPeriodUsesRealTime (bool value)
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual bool	tickPeriodUsesRealTime () const
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual const DtString &	processStateRepositoryName () const
	Name which this component will assign to its PSR.
virtual void	setProcessStateRepositoryName (const DtString &name)
	Name which this component will assign to its PSR.
virtual const DtString &	processStateRepositoryType () const
	Type of PSR this component will create.
virtual void	setProcessStateRepositoryType (const DtString &type)
	Type of PSR this component will create.
virtual void	setIsEnabled (bool yesNo)
	Is the component enabled or not.
virtual bool	isEnabled () const
	Is the component enabled or not.
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtComponentDescriptor *	creator ()

Protected Member Functions
	DtGlobalEnvironmentActuatorDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtActuatorComponentDescriptor
	DtActuatorComponentDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.

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.
Protected Attributes inherited from DtActuatorComponentDescriptor
DtSimArtPartDescriptorList	myArtPartDescriptorList
	Parameter Name: art-part-list Parameter Description: List of articulated parts associated with this actuator.
Protected Attributes inherited from DtComponentDescriptor
DtRwBoolean	myIsEnabled
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component.
DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Minimum tick period for this component.
DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: Minimum tick period for this component.
DtRwBoolean	myTickPeriodUsesRealTime
	Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the min-tick-period and min-tick-period-variance parameters are based on real time or simulation time.
DtRwString	myProcessStateRepositoryName
	Parameter Name: process-state-repository-name Parameter Description: Name of the process state repository associated with this component.
DtRwString	myProcessStateRepositoryType
	Parameter Name: process-state-repository-type Parameter Description: Type of the process state repository assoicated with this component.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory

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