DtVrfWeaponPSR Class Reference

File: weaponPSR.h.

Class: DtVrfWeaponPSR

Inheritance diagram for DtVrfWeaponPSR:

Public Member Functions
	DtVrfWeaponPSR (DtLocalObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=nullptr)
	DtVrfWeaponPSR (const DtVrfWeaponPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=nullptr)
const DtVrfWeaponPSR &	operator= (const DtVrfWeaponPSR &orig)
virtual	~DtVrfWeaponPSR () override
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=nullptr) const override
virtual DtString	type () const override
virtual void	setUserTargetOverride (bool userTargetOverride)
virtual bool	userTargetOverride () const
virtual void	setCurrentTarget (const DtUUID &, bool targetOverride=false)
virtual DtSimObjectReference	currentTarget () const
virtual void	setCurrentLocationTarget (const DtVector &locationTarget, bool targetOverride=false)
virtual DtVector	currentLocationTarget () const
virtual const DtVrfMunitionLoader &	munitionLoader () const
virtual DtVrfMunitionLoader &	munitionLoader ()
virtual void	setCurrentMunitionType (const DtEntityType &currentMunitionName)
virtual const DtEntityType &	currentMunitionType () const
virtual bool	targetAcquired () const
virtual void	setTargetAcquired (bool targetAcquired)
virtual bool	weaponAimed () const
virtual void	setWeaponAimed (bool aimed)
virtual void	setWeaponStowed (bool v)
virtual bool	weaponStowed () const
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
virtual void	setRoundsFiredUponTarget (const int &roundsFired)
virtual const int	roundsFiredUponTarget () const
virtual void	setIsExplicitlyTasked (const bool &explicitlyTasked)
virtual const bool	isExplicitlyTasked () const
virtual void	setIsInFiringCycle (const bool)
virtual bool	isInFiringCycle () const
virtual void	setWeaponStatus (const int weaponStatus)
virtual const int	weaponStatus () const
virtual void	addWeaponStatus (const DtBaseWeaponComponentInterface::DtWeaponStatus weaponStatus)
virtual void	removeWeaponStatus (const DtBaseWeaponComponentInterface::DtWeaponStatus weaponStatus)
virtual void	setWorkingTargetPoint (const DtUUID &id)
virtual DtSimObjectReference	workingTargetPoint () 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 () override
virtual bool	init ()
virtual bool	loadedFromMTL () const
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
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) const
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	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
	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
DtRwBoolean	myTargetAcquired
DtRwSimObjectReference	myCurrentTarget
DtRwVector	myCurrentLocationTarget
DtRwBoolean	myUserTargetOverride
DtRwResource	myCurrentMunitionType
DtVrfMunitionLoader	myMunitionLoader
DtRwBoolean	myWeaponAimed
DtRwSimObjectReferenceList	myActiveMissiles
DtRwNLengthUUIDVector	myMissileFireOrder
DtRwInt	myRoundsFiredUponTarget
DtRwBoolean	myIsExplicitlyTasked
DtRwBoolean	myIsInFiringCycle
DtRwInt	myWeaponStatus
DtRwBoolean	myWeaponStowed
DtRwSimObjectReference	myWorkingTargetPoint
boost::signals2::connection	myActiveMissilesListConnection
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

DtVrfWeaponPSR::DtVrfWeaponPSR ( )

protected

DtVrfWeaponPSR::DtVrfWeaponPSR	(	DtLocalObject *	vrfObject,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = nullptr
	)

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

virtual DtVrfWeaponPSR::~DtVrfWeaponPSR ( )

overridevirtual

Member Function Documentation

const DtVrfWeaponPSR& DtVrfWeaponPSR::operator=

(

const DtVrfWeaponPSR &

orig

)

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

overridevirtual

Implements DtVrfProcessStateRepository.

Reimplemented in DtVrfBalGunPSR, DtVrfIndirectFirePSR, DtVrfTurretedBalGunPSR, and DtJavelinLauncherPSR.

virtual DtString DtVrfWeaponPSR::type ( ) const

overridevirtual

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

Implements DtVrfProcessStateRepository.

Reimplemented in DtVrfTurretedBalGunPSR, DtVrfBalGunPSR, DtVrfIndirectFirePSR, and DtJavelinLauncherPSR.

virtual void DtVrfWeaponPSR::setUserTargetOverride ( bool  userTargetOverride )

virtual

Sets the user target override for the next target detection period. This flag will be reset to false by the target detection sensor at the end of the period regardless of target acquisition and/or target list addition.

virtual bool DtVrfWeaponPSR::userTargetOverride ( ) const

virtual

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

virtual

The target this weapon is currently attacking Was: setCurrentTargetName.

virtual DtSimObjectReference DtVrfWeaponPSR::currentTarget ( ) const

virtual

Was: currentTargetName.

virtual void DtVrfWeaponPSR::setCurrentLocationTarget ( const DtVector &  locationTarget, bool  targetOverride = false  )

virtual

The location this weapon is currently attacking Used when the target is a location - i.e. not an object. Similar to setCurrentTarget() , which sets an object.

virtual DtVector DtVrfWeaponPSR::currentLocationTarget ( ) const

virtual

Returns the position , when the target type is location.

