DtSetWarheadInfo Class Reference

File: setWarheadInfo.h.

Class: DtSetWarheadInfoVR-Link includes 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.

Inheritance diagram for DtSetWarheadInfo:

Public Member Functions
	DtSetWarheadInfo ()
	DtSetWarheadInfo (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	DtSetWarheadInfo (const DtString &writeName, const DtSetWarheadInfo &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtSetWarheadInfo &	operator= (const DtSetWarheadInfo &orig)
virtual	~DtSetWarheadInfo ()
virtual const DtSetMessageType &	type () const
virtual DtSetDataRequest *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString	stringRep () const
virtual void	setWarheadType (DtWarheadType wh)
virtual DtWarheadType	warheadType () const
virtual bool	warheadTypeSpecified () const
virtual void	setFuzeType (DtDetonatorFuze fuze)
virtual DtDetonatorFuze	fuzeType () const
virtual bool	fuzeTypeSpecified () const
virtual void	setAttacker (const DtUUID &)
virtual const DtUUID &	attacker () const
virtual bool	attackerSpecified () const
virtual void	setEventIdString (const DtString &eventId)
virtual DtString	eventIdString () const
virtual bool	eventIdSpecified () const
virtual void	setTarget (const DtUUID &target)
virtual const DtUUID &	target () const
virtual bool	targetSpecified () const
virtual void	setUsingPredeterminedHit (bool yesNo)
virtual bool	usingPredeterminedHit () const
virtual void	setHitsTarget (bool hits)
virtual bool	hitsTarget () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
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. This value is in geocentric
virtual void	setTargetLocation (const DtVector &target)
virtual DtVector	targetLocation () const
virtual bool	targetLocationSpecified () const
virtual void	setLaserCode (int code)
virtual int	laserCode () const
virtual bool	laserCodeSpecified () const
virtual void	setDetonationProximity (DtReal proximity)
virtual DtReal	detonationProximity () const
virtual bool	detonationProximitySpecified () const
virtual void	setDetonationTime (DtReal time)
virtual DtReal	detonationTime () const
virtual bool	detonationTimeSpecified () const
virtual void	setDetonationAltitude (DtReal altitude)
virtual DtReal	detonationAltitude () const
virtual bool	detonationAltitudeSpecified () const
Public Member Functions inherited from DtSetDataRequest
virtual	~DtSetDataRequest ()
virtual bool	init ()
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual char *	netRep ()
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)
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	wasUpdatedSince (DtTime t) const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
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)

Static Public Member Functions
static DtSetDataRequest *	creator ()
Static Public Member Functions inherited from DtSetDataRequest
static DtSetDataRequest *	createSetDataRequest (DtlObjPtr mtlStream)
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 (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 Attributes
DtRwInt	myWarheadType
DtRwInt	myFuzeType
DtRwUUID	myAttacker
DtRwString	myEventIdString
DtRwUUID	myTarget
DtRwVector	myTargetLocation
DtRwInt	myLaserCode
DtRwReal	myDetonationTime
DtRwReal	myDetonationProximity
DtRwReal	myDetonationAltitude
DtRwBoolean	myUsingPredeterminedHit
DtRwBoolean	myHitsTarget
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
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 )()
Protected Member Functions inherited from DtSetDataRequest
	DtSetDataRequest ()
	DtSetDataRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	DtSetDataRequest (const DtString &writeName, const DtSetDataRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtSetDataRequest &	operator= (const DtSetDataRequest &orig)
virtual char *	createNetworkBuffer ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
Static Protected Attributes inherited from DtSetDataRequest
static DtSetDataRequestFactory *	myFactory
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

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 DtUUID &  )

virtual

Set/get the name of the attacker.

virtual const DtUUID& 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::setTarget ( const DtUUID &  target )

virtual

Set/get the target. The warhead only needs a target 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. Was: setTargetName.

virtual const DtUUID& DtSetWarheadInfo::target ( ) const

virtual

Was: targetName.

virtual bool DtSetWarheadInfo::targetSpecified ( ) const

virtual

Was: targetNameSpecified.

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::setDetonationTime ( DtReal  time )

virtual

Set/get the detonation time. If the warhead has a timed fused this is used to set the timer, if this behavior is desired.

virtual DtReal DtSetWarheadInfo::detonationTime ( ) 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::detonationTimeSpecified ( ) 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 void DtSetWarheadInfo::setUsingPredeterminedHit ( bool  yesNo )

virtual

Set/get to true if this missile was predetermined to either hit or miss its target. Defaults to false. Set to true when the launcher is using hit probability tables.

virtual bool DtSetWarheadInfo::usingPredeterminedHit ( ) const

virtual

virtual void DtSetWarheadInfo::setHitsTarget ( bool  hits )

virtual

Set/get if using predetermined hits, specifies whether the missile should hit or miss.

virtual bool DtSetWarheadInfo::hitsTarget ( ) const

virtual

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

DtRwUUID DtSetWarheadInfo::myAttacker

protected

DtRwString DtSetWarheadInfo::myEventIdString

protected

DtRwUUID DtSetWarheadInfo::myTarget

protected

DtRwVector DtSetWarheadInfo::myTargetLocation

protected

DtRwInt DtSetWarheadInfo::myLaserCode

protected

DtRwReal DtSetWarheadInfo::myDetonationTime

protected

DtRwReal DtSetWarheadInfo::myDetonationProximity

protected

DtRwReal DtSetWarheadInfo::myDetonationAltitude

protected

DtRwBoolean DtSetWarheadInfo::myUsingPredeterminedHit

protected

DtRwBoolean DtSetWarheadInfo::myHitsTarget

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrftasks/setWarheadInfo.h