VR-Forces 4.3 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes
DtFireForEffectOnTargetTask Class Reference

DtFireForEffectOnTargetTask represents an artillery task to fire for effect on the specified entity. More...

Inheritance diagram for DtFireForEffectOnTargetTask:
Inheritance graph
[legend]

Public Member Functions

 DtFireForEffectOnTargetTask ()
 default constructor
 DtFireForEffectOnTargetTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
 constructor If you have a task 'put' itself, the writeName will preface the task.
 DtFireForEffectOnTargetTask (const DtString &writeName, const DtFireForEffectOnTargetTask &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
const DtFireForEffectOnTargetTaskoperator= (const DtFireForEffectOnTargetTask &orig)
 assignment operator
virtual ~DtFireForEffectOnTargetTask ()
virtual const
DtSimTaskMessageType
type () const
 Override to define the type of FFE task; types found in radioMsgTypes.h.
virtual DtSimTaskclone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
 Creates a copy of this FFE task.
virtual DtString stringRep () const
 Get a readable string representation of this task.
virtual void setTargetName (const DtString &targetName)
 Set location.
virtual const DtStringtargetName () const
 Get location.
virtual int netRepSize () const
 Returns the size of the full network representation padded to an 8-byte boundary.
virtual bool setFromNet (const char *contentBuffer, unsigned contentSize)
 Fills in the task from the network buffer.
virtual bool setToNet ()
 Fills in the network buffer (created by base class simTask) with the task contents.
- Public Member Functions inherited from DtFireForEffectTask
virtual ~DtFireForEffectTask ()
virtual void addWeapon (const DtString &weap)
 Adds a weapon system to the list of weapons to be used for this task.
virtual const DtRwStringListweaponNames () const
virtual DtRwStringListweaponNames ()
virtual void setWeaponNames (const DtRwStringList &weapons)
virtual bool getWeaponOnList (const DtString &weaponName, DtString &weapon)
 Look up a weaponName (intended to be a display name from a list maintained by a weapon component interface) in the myWeaponNames, which is a list of weapons to fire in this task.
virtual void setNumberOfRounds (int rounds)
 See if ammo type was specified for this task (if not, use default).
virtual int numberOfRounds () const
virtual bool numberOfRoundsSpecified () const
virtual void setDispersionRadius (DtReal radius)
virtual DtReal dispersionRadius () const
virtual bool dispersionRadiusSpecified () const
virtual void setHeightAboveTerrain (DtReal height)
virtual DtReal heightAboveTerrain () const
virtual bool heightAboveTerrainSpecified () const
- Public Member Functions inherited from DtSimTask
virtual ~DtSimTask ()
 destructor
virtual bool init ()
 Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation.
virtual bool isTypeRegistered (const DtSimTaskMessageType &taskName)
virtual void setSubtask (bool flag)
 If true, this task is a subtask.
virtual bool subtask () const
virtual void putData (FILE *fp, int indentLevel=0)
 putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 getData is just used to get us past the type in the data stream, since it's not actually stored.
virtual charnetRep ()
- 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)
 pseudo-copy constructor
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
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 postPutSelf ()
 Called after either version of put self (file or environment). Default is no-op.
virtual void prePutSelf ()
 Called before either version of put self (file or environment). Default is no-op.
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream.
virtual void postGetSelf ()
 Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void preGetSelf ()
 Called before either version of get self (file or environment). Default is no-op.
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 void reset ()
 For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int alignment () const
 For those items that are sent over the network via HLA, this will give the network alignment.
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 charreaderWriterType () const
 Used to supply a string type that this reader writer type is.
virtual const charxmlType () const
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable.
std::string debugText () const
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 bool hasVariableReference () const
 Returns true if this item or any item in the registry (recursive) is a variable reference.
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 recordUpdateTime () const
 Can be implemented in subclasses to stamp the time when updated.
virtual bool wasUpdatedSince (DtTime t) const
 Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual DtlObjPtr getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 Deriving class overrides these to get/put class specific data.
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.
virtual const DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriterdefaultRWValue ()
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void setDefaultRWValue (DtReaderWriter *)
 Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterfaceproperty ()
virtual const DtPropertyInterfaceproperty () const
virtual DtString toXml () const
virtual bool toXml (const DtFilename &) const
 Writes contents of xml result to the given filename.
virtual bool fromXml (const DtString &)
 Restores object from given xml string. Returns true if valid.
