File: indirectFirePSR.h.

Class: DtVrfIndirectFirePSR Class DtVrfIndirectFirePSR: Used to hold checkpointable state for the processes associated with indirect fire weapons (i.e. artillery). Maintains information about any pending detonations (detonation interaction data, simulation time to fire).

Inheritance diagram for DtVrfIndirectFirePSR:

[legend]

Public Member Functions
	DtVrfIndirectFirePSR (DtLocalObject vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry parentRegistry=0)

	DtVrfIndirectFirePSR (const DtVrfIndirectFirePSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)

const DtVrfIndirectFirePSR &	operator= (const DtVrfIndirectFirePSR &orig)

virtual	~DtVrfIndirectFirePSR ()

virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const

virtual DtString	type () const

virtual const DtDetonationDescriptorList &	pendingDetonations () const

virtual void	addPendingDetonation (DtDetonationDescriptor *desc)

virtual void	removePendingDetonation (const DtString &eventId)

virtual void	setHeightAboveTerrain (DtReal height)

virtual DtReal	heightAboveTerrain ()

virtual void	setFireMissionIndex (unsigned int)

virtual DtRwInt32	fireMissionIndex ()

virtual void	setMuzzleSpeed (DtReal v)

virtual DtRwReal	muzzleSpeed ()

virtual void	setMuzzleOrientation (DtTaitBryan &o)

virtual DtRwTaitBryan &	muzzleOrientation ()

virtual void	setDetonationLocation (const DtVector &alt)

virtual const DtVector &	detonationLocation () const

virtual void	setPreferredAltitude (DtReal alt)

virtual DtReal	preferredAltitude () const

virtual void	setGenerateKnownTargetPoint (bool)

virtual bool	generateKnownTargetPoint () const

virtual void	setKnownTargetPointName (const DtString &)

virtual const DtString &	knownTargetPointName () const

virtual void	addLaunchedMunition (const DtString &eventId, const DtUUID &uuid, double timeOfFlight, double launchTime, const DtVector &targetPoint)

virtual bool	removeLaunchedMunition (const DtString &eventId)

virtual bool	removeLaunchedMunition (const DtUUID &uuid)

virtual void	setLastTargetLocation (const DtVector &)

virtual const DtVector &	lastTargetLocation () const

virtual bool	preferredAltitudeSpecified () const

virtual const DtRwLaunchedMunition *	currentLaunchedMunition () const

virtual const DtRwLaunchedMunition *	launchedMunition (const DtString &eventId) const

virtual const DtRwLaunchedMunition *	launchedMunition (const DtUUID &eventId) const

const DtRwLaunchedMunitionsList &	launchedMunitions () const

virtual void	setProvideFireRequestor (const DtUUID &)

virtual const DtUUID &	provideFireRequestor () const

Public Member Functions inherited from DtVrfWeaponPSR
	DtVrfWeaponPSR (DtLocalObject vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry parentRegistry=0)

	DtVrfWeaponPSR (const DtVrfWeaponPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)

const DtVrfWeaponPSR &	operator= (const DtVrfWeaponPSR &orig)

virtual	~DtVrfWeaponPSR ()

virtual void	setUserTargetOverride (bool userTargetOverride)

virtual bool	userTargetOverride () const

virtual void	setCurrentTarget (const DtUUID &, bool targetOverride=false)

virtual DtSimObjectReference	currentTarget () const

virtual const DtVrfMunitionLoader &	munitionLoader () const

virtual DtVrfMunitionLoader &	munitionLoader ()

virtual void	setCurrentMunitionName (const DtString &currentMunitionName)

virtual const DtString &	currentMunitionName () const

virtual bool	targetAcquired () const

virtual void	setTargetAcquired (bool targetAcquired)

virtual bool	weaponAimed () const

virtual void	setWeaponAimed (bool aimed)

virtual void	addActiveMissile (const DtUUID &)

virtual void	removeActiveMissile (const DtUUID &)

virtual const DtRwSimObjectReferenceList &	activeMissiles () const

virtual DtSimObjectReference	lastMissileFired () const

virtual bool	stillTargeting (const DtUUID &) const

Public Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository (DtLocalObject vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry parentRegistry=0)

	DtVrfProcessStateRepository (const DtVrfProcessStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)

const DtVrfProcessStateRepository &	operator= (const DtVrfProcessStateRepository &orig)

virtual	~DtVrfProcessStateRepository ()

