DtCombatIdentificationLevelTableEntry Class Reference

Inheritance diagram for DtCombatIdentificationLevelTableEntry:

Public Member Functions
	DtCombatIdentificationLevelTableEntry (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	constructor with parameters to set up read/writability correctly
	DtCombatIdentificationLevelTableEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtCombatIdentificationLevelTableEntry ()
	destructor
	DtCombatIdentificationLevelTableEntry (const DtCombatIdentificationLevelTableEntry &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor. Use clone instead...
	DtCombatIdentificationLevelTableEntry (const DtCombatIdentificationLevelTableEntry &orig, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
DtCombatIdentificationLevelTableEntry &	operator= (const DtCombatIdentificationLevelTableEntry &orig)
	assignment operator
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
void	printEntry ()
virtual const double	appSignature () const
	Accessor/mutator for myApparentSignature.
virtual void	setAppSignature (const double appSig)
	Accessor/mutator for myApparentSignature.
virtual int	lookupIdentificationLevel (double &detectionInterval) const
	Find the identfication level for given detection interval.
virtual bool	getData (DtCSVLineEntry &entryData, std::vector< double > &timeValues)
	Takes a string from the detection table that is in csv format, parses it and sets the values for the cidLevelTableEntry.
virtual void	addDetectionInterval (DtCombatIdentificationDetectionIntervalEntry *entryData)
	Add a detection interval to our detection list Creates a new entry based on one passed in, so, if passed in entry is allocated, deallocate to prevent memory leak.
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 DtCSVReaderWriter &	operator= (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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
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 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 aliasContainer &	aliases () 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 char *	xmlType () 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 DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
	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 DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () 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.

Protected Types
typedef std::vector < DtCombatIdentificationDetectionIntervalEntry * >	DtDetectionLevelList

Protected Member Functions
void	clearLevelList ()
	Removes and deletes all entries from myDetectionLevelList.
void	copyLevelListFrom (const DtDetectionLevelList &levelList)
	Copies all table entries from the provided source list.
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)
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
parameters
These parameters are available for setting in the detection level table.
DtRwReal	myApparentSignature
	Parameter Name: Parameter Description: The apparent signature of the object.
DtDetectionLevelList	myDetectionLevelList
	Parameter Name: Parameter Description: List of detection intervals and the identification levels associated with that interval Parameter Default Value: Parameter Units:

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 char *	theXmlType ()
	The type that is used when archiving to an XML stream.
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 void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

Member Typedef Documentation

typedef std::vector<DtCombatIdentificationDetectionIntervalEntry*> DtCombatIdentificationLevelTableEntry::DtDetectionLevelList

protected

Constructor & Destructor Documentation

DtCombatIdentificationLevelTableEntry::DtCombatIdentificationLevelTableEntry	(	const DtString &	name = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

constructor with parameters to set up read/writability correctly

DtCombatIdentificationLevelTableEntry::DtCombatIdentificationLevelTableEntry	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

virtual DtCombatIdentificationLevelTableEntry::~DtCombatIdentificationLevelTableEntry ( )

virtual

destructor

DtCombatIdentificationLevelTableEntry::DtCombatIdentificationLevelTableEntry	(	const DtCombatIdentificationLevelTableEntry &	orig,
		const DtString &	name = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor. Use clone instead...

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

Member Function Documentation

DtCombatIdentificationLevelTableEntry& DtCombatIdentificationLevelTableEntry::operator=

(

const DtCombatIdentificationLevelTableEntry &

orig

)

assignment operator

virtual const double DtCombatIdentificationLevelTableEntry::appSignature ( ) const

virtual

Accessor/mutator for myApparentSignature.

virtual void DtCombatIdentificationLevelTableEntry::setAppSignature ( const double  appSig )

virtual

Accessor/mutator for myApparentSignature.

virtual int DtCombatIdentificationLevelTableEntry::lookupIdentificationLevel ( double &  detectionInterval ) const

virtual

Find the identfication level for given detection interval.

virtual bool DtCombatIdentificationLevelTableEntry::getData ( DtCSVLineEntry &  entryData, std::vector< double > &  timeValues  )

virtual

Takes a string from the detection table that is in csv format, parses it and sets the values for the cidLevelTableEntry.

Pass in the time values that coincide with the identification levels.

virtual void DtCombatIdentificationLevelTableEntry::addDetectionInterval ( DtCombatIdentificationDetectionIntervalEntry *  entryData )

virtual

Add a detection interval to our detection list Creates a new entry based on one passed in, so, if passed in entry is allocated, deallocate to prevent memory leak.

virtual const char* DtCombatIdentificationLevelTableEntry::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.

void DtCombatIdentificationLevelTableEntry::printEntry

(

)

void DtCombatIdentificationLevelTableEntry::clearLevelList ( )

protected

Removes and deletes all entries from myDetectionLevelList.

Non-virtual since it is called from constructors/destructor.

void DtCombatIdentificationLevelTableEntry::copyLevelListFrom ( const DtDetectionLevelList &  levelList )

protected

Copies all table entries from the provided source list.

calls clearLevelList() first. Non-virtual since it is called from constructors.

Member Data Documentation

DtRwReal DtCombatIdentificationLevelTableEntry::myApparentSignature

protected

Parameter Name:
Parameter Description: The apparent signature of the object.

Parameter Default Value:

DtDetectionLevelList DtCombatIdentificationLevelTableEntry::myDetectionLevelList

protected

Parameter Name:
Parameter Description: List of detection intervals and the identification levels associated with that interval
Parameter Default Value:
Parameter Units:

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrfutil/combatIdentificationLevelTableEntry.h