DtSetWarheadInfo Class Reference

DtSetWarheadInfo is used to specify data to a DtWarheadDetonationActuator. More...

Inheritance diagram for DtSetWarheadInfo:

Public Member Functions
	DtSetWarheadInfo ()
	default constructor
	DtSetWarheadInfo (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a request 'put' itself, the writeName will preface it.
	DtSetWarheadInfo (const DtString &writeName, const DtSetWarheadInfo &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSetWarheadInfo &	operator= (const DtSetWarheadInfo &orig)
	assignment operator
virtual	~DtSetWarheadInfo ()
virtual const DtSetMessageType &	type () const
	Returns DtSetWarheadInfoType.
virtual DtSetDataRequest *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
	Creates a copy of the request.
virtual DtString	stringRep () const
	Get a readable string representation of this setDataRequest.
virtual void	setWarheadType (DtWarheadType wh)
	Set/get the warhead type.
virtual DtWarheadType	warheadType () const
virtual bool	warheadTypeSpecified () const
virtual void	setFuzeType (DtDetonatorFuze fuze)
	Set/get the fuze type.
virtual DtDetonatorFuze	fuzeType () const
virtual bool	fuzeTypeSpecified () const
virtual void	setAttacker (const DtString &name)
	Set/get the name of the attacker.
virtual DtString	attacker () const
virtual bool	attackerSpecified () const
virtual void	setEventIdString (const DtString &eventId)
	Set/get the event ID.
virtual DtString	eventIdString () const
virtual bool	eventIdSpecified () const
virtual void	setTargetName (const DtString &target)
	Set/get the target name.
virtual DtString	targetName () const
virtual bool	targetNameSpecified () const
virtual int	netRepSize () const
	Returns the size of the full network representation padded to an 8-byte boundary.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Fills in the task from the network buffer.
virtual bool	setToNet ()
	Fills in the network buffer (created by base class simTask) with the task contents.
Target Proximity mode and range
Set/get the target location. The warhead only needs a target location if it is intended to detonate on proximity to the location. Note: the warhead can only be configured for proximity from a target, from a location, or from a laser spot so only one of these methods should be called.
virtual void	setTargetLocation (const DtVector &target)
	Set/get the laser code.
virtual DtVector	targetLocation () const
	Set/get the laser code.
virtual bool	targetLocationSpecified () const
	Set/get the laser code.
virtual void	setLaserCode (int code)
	Set/get the laser code.
virtual int	laserCode () const
	Set/get the laser code.
virtual bool	laserCodeSpecified () const
	Set/get the laser code.
virtual void	setDetonationProximity (DtReal proximity)
	Set/get the detonation proximity.
virtual DtReal	detonationProximity () const
	Set/get the laser code.
virtual bool	detonationProximitySpecified () const
	Set/get the laser code.
virtual void	setDetonationAltitude (DtReal altitude)
	Set/get the detonation altitude.
virtual DtReal	detonationAltitude () const
	Set/get the laser code.
virtual bool	detonationAltitudeSpecified () const
	Set/get the laser code.
Public Member Functions inherited from DtSetDataRequest
virtual	~DtSetDataRequest ()
	destructor
virtual bool	init ()
	Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation.
virtual void	putData (FILE *fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actual stored.
virtual char *	netRep ()
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (FILE *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.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
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.
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
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.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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.
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.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static DtSetDataRequest *	creator ()
Static Public Member Functions inherited from DtSetDataRequest
static DtSetDataRequest *	createSetDataRequest (DtlObjPtr mtlStream)
	Static functions.
static DtSetDataRequest *	createSetDataRequest (DtSetMessageType requestType)
static void	addSetDataRequestCreatorFcn (const DtSetMessageType &setDataName, DtSetDataRequestCreatorFcn fcn)
static void	setFactory (DtSetDataRequestFactory *factory)
static DtSetDataRequestFactory *	factory ()
static bool	isTypeRegistered (DtSetMessageType setDataType)
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Static Public Member Functions inherited from DtObjectDebugger< DtReaderWriter >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()

Protected Attributes
DtRwInt	myWarheadType
DtRwInt	myFuzeType
DtRwString	myAttacker
DtRwString	myEventIdString
DtRwObjectName	myTargetName
DtRwVector	myTargetLocation
DtRwInt	myLaserCode
DtRwReal	myDetonationProximity
DtRwReal	myDetonationAltitude
Protected Attributes inherited from DtSetDataRequest
char *	myNetRep
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.
bool	myInvalid
	Set to true if there is a problem reading this item.

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 )()
Protected Member Functions inherited from DtSetDataRequest
	DtSetDataRequest ()
	Constructors are protected because no one should instantiate the base class, just derived versions.
	DtSetDataRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a request 'put' itself, the write name will preface it.
	DtSetDataRequest (const DtString &writeName, const DtSetDataRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSetDataRequest &	operator= (const DtSetDataRequest &orig)
	assignment operator; same as copy costructor.
virtual char *	createNetworkBuffer ()
	int setDataType);
Static Protected Attributes inherited from DtSetDataRequest
static DtSetDataRequestFactory *	myFactory

Detailed Description

DtSetWarheadInfo is used to specify data to a DtWarheadDetonationActuator.

The Warhead type, fuze type, attack name, detonation event ID, target name detonation proximity are all set through this set data request. Not all fields must be set. Data is preserved within the message on which fields have been set, and which have not. This is accessed though the xxxSpecified() calls for each field. The specified flag is set to true automatically when a mutator is called for that field.

Constructor & Destructor Documentation

DtSetWarheadInfo::DtSetWarheadInfo

(

)

default constructor

DtSetWarheadInfo::DtSetWarheadInfo	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor If you have a request 'put' itself, the writeName will preface it.

DtSetWarheadInfo::DtSetWarheadInfo	(	const DtString &	writeName,
		const DtSetWarheadInfo &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtSetWarheadInfo::~DtSetWarheadInfo ( )

virtual

Member Function Documentation

const DtSetWarheadInfo& DtSetWarheadInfo::operator=

(

const DtSetWarheadInfo &

orig

)

assignment operator

virtual const DtSetMessageType& DtSetWarheadInfo::type ( ) const

virtual

Returns DtSetWarheadInfoType.

Implements DtSetDataRequest.

virtual DtSetDataRequest* DtSetWarheadInfo::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = 0  ) const

virtual

Creates a copy of the request.

Implements DtSetDataRequest.

virtual DtString DtSetWarheadInfo::stringRep ( ) const

virtual

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual void DtSetWarheadInfo::setWarheadType ( DtWarheadType  wh )

virtual

Set/get the warhead type.

virtual DtWarheadType DtSetWarheadInfo::warheadType ( ) const

virtual

virtual bool DtSetWarheadInfo::warheadTypeSpecified ( ) const

virtual

virtual void DtSetWarheadInfo::setFuzeType ( DtDetonatorFuze  fuze )

virtual

Set/get the fuze type.

virtual DtDetonatorFuze DtSetWarheadInfo::fuzeType ( ) const

virtual

virtual bool DtSetWarheadInfo::fuzeTypeSpecified ( ) const

virtual

virtual void DtSetWarheadInfo::setAttacker ( const DtString &  name )

virtual

Set/get the name of the attacker.

virtual DtString DtSetWarheadInfo::attacker ( ) const

virtual

virtual bool DtSetWarheadInfo::attackerSpecified ( ) const

virtual

virtual void DtSetWarheadInfo::setEventIdString ( const DtString &  eventId )

virtual

Set/get the event ID.

The event ID must be passed in its string form in the message because the DtEventId class is different in HLA and DIS.

virtual DtString DtSetWarheadInfo::eventIdString ( ) const

virtual

virtual bool DtSetWarheadInfo::eventIdSpecified ( ) const

virtual

virtual void DtSetWarheadInfo::setTargetName ( const DtString &  target )

virtual

Set/get the target name.

The warhead only needs a target name if it is intended to detonate on proximity to the target. Note: the warhead can only be configured for proximity from a target, from a location, or from a laser spot so only one of these methods should be called.

virtual DtString DtSetWarheadInfo::targetName ( ) const

virtual

virtual bool DtSetWarheadInfo::targetNameSpecified ( ) const

virtual

virtual void DtSetWarheadInfo::setTargetLocation ( const DtVector &  target )

virtual

Set/get the laser code.

The warhead only needs a laser code if it is intended to detonate on proximity to a laser spot. Note: the warhead can only be configured for proximity from a target, from a location, or from a laser spot so only one of these methods should be called.

virtual DtVector DtSetWarheadInfo::targetLocation ( ) const

virtual

Set/get the laser code.

The warhead only needs a laser code if it is intended to detonate on proximity to a laser spot. Note: the warhead can only be configured for proximity from a target, from a location, or from a laser spot so only one of these methods should be called.

virtual bool DtSetWarheadInfo::targetLocationSpecified ( ) const

virtual

Set/get the laser code.

The warhead only needs a laser code if it is intended to detonate on proximity to a laser spot. Note: the warhead can only be configured for proximity from a target, from a location, or from a laser spot so only one of these methods should be called.

virtual void DtSetWarheadInfo::setLaserCode ( int  code )

virtual

Set/get the laser code.

The warhead only needs a laser code if it is intended to detonate on proximity to a laser spot. Note: the warhead can only be configured for proximity from a target, from a location, or from a laser spot so only one of these methods should be called.

virtual int DtSetWarheadInfo::laserCode ( ) const

virtual

Set/get the laser code.

The warhead only needs a laser code if it is intended to detonate on proximity to a laser spot. Note: the warhead can only be configured for proximity from a target, from a location, or from a laser spot so only one of these methods should be called.

virtual bool DtSetWarheadInfo::laserCodeSpecified ( ) const

virtual

Set/get the laser code.

The warhead only needs a laser code if it is intended to detonate on proximity to a laser spot. Note: the warhead can only be configured for proximity from a target, from a location, or from a laser spot so only one of these methods should be called.

virtual void DtSetWarheadInfo::setDetonationProximity ( DtReal  proximity )

virtual

Set/get the detonation proximity.

The warhead needs a target to detonate within proximity of, if this behavior is desired.

virtual DtReal DtSetWarheadInfo::detonationProximity ( ) const

virtual

Set/get the laser code.

The warhead only needs a laser code if it is intended to detonate on proximity to a laser spot. Note: the warhead can only be configured for proximity from a target, from a location, or from a laser spot so only one of these methods should be called.

virtual bool DtSetWarheadInfo::detonationProximitySpecified ( ) const

virtual

Set/get the laser code.

The warhead only needs a laser code if it is intended to detonate on proximity to a laser spot. Note: the warhead can only be configured for proximity from a target, from a location, or from a laser spot so only one of these methods should be called.

virtual void DtSetWarheadInfo::setDetonationAltitude ( DtReal  altitude )

virtual

Set/get the detonation altitude.

If specified, the warhead will detonate when is falls below this altitude.

Note

: This only applies when the warhead is moving down, and passes below this altitude. If level, or moving up, the warhead will not detonate, even if it is below this altitude.

virtual DtReal DtSetWarheadInfo::detonationAltitude ( ) const

virtual

Set/get the laser code.

The warhead only needs a laser code if it is intended to detonate on proximity to a laser spot. Note: the warhead can only be configured for proximity from a target, from a location, or from a laser spot so only one of these methods should be called.

virtual bool DtSetWarheadInfo::detonationAltitudeSpecified ( ) const

virtual

Set/get the laser code.

The warhead only needs a laser code if it is intended to detonate on proximity to a laser spot. Note: the warhead can only be configured for proximity from a target, from a location, or from a laser spot so only one of these methods should be called.

virtual int DtSetWarheadInfo::netRepSize ( ) const

virtual

Returns the size of the full network representation padded to an 8-byte boundary.

Reimplemented from DtSetDataRequest.

virtual bool DtSetWarheadInfo::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

virtual

Fills in the task from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtSetWarheadInfo::setToNet ( )

virtual

Fills in the network buffer (created by base class simTask) with the task contents.

Reimplemented from DtSetDataRequest.

static DtSetDataRequest* DtSetWarheadInfo::creator ( )

static

Member Data Documentation

DtRwInt DtSetWarheadInfo::myWarheadType

protected

DtRwInt DtSetWarheadInfo::myFuzeType

protected

DtRwString DtSetWarheadInfo::myAttacker

protected

DtRwString DtSetWarheadInfo::myEventIdString

protected

DtRwObjectName DtSetWarheadInfo::myTargetName

protected

DtRwVector DtSetWarheadInfo::myTargetLocation

protected

DtRwInt DtSetWarheadInfo::myLaserCode

protected

DtRwReal DtSetWarheadInfo::myDetonationProximity

protected

DtRwReal DtSetWarheadInfo::myDetonationAltitude

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrftasks/setWarheadInfo.h