Represents the interface between the DtIndirectFireController and an indirect fire weapon system.

Inheritance diagram for DtIndirectWeaponComponentInterface:

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

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

const DtIndirectWeaponComponentInterface &	operator= (const DtIndirectWeaponComponentInterface &orig)

virtual	~DtIndirectWeaponComponentInterface ()

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

virtual DtString	type () const

virtual void	updateRegionEvaluator ()

virtual bool	locationWithinRegion (const DtVector &localLocation) const

virtual void	setFireMission (const DtFireMissionInformation &mission)

virtual const DtFireMissionInformation &	fireMission () const

virtual DtFireMissionInformation &	fireMission ()

virtual void	setTargetLocation (const DtVector &target)

virtual const DtVector &	targetLocation () const

virtual void	setInitializeWeapon (const bool needsInit)

virtual const bool	initializeWeapon () const

virtual void	setIsCruiseMissile (const bool isCruise)

virtual const bool	isCruiseMissile () const


virtual void	setTaskId (const int explicitlyTasked)

virtual const int	taskId () const

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

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

const DtBaseWeaponComponentInterface &	operator= (const DtBaseWeaponComponentInterface &orig)

virtual	~DtBaseWeaponComponentInterface ()

virtual void	setRoundsFiredUponTarget (const int &roundsFired)

virtual const int	roundsFiredUponTarget () const

virtual void	setTotalRoundsToFireUponTarget (const int &totalRoundsToFire)

virtual const int	totalRoundsToFireUponTarget () const

virtual void	setIsExplicitlyTasked (const bool &explicitlyTasked)

virtual const bool	isExplicitlyTasked () const

virtual void	setAllowExplicitTasking (const bool &includeInDialogs)

virtual const bool	allowExplicitTasking () const

virtual void	setDisplayName (const DtString &displayName)

virtual const DtString &	displayName () const

virtual void	setWeaponStatus (const int weaponStatus)

virtual const int	weaponStatus () const

virtual DtString	weaponStatusString () const

virtual void	addWeaponStatus (const DtWeaponStatus weaponStatus)

virtual void	removeWeaponStatus (const DtWeaponStatus weaponStatus)

virtual void	setIsInFiringCycle (const bool)

virtual bool	isInFiringCycle () const

virtual void	setResourceList (const std::list< DtString > &list)

virtual const std::list < DtString > &	resourceList () const

virtual std::list< DtString > &	resourceList ()

virtual void	setPriority (const int priority)

virtual int	priority () const

virtual void	createMountPartList (const DtArtPartType partType)

virtual const std::list < DtArtPartType > &	mountPartList () const

virtual void	setSystemTurretNumber (const DtArtPartType num)

virtual DtArtPartType	systemTurretNumber () const

virtual std::set< DtString > &	requiredTokens ()

virtual void	setRequiredTokens (const std::set< DtString > &tokens)

virtual void	setTreatSelectedAsTasked (bool t)

bool	treatSelectedAsTasked () const

virtual void	setControlExternalTurret (bool c)

virtual bool	controlExternalTurret () 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 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
virtual void	setupRegionEvaluator (DtRwSpatialFilterContainer *rangeGeometry)

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
DtSpatialFilterEvaluator *	myRegionEvaluator

DtFireMissionInformation	myFireMission

DtRwInt	myFireMissionTaskId

DtRwBoolean	myWeaponNeedsInitialization

DtRwBoolean	myIsCruiseMissile

Protected Attributes inherited from DtBaseWeaponComponentInterface
DtRwInt	myRoundsFiredUponTarget

DtRwInt	myTotalRoundsToFireUponTarget

DtRwBoolean	myIsInFiringCycle

DtRwBoolean	myIsExplicitlyTasked

DtRwBoolean	myAllowExplicitTasking

DtRwString	myDisplayName

DtRwInt	myWeaponStatus

std::list< DtString >	myResources

DtRwInt	myPriority

std::list< DtArtPartType >	myMountPartList

DtArtPartType	mySystemTurretNumber

DtRwBoolean	myControlExternalTurret

std::set< DtString >	myRequiredTokens

