VR-Forces 5.0.1 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
DtWeaponComponentInterface Class Reference

Represents the interface between the DtTargetSelectionController and a weapon system.

Inheritance diagram for DtWeaponComponentInterface:
Inheritance graph
[legend]

Public Types

typedef DtRwTemplatedMapPtr
< DtRwUUID, DtRwUUID > 		MunitionToTargetMap
 
- 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 )()
 

Public Member Functions

 DtWeaponComponentInterface (const DtLocalObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 
 DtWeaponComponentInterface (const DtWeaponComponentInterface &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 
const DtWeaponComponentInterface & operator= (const DtWeaponComponentInterface &orig)
 
virtual ~DtWeaponComponentInterface ()
 
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 clearTarget ()
 
virtual bool hasTarget () const
 
virtual void setTargetSelectionCriteria (const DtTargetSelectionCriteria &tsc)
 
virtual const
DtTargetSelectionCriteria & 		targetSelectionCriteria () const
 
virtual void setTarget (const DtEntityTargetInformation &target)
 
virtual const
DtEntityTargetInformation & 		target () const
 
virtual void addTargetFiringUpon (const DtUUID &target)
 
virtual void removeTargetFiringUpon (const DtUUID &target)
 
virtual const
DtRwTemplatedUUIDList & 		targetsFiringUpon () 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 ()
 
- 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

DtTargetSelectionCriteria myTargetSelectionCriteria
 
DtEntityTargetInformation myTarget
 
DtRwTemplatedUUIDList myTargetsFiringUpon
 
DtSpatialFilterEvaluator * myRegionEvaluator
 
- 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

 DtWeaponComponentInterface ()
 

Additional Inherited Members

- 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 Typedef Documentation

typedef DtRwTemplatedMapPtr<DtRwUUID, DtRwUUID> DtWeaponComponentInterface::MunitionToTargetMap

Constructor & Destructor Documentation

DtWeaponComponentInterface::DtWeaponComponentInterface ( )
private

default constructor, not implemented

DtWeaponComponentInterface::DtWeaponComponentInterface ( const DtLocalObject *  vrfObject,
const DtString &  rwName = DtString::nullString(),
DtReaderWriterRegistry *  parentRegistry = 0 
)
DtWeaponComponentInterface::DtWeaponComponentInterface ( const DtWeaponComponentInterface &  orig,
const DtString &  rwName = DtString::nullString(),
DtReaderWriterRegistry *  parentRegistry = 0 
)
virtual DtWeaponComponentInterface::~DtWeaponComponentInterface ( )
virtual

Member Function Documentation

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

Implements DtBaseWeaponComponentInterface.

virtual DtString DtWeaponComponentInterface::type ( ) const
virtual

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

Implements DtVrfProcessStateRepository.

virtual void DtWeaponComponentInterface::setTargetSelectionCriteria ( const DtTargetSelectionCriteria &  tsc)
virtual

Accessor/mutator for myTargetSelectionCriteria.

virtual const DtTargetSelectionCriteria& DtWeaponComponentInterface::targetSelectionCriteria ( ) const
virtual

Accessor/mutator for myTargetSelectionCriteria.

virtual void DtWeaponComponentInterface::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 DtWeaponComponentInterface::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 DtWeaponComponentInterface::setTarget ( const DtEntityTargetInformation &  target)
virtual

Accessor/mutator for myTarget.

virtual const DtEntityTargetInformation& DtWeaponComponentInterface::target ( ) const
virtual

Accessor/mutator for myTarget.

virtual void DtWeaponComponentInterface::clearTarget ( )
virtual
virtual bool DtWeaponComponentInterface::hasTarget ( ) const
virtual
virtual void DtWeaponComponentInterface::addTargetFiringUpon ( const DtUUID &  target)
virtual

Add, remove, or get contents of myTargetsFiringUpon.

virtual void DtWeaponComponentInterface::removeTargetFiringUpon ( const DtUUID &  target)
virtual

Add, remove, or get contents of myTargetsFiringUpon.

virtual const DtRwTemplatedUUIDList& DtWeaponComponentInterface::targetsFiringUpon ( ) const
virtual

Add, remove, or get contents of myTargetsFiringUpon.

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

Create an instance of a DtWeaponComponentInterface.

virtual void DtWeaponComponentInterface::setupRegionEvaluator ( )
protectedvirtual

Uses the current data in myTargetSelectionCriteria and creates the and sets myRegionEvaluator, is applicable.

Member Data Documentation

DtTargetSelectionCriteria DtWeaponComponentInterface::myTargetSelectionCriteria
protected

Target selection data for this weapon.

DtEntityTargetInformation DtWeaponComponentInterface::myTarget
protected

Information about current target specified by the target selection controller.

DtRwTemplatedUUIDList DtWeaponComponentInterface::myTargetsFiringUpon
protected

The current targets that have been fired upon. Used only by missile launchers (as of VRF 4.8); for guns, always empty.

DtSpatialFilterEvaluator* DtWeaponComponentInterface::myRegionEvaluator
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Mon Jun 20 00:38:30 EDT 2022 from SVN revision 244029
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)