DtLaunchExpendableResourcePSR Class Reference

class DtLaunchExpendableResourcePSR: More...

Inheritance diagram for DtLaunchExpendableResourcePSR:

List of all members.

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
Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
	Returns a newly created instance of this class.
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

---

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:

• include/vrfobjcore/launchExpendableResourcePSR.h