DtLaunchExpendableResourcePSR Class Reference

class DtLaunchExpendableResourcePSR: More...

Inheritance diagram for DtLaunchExpendableResourcePSR:

Public Member Functions
	DtLaunchExpendableResourcePSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtLaunchExpendableResourcePSR (const DtLaunchExpendableResourcePSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtLaunchExpendableResourcePSR ()
	destructor
DtLaunchExpendableResourcePSR &	operator= (const DtLaunchExpendableResourcePSR &orig)
	assignment operator
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
	returns a newly created copy of this object
virtual DtString	type () const
	Returns the string type of this process state repository.
virtual void	setNumberLeftToFire (const int number)
	Get / Set the number left to fire variable.
virtual const int	numberLeftToFire () const
virtual void	reduceNumberLeftToFire (const int reduce)
	Reduce the number left to fire by the reduce amount. Convience function.
virtual void	setElapsedTimeBetweenInterval (const double time)
	Get/Set the time elapsed since the last resource was fired.
virtual const double	elapsedTimeBetweenInterval () const
virtual void	setAutoLaunchEnabled (bool enabled)
	If enabled entity will automatically launch its resources when the auto launch range is reached.
virtual bool	autoLaunchEnabled () const
virtual bool	autoLaunchEnabledOnSpecified () const
virtual void	setAutoLaunchSubtaskId (const int id)
	If we launched an autotask, it is a subtask which we need to keep track of to remove properly when it completes.
virtual const int	autoLaunchSubtaskId () const
virtual void	setAutoLaunchRange (const double range)
virtual const double	autoLaunchRange () const
virtual void	setElapsedTimeBetweenAutoLaunches (const double time)
	Get/Set the time elapsed since the last auto launch.
virtual const double	elapsedTimeBetweenAutoLaunches () const
Public Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtVrfProcessStateRepository (const DtVrfProcessStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtVrfProcessStateRepository &	operator= (const DtVrfProcessStateRepository &orig)
virtual	~DtVrfProcessStateRepository ()
virtual bool	init ()
	Used for virtual construction. This base method simply returns true.
virtual bool	loadedFromMTL () const
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Top level to read itself from an input stream.
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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &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 void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
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 const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
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 bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called.
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
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 void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class.
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
	Returns a newly created instance of this class.
Static Public Member Functions inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	factory ()
	a DtVrfProcessStateRepositoryFactory is allocated by the DtSimCreator, and this pointer is set.
static void	setFactory (DtVrfProcessStateRepositoryFactory *factory)
static void	addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)
static DtVrfProcessStateRepository *	createRepository (const DtString &name, const DtString &type, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0)
	Creates a new state repository object, using the 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 ()
	The type that is used when archiving to an XML stream.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.

Protected Attributes
DtRwInt	myNumberLeftToFire
	This stores how much time has passed since the limit existence controller was created in the simulation.
DtRwReal	myElapsedTimeBetweenInterval
	This is the time elapsed since the last time we fired a resource.
DtRwBoolean	myAutoLaunchEnabled
	Stores whether the entity is enabled to automatically launch its resources when it reaches auto launch range.
DtRwReal	myAutoLaunchRange
	Stores the range within which the entity can automatically launch its resources.
DtRwReal	myTimeElapsedBetweenAutoLaunches
	Time elapsed since last autoLaunch.
DtRwInt	myAutoLaunchSubtaskId
Protected Attributes inherited from DtVrfProcessStateRepository
DtVrfObject *	myVrfObject
bool	myLoadedFromMTL
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
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked.

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::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

Detailed Description

class DtLaunchExpendableResourcePSR:

This is Process State Repository keeps how many resources are left to be fired from the owner controller. This data will be written to and read from the OOB file when a scenario checkpoint is saved and loaded.

Constructor & Destructor Documentation

DtLaunchExpendableResourcePSR::DtLaunchExpendableResourcePSR	(	DtVrfObject *	vrfObject,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

DtLaunchExpendableResourcePSR::DtLaunchExpendableResourcePSR	(	const DtLaunchExpendableResourcePSR &	orig,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtLaunchExpendableResourcePSR::~DtLaunchExpendableResourcePSR ( )

virtual

destructor

Member Function Documentation

DtLaunchExpendableResourcePSR& DtLaunchExpendableResourcePSR::operator=

(

const DtLaunchExpendableResourcePSR &

orig

)

assignment operator

virtual DtVrfProcessStateRepository* DtLaunchExpendableResourcePSR::clone ( const DtString &  rwName = DtString::nullString(), DtReaderWriterRegistry *  parentRegistry = 0  ) const

virtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtLaunchExpendableResourcePSR::type ( ) const

virtual

Returns the string type of this process state repository.

Implements DtVrfProcessStateRepository.

virtual void DtLaunchExpendableResourcePSR::setNumberLeftToFire ( const int  number )

virtual

Get / Set the number left to fire variable.

virtual const int DtLaunchExpendableResourcePSR::numberLeftToFire ( ) const

virtual

virtual void DtLaunchExpendableResourcePSR::reduceNumberLeftToFire ( const int  reduce )

virtual

Reduce the number left to fire by the reduce amount. Convience function.

virtual void DtLaunchExpendableResourcePSR::setElapsedTimeBetweenInterval ( const double  time )

virtual

Get/Set the time elapsed since the last resource was fired.

virtual const double DtLaunchExpendableResourcePSR::elapsedTimeBetweenInterval ( ) const

virtual

virtual void DtLaunchExpendableResourcePSR::setAutoLaunchEnabled ( bool  enabled )

virtual

If enabled entity will automatically launch its resources when the auto launch range is reached.

virtual bool DtLaunchExpendableResourcePSR::autoLaunchEnabled ( ) const

virtual

virtual bool DtLaunchExpendableResourcePSR::autoLaunchEnabledOnSpecified ( ) const

virtual

virtual void DtLaunchExpendableResourcePSR::setAutoLaunchSubtaskId ( const int  id )

virtual

If we launched an autotask, it is a subtask which we need to keep track of to remove properly when it completes.

So we keep the subtask's id.

virtual const int DtLaunchExpendableResourcePSR::autoLaunchSubtaskId ( ) const

virtual

virtual void DtLaunchExpendableResourcePSR::setAutoLaunchRange ( const double  range )

virtual

virtual const double DtLaunchExpendableResourcePSR::autoLaunchRange ( ) const

virtual

virtual void DtLaunchExpendableResourcePSR::setElapsedTimeBetweenAutoLaunches ( const double  time )

virtual

Get/Set the time elapsed since the last auto launch.

virtual const double DtLaunchExpendableResourcePSR::elapsedTimeBetweenAutoLaunches ( ) const

virtual

static DtVrfProcessStateRepository* DtLaunchExpendableResourcePSR::creator ( const DtString &  rwName, DtVrfObject *  vrfObject, DtReaderWriterRegistry *  parentRegistry  )

static

Returns a newly created instance of this class.

Member Data Documentation

DtRwInt DtLaunchExpendableResourcePSR::myNumberLeftToFire

protected

This stores how much time has passed since the limit existence controller was created in the simulation.

DtRwReal DtLaunchExpendableResourcePSR::myElapsedTimeBetweenInterval

protected

This is the time elapsed since the last time we fired a resource.

We keep track of this so we can determine when the interval time has passed and we should fire the next resource.

DtRwBoolean DtLaunchExpendableResourcePSR::myAutoLaunchEnabled

protected

Stores whether the entity is enabled to automatically launch its resources when it reaches auto launch range.

Criteria for meeting that are determined in the launch expendable resources controller's autoLaunchEngaged

DtRwReal DtLaunchExpendableResourcePSR::myAutoLaunchRange

protected

Stores the range within which the entity can automatically launch its resources.

DtRwReal DtLaunchExpendableResourcePSR::myTimeElapsedBetweenAutoLaunches

protected

Time elapsed since last autoLaunch.

DtRwInt DtLaunchExpendableResourcePSR::myAutoLaunchSubtaskId

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/launchExpendableResourcePSR.h