DtBaseWeaponComponentInterface Class Reference

Abstract base class for all psrs that will serve as an interface between a controlling component on the entity and a group of weapon systems of the same type. For example a derived child of this, weaponComponentInterface, is used as an interface between the entity's target selection controller and it's direct fire weapons, finding available targets for direct fire weapons that aren't currently engaged, and monitoring their progress.

Inheritance diagram for DtBaseWeaponComponentInterface:

Public Types
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 )()

Public Member Functions
	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 DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const =0
virtual void	updateRegionEvaluator ()=0
virtual bool	locationWithinRegion (const DtVector &localLocation) const =0
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 DtString	type () const =0
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)

Protected Attributes
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
	DtBaseWeaponComponentInterface ()

Additional Inherited Members
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 inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()
const DtSimObject *	vrfObject () const
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
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

Member Enumeration Documentation

enum DtBaseWeaponComponentInterface::DtWeaponStatus

The status items below are used as bit fields. To set a state, OR the enumerated value into the weapon status, and to clear the state, AND the Negation of the enumerated value.

Enumerator
DT_OK_TO_FIRE
DT_WEAPON_DISABLED
DT_NO_AMMUNITION_FOR_TARGET	Disabled by disable()
DT_CANNOT_ACQUIRE_TARGET
DT_SUPPRESSED	No LOS to target from gun.
DT_OUT_OF_AMMUNITION_FOR_WEAPON
DT_WEAPON_BUSY

Constructor & Destructor Documentation

DtBaseWeaponComponentInterface::DtBaseWeaponComponentInterface ( )

private

default constructor, not implemented

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

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

virtual DtBaseWeaponComponentInterface::~DtBaseWeaponComponentInterface ( )

virtual

Member Function Documentation

const DtBaseWeaponComponentInterface& DtBaseWeaponComponentInterface::operator=

(

const DtBaseWeaponComponentInterface &

orig

)

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

pure virtual

Implements DtVrfProcessStateRepository.

Implemented in DtIndirectWeaponComponentInterface, and DtWeaponComponentInterface.

virtual void DtBaseWeaponComponentInterface::updateRegionEvaluator ( )

pure virtual

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

Implemented in DtWeaponComponentInterface, and DtIndirectWeaponComponentInterface.

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

pure 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.

Implemented in DtWeaponComponentInterface, and DtIndirectWeaponComponentInterface.

virtual void DtBaseWeaponComponentInterface::setRoundsFiredUponTarget ( const int &  roundsFired )

virtual

Accessor/mutator for myRoundsFiredUponTarget.

virtual const int DtBaseWeaponComponentInterface::roundsFiredUponTarget ( ) const

virtual

virtual void DtBaseWeaponComponentInterface::setTotalRoundsToFireUponTarget ( const int &  totalRoundsToFire )

virtual

Accessor/mutator for myTotalRoundsToFireUponTarget.

virtual const int DtBaseWeaponComponentInterface::totalRoundsToFireUponTarget ( ) const

virtual

virtual void DtBaseWeaponComponentInterface::setIsExplicitlyTasked ( const bool &  explicitlyTasked )

virtual

Accessor/mutator for myIsExplicitlyTasked.

virtual const bool DtBaseWeaponComponentInterface::isExplicitlyTasked ( ) const

virtual

Accessor/mutator for myIsExplicitlyTasked.

virtual void DtBaseWeaponComponentInterface::setAllowExplicitTasking ( const bool &  includeInDialogs )

virtual

Accessor/mutator for myAllowExplicitTasking.

virtual const bool DtBaseWeaponComponentInterface::allowExplicitTasking ( ) const

virtual

Accessor/mutator for myAllowExplicitTasking.

virtual void DtBaseWeaponComponentInterface::setDisplayName ( const DtString &  displayName )

virtual

Accessor/mutator for myDisplayName.

virtual const DtString& DtBaseWeaponComponentInterface::displayName ( ) const

virtual

Accessor/mutator for myDisplayName.

virtual void DtBaseWeaponComponentInterface::setWeaponStatus ( const int  weaponStatus )

virtual

Accessor/mutator for myWeaponStatus.

virtual const int DtBaseWeaponComponentInterface::weaponStatus ( ) const

virtual

Accessor/mutator for myWeaponStatus.

virtual DtString DtBaseWeaponComponentInterface::weaponStatusString ( ) const

virtual

Returns a string describing the weapon status.

virtual void DtBaseWeaponComponentInterface::addWeaponStatus ( const DtWeaponStatus  weaponStatus )

virtual

Performs a logical OR of the input status with the existing weapon status, to add the given condition to status. Updates the weapon status.

virtual void DtBaseWeaponComponentInterface::removeWeaponStatus ( const DtWeaponStatus  weaponStatus )

virtual

Removes the given condition from the weapon status by performing a logical AND of the bitwise NOT of the input status with existing weapon status. Updates the weapon status.

virtual void DtBaseWeaponComponentInterface::setIsInFiringCycle ( const bool  )

virtual

Accessor/mutator for myIsInFiringCycle.

virtual bool DtBaseWeaponComponentInterface::isInFiringCycle ( ) const

virtual

Accessor/mutator for myIsInFiringCycle.

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

virtual

Accessor/mutator for #myResourceList.

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

virtual

