DtDetonationDescriptor Class Reference

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

Inheritance diagram for DtDetonationDescriptor:

Public Member Functions
	DtDetonationDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtDetonationDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
virtual	~DtDetonationDescriptor () override
	DtDetonationDescriptor (const DtString &name, const DtDetonationDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtDetonationDescriptor (const DtSymbolString &name, const DtDetonationDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtDetonationDescriptor &	operator= (const DtDetonationDescriptor &orig)
virtual DtDetonationDescriptor *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtDetonationDescriptor *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	setEventId (const DtString &eventId)
virtual const DtString &	eventId () const
virtual void	setVelocity (const DtVector &velocity)
virtual const DtVector &	velocity () const
virtual void	setEntityLocation (const DtVector &entityLocation)
virtual const DtVector &	entityLocation () const
virtual void	setWorldLocation (const DtVector &worldLocation)
virtual const DtVector &	worldLocation () const
virtual void	setResult (DtDetonationResult result)
virtual DtDetonationResult	result () const
virtual void	setFuzeType (DtDetonatorFuze fuze)
virtual DtDetonatorFuze	fuzeType () const
virtual void	setMunitionType (const DtEntityType &munType)
virtual const DtEntityType &	munitionType () const
virtual void	setQuantity (int quant)
virtual int	quantity () const
virtual void	setRate (int rate)
virtual int	rate () const
virtual void	setWarheadType (DtWarheadType type)
virtual DtWarheadType	warheadType () const
virtual void	setArtParts (const DtSimArtPartDescriptorList &artParts)
virtual const DtSimArtPartDescriptorList &	artParts () const
virtual void	setSimTime (DtTime time)
virtual DtTime	simTime () const
virtual void	setGenerateKnownTargetPoint (bool)
virtual bool	generateKnownTargetPoint () const
virtual void	setAttacker (const DtUUID &)
virtual DtSimObjectReference	attacker () const
virtual void	setTarget (const DtUUID &)
virtual DtSimObjectReference	target () const
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	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
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)

Protected Attributes
DtString	myEventId
DtRwSimObjectReference	myAttacker
DtRwSimObjectReference	myTarget
DtRwVector	myVelocity
DtRwVector	myWorldLocation
DtRwVector	myEntityLocation
DtRwInt	myDetonationResult
DtRwEntityType	myMunitionType
DtRwInt	myWarheadType
DtRwInt	myFuze
DtRwInt	myQuantity
DtRwInt	myRate
DtSimArtPartDescriptorList	myArtPartDescriptorList
DtRwReal	mySimTime
DtRwBoolean	myGenerateKnownTargetPoint
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 )()
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 Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
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

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

overridevirtual

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::setEventId ( const DtString &  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 DtString& DtDetonationDescriptor::eventId ( ) const

virtual

virtual void DtDetonationDescriptor::setAttacker ( const DtUUID &  )

virtual

Set/get attacker.Was: setAttackerName.

virtual DtSimObjectReference DtDetonationDescriptor::attacker ( ) const

virtual

Was: attackerName.

virtual void DtDetonationDescriptor::setTarget ( const DtUUID &  )

virtual

Set/get target.Was: setTargetName.

virtual DtSimObjectReference DtDetonationDescriptor::target ( ) const

virtual

Was: targetName.

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

virtual void DtDetonationDescriptor::setGenerateKnownTargetPoint ( bool  )

virtual

When detonated, generates a known point at the world location based on the first two characters of the shooter's name and 4 randome numbers.

virtual bool DtDetonationDescriptor::generateKnownTargetPoint ( ) const

virtual

Member Data Documentation

DtString DtDetonationDescriptor::myEventId

protected

member data valid only for the duration of execution

detonation interaction event Id

DtRwSimObjectReference DtDetonationDescriptor::myAttacker

protected

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

DtRwSimObjectReference DtDetonationDescriptor::myTarget

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

DtRwBoolean DtDetonationDescriptor::myGenerateKnownTargetPoint

protected

---

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

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