virtual bool fromXmlFile (const DtFilename &)
 Restires object from given xml file.
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 Override to add attributes of actual data.
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 Called when the item is a variable reference.
virtual void getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 Gets data from the environment value.
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 Called when the item is a variable reference.

Static Public Member Functions

static DtSimTaskcreator ()

Protected Attributes

DtRwObjectName myTargetName
- Protected Attributes inherited from DtFireForEffectTask
DtRwStringList myWeaponNames
DtRwInt myNumberOfRounds
DtRwReal myDispersionRadius
DtRwReal myHeightAboveTerrain
- Protected Attributes inherited from DtSimTask
DtRwBoolean mySubtask
charmyNetRep
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
DtReaderWriterRegistry myRegistry
DtReaderWriterRegistrymyParentRegistry
bool myValueSpecified
bool myReadOnlyFlag
bool myIsVariableReference
DtSymbolString myVariableName
bool myVariableIsBound
DtReaderWritermyDefaultValue
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::vector< DtFilename > SearchPaths
typedef std::pair
< DtSymbolString, DtString
DtVariableNameType
typedef DtReaderWriterFactory *(* DtReaderWriterFactoryCreatorFcn )()
- Protected Member Functions inherited from DtFireForEffectTask
 DtFireForEffectTask ()
 default constructor
 DtFireForEffectTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
 constructor If you have a task 'put' itself, the writeName will preface the task.
 DtFireForEffectTask (const DtString &writeName, const DtFireForEffectTask &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
const DtFireForEffectTaskoperator= (const DtFireForEffectTask &orig)
 assignment operator
virtual DtString parameterStringRep () const
 Get a readable string representation of the parameters.
- Static Protected Attributes inherited from DtSimTask
static DtSimTaskFactorymyFactory

Detailed Description

DtFireForEffectOnTargetTask represents an artillery task to fire for effect on the specified entity.

Constructor & Destructor Documentation

DtFireForEffectOnTargetTask::DtFireForEffectOnTargetTask ( )

default constructor

DtFireForEffectOnTargetTask::DtFireForEffectOnTargetTask ( const DtString writeName,
DtReaderWriterRegistry parentRegistry = 0 
)

constructor If you have a task 'put' itself, the writeName will preface the task.

DtFireForEffectOnTargetTask::DtFireForEffectOnTargetTask ( const DtString writeName,
const DtFireForEffectOnTargetTask orig,
DtReaderWriterRegistry parentRegistry = 0 
)

copy constructor

virtual DtFireForEffectOnTargetTask::~DtFireForEffectOnTargetTask ( )
virtual

Member Function Documentation

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

assignment operator

virtual const DtSimTaskMessageType& DtFireForEffectOnTargetTask::type ( ) const
virtual

Override to define the type of FFE task; types found in radioMsgTypes.h.

Implements DtSimTask.

virtual DtSimTask* DtFireForEffectOnTargetTask::clone ( const DtString name,
DtReaderWriterRegistry parentRegistry = 0 
) const
virtual

Creates a copy of this FFE task.

Implements DtSimTask.

virtual DtString DtFireForEffectOnTargetTask::stringRep ( ) const
virtual

Get a readable string representation of this task.

Implements DtSimTask.

virtual void DtFireForEffectOnTargetTask::setTargetName ( const DtString targetName)
virtual

Set location.

virtual const DtString& DtFireForEffectOnTargetTask::targetName ( ) const
virtual

Get location.

virtual int DtFireForEffectOnTargetTask::netRepSize ( ) const
virtual

Returns the size of the full network representation padded to an 8-byte boundary.

Reimplemented from DtFireForEffectTask.

virtual bool DtFireForEffectOnTargetTask::setFromNet ( const char contentBuffer,
unsigned  contentSize 
)
virtual

Fills in the task from the network buffer.

Reimplemented from DtFireForEffectTask.

virtual bool DtFireForEffectOnTargetTask::setToNet ( )
virtual

Fills in the network buffer (created by base class simTask) with the task contents.

Reimplemented from DtFireForEffectTask.

static DtSimTask* DtFireForEffectOnTargetTask::creator ( )
static

Member Data Documentation

DtRwObjectName DtFireForEffectOnTargetTask::myTargetName
protected

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

Document ID: Generated on Wed Mar 11 21:20:57 EDT 2015 from SVN revision 150940
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)