VR-Forces 4.1.1 Class Documentation
List of all members | Public Member Functions
DtRwDetectionLevelContainer Class Reference

DtRwDetectionLevelContainer contains the parameters needed to define a DtDetectionLevelDeterminator. More...

Inheritance diagram for DtRwDetectionLevelContainer:
Inheritance graph
[legend]

Public Member Functions

 DtRwDetectionLevelContainer ()
 default constructor
 DtRwDetectionLevelContainer (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 real constructor
 DtRwDetectionLevelContainer (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 DtRwDetectionLevelContainer (const DtRwDetectionLevelContainer &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
 copy constructor
DtRwDetectionLevelContaineroperator= (const DtRwDetectionLevelContainer &orig)
virtual ~DtRwDetectionLevelContainer ()
virtual void setDetectLevelDeterminatorType (const DtString &type)
 Type of detection level determinator to create.
virtual const DtStringdetectLevelDeterminatorType () const
 Return type of detection leved determinator this container holds parameters for.
virtual void getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Top level to read itself from an input stream.
virtual const int detectionLevelForForce () const
 Accessor/mutator for myLevelForSettingForceType.
virtual void setDetectionLevelForForce (const int level)
 Accessor/mutator for myLevelForSettingForceType.
virtual const
DtCombatIdentificationLevelTable
sensorCombatIdentificationTable () const
 Accessor/mutator for mySensorCombatIdentificationTable.
virtual void setSensorCombatIdentificationTable (const DtCombatIdentificationLevelTable &cidTable)
 Accessor/mutator for mySensorCombatIdentificationTable.
virtual const DtReaderWriterFilesensorCombatIdentificationTableFilename () const
 Accessor/mutator for mySensorCombatIdentificationTableFilename.
virtual void setSensorCombatIdentificationTableFilename (const DtReaderWriterFile &filename)
 Accessor/mutator for mySensorCombatIdentificationTableFilename.
- 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.

Protected Attributes

parameters

These parameters are available for setting in the OPD files.

Parameter Name: determinator-type
Parameter Description: This is the type of determinator to use to determine the detection level of sensed entities. Base type is signature detection level. It uses the time of observation and distance to the sensed entity to determine detection level. Uses the detection files found in "data\simulationModelSets\default\vrfSim\detection".
Parameter Default Value: signature-detection-level-determinator

DtRwString myDetectLevelDeterminatorType
 Parameter Name: detection-level-to-set-force-type
Parameter Description: This is the combat identification level at which the force type of the object is set.
DtRwInt myLevelForSettingForceType
 Parameter Name: detection-level-to-set-force-type
Parameter Description: This is the combat identification level at which the force type of the object is set.
DtReaderWriterFile mySensorCombatIdentificationTableFilename
 Parameter Name: combat-identification-level-table-file
Parameter Description: The name of the file that is used to create the sensor's combatIdentificationTable
Parameter Default Value:
.
DtCombatIdentificationLevelTable mySensorCombatIdentificationTable
 Parameter Name: combat-identification-level-table
Parameter Description: The table that uses the apparent signature of a detected object and the amount of time it's been detected for to determine the combat Identification(CID) level for the object.
- 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
- 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 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 DtReaderWriterFactory theFactory

Detailed Description

DtRwDetectionLevelContainer contains the parameters needed to define a DtDetectionLevelDeterminator.

Currently just need to specify the type.

Constructor & Destructor Documentation

DtRwDetectionLevelContainer::DtRwDetectionLevelContainer ( )

default constructor

DtRwDetectionLevelContainer::DtRwDetectionLevelContainer ( const DtString name,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)

real constructor

DtRwDetectionLevelContainer::DtRwDetectionLevelContainer ( const DtSymbolString name,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)
DtRwDetectionLevelContainer::DtRwDetectionLevelContainer ( const DtRwDetectionLevelContainer orig,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)

copy constructor

virtual DtRwDetectionLevelContainer::~DtRwDetectionLevelContainer ( )
virtual

Member Function Documentation

DtRwDetectionLevelContainer& DtRwDetectionLevelContainer::operator= ( const DtRwDetectionLevelContainer orig)
virtual const int DtRwDetectionLevelContainer::detectionLevelForForce ( ) const
virtual

Accessor/mutator for myLevelForSettingForceType.

virtual void DtRwDetectionLevelContainer::setDetectionLevelForForce ( const int  level)
virtual

Accessor/mutator for myLevelForSettingForceType.

virtual const DtCombatIdentificationLevelTable& DtRwDetectionLevelContainer::sensorCombatIdentificationTable ( ) const
virtual

Accessor/mutator for mySensorCombatIdentificationTable.

virtual void DtRwDetectionLevelContainer::setSensorCombatIdentificationTable ( const DtCombatIdentificationLevelTable cidTable)
virtual

Accessor/mutator for mySensorCombatIdentificationTable.

virtual const DtReaderWriterFile& DtRwDetectionLevelContainer::sensorCombatIdentificationTableFilename ( ) const
virtual
virtual void DtRwDetectionLevelContainer::setSensorCombatIdentificationTableFilename ( const DtReaderWriterFile filename)
virtual
virtual void DtRwDetectionLevelContainer::setDetectLevelDeterminatorType ( const DtString type)
virtual

Type of detection level determinator to create.

virtual const DtString& DtRwDetectionLevelContainer::detectLevelDeterminatorType ( ) const
virtual

Return type of detection leved determinator this container holds parameters for.

virtual void DtRwDetectionLevelContainer::getSelf ( DtlObjPtr  args,
const DtFilename &  searchPath,
const DtVariableBindingsList variableBindings 
)
virtual

Top level to read itself from an input stream.

searchPath is passed down to all DtReaderWriter members in its DtReaderWriterRegistry (collection of child DtReaderWriter nodes). If a given member in the registry is of type DtReaderWriterFile, and the searchPath is specified with a non-NULL string, then file to be read in is searched for in the given path.

Reimplemented from DtReaderWriter.

Member Data Documentation

DtRwString DtRwDetectionLevelContainer::myDetectLevelDeterminatorType
protected

Parameter Name: detection-level-to-set-force-type
Parameter Description: This is the combat identification level at which the force type of the object is set.

Derived classes might want to determine force type in more complex ways. In that case set this to -1 == no combat identification level specified.
Parameter Default Value: 3

DtRwInt DtRwDetectionLevelContainer::myLevelForSettingForceType
protected

Parameter Name: detection-level-to-set-force-type
Parameter Description: This is the combat identification level at which the force type of the object is set.

Derived classes might want to determine force type in more complex ways. In that case set this to -1 == no combat identification level specified.
Parameter Default Value: 3

DtReaderWriterFile DtRwDetectionLevelContainer::mySensorCombatIdentificationTableFilename
protected

Parameter Name: combat-identification-level-table-file
Parameter Description: The name of the file that is used to create the sensor's combatIdentificationTable
Parameter Default Value:
.

DtCombatIdentificationLevelTable DtRwDetectionLevelContainer::mySensorCombatIdentificationTable
protected

Parameter Name: combat-identification-level-table
Parameter Description: The table that uses the apparent signature of a detected object and the amount of time it's been detected for to determine the combat Identification(CID) level for the object.


Parameter Default Value:


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)