virtual bool	init ()

virtual bool	loadedFromMTL () const

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

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

Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &name, DtLocalObject vrfObject, DtReaderWriterRegistry parentRegistry)

Static Public Member Functions inherited from DtVrfWeaponPSR
static DtVrfProcessStateRepository *	creator (const DtString &name, DtLocalObject vrfObject, DtReaderWriterRegistry parentRegistry)

Static Public Member Functions inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	factory ()

static void	setFactory (DtVrfProcessStateRepositoryFactory *factory)

static void	addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)

static DtVrfProcessStateRepository *	createRepository (const DtString &name, const DtString &type, DtLocalObject vrfObject, DtReaderWriterRegistry parentRegistry=0)

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
	DtVrfIndirectFirePSR ()

Protected Member Functions inherited from DtVrfWeaponPSR
	DtVrfWeaponPSR ()

virtual void	missileRemoved (const DtUUID &)

Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()

const DtSimObject *	vrfObject () const

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
DtDetonationDescriptorList	myPendingDetonations

DtRwReal	myHeightAboveTerrain

DtRwReal	myMuzzleSpeed

DtRwTaitBryan	myMuzzleOrientation

DtRwVector	myDetonationLocation

DtRwReal	myPreferredAltitude

DtRwBoolean	myGenerateKnownTargetPoint

DtRwLaunchedMunitionsList	myLaunchedMunitions

DtRwVector	myLastTargetLocation

DtRwUUID	myProvideFireRequestor

DtRwInt32	myFireMissionIndex

DtRwString	myKnownTargetPointName

Protected Attributes inherited from DtVrfWeaponPSR
DtRwBoolean	myTargetAcquired

DtRwSimObjectReference	myCurrentTarget

DtRwBoolean	myUserTargetOverride

DtRwString	myCurrentMunitionName

DtVrfMunitionLoader	myMunitionLoader

DtRwBoolean	myWeaponAimed

DtRwSimObjectReferenceList	myActiveMissiles

DtRwNLengthUUIDVector	myMissileFireOrder

Protected Attributes inherited from DtVrfProcessStateRepository
DtLocalObject *	myVrfObject

bool	myLoadedFromMTL

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 Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

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

DtVrfIndirectFirePSR::DtVrfIndirectFirePSR ( )

protected