DtRwBoolean	myTreatSelectedAsTasked

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

Private Member Functions
	DtIndirectWeaponComponentInterface ()

Additional Inherited Members
Public Types inherited from DtBaseWeaponComponentInterface
enum	DtWeaponStatus { DT_OK_TO_FIRE = 0, DT_WEAPON_DISABLED = 1, DT_NO_AMMUNITION_FOR_TARGET = 2, DT_CANNOT_ACQUIRE_TARGET = 4, DT_SUPPRESSED = 8, DT_OUT_OF_AMMUNITION_FOR_WEAPON = 16, DT_WEAPON_BUSY = 32 }

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

DtIndirectWeaponComponentInterface::DtIndirectWeaponComponentInterface ( )

private

default constructor, not implemented

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

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

virtual DtIndirectWeaponComponentInterface::~DtIndirectWeaponComponentInterface ( )

virtual

Member Function Documentation

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

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

virtual

Implements DtBaseWeaponComponentInterface.

virtual DtString DtIndirectWeaponComponentInterface::type ( ) const

virtual

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

Implements DtVrfProcessStateRepository.

virtual void DtIndirectWeaponComponentInterface::updateRegionEvaluator ( )

virtual

This must be called before calling locationWithinRegion() if the host entity has moved at all since this was last called.

Implements DtBaseWeaponComponentInterface.

virtual bool DtIndirectWeaponComponentInterface::locationWithinRegion ( const DtVector & localLocation ) const

virtual

Returns: True if localLocation falls within the valid target region.

Note: updateRegionEvaluator() must be called prior to this function if there is a chance that the host entity has moved or reoriented since the last time updateRegionEvaluator() was called.

Implements DtBaseWeaponComponentInterface.

virtual void DtIndirectWeaponComponentInterface::setFireMission ( const DtFireMissionInformation & mission )

virtual

virtual const DtFireMissionInformation& DtIndirectWeaponComponentInterface::fireMission ( ) const

virtual

virtual DtFireMissionInformation& DtIndirectWeaponComponentInterface::fireMission ( )

virtual

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

virtual

virtual const DtVector& DtIndirectWeaponComponentInterface::targetLocation ( ) const

virtual

virtual void DtIndirectWeaponComponentInterface::setInitializeWeapon ( const bool needsInit )

virtual

virtual const bool DtIndirectWeaponComponentInterface::initializeWeapon ( ) const

virtual

virtual void DtIndirectWeaponComponentInterface::setIsCruiseMissile ( const bool isCruise )

virtual

virtual const bool DtIndirectWeaponComponentInterface::isCruiseMissile ( ) const

virtual

virtual void DtIndirectWeaponComponentInterface::setTaskId ( const int explicitlyTasked )

virtual

Accessor/mutator for #myFireSupportTaskId.

virtual const int DtIndirectWeaponComponentInterface::taskId ( ) const

virtual

Accessor/mutator for #myFireSupportTaskId.

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

static

Create an instance of a DtLasingControllerPSR.

virtual void DtIndirectWeaponComponentInterface::setupRegionEvaluator ( DtRwSpatialFilterContainer * rangeGeometry )

protectedvirtual

Uses the range data from the Indirect fire weapon's range geometry to set up the spatial evaluator.

Member Data Documentation

DtSpatialFilterEvaluator* DtIndirectWeaponComponentInterface::myRegionEvaluator

protected

DtFireMissionInformation DtIndirectWeaponComponentInterface::myFireMission

protected

This is the desired mission for the weapon to execute.

DtRwInt DtIndirectWeaponComponentInterface::myFireMissionTaskId

protected

What Fire support/Artillery task this weapon is currently tasked to. -1 means no task.

DtRwBoolean DtIndirectWeaponComponentInterface::myWeaponNeedsInitialization

protected

This is used when a new task comes in and the weapon needs to be initialized for the task–set up range, munition type to load...

DtRwBoolean DtIndirectWeaponComponentInterface::myIsCruiseMissile

protected

Indicates this weapon interface is for a cruise missile.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfobjcore/indirectWeaponComponentInterface.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation