DtFireForEffectTask Class Reference

File: fireForEff.h.

Class: DtFireForEffectTask DtFireForEffectTask is an abstract base class which used to create fire for effect tasks that differ only by target type: entity, location, or target control point.

Inheritance diagram for DtFireForEffectTask:

Public Member Functions
virtual	~DtFireForEffectTask ()
virtual void	addWeapon (const DtString &weap)
virtual const DtRwStringList &	weaponNames () const
virtual DtRwStringList &	weaponNames ()
virtual void	setWeaponNames (const DtRwStringList &weapons)
virtual bool	getWeaponOnList (const DtString &weaponName, DtString &weapon)
virtual void	setNumberOfRounds (int rounds)
virtual int	numberOfRounds () const
virtual bool	numberOfRoundsSpecified () const
virtual void	setDispersionRadius (DtReal radius)
virtual DtReal	dispersionRadius () const
virtual bool	dispersionRadiusSpecified () const
virtual void	setHeightAboveTerrain (DtReal height)
virtual DtReal	heightAboveTerrain () const
virtual bool	heightAboveTerrainSpecified () const
virtual void	setMuzzleSpeed (DtReal v)
virtual DtReal	muzzleSpeed () const
virtual bool	muzzleSpeedSpecified () const
virtual void	setMuzzleOrientation (DtTaitBryan &orient)
virtual const DtRwTaitBryan &	muzzleOrientation () const
virtual bool	muzzleOrientationSpecified () const
virtual void	setFuseType (int i)
virtual bool	fuseTypeSpecified () const
virtual DtDetonatorFuze	fuseType () const
virtual void	setGenerateKnownTargetPoint (bool)
virtual bool	generateKnownTargetPoint () const
virtual void	setKnownTargetPointName (const DtString &)
virtual const DtString &	knownTargetPointName () const
virtual void	setContinuousFire (bool)
virtual bool	continuousFire () const
virtual void	setFireMissionIndex (unsigned int)
virtual unsigned int	fireMissionIndex () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual DtString	parameterStringRep () const
Public Member Functions inherited from DtSimTask
virtual	~DtSimTask ()
virtual bool	init ()
virtual const DtSimTaskMessageType &	type () const =0
virtual bool	isTypeRegistered (const DtSimTaskMessageType &taskName)
virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const =0
virtual DtString	stringRep () const =0
virtual void	setSubtask (bool flag)
virtual bool	subtask () const
virtual void	setAllowTaskVisualizations (bool flag)
virtual bool	allowTaskVisualizations () const
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)

Protected Member Functions
	DtFireForEffectTask ()
	DtFireForEffectTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	DtFireForEffectTask (const DtString &writeName, const DtFireForEffectTask &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtFireForEffectTask &	operator= (const DtFireForEffectTask &orig)
Protected Member Functions inherited from DtSimTask
	DtSimTask ()
	DtSimTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	DtSimTask (const DtString &writeName, const DtSimTask &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtSimTask &	operator= (const DtSimTask &orig)
virtual char *	createNetworkBuffer ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
DtRwStringList	myWeaponNames
DtRwInt	myNumberOfRounds
DtRwReal	myDispersionRadius
DtRwReal	myHeightAboveTerrain
DtRwInt	myFuseType
DtRwInt	myFireMissionIndex
DtRwReal	myMuzzleSpeed
DtRwTaitBryan	myMuzzleOrientation
DtRwBoolean	myGenerateKnownTargetPoint
DtRwString	myKnownTargetPointName
DtRwBoolean	myContinuousFire
Protected Attributes inherited from DtSimTask
DtRwBoolean	mySubtask
DtRwBoolean	myAllowTaskVisualizations
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 )()
Static Public Member Functions inherited from DtSimTask
static DtSimTask *	createTask (DtlObjPtr mtlStream)
static DtSimTask *	createTask (const DtSimTaskMessageType &taskType)
static void	addTaskCreatorFcn (const DtSimTaskMessageType &taskName, DtSimTaskCreatorFcn fcn)
static void	setFactory (DtSimTaskFactory *factory)
static DtSimTaskFactory *	factory ()
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)
Static Protected Attributes inherited from DtSimTask
static DtSimTaskFactory *	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

DtFireForEffectTask::DtFireForEffectTask ( )

protected

default constructor

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

protected

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

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

protected

copy constructor

virtual DtFireForEffectTask::~DtFireForEffectTask ( )

virtual

Member Function Documentation

const DtFireForEffectTask& DtFireForEffectTask::operator= ( const DtFireForEffectTask &  orig )

protected

assignment operator

virtual void DtFireForEffectTask::addWeapon ( const DtString &  weap )

virtual

Adds a weapon system to the list of weapons to be used for this task.

virtual const DtRwStringList& DtFireForEffectTask::weaponNames ( ) const

virtual

virtual DtRwStringList& DtFireForEffectTask::weaponNames ( )

virtual

virtual void DtFireForEffectTask::setWeaponNames ( const DtRwStringList &  weapons )

virtual

virtual bool DtFireForEffectTask::getWeaponOnList ( const DtString &  weaponName, DtString &  weapon  )

virtual

