VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions
DtCombatIdentificationDetectionIntervalEntry Class Reference

DtCombatIdentificationDetectionIntervalEntry. More...

Inheritance diagram for DtCombatIdentificationDetectionIntervalEntry:
Inheritance graph
[legend]

Public Member Functions

 DtCombatIdentificationDetectionIntervalEntry (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
 constructor with parameters to set up read/writability correctly
 DtCombatIdentificationDetectionIntervalEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual ~DtCombatIdentificationDetectionIntervalEntry ()
 destructor
 DtCombatIdentificationDetectionIntervalEntry (const DtCombatIdentificationDetectionIntervalEntry &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor. Use clone instead...
 DtCombatIdentificationDetectionIntervalEntry (const DtCombatIdentificationDetectionIntervalEntry &orig, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
DtCombatIdentificationDetectionIntervalEntryoperator= (const DtCombatIdentificationDetectionIntervalEntry &orig)
 assignment operator
virtual const char * readerWriterType () const
 Used to supply a string type that this reader writer type is.
virtual const double detectionInterval () const
 Accessor/mutator for myDetectionInterval.
virtual void setDetectionInterval (const double time)
 Accessor/mutator for myDetectionInterval.
virtual const int identificationLevel () const
 Accessor/mutator for myCombatIdentificationLevel.
virtual void setIdentificationLevel (const int level)
 Accessor/mutator for myCombatIdentificationLevel.
virtual bool getData (DtCSVLineEntry &sData, unsigned int timeIndex)
 Takes a string from a csv table and parses it to fill in the relevant data.
- Public Member Functions inherited from DtCSVReaderWriter
 DtCSVReaderWriter ()
 default constructor
 DtCSVReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream.
 DtCSVReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 DtCSVReaderWriter (const DtString &name, const DtCSVReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
 DtCSVReaderWriter (const DtSymbolString &name, const DtCSVReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtCSVReaderWriteroperator= (const DtCSVReaderWriter &orig)
 assignment operator
virtual ~DtCSVReaderWriter ()
 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 (FILE *fp)
 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 to write out individual data items.
- 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 getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream.
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 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 detection level table.

DtRwReal myDetectionInterval
 Parameter Name: detection-interval
Parameter Description: The amount of time an object has been detected for
Parameter Default Value:
Parameter Units: Seconds.
DtRwInt myCombatIdentificationLevel
 Parameter Name: combat-identification-level
Parameter Description: The level of identification that can be acsertained given the apparent signature of an object and the amount of time it's been observed.

Additional Inherited Members

- Public Types inherited from DtCSVReaderWriter
typedef std::vector< std::string > DtCSVLineEntry
 Stores a parsed csv line.
- 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 DtCSVReaderWriter
virtual void putData (FILE *fp, int indentLevel=0)
 Deriving class overrides these to get/put class specific data.
virtual bool getData (FILE *fp)
bool readLine (FILE *fp, DtString &line)
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
static DtGetSelfCallbackInfo thePostGetSelfCallback
static DtPutSelfCallbackInfo thePrePutSelfCallback
static const DtVariableBindingsList theEmptyVariableBindingsList
static DtReaderWriterFactory theFactory

Detailed Description

DtCombatIdentificationDetectionIntervalEntry.

Instances of DtCombatIdentificationDetectionIntervalEntry are the readable/writeable objects that hold a detection interval and it's associated identificiation level

Constructor & Destructor Documentation

DtCombatIdentificationDetectionIntervalEntry::DtCombatIdentificationDetectionIntervalEntry ( const DtString name = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = NULL 
)

constructor with parameters to set up read/writability correctly

DtCombatIdentificationDetectionIntervalEntry::DtCombatIdentificationDetectionIntervalEntry ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
)
virtual DtCombatIdentificationDetectionIntervalEntry::~DtCombatIdentificationDetectionIntervalEntry ( )
virtual

destructor

DtCombatIdentificationDetectionIntervalEntry::DtCombatIdentificationDetectionIntervalEntry ( const DtCombatIdentificationDetectionIntervalEntry orig,
const DtString name = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = NULL 
)

copy constructor. Use clone instead...

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

Member Function Documentation

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

assignment operator

virtual const double DtCombatIdentificationDetectionIntervalEntry::detectionInterval ( ) const
virtual

Accessor/mutator for myDetectionInterval.

virtual void DtCombatIdentificationDetectionIntervalEntry::setDetectionInterval ( const double  time)
virtual

Accessor/mutator for myDetectionInterval.

virtual const int DtCombatIdentificationDetectionIntervalEntry::identificationLevel ( ) const
virtual

Accessor/mutator for myCombatIdentificationLevel.

virtual void DtCombatIdentificationDetectionIntervalEntry::setIdentificationLevel ( const int  level)
virtual

Accessor/mutator for myCombatIdentificationLevel.

virtual bool DtCombatIdentificationDetectionIntervalEntry::getData ( DtCSVLineEntry sData,
unsigned int  timeIndex 
)
virtual

Takes a string from a csv table and parses it to fill in the relevant data.

virtual const char* DtCombatIdentificationDetectionIntervalEntry::readerWriterType ( ) const
virtual

Used to supply a string type that this reader writer type is.

This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create

Reimplemented from DtCSVReaderWriter.

Member Data Documentation

DtRwReal DtCombatIdentificationDetectionIntervalEntry::myDetectionInterval
protected

Parameter Name: detection-interval
Parameter Description: The amount of time an object has been detected for
Parameter Default Value:
Parameter Units: Seconds.

DtRwInt DtCombatIdentificationDetectionIntervalEntry::myCombatIdentificationLevel
protected

Parameter Name: combat-identification-level
Parameter Description: The level of identification that can be acsertained given the apparent signature of an object and the amount of time it's been observed.


Parameter Default Value:
Parameter Units:


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)