VR-Forces 4.1.1 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Private Attributes
DtIndirectArtilleryPSR Class Reference
Inheritance diagram for DtIndirectArtilleryPSR:
Inheritance graph
[legend]

Public Member Functions

 DtIndirectArtilleryPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 constructor
 DtIndirectArtilleryPSR (const DtIndirectArtilleryPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
virtual ~DtIndirectArtilleryPSR ()
 destructor
DtIndirectArtilleryPSRoperator= (const DtIndirectArtilleryPSR &orig)
 assignment operator
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 this process state repository.
virtual void setNumberOfSalvos (int numSalvos)
 Get / Set the number of salvos state variable.
virtual int numberOfSalvos () const
virtual void setRoundsPerSalvo (int roundsPerSalvo)
 Get / Set the number of rounds per salvo state variable.
virtual int roundsPerSalvo () const
virtual void setStartTime (int startTime)
 Get / Set the start time state variable.
virtual int startTime () const
virtual void setStartTimeImmediate (bool flag)
 Get / Set the start time state variable.
virtual bool startTimeImmediate () const
virtual void setTimeBetweenSalvos (int timeBetweenSalvos)
 Get / Set the time between salvos state variable.
virtual int timeBetweenSalvos () const
virtual void setScatterTime (double scatterTime)
 Get / Set the time between salvos state variable.
virtual double scatterTime () const
virtual void setAltitude (double altitude)
 Get / Set the altitude state variable.
virtual double altitude () const
virtual void setWindDirection (double windDirection)
 Get / Set the wind offset direction (degrees) state variable. 0 = Due north, 90 = Due east.
virtual double windDirection () const
virtual void setWindDistance (double windDistance)
 Get / Set the wind offset direction (degrees) state variable. 0 = Due north, 90 = Due east.
virtual double windDistance () const
virtual void setMunitionType (DtEntityType const &munitionType)
 Get / Set the munition type state variable.
virtual DtEntityType munitionType () 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.

Private Attributes

DtRwInt myNumberOfSalvos
 Number of salvos.
DtRwInt myRoundsPerSalvo
 Number of rounds per salvo.
DtRwInt myStartTime
 Time in seconds, relative to simulation start, when rounds start arriving.
DtRwBoolean myStartTimeImmediate
 If true, then barrage will start on next tick, and startTime will be set to that tick.
DtRwInt myTimeBetweenSalvos
 Time in seconds between salvos.
DtRwReal myScatterTime
 A timer used to keep rounds from arriving at the same time.
DtRwReal myAltitude
 Altitude (meters AGL) where detonation will take place.
DtRwReal myWindDirection
 Direction of wind displacement.
DtRwReal myWindDistance
 Distance of wind displacement.
DtRwEntityType myMunitionType
 Distance of wind displacement.

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 ()
- Protected Attributes inherited from DtVrfProcessStateRepository
DtVrfObjectmyVrfObject
bool myLoadedFromMTL
- Static Protected Attributes inherited from DtVrfProcessStateRepository
static
DtVrfProcessStateRepositoryFactory
theFactory

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtIndirectArtilleryPSR::~DtIndirectArtilleryPSR ( )
virtual

destructor

Member Function Documentation

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

assignment operator

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

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtIndirectArtilleryPSR::type ( ) const
virtual

Returns the string type of this process state repository.

Implements DtVrfProcessStateRepository.

virtual void DtIndirectArtilleryPSR::setNumberOfSalvos ( int  numSalvos)
virtual

Get / Set the number of salvos state variable.

virtual int DtIndirectArtilleryPSR::numberOfSalvos ( ) const
virtual
virtual void DtIndirectArtilleryPSR::setRoundsPerSalvo ( int  roundsPerSalvo)
virtual

Get / Set the number of rounds per salvo state variable.

virtual int DtIndirectArtilleryPSR::roundsPerSalvo ( ) const
virtual
virtual void DtIndirectArtilleryPSR::setStartTime ( int  startTime)
virtual

Get / Set the start time state variable.

virtual int DtIndirectArtilleryPSR::startTime ( ) const
virtual
virtual void DtIndirectArtilleryPSR::setStartTimeImmediate ( bool  flag)
virtual

Get / Set the start time state variable.

virtual bool DtIndirectArtilleryPSR::startTimeImmediate ( ) const
virtual
virtual void DtIndirectArtilleryPSR::setTimeBetweenSalvos ( int  timeBetweenSalvos)
virtual

Get / Set the time between salvos state variable.

virtual int DtIndirectArtilleryPSR::timeBetweenSalvos ( ) const
virtual
virtual void DtIndirectArtilleryPSR::setScatterTime ( double  scatterTime)
virtual

Get / Set the time between salvos state variable.

virtual double DtIndirectArtilleryPSR::scatterTime ( ) const
virtual
virtual void DtIndirectArtilleryPSR::setAltitude ( double  altitude)
virtual

Get / Set the altitude state variable.

virtual double DtIndirectArtilleryPSR::altitude ( ) const
virtual
virtual void DtIndirectArtilleryPSR::setWindDirection ( double  windDirection)
virtual

Get / Set the wind offset direction (degrees) state variable. 0 = Due north, 90 = Due east.

virtual double DtIndirectArtilleryPSR::windDirection ( ) const
virtual
virtual void DtIndirectArtilleryPSR::setWindDistance ( double  windDistance)
virtual

Get / Set the wind offset direction (degrees) state variable. 0 = Due north, 90 = Due east.

virtual double DtIndirectArtilleryPSR::windDistance ( ) const
virtual
virtual void DtIndirectArtilleryPSR::setMunitionType ( DtEntityType const &  munitionType)
virtual

Get / Set the munition type state variable.

virtual DtEntityType DtIndirectArtilleryPSR::munitionType ( ) const
virtual
static DtVrfProcessStateRepository* DtIndirectArtilleryPSR::creator ( const DtString rwName,
DtVrfObject vrfObject,
DtReaderWriterRegistry parentRegistry 
)
static

Returns a newly created instance of this class.

Member Data Documentation

DtRwInt DtIndirectArtilleryPSR::myNumberOfSalvos
private

Number of salvos.

DtRwInt DtIndirectArtilleryPSR::myRoundsPerSalvo
private

Number of rounds per salvo.

DtRwInt DtIndirectArtilleryPSR::myStartTime
private

Time in seconds, relative to simulation start, when rounds start arriving.

DtRwBoolean DtIndirectArtilleryPSR::myStartTimeImmediate
private

If true, then barrage will start on next tick, and startTime will be set to that tick.

DtRwInt DtIndirectArtilleryPSR::myTimeBetweenSalvos
private

Time in seconds between salvos.

DtRwReal DtIndirectArtilleryPSR::myScatterTime
private

A timer used to keep rounds from arriving at the same time.

The actual arrival time is is startTime + DtRand() * scatterTime.

DtRwReal DtIndirectArtilleryPSR::myAltitude
private

Altitude (meters AGL) where detonation will take place.

DtRwReal DtIndirectArtilleryPSR::myWindDirection
private

Direction of wind displacement.

DtRwReal DtIndirectArtilleryPSR::myWindDistance
private

Distance of wind displacement.

DtRwEntityType DtIndirectArtilleryPSR::myMunitionType
private

Distance of wind displacement.


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

Document ID: Generated on Mon Apr 8 19:24:01 EDT 2013 from SVN revision 125877
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)