DtVrfIndirectFirePSR::DtVrfIndirectFirePSR	(	DtLocalObject *	vrfObject,
		const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

DtVrfIndirectFirePSR::DtVrfIndirectFirePSR	(	const DtVrfIndirectFirePSR &	orig,
		const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

virtual DtVrfIndirectFirePSR::~DtVrfIndirectFirePSR ( )

virtual

Member Function Documentation

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

virtual DtVrfProcessStateRepository* DtVrfIndirectFirePSR::clone	(	const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)		const

virtual

Reimplemented from DtVrfWeaponPSR.

virtual DtString DtVrfIndirectFirePSR::type ( ) const

virtual

Returns the string type of the repository, as defined in procSRTypes.h.

Reimplemented from DtVrfWeaponPSR.

virtual const DtDetonationDescriptorList& DtVrfIndirectFirePSR::pendingDetonations ( ) const

virtual

Get list of pending detonations.

virtual void DtVrfIndirectFirePSR::addPendingDetonation ( DtDetonationDescriptor * desc )

virtual

Add a new pending detonation.

virtual void DtVrfIndirectFirePSR::removePendingDetonation ( const DtString & eventId )

virtual

Remove a particular pending detonation.

virtual void DtVrfIndirectFirePSR::setHeightAboveTerrain ( DtReal height )

virtual

Set the the height above terrain for the shell to detonate.

virtual DtReal DtVrfIndirectFirePSR::heightAboveTerrain ( )

virtual

Get the the height above terrain for the shell to detonate.

virtual void DtVrfIndirectFirePSR::setFireMissionIndex ( unsigned int )

virtual

virtual DtRwInt32 DtVrfIndirectFirePSR::fireMissionIndex ( )

virtual

virtual void DtVrfIndirectFirePSR::setMuzzleSpeed ( DtReal v )

virtual

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

virtual DtRwReal DtVrfIndirectFirePSR::muzzleSpeed ( )

virtual

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

virtual void DtVrfIndirectFirePSR::setMuzzleOrientation ( DtTaitBryan & o )

virtual

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

virtual DtRwTaitBryan& DtVrfIndirectFirePSR::muzzleOrientation ( )

virtual

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

virtual void DtVrfIndirectFirePSR::setDetonationLocation ( const DtVector & alt )

virtual

Set the desired detonation location in local coordinates.

virtual const DtVector& DtVrfIndirectFirePSR::detonationLocation ( ) const

virtual

Get the desired detonation location in local coordinates.

virtual void DtVrfIndirectFirePSR::setPreferredAltitude ( DtReal alt )

virtual

Set the preferred altitude above shooter and target that the peak of trajectory should reach.

virtual DtReal DtVrfIndirectFirePSR::preferredAltitude ( ) const

virtual

Get the preferred altitude above shooter and target that the peak of trajectory should reach.

virtual void DtVrfIndirectFirePSR::setGenerateKnownTargetPoint ( bool )

virtual

On detonation generate a known point as the first two letters of the shooter's name and 4 random numbers.

virtual bool DtVrfIndirectFirePSR::generateKnownTargetPoint ( ) const

virtual

virtual void DtVrfIndirectFirePSR::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& DtVrfIndirectFirePSR::knownTargetPointName ( ) const

virtual

virtual void DtVrfIndirectFirePSR::addLaunchedMunition	(	const DtString &	eventId,
		const DtUUID &	uuid,
		double	timeOfFlight,
		double	launchTime,
		const DtVector &	targetPoint
	)

virtual

List of munitions and event ids launched by this entity.

virtual bool DtVrfIndirectFirePSR::removeLaunchedMunition ( const DtString & eventId )

virtual

virtual bool DtVrfIndirectFirePSR::removeLaunchedMunition ( const DtUUID & uuid )

virtual

virtual void DtVrfIndirectFirePSR::setLastTargetLocation ( const DtVector & )

virtual

Last target location in world coordinates.

virtual const DtVector& DtVrfIndirectFirePSR::lastTargetLocation ( ) const

virtual

virtual bool DtVrfIndirectFirePSR::preferredAltitudeSpecified ( ) const

virtual

Whether the preferred altitude has been specified.

virtual const DtRwLaunchedMunition* DtVrfIndirectFirePSR::currentLaunchedMunition ( ) const

virtual

virtual const DtRwLaunchedMunition* DtVrfIndirectFirePSR::launchedMunition ( const DtString & eventId ) const

virtual

virtual const DtRwLaunchedMunition* DtVrfIndirectFirePSR::launchedMunition ( const DtUUID & eventId ) const

virtual

const DtRwLaunchedMunitionsList& DtVrfIndirectFirePSR::launchedMunitions ( ) const

inline

virtual void DtVrfIndirectFirePSR::setProvideFireRequestor ( const DtUUID & )

virtual

The requestor of the provide indirect fire. This will be used to send back admin content for information about munitions. This will not be sent to the front-end if the front-end is the requestor.

virtual const DtUUID& DtVrfIndirectFirePSR::provideFireRequestor ( ) const

virtual

static DtVrfProcessStateRepository* DtVrfIndirectFirePSR::creator	(	const DtString &	name,
		DtLocalObject *	vrfObject,
		DtReaderWriterRegistry *	parentRegistry
	)

static

Member Data Documentation

DtDetonationDescriptorList DtVrfIndirectFirePSR::myPendingDetonations

protected

List of DtDetonationDescriptors, used to save/restore information about pending scheduled detonations.

DtRwReal DtVrfIndirectFirePSR::myHeightAboveTerrain

protected

Set from the indirect fire weapon component interface's fire mission.

DtRwReal DtVrfIndirectFirePSR::myMuzzleSpeed

protected

DtRwTaitBryan DtVrfIndirectFirePSR::myMuzzleOrientation

protected

DtRwVector DtVrfIndirectFirePSR::myDetonationLocation

protected

DtRwReal DtVrfIndirectFirePSR::myPreferredAltitude

protected

DtRwBoolean DtVrfIndirectFirePSR::myGenerateKnownTargetPoint

protected

DtRwLaunchedMunitionsList DtVrfIndirectFirePSR::myLaunchedMunitions

protected

DtRwVector DtVrfIndirectFirePSR::myLastTargetLocation

protected

DtRwUUID DtVrfIndirectFirePSR::myProvideFireRequestor

protected

DtRwInt32 DtVrfIndirectFirePSR::myFireMissionIndex

protected

DtRwString DtVrfIndirectFirePSR::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-0-branch/include/vrfobjcore/vrfIndirectFirePSR.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation