DtDetonationDescriptor Class Reference

class DtDetonationDescriptor: More...

Inheritance diagram for DtDetonationDescriptor:

List of all members.

Public Member Functions
	DtDetonationDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	constructor
	DtDetonationDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
virtual	~DtDetonationDescriptor ()
	destructor
	DtDetonationDescriptor (const DtString &name, const DtDetonationDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtDetonationDescriptor (const DtSymbolString &name, const DtDetonationDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtDetonationDescriptor &	operator= (const DtDetonationDescriptor &orig)
	assignment operator
virtual DtDetonationDescriptor *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
	clone - return a newly created copy of ourself.
virtual DtDetonationDescriptor *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	setAttackerId (const DtGlobalObjectDesignator &globalId)
	Set/get global Id of attacker (not a reader/writer parameter - attacker object name is stored instead).
virtual const DtGlobalObjectDesignator &	attackerId () const
virtual void	setTargetId (const DtGlobalObjectDesignator &globalId)
	Set/get global Id of target (not a reader/writer parameter - target object name is stored instead).
virtual const DtGlobalObjectDesignator &	targetId () const
virtual void	setEventId (const DtEventId &eventId)
	Set/get event Id of detonation (not a reader/writer parameter - useful to identify detonation event during runtime - does not persist across runs, however).
virtual const DtEventId &	eventId () const
virtual void	setAttackerName (const DtString &objectName)
	Set/get object name of attacker.
virtual const DtString &	attackerName () const
virtual void	setTargetName (const DtString &objectName)
	Set/get object name of target.
virtual const DtString &	targetName () const
virtual void	setVelocity (const DtVector &velocity)
	Set/get velocity (world coordinates, meters/second).
virtual const DtVector &	velocity () const
virtual void	setEntityLocation (const DtVector &entityLocation)
	Set/get location of the detonation in entity coordinates (meters).
virtual const DtVector &	entityLocation () const
virtual void	setWorldLocation (const DtVector &worldLocation)
	Set/get location of detonation in world coordinates (meters).
virtual const DtVector &	worldLocation () const
virtual void	setResult (DtDetonationResult result)
	Set/get detonation result (enumeration defined in disEnums.h).
virtual DtDetonationResult	result () const
virtual void	setFuzeType (DtDetonatorFuze fuze)
	Set/Get the detonator fuze type (enumeration defined in disEnums.h).
virtual DtDetonatorFuze	fuzeType () const
virtual void	setMunitionType (const DtEntityType &munType)
	Set/get the munition entity type.
virtual const DtEntityType &	munitionType () const
virtual void	setQuantity (int quant)
	Set/get the quantity of munition rounds.
virtual int	quantity () const
virtual void	setRate (int rate)
	Set/get the rate (per second).
virtual int	rate () const
virtual void	setWarheadType (DtWarheadType type)
	Set/get the warhead type (enumeration defined in disEnums.h).
virtual DtWarheadType	warheadType () const
virtual void	setArtParts (const DtSimArtPartDescriptorList &artParts)
	Set/get the articulated parts list.
virtual const DtSimArtPartDescriptorList &	artParts () const
virtual void	setSimTime (DtTime time)
	Set/get the simulation time (seconds) at which this detonation occurs.
virtual DtTime	simTime () const
Protected Attributes
DtGlobalObjectDesignator	myAttackerId
	member data valid only for the duration of execution
DtGlobalObjectDesignator	myTargetId
DtEventId	myEventId
	detonation interaction event Id
DtRwString	myAttackerName
	read/writer member data (data that can be stored/restored across runs)
DtRwString	myTargetName
DtRwVector	myVelocity
DtRwVector	myWorldLocation
DtRwVector	myEntityLocation
DtRwInt	myDetonationResult
DtRwEntityType	myMunitionType
DtRwInt	myWarheadType
DtRwInt	myFuze
DtRwInt	myQuantity
DtRwInt	myRate
DtSimArtPartDescriptorList	myArtPartDescriptorList
DtRwReal	mySimTime

---

Detailed Description

class DtDetonationDescriptor:

Instances of DtDetonationDescriptor are readable/writeable objects used to hold the information needed to construct a DtDetonation object. Note that object names are preserved, rather than object Ids (object names can persist from run to run, while object Ids are only valid during a given run). Also note that simulation time of the detonation is included (not part of a detonation PDU or interaction, but its useful to store the time at which this detonation should occur).

---

Constructor & Destructor Documentation

DtDetonationDescriptor::DtDetonationDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL,
		bool	readonly = false
	)

constructor

DtDetonationDescriptor::DtDetonationDescriptor	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL,
		bool	readonly = false
	)

virtual DtDetonationDescriptor::~DtDetonationDescriptor

(

)

[virtual]

destructor

DtDetonationDescriptor::DtDetonationDescriptor	(	const DtString &	name,
		const DtDetonationDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

DtDetonationDescriptor::DtDetonationDescriptor	(	const DtSymbolString &	name,
		const DtDetonationDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

---

Member Function Documentation

DtDetonationDescriptor& DtDetonationDescriptor::operator=

(

const DtDetonationDescriptor &

orig

)

assignment operator

virtual DtDetonationDescriptor* DtDetonationDescriptor::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)		const [virtual]

clone - return a newly created copy of ourself.

virtual DtDetonationDescriptor* DtDetonationDescriptor::clone	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)		const [virtual]

virtual void DtDetonationDescriptor::setAttackerId

(

const DtGlobalObjectDesignator &

globalId

)

