DtRwSensorContactInfo Class Reference

This class represents the data gathered by a sensor about a particular single sensor contact. More...

Inheritance diagram for DtRwSensorContactInfo:

Public Member Functions
	DtRwSensorContactInfo ()
	DtRwSensorContactInfo (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwSensorContactInfo (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwSensorContactInfo (const DtRwSensorContactInfo &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
virtual	~DtRwSensorContactInfo ()
DtRwSensorContactInfo &	operator= (const DtRwSensorContactInfo &orig)
virtual const DtNLengthIntegerVector &	contactSources () const
	The list of sources for the contact, ie infrared sensor, visual sensor, spot report...
virtual void	setContactSources (const DtNLengthIntegerVector &sources)
virtual bool	addContactSource (int source)
	Add a contact source.
virtual bool	addContactSources (const DtNLengthIntegerVector &sources)
	Add multiple contact sources.
virtual DtRwSensorContactInfo *	clone () const
	Returns a newly created clone of this class.
bool	operator== (const DtRwSensorContactInfo &) const
virtual const DtEntityIdentifier &	id () const
	Entity identifier for the contact.
virtual void	setId (const DtEntityIdentifier &id)
	Entity identifier for the contact.
virtual double	originalDetectionTime () const
	First time the contact was spotted by the sensor.
virtual void	setOriginalDetectionTime (DtReal origTime)
	First time the contact was spotted by the sensor.
virtual void	setLastTimeOfDetection (double time)
	The most recent time this contact was spotted by the sensor.
virtual double	lastDetectionTime () const
	The most recent time this contact was spotted by the sensor.
virtual DtString	contactName () const
	The object name of the sensor contact.
virtual void	setContactName (const DtString &name)
	The object name of the sensor contact.
virtual int	combatIdentificationLevel () const
	The combat Identification level associated with this sensor contact.
virtual void	setCombatIdentificationLevel (int level)
	The combat Identification level associated with this sensor contact.
virtual double	detectionError () const
	The quality of the physical characteristics associated with this sensor contact.
virtual void	setDetectionError (double level)
	The quality of the physical characteristics associated with this sensor contact.
virtual void	setContactPosition (const DtVector &vector)
	The perceived location of the contact.
virtual DtVector	contactPosition () const
	The perceived location of the contact.
virtual void	setContactOrientation (const DtTaitBryan &orientation)
	The perceived orientation of the contact.
virtual DtTaitBryan	contactOrientation () const
	The perceived orientation of the contact.
virtual void	setContactVelocity (const DtVector &velocity)
	The perceived velocity of the contact.
virtual DtVector	contactVelocity () const
	The perceived velocity of the contact.
virtual void	setContactType (const DtObjectType &type)
	The perceived type of the contact being reported.
virtual DtObjectType	contactType () const
	The perceived type of the contact being reported.
virtual void	setContactForce (const DtForceType &force)
	The perceived force of the contact being detected.
virtual DtForceType	contactForce () const
	The perceived force of the contact being detected.
virtual void	setContactFormation (const DtAggregateFormation formation)
	The perceived formation of the contact.
virtual DtAggregateFormation	contactFormation () const
	The perceived formation of the contact.
virtual DtString	contactFormationString () const
	The perceived formation of the contact.
virtual void	setContactActivity (DtU32 activityEnum)
	The perceived activity of the contact.
virtual DtU32	contactActivity () const
	The perceived activity of the contact.
virtual void	setContactAppearance (const DtAppearance &app)
	The appearance of the contact–alive or dead, lights on....
virtual const DtAppearance &	contactAppearance () const
	The appearance of the contact–alive or dead, lights on....
virtual DtAppearance &	contactAppearance ()
	The appearance of the contact–alive or dead, lights on....
virtual void	removeContactSource (int source)
	Remove a contact source.
virtual int	findContactSource (int source)
	Returns index of the source type if found If not found returns -1.
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 DtReaderWriter &	operator= (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	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	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, 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 aliasContainer &	aliases () 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 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.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Protected Attributes
DtRwString	myContactName
DtEntityIdentifier	myId
DtRwReal	myOriginalTimeOfDetection
DtRwReal	myLastTimeOfDetection
DtRwInt	myCombatIdentificationLevel
DtRwReal	myDetectionError
	Describes how well known the position and velocity are.
DtRwVector	myContactPosition
	In world reference frame. (Geocentric)
DtRwTaitBryan	myContactOrientation
	In world reference frame. (Geocentric)
DtRwVector	myContactVelocity
	In world reference frame. (Geocentric)
DtRwObjectType	myContactType
DtRwForceType	myContactForce
DtNLengthIntegerVector	myContactSourceTypes
DtRwFormationType	myContactFormation
	Not currently used.
DtRwInt	myContactActivity
DtRwAppearance	myContactAppearance
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
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
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 void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static DtReaderWriterFactory *	factory ()
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 bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

Detailed Description

This class represents the data gathered by a sensor about a particular single sensor contact.

The DtRwSensorContactInfo class is a readable/writable class that can store itself and read itself from a file. Note that the entity ID is not written or read, since these change between scenario runs. The using code must manage the setting of entity IDs when loaded from a file.

Constructor & Destructor Documentation

DtRwSensorContactInfo::DtRwSensorContactInfo

(

)

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

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

DtRwSensorContactInfo::DtRwSensorContactInfo	(	const DtRwSensorContactInfo &	orig,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

virtual DtRwSensorContactInfo::~DtRwSensorContactInfo ( )

virtual

Member Function Documentation

DtRwSensorContactInfo& DtRwSensorContactInfo::operator=

(

const DtRwSensorContactInfo &

orig

)

virtual const DtEntityIdentifier& DtRwSensorContactInfo::id ( ) const

inlinevirtual

Entity identifier for the contact.

It is preferred to use contactName() instead.

virtual void DtRwSensorContactInfo::setId ( const DtEntityIdentifier &  id )

inlinevirtual

Entity identifier for the contact.

It is preferred to use contactName() instead.

virtual double DtRwSensorContactInfo::originalDetectionTime ( ) const

inlinevirtual

First time the contact was spotted by the sensor.

virtual void DtRwSensorContactInfo::setOriginalDetectionTime ( DtReal  origTime )

inlinevirtual

First time the contact was spotted by the sensor.

virtual void DtRwSensorContactInfo::setLastTimeOfDetection ( double  time )

inlinevirtual

The most recent time this contact was spotted by the sensor.

virtual double DtRwSensorContactInfo::lastDetectionTime ( ) const

inlinevirtual

The most recent time this contact was spotted by the sensor.

virtual DtString DtRwSensorContactInfo::contactName ( ) const

inlinevirtual

The object name of the sensor contact.

virtual void DtRwSensorContactInfo::setContactName ( const DtString &  name )

inlinevirtual

The object name of the sensor contact.

References DtReaderWriter::name().

virtual int DtRwSensorContactInfo::combatIdentificationLevel ( ) const

inlinevirtual

The combat Identification level associated with this sensor contact.

virtual void DtRwSensorContactInfo::setCombatIdentificationLevel ( int  level )

inlinevirtual

The combat Identification level associated with this sensor contact.

virtual double DtRwSensorContactInfo::detectionError ( ) const

inlinevirtual

The quality of the physical characteristics associated with this sensor contact.

I.e percentage of error associated with this information.

virtual void DtRwSensorContactInfo::setDetectionError ( double  level )

inlinevirtual

The quality of the physical characteristics associated with this sensor contact.

I.e percentage of error associated with this information.

virtual void DtRwSensorContactInfo::setContactPosition ( const DtVector &  vector )

virtual

The perceived location of the contact.

Specified in geocentric coordinates.

virtual DtVector DtRwSensorContactInfo::contactPosition ( ) const

virtual

The perceived location of the contact.

Specified in geocentric coordinates.

virtual void DtRwSensorContactInfo::setContactOrientation ( const DtTaitBryan &  orientation )

virtual

The perceived orientation of the contact.

Specified in the geocentric reference frame.

virtual DtTaitBryan DtRwSensorContactInfo::contactOrientation ( ) const

virtual

The perceived orientation of the contact.

Specified in the geocentric reference frame.

virtual void DtRwSensorContactInfo::setContactVelocity ( const DtVector &  velocity )

virtual

The perceived velocity of the contact.

Specified in the geocentric reference frame.

virtual DtVector DtRwSensorContactInfo::contactVelocity ( ) const

virtual

The perceived velocity of the contact.

Specified in the geocentric reference frame.

virtual void DtRwSensorContactInfo::setContactType ( const DtObjectType &  type )

virtual

The perceived type of the contact being reported.

Types may be only partially filled in, using -1 for fields that are unknown. So if we have a very low level of identification the type may only reflect a ground vehicle (1 (1 1 -1 -1 -1 -1 -1))

virtual DtObjectType DtRwSensorContactInfo::contactType ( ) const

virtual

The perceived type of the contact being reported.

Types may be only partially filled in, using -1 for fields that are unknown. So if we have a very low level of identification the type may only reflect a ground vehicle (1 (1 1 -1 -1 -1 -1 -1))

virtual void DtRwSensorContactInfo::setContactForce ( const DtForceType &  force )

virtual

The perceived force of the contact being detected.

Defaults to DtForceOther

virtual DtForceType DtRwSensorContactInfo::contactForce ( ) const

virtual

The perceived force of the contact being detected.

Defaults to DtForceOther

virtual void DtRwSensorContactInfo::setContactFormation ( const DtAggregateFormation  formation )

virtual

The perceived formation of the contact.

Uses OtherFormation to indicate unknown formation. (the default)

virtual DtAggregateFormation DtRwSensorContactInfo::contactFormation ( ) const

virtual

The perceived formation of the contact.

Uses OtherFormation to indicate unknown formation. (the default)

virtual DtString DtRwSensorContactInfo::contactFormationString ( ) const

virtual

The perceived formation of the contact.

Uses OtherFormation to indicate unknown formation. (the default)

virtual void DtRwSensorContactInfo::setContactActivity ( DtU32  activityEnum )

virtual

The perceived activity of the contact.

This value is an enumeration of activities. Not currently used by VR-Forces, but still transmitted with the message. Defaults to DtActivityUnknown.

virtual DtU32 DtRwSensorContactInfo::contactActivity ( ) const

virtual

The perceived activity of the contact.

This value is an enumeration of activities. Not currently used by VR-Forces, but still transmitted with the message. Defaults to DtActivityUnknown.

virtual void DtRwSensorContactInfo::setContactAppearance ( const DtAppearance &  app )

virtual

The appearance of the contact–alive or dead, lights on....

virtual const DtAppearance& DtRwSensorContactInfo::contactAppearance ( ) const

virtual

The appearance of the contact–alive or dead, lights on....

virtual DtAppearance& DtRwSensorContactInfo::contactAppearance ( )

virtual

The appearance of the contact–alive or dead, lights on....

virtual const DtNLengthIntegerVector& DtRwSensorContactInfo::contactSources ( ) const

virtual

The list of sources for the contact, ie infrared sensor, visual sensor, spot report...

virtual void DtRwSensorContactInfo::setContactSources ( const DtNLengthIntegerVector &  sources )

virtual

virtual bool DtRwSensorContactInfo::addContactSource ( int  source )

virtual

Add a contact source.

Returns

True if the source was added. If it is already present in the list it will not be added a second time.

virtual bool DtRwSensorContactInfo::addContactSources ( const DtNLengthIntegerVector &  sources )

virtual

Add multiple contact sources.

Returns

True if the contact sources list was changed by this call. If the list already contains every source in the new list, nothing will be added.

virtual void DtRwSensorContactInfo::removeContactSource ( int  source )

virtual

Remove a contact source.

virtual int DtRwSensorContactInfo::findContactSource ( int  source )

virtual

Returns index of the source type if found If not found returns -1.

virtual DtRwSensorContactInfo* DtRwSensorContactInfo::clone ( ) const

virtual

Returns a newly created clone of this class.

bool DtRwSensorContactInfo::operator==

(

const DtRwSensorContactInfo &

)

const

Member Data Documentation

DtRwString DtRwSensorContactInfo::myContactName

protected

DtEntityIdentifier DtRwSensorContactInfo::myId

protected

DtRwReal DtRwSensorContactInfo::myOriginalTimeOfDetection

protected

DtRwReal DtRwSensorContactInfo::myLastTimeOfDetection

protected

DtRwInt DtRwSensorContactInfo::myCombatIdentificationLevel

protected

DtRwReal DtRwSensorContactInfo::myDetectionError

protected

Describes how well known the position and velocity are.

Determined by the sensor and it's associated errors in detecting.

DtRwVector DtRwSensorContactInfo::myContactPosition

protected

In world reference frame. (Geocentric)

DtRwTaitBryan DtRwSensorContactInfo::myContactOrientation

protected

In world reference frame. (Geocentric)

DtRwVector DtRwSensorContactInfo::myContactVelocity

protected

In world reference frame. (Geocentric)

DtRwObjectType DtRwSensorContactInfo::myContactType

protected

DtRwForceType DtRwSensorContactInfo::myContactForce

protected

DtNLengthIntegerVector DtRwSensorContactInfo::myContactSourceTypes

protected

DtRwFormationType DtRwSensorContactInfo::myContactFormation

protected

Not currently used.

DtRwInt DtRwSensorContactInfo::myContactActivity

protected

DtRwAppearance DtRwSensorContactInfo::myContactAppearance

protected

---

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

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