DtWeaponComponentInterface Class Reference

Represents the interface between the DtTargetSelectionController and a weapon system. More...

Inheritance diagram for DtWeaponComponentInterface:

List of all members.

Public Types
enum	DtWeaponStatus { DT_OK_TO_FIRE = 0, DT_WEAPON_DISABLED = 1, DT_NO_AMMUNITION_FOR_TARGET = 2, DT_CANNOT_ACQUIRE_TARGET = 4 }
Public Member Functions
	DtWeaponComponentInterface (DtVrfObject *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
	Returns the string type of the repository, as defined in procSRTypes.h.
virtual void	updateRegionEvaluator ()
	This must be called before calling locationWithinRegion() if the host entity has moved at all since this was last called.
virtual bool	locationWithinRegion (const DtVector &localLocation) const
virtual void	setTarget (const DtEntityTargetInformation &target)
virtual const DtEntityTargetInformation &	target () const
virtual void	setRoundsFiredUponTarget (const int &roundsFired)
	Accessor/mutator for myRoundsFiredUponTarget.
virtual const int	roundsFiredUponTarget () const
virtual void	setTotalRoundsToFireUponTarget (const int &totalRoundsToFire)
	Accessor/mutator for myTotalRoundsToFireUponTarget.
virtual const int	totalRoundsToFireUponTarget () const
virtual void	setTargetSelectionCriteria (const DtTargetSelectionCriteria &tsc)
	Accessor/mutator for myTargetSelectionCriteria.
virtual const DtTargetSelectionCriteria &	targetSelectionCriteria () const
	Accessor/mutator for myTargetSelectionCriteria.
virtual void	setIsExplicitlyTasked (const bool &explicitlyTasked)
	Accessor/mutator for myIsExplicitlyTasked.
virtual const bool	isExplicitlyTasked () const
	Accessor/mutator for myIsExplicitlyTasked.
virtual void	setAllowExplicitTasking (const bool &includeInDialogs)
	Accessor/mutator for myAllowExplicitTasking.
virtual const bool	allowExplicitTasking () const
	Accessor/mutator for myAllowExplicitTasking.
virtual void	setDisplayName (const DtString &displayName)
	Accessor/mutator for myDisplayName.
virtual const DtString	displayName () const
	Accessor/mutator for myDisplayName.
virtual void	setWeaponStatus (const int weaponStatus)
	Accessor/mutator for myWeaponStatus.
virtual const int	weaponStatus () const
	Accessor/mutator for myWeaponStatus.
virtual void	clearTarget ()
	Accessor/mutator for myTarget.
virtual bool	hasTarget () const
	Accessor/mutator for myTarget.
Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
	Create an instance of a DtLasingControllerPSR.
Protected Member Functions
virtual void	setupRegionEvaluator ()
	Uses the current data in myTargetSelectionCriteria and creates the and sets myRegionEvaluator, is applicable.
Protected Attributes
DtTargetSelectionCriteria	myTargetSelectionCriteria
	Target selection data for this weapon.
DtEntityTargetInformation	myTarget
	Information about current target.
DtSpatialFilterEvaluator *	myRegionEvaluator
DtRwInt	myRoundsFiredUponTarget
	Tracks rounds fired upon current target.
DtRwInt	myTotalRoundsToFireUponTarget
	Tracks total rounds to fire upon current target.
DtRwBoolean	myIsExplicitlyTasked
	Tracks whether the weapon system has been explicitly tasked as opposed to a target being automatically selected.
DtRwBoolean	myAllowExplicitTasking
DtRwString	myDisplayName
	Name to be used in the gui to represent this weapon.
DtVrfObject *	myHostObject
	DtVrfObject the weapon is attached to.
DtRwInt	myWeaponStatus
Private Member Functions
	DtWeaponComponentInterface ()
	default constructor, not implemented

---

Detailed Description

Represents the interface between the DtTargetSelectionController and a weapon system.

---

Member Enumeration Documentation

enum DtWeaponComponentInterface::DtWeaponStatus

Enumerator:

DT_OK_TO_FIRE
DT_WEAPON_DISABLED
DT_NO_AMMUNITION_FOR_TARGET
DT_CANNOT_ACQUIRE_TARGET

---

Constructor & Destructor Documentation

DtWeaponComponentInterface::DtWeaponComponentInterface

(

)

[private]

default constructor, not implemented

DtWeaponComponentInterface::DtWeaponComponentInterface	(	DtVrfObject *	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 DtVrfProcessStateRepository.

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.

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.

virtual void DtWeaponComponentInterface::setTarget

(

const DtEntityTargetInformation &

target

)

[virtual]

virtual const DtEntityTargetInformation& DtWeaponComponentInterface::target

(

)

const [virtual]

virtual void DtWeaponComponentInterface::setRoundsFiredUponTarget

(

const int &

roundsFired

)

[virtual]

Accessor/mutator for myRoundsFiredUponTarget.

virtual const int DtWeaponComponentInterface::roundsFiredUponTarget

(

)

const [virtual]

virtual void DtWeaponComponentInterface::setTotalRoundsToFireUponTarget

(

const int &

totalRoundsToFire

)

[virtual]

Accessor/mutator for myTotalRoundsToFireUponTarget.

virtual const int DtWeaponComponentInterface::totalRoundsToFireUponTarget

(

)

const [virtual]

virtual void DtWeaponComponentInterface::setIsExplicitlyTasked

(

const bool &

explicitlyTasked

)

[virtual]

Accessor/mutator for myIsExplicitlyTasked.

virtual const bool DtWeaponComponentInterface::isExplicitlyTasked

(

)

const [virtual]

Accessor/mutator for myIsExplicitlyTasked.

virtual void DtWeaponComponentInterface::setAllowExplicitTasking

(

const bool &

includeInDialogs

)

[virtual]

Accessor/mutator for myAllowExplicitTasking.

virtual const bool DtWeaponComponentInterface::allowExplicitTasking

(

)

const [virtual]

Accessor/mutator for myAllowExplicitTasking.

virtual void DtWeaponComponentInterface::setDisplayName

(

const DtString &

displayName

)

[virtual]

Accessor/mutator for myDisplayName.

virtual const DtString DtWeaponComponentInterface::displayName

(

)

const [virtual]

Accessor/mutator for myDisplayName.

virtual void DtWeaponComponentInterface::setWeaponStatus

(

const int

weaponStatus

)

[virtual]

Accessor/mutator for myWeaponStatus.

virtual const int DtWeaponComponentInterface::weaponStatus

(

)

const [virtual]

Accessor/mutator for myWeaponStatus.

virtual void DtWeaponComponentInterface::clearTarget

(

)

[virtual]

Accessor/mutator for myTarget.

virtual bool DtWeaponComponentInterface::hasTarget

(

)

const [virtual]

Accessor/mutator for myTarget.

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

Create an instance of a DtLasingControllerPSR.

virtual void DtWeaponComponentInterface::setupRegionEvaluator

(

)

[protected, virtual]

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.

DtSpatialFilterEvaluator* DtWeaponComponentInterface::myRegionEvaluator [protected]

DtRwInt DtWeaponComponentInterface::myRoundsFiredUponTarget [protected]

Tracks rounds fired upon current target.

DtRwInt DtWeaponComponentInterface::myTotalRoundsToFireUponTarget [protected]

Tracks total rounds to fire upon current target.

DtRwBoolean DtWeaponComponentInterface::myIsExplicitlyTasked [protected]

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

DtRwBoolean DtWeaponComponentInterface::myAllowExplicitTasking [protected]

DtRwString DtWeaponComponentInterface::myDisplayName [protected]

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

DtVrfObject* DtWeaponComponentInterface::myHostObject [protected]

DtVrfObject the weapon is attached to.

DtRwInt DtWeaponComponentInterface::myWeaponStatus [protected]

---

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

• include/vrfobjcore/weaponComponentInterface.h