DtCombatIdentificationDetectionIntervalEntry. More...

Inheritance diagram for DtCombatIdentificationDetectionIntervalEntry:

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)
DtCombatIdentificationDetectionIntervalEntry &	operator= (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)

virtual const int	identificationLevel () const
	Accessor/mutator for myCombatIdentificationLevel.
virtual void	setIdentificationLevel (const int level)

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 DtCSVReaderWriter &	operator= (const DtCSVReaderWriter &orig)
	assignment operator
virtual	~DtCSVReaderWriter ()
	destructor
virtual void	putSelf (std::string &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 (std::string &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 void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
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)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
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)
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 ()
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 ()
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 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 (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
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 &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	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.
Protected Member Functions inherited from DtCSVReaderWriter
virtual void	putData (std::string &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 bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent

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

virtual const int DtCombatIdentificationDetectionIntervalEntry::identificationLevel ( ) const

virtual

Accessor/mutator for myCombatIdentificationLevel.

virtual void DtCombatIdentificationDetectionIntervalEntry::setIdentificationLevel ( const int level )

virtual

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:

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/combatIdentificationDetectionIntervalEntry.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation