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

File: indirectFirePSR.h. More...

Inheritance diagram for DtVrfIndirectFirePSR:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtVrfIndirectFirePSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 DtVrfIndirectFirePSR (const DtVrfIndirectFirePSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtVrfIndirectFirePSRoperator= (const DtVrfIndirectFirePSR &orig)
virtual ~DtVrfIndirectFirePSR ()
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 const
DtDetonationDescriptorList
pendingDetonations () const
 Get list of pending detonations.
virtual void addPendingDetonation (DtDetonationDescriptor *desc)
 Add a new pending detonation.
virtual void removePendingDetonation (const DtEventId &eventId)
 Remove a particular pending detonation.
virtual void setNumberOfRoundsToFire (int number)
 Set/get the number of rounds we've been told to fire as as task.
virtual int numberOfRoundsToFire () const
virtual void setRoundsFiredSoFar (int number)
 Set/get the number of rounds we've fired so far in execting a task.
virtual int roundsFiredSoFar () const
virtual void setHeightAboveTerrain (DtReal height)
 Set the the height above terrain for the shell to detonate.
virtual DtReal heightAboveTerrain ()
 Get the the height above terrain for the shell to detonate.
virtual void setCurrentTargetLocation (const DtVector &location)
virtual const DtVectorcurrentTargetLocation ()
virtual void setTaskCurrentlyQueued (bool queued)
 Returns true if the DtIndirectFireController has queued a task for which it still needs to page in terrain tiles.
virtual bool taskCurrentlyQueued ()
 Returns true if the DtIndirectFireController has queued a task for which it still needs to page in terrain tiles.

Static Public Member Functions

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

Protected Member Functions

 DtVrfIndirectFirePSR ()

Protected Attributes

DtDetonationDescriptorList myPendingDetonations
 List of DtDetonationDescriptors, used to save/restore information about pending scheduled detonations.
DtRwInt myNumberOfRoundsToFire
 Moved here from DtIndirectFireController (indFireCtlr.h).
DtRwInt myRoundsFiredSoFar
DtRwReal myHeightAboveTerrain
DtRwVector myCurrentTargetLocation
DtRwBoolean myTaskCurrentlyQueued

Detailed Description

File: indirectFirePSR.h.

Class: DtVrfIndirectFirePSR Class DtVrfIndirectFirePSR: Used to hold checkpointable state for the processes associated with indirect fire weapons (i.e. artillery). Maintains information about any pending detonations (detonation interaction data, simulation time to fire).


Constructor & Destructor Documentation

DtVrfIndirectFirePSR::DtVrfIndirectFirePSR ( DtVrfObject vrfObject,
const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
)
DtVrfIndirectFirePSR::DtVrfIndirectFirePSR ( const DtVrfIndirectFirePSR orig,
const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
)

Member Function Documentation

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

Reimplemented from DtVrfWeaponPSR.

virtual DtString DtVrfIndirectFirePSR::type ( ) const [virtual]

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

Reimplemented from DtVrfWeaponPSR.

Get list of pending detonations.

Add a new pending detonation.

virtual void DtVrfIndirectFirePSR::removePendingDetonation ( const DtEventId &  eventId) [virtual]

Remove a particular pending detonation.

virtual void DtVrfIndirectFirePSR::setNumberOfRoundsToFire ( int  number) [virtual]

Set/get the number of rounds we've been told to fire as as task.

virtual int DtVrfIndirectFirePSR::numberOfRoundsToFire ( ) const [virtual]
virtual void DtVrfIndirectFirePSR::setRoundsFiredSoFar ( int  number) [virtual]

Set/get the number of rounds we've fired so far in execting a task.

virtual int DtVrfIndirectFirePSR::roundsFiredSoFar ( ) const [virtual]
virtual void DtVrfIndirectFirePSR::setHeightAboveTerrain ( DtReal  height) [virtual]

Set the the height above terrain for the shell to detonate.

virtual DtReal DtVrfIndirectFirePSR::heightAboveTerrain ( ) [virtual]

Get the the height above terrain for the shell to detonate.

virtual void DtVrfIndirectFirePSR::setCurrentTargetLocation ( const DtVector location) [virtual]
virtual void DtVrfIndirectFirePSR::setTaskCurrentlyQueued ( bool  queued) [virtual]

Returns true if the DtIndirectFireController has queued a task for which it still needs to page in terrain tiles.

Returns true if the DtIndirectFireController has queued a task for which it still needs to page in terrain tiles.

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

Create an instance of a DtVrfWeaponPSR.

Reimplemented from DtVrfWeaponPSR.


Member Data Documentation

List of DtDetonationDescriptors, used to save/restore information about pending scheduled detonations.


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)