DtVrfBalGunPSR Class Reference

Class DtVrfBalGunPSR: Used to hold checkpointable state for the processes associated with ballistic guns. More...

Inheritance diagram for DtVrfBalGunPSR:

List of all members.

Public Member Functions
	DtVrfBalGunPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtVrfBalGunPSR (const DtVrfBalGunPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtVrfBalGunPSR &	operator= (const DtVrfBalGunPSR &orig)
virtual	~DtVrfBalGunPSR ()
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString	type () const
	Returns the string type of the repository, as defined in procSRTypes.h.
virtual const DtDetonationDescriptorList &	pendingDetonations () const
	Get list of pending detonations.
virtual void	addPendingDetonation (DtDetonationDescriptor *desc)
	Add a new pending detonation.
virtual void	removePendingDetonation (const DtEventId &eventId)
	Remove a particular pending detonation.
virtual void	setFiringCycleCompleteTime (DtTime completeTime)
	Update the time that the firing cycle will be complete.
virtual DtTime	timeFiringCycleComplete () const
	Access firing cycle complete time.
virtual void	setDisplayName (const DtString &displayName)
virtual const DtString	displayName () const
virtual void	setCommandedToFire ()
	Change and test functions for fire state.
virtual void	setHasFired ()
	Change and test functions for fire state.
virtual bool	isCommandedToFire ()
	Change and test functions for fire state.
virtual bool	hasFired ()
	Change and test functions for fire state.
Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
	Create an instance of a DtVrfWeaponPSR.
Protected Types
enum	FireState { CommandedToFire, HasFired }
	State describing the gun. More...
Protected Member Functions
	DtVrfBalGunPSR ()
Protected Attributes
DtDetonationDescriptorList	myPendingDetonations
	List of DtDetonationDescriptors, used to save/restore information about pending scheduled detonations.
DtRwInt	myFireState
	State describing the gun; for communication between the controller and actuator.
DtRwReal	myFireCycleCompleteTime
	The time at which the gun firing cycle is complete.
DtRwString	myDisplayName

---

Detailed Description

Class DtVrfBalGunPSR: Used to hold checkpointable state for the processes associated with ballistic guns.

Maintains information about any pending detonations (detonation interaction data, simulation time to fire).

---

Member Enumeration Documentation

enum DtVrfBalGunPSR::FireState [protected]

State describing the gun.

We could add more physical gun states here such as "jammed."

Enumerator:

CommandedToFire
HasFired

---

Constructor & Destructor Documentation

DtVrfBalGunPSR::DtVrfBalGunPSR

(

)

[protected]

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

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

virtual DtVrfBalGunPSR::~DtVrfBalGunPSR

(

)

[virtual]

---

Member Function Documentation

const DtVrfBalGunPSR& DtVrfBalGunPSR::operator=

(

const DtVrfBalGunPSR &

orig

)

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

Reimplemented from DtVrfWeaponPSR.

Reimplemented in DtVrfTurretedBalGunPSR.

virtual DtString DtVrfBalGunPSR::type

(

)

const [virtual]

Returns the string type of the repository, as defined in procSRTypes.h.

Reimplemented from DtVrfWeaponPSR.

Reimplemented in DtVrfTurretedBalGunPSR.

virtual const DtDetonationDescriptorList& DtVrfBalGunPSR::pendingDetonations

(

)

const [virtual]

Get list of pending detonations.

virtual void DtVrfBalGunPSR::addPendingDetonation

(

DtDetonationDescriptor *

desc

)

[virtual]

Add a new pending detonation.

virtual void DtVrfBalGunPSR::removePendingDetonation

(

const DtEventId &

eventId

)

[virtual]

Remove a particular pending detonation.

virtual void DtVrfBalGunPSR::setFiringCycleCompleteTime

(

DtTime

completeTime

)

[virtual]

Update the time that the firing cycle will be complete.

virtual DtTime DtVrfBalGunPSR::timeFiringCycleComplete

(

)

const [virtual]

Access firing cycle complete time.

virtual void DtVrfBalGunPSR::setCommandedToFire

(

)

[virtual]

Change and test functions for fire state.

virtual void DtVrfBalGunPSR::setHasFired

(

)

[virtual]

Change and test functions for fire state.

virtual bool DtVrfBalGunPSR::isCommandedToFire

(

)

[virtual]

Change and test functions for fire state.

virtual bool DtVrfBalGunPSR::hasFired

(

)

[virtual]

Change and test functions for fire state.

virtual void DtVrfBalGunPSR::setDisplayName

(

const DtString &

displayName

)

[virtual]

virtual const DtString DtVrfBalGunPSR::displayName

(

)

const [virtual]

static DtVrfProcessStateRepository* DtVrfBalGunPSR::creator	(	const DtString &	name,
		DtVrfObject *	vrfObject,
		DtReaderWriterRegistry *	parentRegistry
	)		[static]

Create an instance of a DtVrfWeaponPSR.

Reimplemented from DtVrfWeaponPSR.

Reimplemented in DtVrfTurretedBalGunPSR.

---

Member Data Documentation

DtDetonationDescriptorList DtVrfBalGunPSR::myPendingDetonations [protected]

List of DtDetonationDescriptors, used to save/restore information about pending scheduled detonations.

DtRwInt DtVrfBalGunPSR::myFireState [protected]

State describing the gun; for communication between the controller and actuator.

The controller sets this to "commanded," and the actuator sets it either to "has fired" or "unable." When the gun "has fired" and the cycle complete time has expired (below), then the controller can fire again.

DtRwReal DtVrfBalGunPSR::myFireCycleCompleteTime [protected]

The time at which the gun firing cycle is complete.

Set by the gun actuator component to inform the gun controller component that it can issue another fire command for another target.

DtRwString DtVrfBalGunPSR::myDisplayName [protected]

---

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

• include/vrfobjcore/balGunPSR.h