VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes
DtWarheadDetonationActuatorPSR Class Reference

class DtWarheadDetonationActuatorPSR: More...

Inheritance diagram for DtWarheadDetonationActuatorPSR:
Inheritance graph
[legend]

Public Member Functions

 DtWarheadDetonationActuatorPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 constructor
 DtWarheadDetonationActuatorPSR (const DtWarheadDetonationActuatorPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 copy constructor - not implemented
virtual ~DtWarheadDetonationActuatorPSR ()
 destructor
DtWarheadDetonationActuatorPSRoperator= (const DtWarheadDetonationActuatorPSR &orig)
 assignment operator - not implemented
virtual
DtVrfProcessStateRepository
clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
 returns a newly created copy of this object
virtual DtString type () const
 Returns the string type of the repository, as defined in procSRTypes.h.
virtual DtWarheadType warhead () const
 Get the warhead type.
virtual void setWarhead (DtWarheadType wh)
 Set the warhead type.
virtual DtDetonatorFuze fuze () const
 Get the fuze type.
virtual void setFuze (DtDetonatorFuze fuze)
 Set the fuze type.
virtual DtString attackerName () const
 Get the attacker entity Name.
virtual void setAttackerName (const DtString &name)
 Set the attacker entity Name.
virtual DtString targetName () const
 Get the target name associated with the detonation proximity.
virtual void setTargetName (const DtString &target)
 Set the target name associated with the detonation proximity.
virtual void setLaserCode (int code)
 Set the current laser code associated with the detonation proximity.
virtual int laserCode () const
 Get the current laser code associated with the detonation proximity.
virtual void setTargetLocation (const DtVector &targetLocation)
 Set the target point location associated with the detonation proximity.
virtual const DtVectortargetLocation () const
 Get the target point location associated with the detonation proximity.
virtual DtReal detonationProximity () const
 Get the detonation proximity.
virtual void setDetonationProximity (DtReal proximity)
 Set the detonation proximity.
virtual void setDetonationTime (DtReal time)
 Set the detonation time.
virtual DtReal detonationTime () const
 Get the detonation time.
virtual void setArmed (bool arm)
 Set whether the munition is armed or not.
virtual bool armed () const
 Get whether we're armed or not.
virtual const DtSimMunitioncurrentMunition () const
virtual DtSimMunitioncurrentMunition ()
virtual void setCurrentMunition (const DtSimMunition &currentMunition)
virtual void setTrackingMode (DtTargetTrackingMode mode)
 Set/get the tracking mode in use.
virtual DtTargetTrackingMode trackingMode () const
virtual void setDetonationAltitude (double alt)
virtual double detonationAltitude () const
- Public Member Functions inherited from DtVrfProcessStateRepository
 DtVrfProcessStateRepository (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 DtVrfProcessStateRepository (const DtVrfProcessStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtVrfProcessStateRepositoryoperator= (const DtVrfProcessStateRepository &orig)
virtual ~DtVrfProcessStateRepository ()
virtual bool init ()
 Used for virtual construction. This base method simply returns true.
virtual bool loadedFromMTL () const
virtual void getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Top level to read itself from an input stream.
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 default constructor
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream.
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
virtual ~DtReaderWriter ()
 destructor
virtual void putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file.
virtual void writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object.
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object.
virtual bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
virtual bool isReadonly () const
virtual bool variableIsBound () const
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false.
virtual void setName (const DtString &)
 Set the name of the object.
virtual const char * readerWriterType () const
 Used to supply a string type that this reader writer type is.
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable.
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children.
virtual std::list
< DtVariableNameType
unboundVariables () const
bool invalid () const
virtual bool hasChild (const DtReaderWriter *p) const
 Returns true if this variable has a child p in it's chain.
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
 The specified flags are used for optional values.
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void setIsVariableReference (bool value)
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference.
virtual void setVariableName (const DtSymbolString variableName)
 The variable name, if this object is a variable reference.
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions

static
DtVrfProcessStateRepository
creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
 Returns a newly created instance of this class.
- Static Public Member Functions inherited from DtVrfProcessStateRepository
static
DtVrfProcessStateRepositoryFactory
factory ()
 a DtVrfProcessStateRepositoryFactory is allocated by the DtSimCreator, and this pointer is set.
static void setFactory (DtVrfProcessStateRepositoryFactory *factory)
static void addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)
static
DtVrfProcessStateRepository
createRepository (const DtString &name, const DtString &type, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0)
 Creates a new state repository object, using the factory.
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (FILE *fp, int indentLevel)
static const
DtVariableBindingsList
nullVariableReference ()
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename & appPath ()
 Gets the current working directory.

Protected Attributes

DtRwInt myFuze
DtSimMunition myCurrentMunition
DtRwBoolean myAmArmed
DtRwReal myDetonationTime
 For timed detonations.
DtRwString myAttackerName
 Stores the writable name of the attacker.
DtRwString myTargetName
DtRwReal myDetonationProximity
 For proximity detonation:
DtRwInt myTrackingMode
 Current tracking mode (based on DtTargetTrackingMode)
DtRwInt myLaserCode
DtRwVector myTargetLocation
DtRwReal myDetonationAltitude
- Protected Attributes inherited from DtVrfProcessStateRepository
DtVrfObjectmyVrfObject
bool myLoadedFromMTL
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
DtReaderWriterRegistry myRegistry
bool myValueSpecified
bool myReadOnlyFlag
bool myIsVariableReference
DtSymbolString myVariableName
bool myVariableIsBound
aliasContainer myAliases
 Container for the aliases which represent alternative names for the object.
bool myInvalid
 Set to true if there is a problem reading this item.

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::pair
< DtSymbolString, DtString
DtVariableNameType
- Protected Member Functions inherited from DtVrfProcessStateRepository
 DtVrfProcessStateRepository ()
- Static Protected Attributes inherited from DtVrfProcessStateRepository
static
DtVrfProcessStateRepositoryFactory
theFactory

Detailed Description

class DtWarheadDetonationActuatorPSR:

Instances of DtWarheadDetonationActuatorPSR are used to hold runtime variables for the DtWarheadDetonationActuator for checkpointing.

Constructor & Destructor Documentation

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

constructor

DtWarheadDetonationActuatorPSR::DtWarheadDetonationActuatorPSR ( const DtWarheadDetonationActuatorPSR orig,
const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
)

copy constructor - not implemented

virtual DtWarheadDetonationActuatorPSR::~DtWarheadDetonationActuatorPSR ( )
virtual

destructor

Member Function Documentation

DtWarheadDetonationActuatorPSR& DtWarheadDetonationActuatorPSR::operator= ( const DtWarheadDetonationActuatorPSR orig)

assignment operator - not implemented

virtual DtVrfProcessStateRepository* DtWarheadDetonationActuatorPSR::clone ( const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
) const
virtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtWarheadDetonationActuatorPSR::type ( ) const
virtual

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

Implements DtVrfProcessStateRepository.

virtual DtWarheadType DtWarheadDetonationActuatorPSR::warhead ( ) const
virtual

Get the warhead type.

virtual void DtWarheadDetonationActuatorPSR::setWarhead ( DtWarheadType  wh)
virtual

Set the warhead type.

virtual DtDetonatorFuze DtWarheadDetonationActuatorPSR::fuze ( ) const
virtual

Get the fuze type.

virtual void DtWarheadDetonationActuatorPSR::setFuze ( DtDetonatorFuze  fuze)
virtual

Set the fuze type.

virtual DtString DtWarheadDetonationActuatorPSR::attackerName ( ) const
virtual

Get the attacker entity Name.

virtual void DtWarheadDetonationActuatorPSR::setAttackerName ( const DtString name)
virtual

Set the attacker entity Name.

virtual DtString DtWarheadDetonationActuatorPSR::targetName ( ) const
virtual

Get the target name associated with the detonation proximity.

Note that this is only valid if trackingMode() is DtTrackTarget.

virtual void DtWarheadDetonationActuatorPSR::setTargetName ( const DtString target)
virtual

Set the target name associated with the detonation proximity.

virtual void DtWarheadDetonationActuatorPSR::setLaserCode ( int  code)
virtual

Set the current laser code associated with the detonation proximity.

virtual int DtWarheadDetonationActuatorPSR::laserCode ( ) const
virtual

Get the current laser code associated with the detonation proximity.

Note that this is only valid if trackingMode() is DtTrackLaserSpot.

virtual void DtWarheadDetonationActuatorPSR::setTargetLocation ( const DtVector targetLocation)
virtual

Set the target point location associated with the detonation proximity.

virtual const DtVector& DtWarheadDetonationActuatorPSR::targetLocation ( ) const
virtual

Get the target point location associated with the detonation proximity.

Note that this is only valid if trackingMode() is DtTrackLocation.

virtual DtReal DtWarheadDetonationActuatorPSR::detonationProximity ( ) const
virtual

Get the detonation proximity.

virtual void DtWarheadDetonationActuatorPSR::setDetonationProximity ( DtReal  proximity)
virtual

Set the detonation proximity.

virtual void DtWarheadDetonationActuatorPSR::setDetonationTime ( DtReal  time)
virtual

Set the detonation time.

virtual DtReal DtWarheadDetonationActuatorPSR::detonationTime ( ) const
virtual

Get the detonation time.

virtual void DtWarheadDetonationActuatorPSR::setArmed ( bool  arm)
virtual

Set whether the munition is armed or not.

virtual bool DtWarheadDetonationActuatorPSR::armed ( ) const
virtual

Get whether we're armed or not.

virtual const DtSimMunition& DtWarheadDetonationActuatorPSR::currentMunition ( ) const
virtual
virtual DtSimMunition& DtWarheadDetonationActuatorPSR::currentMunition ( )
virtual
virtual void DtWarheadDetonationActuatorPSR::setCurrentMunition ( const DtSimMunition currentMunition)
virtual
virtual void DtWarheadDetonationActuatorPSR::setTrackingMode ( DtTargetTrackingMode  mode)
virtual

Set/get the tracking mode in use.

virtual DtTargetTrackingMode DtWarheadDetonationActuatorPSR::trackingMode ( ) const
virtual
virtual void DtWarheadDetonationActuatorPSR::setDetonationAltitude ( double  alt)
virtual
virtual double DtWarheadDetonationActuatorPSR::detonationAltitude ( ) const
virtual
static DtVrfProcessStateRepository* DtWarheadDetonationActuatorPSR::creator ( const DtString rwName,
DtVrfObject vrfObject,
DtReaderWriterRegistry parentRegistry 
)
static

Returns a newly created instance of this class.

Member Data Documentation

DtRwInt DtWarheadDetonationActuatorPSR::myFuze
protected
DtSimMunition DtWarheadDetonationActuatorPSR::myCurrentMunition
protected
DtRwBoolean DtWarheadDetonationActuatorPSR::myAmArmed
protected
DtRwReal DtWarheadDetonationActuatorPSR::myDetonationTime
protected

For timed detonations.

DtRwString DtWarheadDetonationActuatorPSR::myAttackerName
protected

Stores the writable name of the attacker.

DtRwString DtWarheadDetonationActuatorPSR::myTargetName
protected
DtRwReal DtWarheadDetonationActuatorPSR::myDetonationProximity
protected

For proximity detonation:

DtRwInt DtWarheadDetonationActuatorPSR::myTrackingMode
protected

Current tracking mode (based on DtTargetTrackingMode)

DtRwInt DtWarheadDetonationActuatorPSR::myLaserCode
protected
DtRwVector DtWarheadDetonationActuatorPSR::myTargetLocation
protected
DtRwReal DtWarheadDetonationActuatorPSR::myDetonationAltitude
protected

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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)