DtDetonationDescriptor Class Reference

class DtDetonationDescriptor: More...

Inheritance diagram for DtDetonationDescriptor:

Public Member Functions
	DtDetonationDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	constructor More...
	DtDetonationDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
virtual	~DtDetonationDescriptor ()
	destructor More...
	DtDetonationDescriptor (const DtString &name, const DtDetonationDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...
	DtDetonationDescriptor (const DtSymbolString &name, const DtDetonationDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtDetonationDescriptor &	operator= (const DtDetonationDescriptor &orig)
	assignment operator More...
virtual DtDetonationDescriptor *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
	clone - return a newly created copy of ourself. More...
virtual DtDetonationDescriptor *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) 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). More...
virtual const DtEventId &	eventId () const
virtual void	setVelocity (const DtVector &velocity)
	Set/get velocity (world coordinates, meters/second). More...
virtual const DtVector &	velocity () const
virtual void	setEntityLocation (const DtVector &entityLocation)
	Set/get location of the detonation in entity coordinates (meters). More...
virtual const DtVector &	entityLocation () const
virtual void	setWorldLocation (const DtVector &worldLocation)
	Set/get location of detonation in world coordinates (meters). More...
virtual const DtVector &	worldLocation () const
virtual void	setResult (DtDetonationResult result)
	Set/get detonation result (enumeration defined in disEnums.h). More...
virtual DtDetonationResult	result () const
virtual void	setFuzeType (DtDetonatorFuze fuze)
	Set/Get the detonator fuze type (enumeration defined in disEnums.h). More...
virtual DtDetonatorFuze	fuzeType () const
virtual void	setMunitionType (const DtEntityType &munType)
	Set/get the munition entity type. More...
virtual const DtEntityType &	munitionType () const
virtual void	setQuantity (int quant)
	Set/get the quantity of munition rounds. More...
virtual int	quantity () const
virtual void	setRate (int rate)
	Set/get the rate (per second). More...
virtual int	rate () const
virtual void	setWarheadType (DtWarheadType type)
	Set/get the warhead type (enumeration defined in disEnums.h). More...
virtual DtWarheadType	warheadType () const
virtual void	setArtParts (const DtSimArtPartDescriptorList &artParts)
	Set/get the articulated parts list. More...
virtual const DtSimArtPartDescriptorList &	artParts () const
virtual void	setSimTime (DtTime time)
	Set/get the simulation time (seconds) at which this detonation occurs. More...
virtual DtTime	simTime () const
virtual void	setAttacker (const DtUUID &)
	Set/get attacker. More...
virtual const DtRwVrfObjectReference &	attacker () const
	Was: attackerName. More...
virtual DtRwVrfObjectReference &	attacker ()
virtual void	setTarget (const DtUUID &)
	Set/get target. More...
virtual const DtRwVrfObjectReference &	target () const
	Was: targetName. More...
virtual DtRwVrfObjectReference &	target ()
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor More...
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream. More...
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor More...
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator More...
bool	operator== (const DtReaderWriter &) const
	Equivalence operator. More...
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor More...
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file. More...
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op. More...
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op. More...
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream. More...
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op. More...
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op. More...
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry. More...
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object. More...
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object. More...
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag. More...
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More...
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment. More...
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false. More...
virtual void	setName (const DtString &)
	Set the name of the object. More...
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable. More...
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children. More...
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain. More...
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference. More...
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings. More...
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated. More...
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time. More...
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called. More...
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...
virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data. More...
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values. More...
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively. More...
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference. More...
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified. More...
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here. More...
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object. More...
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename. More...
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid. More...
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file. More...
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data. More...
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference. More...
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())
	Gets data from the environment value. More...
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. More...
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference. More...

Protected Attributes
DtEventId	myEventId
	member data valid only for the duration of execution More...
DtRwVrfObjectReference	myAttacker
	read/writer member data (data that can be stored/restored across runs) More...
DtRwVrfObjectReference	myTarget
DtRwVector	myVelocity
DtRwVector	myWorldLocation
DtRwVector	myEntityLocation
DtRwInt	myDetonationResult
DtRwEntityType	myMunitionType
DtRwInt	myWarheadType
DtRwInt	myFuze
DtRwInt	myQuantity
DtRwInt	myRate
DtSimArtPartDescriptorList	myArtPartDescriptorList
DtRwReal	mySimTime
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
	Container for the aliases which represent alternative names for the object. More...
bool	myInvalid
	Set to true if there is a problem reading this item. More...
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...

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 ()
	The type that is used when archiving to an XML stream. More...
static const DtFilename &	appPath ()
	Gets the current working directory. More...
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory. More...
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)
	Given a filename, returns a newly created reader/writer object from the object found within. More...
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within. More...
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP. More...
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter. More...
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

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::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::setAttacker ( const DtUUID &  )

virtual

Set/get attacker.

Was: setAttackerName

virtual const DtRwVrfObjectReference& DtDetonationDescriptor::attacker ( ) const

virtual

Was: attackerName.

virtual DtRwVrfObjectReference& DtDetonationDescriptor::attacker ( )

virtual

virtual void DtDetonationDescriptor::setTarget ( const DtUUID &  )

virtual

Set/get target.

Was: setTargetName

virtual const DtRwVrfObjectReference& DtDetonationDescriptor::target ( ) const

virtual

Was: targetName.

virtual DtRwVrfObjectReference& DtDetonationDescriptor::target ( )

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

DtEventId DtDetonationDescriptor::myEventId

protected

member data valid only for the duration of execution

detonation interaction event Id

DtRwVrfObjectReference DtDetonationDescriptor::myAttacker

protected

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

DtRwVrfObjectReference 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

---

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

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