DtFireMissionInformation Class Reference

Inheritance diagram for DtFireMissionInformation:

Public Member Functions
	DtFireMissionInformation ()
	DtFireMissionInformation (const DtString &name, DtReaderWriterRegistry *const parentRegistry=0)
	DtFireMissionInformation (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=0)
	DtFireMissionInformation (const DtString &writeName, const DtFireMissionInformation &orig, DtReaderWriterRegistry *const parentRegistry=0)
virtual	~DtFireMissionInformation ()
DtFireMissionInformation &	operator= (const DtFireMissionInformation &orig)
const DtRwVector &	currentTargetLocation () const
void	setCurrentTargetLocation (const DtVector &loc)
DtRwSimObjectReference	target () const
void	setTarget (const DtUUID &name)
const DtRwString &	ammoType () const
void	setAmmoType (const DtString &ammo)
const DtRwInt	numberOfRounds () const
void	setNumberOfRounds (const int num)
virtual void	setHeightAboveTerrain (DtReal height)
virtual DtReal	heightAboveTerrain ()
virtual void	setMuzzleSpeed (DtReal v)
virtual DtRwReal	muzzleSpeed ()
virtual void	setMuzzleOrientation (const DtRwTaitBryan &o)
virtual DtRwTaitBryan &	muzzleOrientation ()
DtRwSimObjectReference	route () const
void	setRoute (const DtUUID &name)
void	setFuseType (int i)
bool	fuseTypeSpecified () const
DtDetonatorFuze	fuseType () const
virtual const DtReal	detonationProximity () const
virtual void	setDetonationProximity (DtReal prox)
virtual bool	generateKnownTargetPoint () const
virtual void	setGenerateKnownTargetPoint (bool b)
virtual void	setKnownTargetPointName (const DtString &s)
virtual const DtString &	knownTargetPointName () 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)
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
DtRwSimObjectReference	myTarget
DtRwString	myAmmoType
DtRwVector	myCurrentTargetLocation
DtRwInt	myNumberRounds
DtRwReal	myHeightAboveTerrain
DtRwReal	myMuzzleSpeed
DtRwTaitBryan	myMuzzleOrientation
DtRwSimObjectReference	myRoute
DtRwReal	myDetonationProximity
DtRwInt	myFuseType
DtRwBoolean	myGenerateKnownTargetPoint
DtRwString	myKnownTargetPointName
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

Related Functions
(Note that these are not member functions.)
typedef DtRwTemplatedListPtr < DtFireMissionInformation, true >	DtFireMissionList
typedef std::map< DtString, DtFireMissionInformation >	DtMappedFireMissionList

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

DtFireMissionInformation::DtFireMissionInformation

(

)

DtFireMissionInformation::DtFireMissionInformation	(	const DtString &	name,
		DtReaderWriterRegistry *const	parentRegistry = 0
	)

DtFireMissionInformation::DtFireMissionInformation	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *const	parentRegistry = 0
	)

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

Copy constructor.

virtual DtFireMissionInformation::~DtFireMissionInformation ( )

virtual

Member Function Documentation

DtFireMissionInformation& DtFireMissionInformation::operator=

(

const DtFireMissionInformation &

orig

)

const DtRwVector& DtFireMissionInformation::currentTargetLocation ( ) const

inline

void DtFireMissionInformation::setCurrentTargetLocation ( const DtVector &  loc )

inline

DtRwSimObjectReference DtFireMissionInformation::target ( ) const

inline

If the fire mission objective is an entity we need to know it so we can update the location. Was: targeName.

void DtFireMissionInformation::setTarget ( const DtUUID &  name )

inline

Was: setTargetName.

const DtRwString& DtFireMissionInformation::ammoType ( ) const

inline

void DtFireMissionInformation::setAmmoType ( const DtString &  ammo )

inline

const DtRwInt DtFireMissionInformation::numberOfRounds ( ) const

inline

void DtFireMissionInformation::setNumberOfRounds ( const int  num )

inline

virtual void DtFireMissionInformation::setHeightAboveTerrain ( DtReal  height )

inlinevirtual

Set the height above terrain for the shell to detonate.

virtual DtReal DtFireMissionInformation::heightAboveTerrain ( )

inlinevirtual

Get the height above terrain for the shell to detonate.

virtual void DtFireMissionInformation::setMuzzleSpeed ( DtReal  v )

inlinevirtual

If specified in the task set the initial speed of the munition. Usefull for hand grenades.

virtual DtRwReal DtFireMissionInformation::muzzleSpeed ( )

inlinevirtual

Get the initial velocity for the shell to be fired at.

virtual void DtFireMissionInformation::setMuzzleOrientation ( const DtRwTaitBryan &  o )

inlinevirtual

If specified in the task set the orientation of the munition. Usefull for hand grenades.

References DtReaderWriter::setValueSpecified().

virtual DtRwTaitBryan& DtFireMissionInformation::muzzleOrientation ( )

inlinevirtual

Get the initial velocity for the shell to be fired at.

DtRwSimObjectReference DtFireMissionInformation::route ( ) const

inline

Additional Parameters for Cruise Missiles.

void DtFireMissionInformation::setRoute ( const DtUUID &  name )

inline

void DtFireMissionInformation::setFuseType ( int  i )

inline

Type of fuse to use, if known.

bool DtFireMissionInformation::fuseTypeSpecified ( ) const

inline

DtDetonatorFuze DtFireMissionInformation::fuseType ( ) const

inline

virtual const DtReal DtFireMissionInformation::detonationProximity ( ) const

inlinevirtual

virtual void DtFireMissionInformation::setDetonationProximity ( DtReal  prox )

inlinevirtual

virtual bool DtFireMissionInformation::generateKnownTargetPoint ( ) const

inlinevirtual

virtual void DtFireMissionInformation::setGenerateKnownTargetPoint ( bool  b )

inlinevirtual

virtual void DtFireMissionInformation::setKnownTargetPointName ( const DtString &  s )

inlinevirtual

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& DtFireMissionInformation::knownTargetPointName ( ) const

inlinevirtual

Friends And Related Function Documentation

typedef DtRwTemplatedListPtr<DtFireMissionInformation,true> DtFireMissionList

related

typedef std::map<DtString, DtFireMissionInformation> DtMappedFireMissionList

related

Member Data Documentation

DtRwSimObjectReference DtFireMissionInformation::myTarget

protected

DtRwString DtFireMissionInformation::myAmmoType

protected

DtRwVector DtFireMissionInformation::myCurrentTargetLocation

protected

DtRwInt DtFireMissionInformation::myNumberRounds

protected

DtRwReal DtFireMissionInformation::myHeightAboveTerrain

protected

DtRwReal DtFireMissionInformation::myMuzzleSpeed

protected

DtRwTaitBryan DtFireMissionInformation::myMuzzleOrientation

protected

DtRwSimObjectReference DtFireMissionInformation::myRoute

protected

Additional parameters needed for cruise missiles.

DtRwReal DtFireMissionInformation::myDetonationProximity

protected

DtRwInt DtFireMissionInformation::myFuseType

protected

DtRwBoolean DtFireMissionInformation::myGenerateKnownTargetPoint

protected

DtRwString DtFireMissionInformation::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.

---

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

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