[virtual]

Set/get global Id of attacker (not a reader/writer parameter - attacker object name is stored instead).

virtual const DtGlobalObjectDesignator& DtDetonationDescriptor::attackerId

(

)

const [virtual]

virtual void DtDetonationDescriptor::setTargetId

(

const DtGlobalObjectDesignator &

globalId

)

[virtual]

Set/get global Id of target (not a reader/writer parameter - target object name is stored instead).

virtual const DtGlobalObjectDesignator& DtDetonationDescriptor::targetId

(

)

const [virtual]

virtual void DtDetonationDescriptor::setEventId

(

const DtEventId &

eventId

)

[virtual]

Set/get event Id of detonation (not a reader/writer parameter - useful to identify detonation event during runtime - does not persist across runs, however).

virtual const DtEventId& DtDetonationDescriptor::eventId

(

)

const [virtual]

virtual void DtDetonationDescriptor::setAttackerName

(

const DtString &

objectName

)

[virtual]

Set/get object name of attacker.

virtual const DtString& DtDetonationDescriptor::attackerName

(

)

const [virtual]

virtual void DtDetonationDescriptor::setTargetName

(

const DtString &

objectName

)

[virtual]

Set/get object name of target.

virtual const DtString& DtDetonationDescriptor::targetName

(

)

const [virtual]

virtual void DtDetonationDescriptor::setVelocity

(

const DtVector &

velocity

)

[virtual]

Set/get velocity (world coordinates, meters/second).

virtual const DtVector& DtDetonationDescriptor::velocity

(

)

const [virtual]

virtual void DtDetonationDescriptor::setEntityLocation

(

const DtVector &

entityLocation

)

[virtual]

Set/get location of the detonation in entity coordinates (meters).

virtual const DtVector& DtDetonationDescriptor::entityLocation

(

)

const [virtual]

virtual void DtDetonationDescriptor::setWorldLocation

(

const DtVector &

worldLocation

)

[virtual]

Set/get location of detonation in world coordinates (meters).

virtual const DtVector& DtDetonationDescriptor::worldLocation

(

)

const [virtual]

virtual void DtDetonationDescriptor::setResult

(

DtDetonationResult

result

)

[virtual]

Set/get detonation result (enumeration defined in disEnums.h).

virtual DtDetonationResult DtDetonationDescriptor::result

(

)

const [virtual]

virtual void DtDetonationDescriptor::setFuzeType

(

DtDetonatorFuze

fuze

)

[virtual]

Set/Get the detonator fuze type (enumeration defined in disEnums.h).

virtual DtDetonatorFuze DtDetonationDescriptor::fuzeType

(

)

const [virtual]

virtual void DtDetonationDescriptor::setMunitionType

(

const DtEntityType &

munType

)

[virtual]

Set/get the munition entity type.

virtual const DtEntityType& DtDetonationDescriptor::munitionType

(

)

const [virtual]

virtual void DtDetonationDescriptor::setQuantity

(

int

quant

)

[virtual]

Set/get the quantity of munition rounds.

virtual int DtDetonationDescriptor::quantity

(

)

const [virtual]

virtual void DtDetonationDescriptor::setRate

(

int

rate

)

[virtual]

Set/get the rate (per second).

virtual int DtDetonationDescriptor::rate

(

)

const [virtual]

virtual void DtDetonationDescriptor::setWarheadType

(

DtWarheadType

type

)

[virtual]

Set/get the warhead type (enumeration defined in disEnums.h).

virtual DtWarheadType DtDetonationDescriptor::warheadType

(

)

const [virtual]

virtual void DtDetonationDescriptor::setArtParts

(

const DtSimArtPartDescriptorList &

artParts

)

[virtual]

Set/get the articulated parts list.

virtual const DtSimArtPartDescriptorList& DtDetonationDescriptor::artParts

(

)

const [virtual]

virtual void DtDetonationDescriptor::setSimTime

(

DtTime

time

)

[virtual]

Set/get the simulation time (seconds) at which this detonation occurs.

virtual DtTime DtDetonationDescriptor::simTime

(

)

const [virtual]

---

Member Data Documentation

DtGlobalObjectDesignator DtDetonationDescriptor::myAttackerId [protected]

member data valid only for the duration of execution

detonation interaction global Ids

DtGlobalObjectDesignator DtDetonationDescriptor::myTargetId [protected]

DtEventId DtDetonationDescriptor::myEventId [protected]

detonation interaction event Id

DtRwString DtDetonationDescriptor::myAttackerName [protected]

read/writer member data (data that can be stored/restored across runs)

DtRwString DtDetonationDescriptor::myTargetName [protected]

DtRwVector DtDetonationDescriptor::myVelocity [protected]

DtRwVector DtDetonationDescriptor::myWorldLocation [protected]

DtRwVector DtDetonationDescriptor::myEntityLocation [protected]

DtRwInt DtDetonationDescriptor::myDetonationResult [protected]

DtRwEntityType DtDetonationDescriptor::myMunitionType [protected]

DtRwInt DtDetonationDescriptor::myWarheadType [protected]

DtRwInt DtDetonationDescriptor::myFuze [protected]

DtRwInt DtDetonationDescriptor::myQuantity [protected]

DtRwInt DtDetonationDescriptor::myRate [protected]

DtSimArtPartDescriptorList DtDetonationDescriptor::myArtPartDescriptorList [protected]

DtRwReal DtDetonationDescriptor::mySimTime [protected]

---

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

• include/vrfobjcore/detonationDesc.h