VR-Forces 4.2 Class Documentation
List of all members | Public Member Functions | Protected Attributes | Related Functions
DtFireMissionInformation Class Reference
Inheritance diagram for DtFireMissionInformation:
Inheritance graph
[legend]

Public Member Functions

 DtFireMissionInformation ()
 DtFireMissionInformation (const DtString &name, DtReaderWriterRegistry *const parentRegistry=0)
 DtFireMissionInformation (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=0)
 DtFireMissionInformation (const DtString &writeName, const DtFireMissionInformation &orig, DtReaderWriterRegistry *const parentRegistry=0)
 Copy constructor.
virtual ~DtFireMissionInformation ()
DtFireMissionInformationoperator= (const DtFireMissionInformation &orig)
const DtRwVectorcurrentTargetLocation () const
void setCurrentTargetLocation (const DtVector &loc)
const DtRwStringtargetName () const
 If the fire mission objective is an entity we need to know name so we can update the location.
void setTargetName (const DtString &name)
const DtRwStringammoType () const
void setAmmoType (const DtString &ammo)
const DtRwInt numberOfRounds () const
void setNumberOfRounds (const int num)
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.
- 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
bool operator== (const DtReaderWriter &) const
 Equivalence operator.
bool operator!= (const DtReaderWriter &rhs)
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 getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream.
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 void clearAllVariableReferenceFlags ()
 Clears out all variable reference flags from all readerwriter items in registry recursively.
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.

Protected Attributes

DtRwString myTargetName
DtRwString myAmmoType
DtRwVector myCurrentTargetLocation
DtRwInt myNumberRounds
DtRwReal myHeightAboveTerrain
- 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.

Related Functions

(Note that these are not member functions.)

typedef DtRwTemplatedListPtr
< DtFireMissionInformation
DtFireMissionList
typedef std::map< DtString,
DtFireMissionInformation
DtMappedFireMissionList

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
typedef DtReaderWriterFactory *(* DtReaderWriterFactoryCreatorFcn )()
- 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.
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 Sets the function to create the DtReaderWriterFactory.
static void createReaderWriterFactory ()
static DtReaderWriterFactoryfactory ()
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void putData (FILE *fp, int indentLevel=0)
 Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Deriving class overrides these to get/put class specific data.
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
static DtGetSelfCallbackInfo thePostGetSelfCallback
static DtPutSelfCallbackInfo thePrePutSelfCallback
static const DtVariableBindingsList theEmptyVariableBindingsList
static bool theCreatorFcnSet
static DtReaderWriterFactorytheFactory
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn

Constructor & Destructor Documentation

DtFireMissionInformation::DtFireMissionInformation ( )
DtFireMissionInformation::DtFireMissionInformation ( const DtString name,
DtReaderWriterRegistry *const  parentRegistry = 0 
)
DtFireMissionInformation::DtFireMissionInformation ( const DtSymbolString &  name,
DtReaderWriterRegistry *const  parentRegistry = 0 
)
DtFireMissionInformation::DtFireMissionInformation ( const DtString writeName,
const DtFireMissionInformation orig,
DtReaderWriterRegistry *const  parentRegistry = 0 
)

Copy constructor.

virtual DtFireMissionInformation::~DtFireMissionInformation ( )
virtual

Member Function Documentation

DtFireMissionInformation& DtFireMissionInformation::operator= ( const DtFireMissionInformation orig)
const DtRwVector& DtFireMissionInformation::currentTargetLocation ( ) const
inline
void DtFireMissionInformation::setCurrentTargetLocation ( const DtVector loc)
inline
const DtRwString& DtFireMissionInformation::targetName ( ) const
inline

If the fire mission objective is an entity we need to know name so we can update the location.

void DtFireMissionInformation::setTargetName ( const DtString name)
inline
const DtRwString& DtFireMissionInformation::ammoType ( ) const
inline
void DtFireMissionInformation::setAmmoType ( const DtString ammo)
inline
const DtRwInt DtFireMissionInformation::numberOfRounds ( ) const
inline
void DtFireMissionInformation::setNumberOfRounds ( const int  num)
inline
virtual void DtFireMissionInformation::setHeightAboveTerrain ( DtReal  height)
inlinevirtual

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

virtual DtReal DtFireMissionInformation::heightAboveTerrain ( )
inlinevirtual

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

Friends And Related Function Documentation

Member Data Documentation

DtRwString DtFireMissionInformation::myTargetName
protected
DtRwString DtFireMissionInformation::myAmmoType
protected
DtRwVector DtFireMissionInformation::myCurrentTargetLocation
protected
DtRwInt DtFireMissionInformation::myNumberRounds
protected
DtRwReal DtFireMissionInformation::myHeightAboveTerrain
protected

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

Document ID: Generated on Sun Nov 24 19:49:21 EST 2013 from SVN revision 133924
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)