virtual const DtVrfMunitionLoader& DtVrfWeaponPSR::munitionLoader ( ) const

virtual

The munitionLoader manages loading and unloading timers.

virtual DtVrfMunitionLoader& DtVrfWeaponPSR::munitionLoader ( )

virtual

virtual void DtVrfWeaponPSR::setCurrentMunitionType ( const DtEntityType &  currentMunitionName )

virtual

Sets the name of the current munition.

virtual const DtEntityType& DtVrfWeaponPSR::currentMunitionType ( ) const

virtual

Returns the name of the current munition.

virtual bool DtVrfWeaponPSR::targetAcquired ( ) const

virtual

Do I have the target in my sights, ready to be fired upon?

virtual void DtVrfWeaponPSR::setTargetAcquired ( bool  targetAcquired )

virtual

virtual bool DtVrfWeaponPSR::weaponAimed ( ) const

virtual

Is the weapon aimed at the correct location?

virtual void DtVrfWeaponPSR::setWeaponAimed ( bool  aimed )

virtual

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

static

Create an instance of a DtVrfWeaponPSR.

virtual void DtVrfWeaponPSR::addActiveMissile ( const DtUUID &  )

virtual

Active missile handling.

virtual void DtVrfWeaponPSR::removeActiveMissile ( const DtUUID &  )

virtual

Active missile handling.

virtual const DtRwSimObjectReferenceList& DtVrfWeaponPSR::activeMissiles ( ) const

virtual

Active missile handling.

virtual DtSimObjectReference DtVrfWeaponPSR::lastMissileFired ( ) const

virtual

Active missile handling.

virtual bool DtVrfWeaponPSR::stillTargeting ( const DtUUID &  ) const

virtual

Active missile handling.

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

virtual

Accessor/mutator for myRoundsFiredUponTarget.

virtual const int DtVrfWeaponPSR::roundsFiredUponTarget ( ) const

virtual

Accessor/mutator for myRoundsFiredUponTarget.

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

virtual

Accessor/mutator for myIsExplicitlyTasked.

virtual const bool DtVrfWeaponPSR::isExplicitlyTasked ( ) const

virtual

Accessor/mutator for myIsExplicitlyTasked.

virtual void DtVrfWeaponPSR::setIsInFiringCycle ( const bool  )

virtual

Accessor/mutator for myIsInFiringCycle.

virtual bool DtVrfWeaponPSR::isInFiringCycle ( ) const

virtual

Accessor/mutator for myIsInFiringCycle.

virtual void DtVrfWeaponPSR::setWeaponStatus ( const int  weaponStatus )

virtual

Accessor/mutator for myWeaponStatus.

virtual const int DtVrfWeaponPSR::weaponStatus ( ) const

virtual

Accessor/mutator for myWeaponStatus.

virtual void DtVrfWeaponPSR::addWeaponStatus ( const DtBaseWeaponComponentInterface::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 DtVrfWeaponPSR::removeWeaponStatus ( const DtBaseWeaponComponentInterface::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 DtVrfWeaponPSR::setWeaponStowed ( bool  v )

virtual

virtual bool DtVrfWeaponPSR::weaponStowed ( ) const

virtual

virtual void DtVrfWeaponPSR::setWorkingTargetPoint ( const DtUUID &  id )

virtual

The UUID of a working control point that was created by the controller, and should be deleted by it.

virtual DtSimObjectReference DtVrfWeaponPSR::workingTargetPoint ( ) const

virtual

The UUID of a working control point that was created by the controller, and should be deleted by it.

virtual void DtVrfWeaponPSR::missileRemoved ( const DtUUID &  )

protectedvirtual

Called when a missile is removed from the active missile list.

Member Data Documentation

DtRwBoolean DtVrfWeaponPSR::myTargetAcquired

protected

DtRwSimObjectReference DtVrfWeaponPSR::myCurrentTarget

protected

DtRwVector DtVrfWeaponPSR::myCurrentLocationTarget

protected

DtRwBoolean DtVrfWeaponPSR::myUserTargetOverride

protected

DtRwResource DtVrfWeaponPSR::myCurrentMunitionType

protected

DtVrfMunitionLoader DtVrfWeaponPSR::myMunitionLoader

protected

DtRwBoolean DtVrfWeaponPSR::myWeaponAimed

protected

DtRwSimObjectReferenceList DtVrfWeaponPSR::myActiveMissiles

protected

DtRwNLengthUUIDVector DtVrfWeaponPSR::myMissileFireOrder

protected

DtRwInt DtVrfWeaponPSR::myRoundsFiredUponTarget

protected

Tracks rounds fired upon current target.

DtRwBoolean DtVrfWeaponPSR::myIsExplicitlyTasked

protected

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

DtRwBoolean DtVrfWeaponPSR::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.

DtRwInt DtVrfWeaponPSR::myWeaponStatus

protected

Current status of the weapon, is it able to fire or not. This value is a bit field composed of the values defined in the enum DtBaseWeaponComponentInterface::DtWeaponStatus.

DtRwBoolean DtVrfWeaponPSR::myWeaponStowed

protected

DtRwSimObjectReference DtVrfWeaponPSR::myWorkingTargetPoint

protected

boost::signals2::connection DtVrfWeaponPSR::myActiveMissilesListConnection

protected

---

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

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