Accessor/mutator for #myResourceList.

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

virtual

Accessor/mutator for #myResourceList.

virtual void DtBaseWeaponComponentInterface::setPriority ( const int  priority )

virtual

A priority value to determine which weapon on an entity should be used if both have targets. A value of 1 is the highest priority, and higher numbers are lower priority. Default value is 1.

virtual int DtBaseWeaponComponentInterface::priority ( ) const

virtual

A priority value to determine which weapon on an entity should be used if both have targets. A value of 1 is the highest priority, and higher numbers are lower priority. Default value is 1.

virtual void DtBaseWeaponComponentInterface::createMountPartList ( const DtArtPartType  partType )

virtual

A list of articulated parts to which this weapon is attached. That is, its parent part, that parent's part, etc. Used to determine when different weapons are dependent on the same part. The list contains articulated part type numbers.
The list includes this part (in case another weapon might be mounted on it), but not the base.This function uses the entity's attachment manager to go through the articulated parts and find the parents and ancestors of this weapon.

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

virtual

Retrieves the list.

virtual void DtBaseWeaponComponentInterface::setSystemTurretNumber ( const DtArtPartType  num )

virtual

Accessor/mutator for mySystemTurretNumber.

virtual DtArtPartType DtBaseWeaponComponentInterface::systemTurretNumber ( ) const

virtual

Accessor/mutator for mySystemTurretNumber.

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

virtual

Accessor/mutator for myRequiredTokens. Not that for convenience, the mutator takes a list for its argument, while the accessor returns a set.

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

virtual

Accessor/mutator for myRequiredTokens. Not that for convenience, the mutator takes a list for its argument, while the accessor returns a set.

virtual void DtBaseWeaponComponentInterface::setTreatSelectedAsTasked ( bool  t )

virtual

Accessor for myTreatSelectedAsTasked.

bool DtBaseWeaponComponentInterface::treatSelectedAsTasked

(

)

const

Accessor for myTreatSelectedAsTasked.

virtual void DtBaseWeaponComponentInterface::setControlExternalTurret ( bool  c )

virtual

Accessor for myControlExternalTurret.

virtual bool DtBaseWeaponComponentInterface::controlExternalTurret ( ) const

virtual

Accessor for myControlExternalTurret.

Member Data Documentation

DtRwInt DtBaseWeaponComponentInterface::myRoundsFiredUponTarget

protected

Tracks rounds fired upon current target.

DtRwInt DtBaseWeaponComponentInterface::myTotalRoundsToFireUponTarget

protected

Tracks total rounds to fire upon current target.

DtRwBoolean DtBaseWeaponComponentInterface::myIsInFiringCycle

protected

Indicates that the weapon is in its firing cycle, which may mean is still firing a burst, or is in a mandatory cool down period after firing.

DtRwBoolean DtBaseWeaponComponentInterface::myIsExplicitlyTasked

protected

Tracks whether the weapon system has been explicitly tasked as opposed to a target being automatically selected.

DtRwBoolean DtBaseWeaponComponentInterface::myAllowExplicitTasking

protected

DtRwString DtBaseWeaponComponentInterface::myDisplayName

protected

Name to be used in the gui to represent this weapon.

DtRwInt DtBaseWeaponComponentInterface::myWeaponStatus

protected

Current status of the weapon, is it able to fire or not.

std::list<DtString> DtBaseWeaponComponentInterface::myResources

protected

List of the available munition resources. This is not written out since it gets updated from the system. Only resources with non zero amounts are on this list. This list is used in the weapon response reply to the front end to provide the available munitions for the user to choose.

DtRwInt DtBaseWeaponComponentInterface::myPriority

protected

A priority value to determine which weapon on an entity should be used if both have targets. A value of 1 is the highest priority, and higher numbers are lower priority.

std::list<DtArtPartType> DtBaseWeaponComponentInterface::myMountPartList

protected

A list of articulated parts to which this weapon is attached. That is, its parent part, that parent's part, etc. Used to determine when different weapons are dependent on the same part. The list contains articulated part type numbers.
The list includes this part (in case another weapon might be mounted on it), but not the base.
This list is reconstructed when the ballistic gun controller gets its weapon interfaces, so it does not need to be saved with a scenario.

DtArtPartType DtBaseWeaponComponentInterface::mySystemTurretNumber

protected

The articulated part corresponding to the turret in this gun system (as opposed to an ancestor part).

DtRwBoolean DtBaseWeaponComponentInterface::myControlExternalTurret

protected

Indicates that this weapon is controlling parent parts outside of the system to turn the gun. I.e., a tank MG is controlling the main turret in order to reach targets outside the normal slew range of the MG.

std::set<DtString> DtBaseWeaponComponentInterface::myRequiredTokens

protected

List of resources required to operate the weapon; these are tokens that are reserved when the weapon operates, but are not consumed. There is no token reservation system; other components just check to see if their tokens against this set to see if there is a conflict. These resources may represent crew members, for example.

DtRwBoolean DtBaseWeaponComponentInterface::myTreatSelectedAsTasked

protected

Indicates that when a target is auto-selected for this gun, vs. set in a fire-at-target task, the gun priority should be the same as when the target is set by task. This makes a high priority gun keep control of necessary turrets even if a lower priority gun on the same turret is tasked. Default is false.

---

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

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