Look up a weaponName (intended to be a display name from a list maintained by a weapon component interface) in the myWeaponNames, which is a list of weapons to fire in this task. myWeaponNames entries also have an ammo appended and a ":" separator, but this is stripped off before the comparison with weaponName. Returns true if weaponName was found on the list, and false otherwise. If it returns true, then weapon will hold weaponname:ammo from myWeaponNames.

virtual void DtFireForEffectTask::setNumberOfRounds ( int  rounds )

virtual

See if ammo type was specified for this task (if not, use default).

virtual int DtFireForEffectTask::numberOfRounds ( ) const

virtual

virtual bool DtFireForEffectTask::numberOfRoundsSpecified ( ) const

virtual

virtual void DtFireForEffectTask::setDispersionRadius ( DtReal  radius )

virtual

virtual DtReal DtFireForEffectTask::dispersionRadius ( ) const

virtual

virtual bool DtFireForEffectTask::dispersionRadiusSpecified ( ) const

virtual

virtual void DtFireForEffectTask::setHeightAboveTerrain ( DtReal  height )

virtual

virtual DtReal DtFireForEffectTask::heightAboveTerrain ( ) const

virtual

virtual bool DtFireForEffectTask::heightAboveTerrainSpecified ( ) const

virtual

virtual void DtFireForEffectTask::setMuzzleSpeed ( DtReal  v )

virtual

virtual DtReal DtFireForEffectTask::muzzleSpeed ( ) const

virtual

virtual bool DtFireForEffectTask::muzzleSpeedSpecified ( ) const

virtual

virtual void DtFireForEffectTask::setMuzzleOrientation ( DtTaitBryan &  orient )

virtual

virtual const DtRwTaitBryan& DtFireForEffectTask::muzzleOrientation ( ) const

virtual

virtual bool DtFireForEffectTask::muzzleOrientationSpecified ( ) const

virtual

virtual void DtFireForEffectTask::setFuseType ( int  i )

virtual

Type of fuse to use, if known.

virtual bool DtFireForEffectTask::fuseTypeSpecified ( ) const

virtual

virtual DtDetonatorFuze DtFireForEffectTask::fuseType ( ) const

virtual

virtual void DtFireForEffectTask::setGenerateKnownTargetPoint ( bool  )

virtual

virtual bool DtFireForEffectTask::generateKnownTargetPoint ( ) const

virtual

virtual void DtFireForEffectTask::setKnownTargetPointName ( const DtString &  )

virtual

Sets the name of the known target point (if generated). Note that this will not enforce uniqueness on the sim side. It is up to the user to make sure this name is unique. If this is blank one will be generated randomly.

virtual const DtString& DtFireForEffectTask::knownTargetPointName ( ) const

virtual

virtual void DtFireForEffectTask::setContinuousFire ( bool  )

virtual

virtual bool DtFireForEffectTask::continuousFire ( ) const

virtual

virtual void DtFireForEffectTask::setFireMissionIndex ( unsigned  int )

virtual

virtual unsigned int DtFireForEffectTask::fireMissionIndex ( ) const

virtual

virtual int DtFireForEffectTask::netRepSize ( ) const

virtual

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

Reimplemented from DtSimTask.

Reimplemented in DtFireForEffectOnLocationTask, DtFireForEffectOnTargetTask, DtFireForEffectOnEntityTask, and DtProvideIndirectFireTask.

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

virtual

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

Reimplemented in DtFireForEffectOnLocationTask, DtFireForEffectOnTargetTask, DtFireForEffectOnEntityTask, and DtProvideIndirectFireTask.

virtual bool DtFireForEffectTask::setToNet ( )

virtual

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

Reimplemented from DtSimTask.

Reimplemented in DtFireForEffectOnLocationTask, DtFireForEffectOnTargetTask, DtFireForEffectOnEntityTask, and DtProvideIndirectFireTask.

virtual DtString DtFireForEffectTask::parameterStringRep ( ) const

virtual

Get a readable string representation of the parameters. Historical note: in 4.2, ammoSpecified has been removed; ammo is now specified for each weapon as part of the name in myWeaponNames. The ammo name is appended with a ":" separator.

Member Data Documentation

DtRwStringList DtFireForEffectTask::myWeaponNames

protected

DtRwInt DtFireForEffectTask::myNumberOfRounds

protected

DtRwReal DtFireForEffectTask::myDispersionRadius

protected

DtRwReal DtFireForEffectTask::myHeightAboveTerrain

protected

DtRwInt DtFireForEffectTask::myFuseType

protected

DtRwInt DtFireForEffectTask::myFireMissionIndex

protected

DtRwReal DtFireForEffectTask::myMuzzleSpeed

protected

In some circumstances like a hand tossed grenade the user may want to temper the force with which they throw creating a different trajectory.

DtRwTaitBryan DtFireForEffectTask::myMuzzleOrientation

protected

DtRwBoolean DtFireForEffectTask::myGenerateKnownTargetPoint

protected

On detonation create a known target point of first two letters of shooters name plus 4 random numbers.

DtRwString DtFireForEffectTask::myKnownTargetPointName

protected

If generating a known point, set this text to be the name of the known point rather than having the sim generate a random one.

DtRwBoolean DtFireForEffectTask::myContinuousFire

protected

Whether or not the firing will be continuous until a cease fire task is received.

---

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

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