VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtVrfWeaponPSR Class Reference

File: weaponPSR.h. More...

Inheritance diagram for DtVrfWeaponPSR:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtVrfWeaponPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 DtVrfWeaponPSR (const DtVrfWeaponPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtVrfWeaponPSRoperator= (const DtVrfWeaponPSR &orig)
virtual ~DtVrfWeaponPSR ()
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 setCurrentTarget (const DtEntityIdentifier &target, bool targetOverride=false)
 These two are provided for backward compatibility.
virtual const DtEntityIdentifier & currentTarget () const
virtual void setUserTargetOverride (bool userTargetOverride)
 Sets the user target override for the next target detection period.
virtual bool userTargetOverride () const
virtual void setCurrentTargetName (const DtString &target, bool targetOverride=false)
 The name of the target this weapon is currently attacking.
virtual const DtStringcurrentTargetName () const
virtual const DtVrfMunitionLoadermunitionLoader () const
 The munitionLoader manages loading and unloading timers.
virtual DtVrfMunitionLoadermunitionLoader ()
virtual void setCurrentMunitionName (const DtString &currentMunitionName)
 Sets the name of the current munition.
virtual const DtStringcurrentMunitionName () const
 Returns the name of the current munition.
virtual bool targetAcquired () const
 Do I have the target in my sights, ready to be fired upon?
virtual void setTargetAcquired (bool targetAcquired)

Static Public Member Functions

static
DtVrfProcessStateRepository
creator (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
 Create an instance of a DtVrfWeaponPSR.

Protected Member Functions

 DtVrfWeaponPSR ()

Protected Attributes

DtRwBoolean myTargetAcquired
DtRwString myCurrentTargetName
DtRwBoolean myUserTargetOverride
DtRwString myCurrentMunitionName
DtVrfMunitionLoader myMunitionLoader
DtEntityIdentifier myCurrentTargetId
 to have something concrete to return in currentTarget; not written to OOB

Detailed Description

File: weaponPSR.h.

Class: DtVrfWeaponPSR Class DtVrfWeaponPSR:


Constructor & Destructor Documentation

DtVrfWeaponPSR::DtVrfWeaponPSR ( DtVrfObject vrfObject,
const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
)
DtVrfWeaponPSR::DtVrfWeaponPSR ( const DtVrfWeaponPSR orig,
const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
)
virtual DtVrfWeaponPSR::~DtVrfWeaponPSR ( ) [virtual]

Member Function Documentation

const DtVrfWeaponPSR& DtVrfWeaponPSR::operator= ( const DtVrfWeaponPSR orig)
virtual DtVrfProcessStateRepository* DtVrfWeaponPSR::clone ( const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
) const [virtual]
virtual DtString DtVrfWeaponPSR::type ( ) const [virtual]

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

Implements DtVrfProcessStateRepository.

Reimplemented in DtVrfTurretedBalGunPSR, DtVrfBalGunPSR, and DtVrfIndirectFirePSR.

virtual void DtVrfWeaponPSR::setCurrentTarget ( const DtEntityIdentifier &  target,
bool  targetOverride = false 
) [virtual]

These two are provided for backward compatibility.

target names are stored here, and converted to/from entityIdentifiers as necessary

virtual const DtEntityIdentifier& DtVrfWeaponPSR::currentTarget ( ) const [virtual]
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::setCurrentTargetName ( const DtString target,
bool  targetOverride = false 
) [virtual]

The name of the target this weapon is currently attacking.

virtual const DtString& DtVrfWeaponPSR::currentTargetName ( ) const [virtual]
virtual const DtVrfMunitionLoader& DtVrfWeaponPSR::munitionLoader ( ) const [virtual]

The munitionLoader manages loading and unloading timers.

virtual void DtVrfWeaponPSR::setCurrentMunitionName ( const DtString currentMunitionName) [virtual]

Sets the name of the current munition.

virtual const DtString& DtVrfWeaponPSR::currentMunitionName ( ) 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]
static DtVrfProcessStateRepository* DtVrfWeaponPSR::creator ( const DtString name,
DtVrfObject vrfObject,
DtReaderWriterRegistry parentRegistry 
) [static]

Create an instance of a DtVrfWeaponPSR.

Reimplemented in DtVrfBalGunPSR, DtVrfIndirectFirePSR, and DtVrfTurretedBalGunPSR.


Member Data Documentation

DtEntityIdentifier DtVrfWeaponPSR::myCurrentTargetId [protected]

to have something concrete to return in currentTarget; not written to OOB


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)