DtChangeTimeOfDayCommand Class Reference

A DtSimCommand subclass which specifies a change to the time of day settings in the simulation engine.

Inheritance diagram for DtChangeTimeOfDayCommand:

Public Member Functions
	DtChangeTimeOfDayCommand ()
	DtChangeTimeOfDayCommand (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtChangeTimeOfDayCommand (const DtString &writeName, const DtChangeTimeOfDayCommand &orig, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtChangeTimeOfDayCommand ()
DtChangeTimeOfDayCommand &	operator= (const DtChangeTimeOfDayCommand &orig)
const DtSimCommandMessageType &	type () const
virtual DtSimCommand *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual DtString	stringRep () const
virtual void	setDateAndTimeOfDay (time_t secondsPastMidnight)
virtual time_t	dateAndTimeOfDay () const
virtual bool	changeDateAndTimeOfDay () const
virtual void	setUseDayNightIlluminationModel (bool)
virtual bool	useDayNightIlluminationModel () const
virtual bool	changeUseDayNightIlluminationModel () const
virtual void	setTimeOfDayAdvanceSpeed (double secondsPastMidnight)
virtual double	timeOfDayAdvanceSpeed () const
virtual bool	changeTimeOfDayAdvanceSpeed () const
virtual void	setGeneratedByRemoteSetter (bool value)
virtual bool	generatedByRemoteSetter () const
Public Member Functions inherited from DtSimCommand
virtual	~DtSimCommand ()
virtual bool	init ()
virtual DtSimCommand *	clone () const
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual char *	netRep ()
virtual void	setLocalDelivery (bool)
virtual bool	localDelivery () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
bool	operator== (const DtReaderWriter &) const
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	postGetSelf ()
virtual void	preGetSelf ()
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual DtSymbolString	name () const
virtual void	addAlias (const DtSymbolString &alias)
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
bool	isReadonly () const
virtual void	reset ()
virtual int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
virtual bool	hasVariableReference () const
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
virtual void	recordUpdateTime () const
virtual bool	wasUpdatedSince (DtTime t) const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static DtSimCommand *	creator ()
Static Public Member Functions inherited from DtSimCommand
static DtSimCommand *	createSimCommand (DtlObjPtr mtlStream)
static DtSimCommand *	createSimCommand (const DtSimCommandMessageType &simCommandType)
static DtSimCommand *	createFromFactory (const DtSimCommandMessageType &simCommandType)
static void	addSimCommandCreatorFcn (const DtSimCommandMessageType &simCommandName, DtSimCommandCreatorFcn fcn)
static void	setFactory (DtSimCommandFactory *factory)
static DtSimCommandFactory *	factory ()
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
Protected Member Functions inherited from DtSimCommand
	DtSimCommand ()
	DtSimCommand (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	DtSimCommand (const DtString &writeName, const DtSimCommand &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtSimCommand &	operator= (const DtSimCommand &orig)
virtual char *	createNetworkBuffer ()
virtual bool	isTypeRegistered (const DtSimCommandMessageType &commandType)
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
DtRwReal	mySecondsPastUTC
DtRwReal	myToDAdvanceSpeed
DtRwBoolean	myGeneratedByRemoteSetter
DtRwBoolean	myUseDayNightIlluminationModel
Protected Attributes inherited from DtSimCommand
char *	myNetRep
bool	myLocalDelivery
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
bool	myInvalid
bool	myChangedFlag

Additional Inherited Members
Public Types inherited from DtSimCommand
typedef DtSimCommandMessageType	FactoryKeyType
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::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Static Protected Attributes inherited from DtSimCommand
static DtSimCommandFactory *	myFactory
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent
static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

DtChangeTimeOfDayCommand::DtChangeTimeOfDayCommand

(

)

default constructor

DtChangeTimeOfDayCommand::DtChangeTimeOfDayCommand	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

Usual constructor.

DtChangeTimeOfDayCommand::DtChangeTimeOfDayCommand	(	const DtString &	writeName,
		const DtChangeTimeOfDayCommand &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

virtual DtChangeTimeOfDayCommand::~DtChangeTimeOfDayCommand ( )

virtual

destructor

Member Function Documentation

DtChangeTimeOfDayCommand& DtChangeTimeOfDayCommand::operator=

(

const DtChangeTimeOfDayCommand &

orig

)

assignment operator

const DtSimCommandMessageType& DtChangeTimeOfDayCommand::type ( ) const

virtual

Returns

The type of this DtSimCommand (specified in radioMsgTypes.h)

Implements DtSimCommand.

virtual DtSimCommand* DtChangeTimeOfDayCommand::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = 0  ) const

virtual

Returns

A new instance of this class, copied from the original.

Implements DtSimCommand.

virtual int DtChangeTimeOfDayCommand::netRepSize ( ) const

virtual

Returns the size in bytes of the network representation of the class. This is the size in bytes of the DtNetSimSimCommand structure. Derived classes should take into acount the size returned by this class when overriding (they should call down to this class and add the result to their additional size).

Reimplemented from DtSimCommand.

virtual bool DtChangeTimeOfDayCommand::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

virtual

Sets mySubsimCommand member from the incoming contentBuffer (cast to type DtNetSimSimCommand). Derived classes should call down to this function first, and then extract their own data starting at the location contentBuffer + DtSimCommand::netRepSize().

Reimplemented from DtSimCommand.

virtual bool DtChangeTimeOfDayCommand::setToNet ( )

virtual

Calls netRep() to create the network buffer. Casts the resulting myNetRep to type DtNetSimSimCommand*, and then sets the mySubsimCommand member in the DtNetSimSimCommand from mySubsimCommand. Derived classes should call down to the base class version of setToNet() at the start of the function (before doing any processing on the network representation) They can then start to fill in their network data, starting at the location myNetRep + DtSimCommand::netRepSize().

Reimplemented from DtSimCommand.

virtual void DtChangeTimeOfDayCommand::setDateAndTimeOfDay ( time_t  secondsPastMidnight )

virtual

The date and time of day, represented as the number of seconds past 00:00 hours, Jan 1, 1970 UTC.

virtual time_t DtChangeTimeOfDayCommand::dateAndTimeOfDay ( ) const

virtual

The date and time of day, represented as the number of seconds past 00:00 hours, Jan 1, 1970 UTC.

virtual bool DtChangeTimeOfDayCommand::changeDateAndTimeOfDay ( ) const

virtual

The date and time of day, represented as the number of seconds past 00:00 hours, Jan 1, 1970 UTC.

virtual void DtChangeTimeOfDayCommand::setUseDayNightIlluminationModel ( bool  )

virtual

Sets the sim to use the position to the entity (if true) for sunrise/sunset rather than GMT.

Wrap gmt position usage

virtual bool DtChangeTimeOfDayCommand::useDayNightIlluminationModel ( ) const

virtual

Sets the sim to use the position to the entity (if true) for sunrise/sunset rather than GMT.

Wrap gmt position usage

virtual bool DtChangeTimeOfDayCommand::changeUseDayNightIlluminationModel ( ) const

virtual

Sets the sim to use the position to the entity (if true) for sunrise/sunset rather than GMT.

Wrap gmt position usage

virtual void DtChangeTimeOfDayCommand::setTimeOfDayAdvanceSpeed ( double  secondsPastMidnight )

virtual

The time of day advance speed.

virtual double DtChangeTimeOfDayCommand::timeOfDayAdvanceSpeed ( ) const

virtual

The time of day advance speed.

virtual bool DtChangeTimeOfDayCommand::changeTimeOfDayAdvanceSpeed ( ) const

virtual

The time of day advance speed.

virtual void DtChangeTimeOfDayCommand::setGeneratedByRemoteSetter ( bool  value )

virtual

Used internally by VRF. This value is set to true if this command was generated by a VRF Sim engine that is not simulating the time of day, to communicate time of day changes to another sim engine. It defaults to false, and should typically be left as the default.

virtual bool DtChangeTimeOfDayCommand::generatedByRemoteSetter ( ) const

virtual

Used internally by VRF. This value is set to true if this command was generated by a VRF Sim engine that is not simulating the time of day, to communicate time of day changes to another sim engine. It defaults to false, and should typically be left as the default.

virtual DtString DtChangeTimeOfDayCommand::stringRep ( ) const

virtual

Text representation of this command.

Implements DtSimCommand.

static DtSimCommand* DtChangeTimeOfDayCommand::creator ( )

static

virtual void DtChangeTimeOfDayCommand::getSelf ( DtlObjPtr  args, const DtReaderWriter::SearchPaths &  searchPaths = DtReaderWriter::SearchPaths(), const DtVariableBindingsList &  variableBindings = nullVariableReference()  )

protectedvirtual

Override to support previous versions of this command which used time of day.

Reimplemented from DtReaderWriter.

Member Data Documentation

DtRwReal DtChangeTimeOfDayCommand::mySecondsPastUTC

protected

DtRwReal DtChangeTimeOfDayCommand::myToDAdvanceSpeed

protected

DtRwBoolean DtChangeTimeOfDayCommand::myGeneratedByRemoteSetter

protected

DtRwBoolean DtChangeTimeOfDayCommand::myUseDayNightIlluminationModel

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfplan/changeTimeOfDayCommand.h