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.

Inheritance diagram for DtLaunchExpendableResourcePSR:

[legend]

Public Member Functions
	DtLaunchExpendableResourcePSR (DtLocalObject vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry parentRegistry=nullptr)

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

virtual	~DtLaunchExpendableResourcePSR () override

DtLaunchExpendableResourcePSR &	operator= (const DtLaunchExpendableResourcePSR &orig)

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

virtual DtString	type () const override

virtual void	setNumberLeftToFire (const int number)

virtual const int	numberLeftToFire () const

virtual void	reduceNumberLeftToFire (const int reduce)

virtual void	setElapsedTimeBetweenInterval (const double time)

virtual const double	elapsedTimeBetweenInterval () const

virtual void	setAutoLaunchEnabled (bool enabled)

virtual bool	autoLaunchEnabled () const

virtual bool	autoLaunchEnabledOnSpecified () const

virtual void	setAutoLaunchSubtaskId (const int id)

virtual const int	autoLaunchSubtaskId () const

virtual void	setAutoLaunchRange (const double range)

virtual const double	autoLaunchRange () const

virtual void	setElapsedTimeBetweenAutoLaunches (const double time)

virtual const double	elapsedTimeBetweenAutoLaunches () const

Public Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository (DtLocalObject 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 () override

virtual bool	init ()

virtual bool	loadedFromMTL () const

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

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) const

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	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	putData (std::string &fp, int indentLevel=0)

virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

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 DtVrfProcessStateRepository *	creator (const DtString &rwName, DtLocalObject vrfObject, DtReaderWriterRegistry parentRegistry)

Static Public Member Functions inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	factory ()

static void	setFactory (DtVrfProcessStateRepositoryFactory *factory)

static void	addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)

static DtVrfProcessStateRepository *	createRepository (const DtString &name, const DtString &type, DtLocalObject vrfObject, DtReaderWriterRegistry parentRegistry=0)

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 Attributes
DtRwInt	myNumberLeftToFire

DtRwReal	myElapsedTimeBetweenInterval

DtRwBoolean	myAutoLaunchEnabled

DtRwReal	myAutoLaunchRange

DtRwReal	myTimeElapsedBetweenAutoLaunches

DtRwInt	myAutoLaunchSubtaskId

Protected Attributes inherited from DtVrfProcessStateRepository
DtLocalObject *	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

bool	myInvalid

bool	myChangedFlag

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 ()

const DtSimObject *	vrfObject () const

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

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

DtLaunchExpendableResourcePSR::DtLaunchExpendableResourcePSR	(	DtLocalObject *	vrfObject,
		const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `nullptr`
	)

constructor

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

copy constructor

virtual DtLaunchExpendableResourcePSR::~DtLaunchExpendableResourcePSR ( )

overridevirtual

destructor

Member Function Documentation

DtLaunchExpendableResourcePSR& DtLaunchExpendableResourcePSR::operator= ( const DtLaunchExpendableResourcePSR & orig )

assignment operator

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

overridevirtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtLaunchExpendableResourcePSR::type ( ) const

overridevirtual

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. Convenience 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,
		DtLocalObject *	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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfobjcore/launchExpendableResourcePSR.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation