DtSpotReport Class Reference

DtSpotReport; subclass of DtSimReport. More...

Inheritance diagram for DtSpotReport:

Public Member Functions
	DtSpotReport (const DtString &rwName, DtReaderWriterRegistry *parentRegistry=0)
	DtSpotReport (const DtString &rwName, const DtSpotReport &orig, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSpotReport ()
const DtSpotReport &	operator= (const DtSpotReport &orig)
virtual const DtSimReportMessageType &	type () const
	What kind of report am I? Returns a character string representing the kind of report.
virtual DtSimReport *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
	make a copy of this report
virtual int	netRepSize () const
	Adds current size of this message to size reported by base class.
virtual bool	setFromNet (const char *networkBuffer, unsigned contentSize)
	Extracts elements of this report from the network buffer.
virtual bool	setToNet ()
	Encodes contents of this report into the network buffer.
virtual DtString	stringRep () const
virtual void	setContactLocation (const DtVector &vector)
	The perceived location of the contact being reported.
virtual DtVector	contactLocation () const
	The perceived location of the contact being reported.
virtual void	setContactOrientation (const DtTaitBryan &orientation)
	The perceived orientation of the contact being reported.
virtual DtTaitBryan	contactOrientation () const
	The perceived orientation of the contact being reported.
virtual void	setContactVelocity (const DtVector &velocity)
	The perceived velocity of the contact being reported.
virtual DtVector	contactVelocity () const
	The perceived velocity of the contact being reported.
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	setContactFormation (const DtAggregateFormation formation)
	The perceived formation of the contact being reported.
virtual DtAggregateFormation	contactFormation () const
	The perceived formation of the contact being reported.
virtual void	setContactForce (const DtForceType &force)
	The perceived force of the contact being reported.
virtual DtForceType	contactForce () const
	The perceived force of the contact being reported.
virtual void	setContactActivity (DtU32 activityEnum)
	The perceived activity of the contact being reported.
virtual DtU32	contactActivity () const
	The perceived activity of the contact being reported.
virtual void	setContactName (const DtString &name)
	The object name of the contact being reported, if the contact represents an actual object in the simulation.
virtual DtString	contactName () const
	The object name of the contact being reported, if the contact represents an actual object in the simulation.
virtual void	setSpotterName (const DtString &name)
	The object name of the entity which initially reported the contact.
virtual DtString	spotterName () const
	The object name of the entity which initially reported the contact.
virtual void	setTimeOfReport (DtTime t)
	The simulation time the report was initially generated.
virtual DtTime	timeOfReport () const
	The simulation time the report was initially generated.
virtual void	setTimeOfContact (DtTime t)
	The simulation time of the data about the contact contained in this report.
virtual DtTime	timeOfContact () const
	The simulation time of the data about the contact contained in this report.
virtual void	setCombatIdentificationLevel (int t)
	The identification level of the contact.
virtual int	combatIdentificationLevel () const
	The identification level of the contact.
virtual void	setDetectionError (double detectionErrorIn)
	The identification detection error.
virtual double	detectionError () const
	The identification detection error.
virtual void	setContactInfo (const DtRwSensorContactInfo &info)
	Accessor for the contact info.
virtual const DtRwSensorContactInfo &	contactInfo () const
	Accessor for the contact info.
virtual DtRwSensorContactInfo &	contactInfo ()
	Accessor for the contact info.
Public Member Functions inherited from DtSimReport
virtual	~DtSimReport ()
	destructor
virtual bool	init ()
	Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation.
virtual void	putData (FILE *fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored.
virtual char *	netRep ()
virtual void	clearNetRep ()
	Clears the stored netRep.
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
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 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.

Static Public Member Functions
static DtSimReport *	creator ()
	Returns a new instance of DtSpotReport.
Static Public Member Functions inherited from DtSimReport
static DtSimReport *	createReport (const DtSimReportMessageType &reportTypeString)
	Static functions.
static void	addReportCreatorFcn (const DtSimReportMessageType &reportName, DtSimReportCreatorFcn fcn)
static void	setFactory (DtSimReportFactory *factory)
static DtSimReportFactory *	factory ()
static bool	isTypeRegistered (const DtSimReportMessageType &type)
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.

Protected Attributes
DtRwSensorContactInfo	myContactInfo
DtRwString	mySpotterName
DtRwReal	myTimeOfReport
	Time report was generated.
Protected Attributes inherited from DtSimReport
char *	myNetRep
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.

Private Member Functions
	DtSpotReport ()
	Default constructor is private since it is not implemented.

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
Protected Member Functions inherited from DtSimReport
	DtSimReport ()
	Constructors are protected because no one should instantiate the base class, just derived versions.
	DtSimReport (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor if you have a task 'put' itself, the write name will preface the task.
	DtSimReport (const DtString &writeName, const DtSimReport &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSimReport &	operator= (const DtSimReport &orig)
	assignment operator; same as copy constructor
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtSimReport
static DtSimReportFactory *	myFactory

Detailed Description

DtSpotReport; subclass of DtSimReport.

A report containing information about a single sighting made of an entity by another entity. This report contains perceived data about the sighted object (referred to as the Contact) that does not necessarily reflect the ground truth of the contact's state. This report is a RW object that supports file serialization, as well as supporting network serialization. All location data is in the geocentric coordinate system.

Constructor & Destructor Documentation

DtSpotReport::DtSpotReport	(	const DtString &	rwName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

DtSpotReport::DtSpotReport	(	const DtString &	rwName,
		const DtSpotReport &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

virtual DtSpotReport::~DtSpotReport ( )

virtual

DtSpotReport::DtSpotReport ( )

private

Default constructor is private since it is not implemented.

Member Function Documentation

const DtSpotReport& DtSpotReport::operator=

(

const DtSpotReport &

orig

)

virtual const DtSimReportMessageType& DtSpotReport::type ( ) const

virtual

What kind of report am I? Returns a character string representing the kind of report.

Derived classes must implement this function, returning a string that uniquely represents the kind of report it is. The definitions for report types used in VR-Forces are in radioMsgTypes.h.

Returns

DtSpotReportType

Implements DtSimReport.

virtual DtSimReport* DtSpotReport::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = 0  ) const

virtual

make a copy of this report

Implements DtSimReport.

virtual void DtSpotReport::setContactLocation ( const DtVector &  vector )

virtual

The perceived location of the contact being reported.

Specified in geocentric coordinates.

virtual DtVector DtSpotReport::contactLocation ( ) const

virtual

The perceived location of the contact being reported.

Specified in geocentric coordinates.

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

virtual

The perceived orientation of the contact being reported.

Specified in the geocentric reference frame.

virtual DtTaitBryan DtSpotReport::contactOrientation ( ) const

virtual

The perceived orientation of the contact being reported.

Specified in the geocentric reference frame.

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

virtual

The perceived velocity of the contact being reported.

Specified in the geocentric reference frame.

virtual DtVector DtSpotReport::contactVelocity ( ) const

virtual

The perceived velocity of the contact being reported.

Specified in the geocentric reference frame.

virtual void DtSpotReport::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. In this way, a report could specify "Some type of vehicle" using type (1 (1 1 -1 -1 -1 -1 -1))

virtual DtObjectType DtSpotReport::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. In this way, a report could specify "Some type of vehicle" using type (1 (1 1 -1 -1 -1 -1 -1))

virtual void DtSpotReport::setContactFormation ( const DtAggregateFormation  formation )

virtual

The perceived formation of the contact being reported.

The report uses OtherFormation to indicate unknown formation. (the default)

virtual DtAggregateFormation DtSpotReport::contactFormation ( ) const

virtual

The perceived formation of the contact being reported.

The report uses OtherFormation to indicate unknown formation. (the default)

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

virtual

The perceived force of the contact being reported.

Defaults to DtForceOther

virtual DtForceType DtSpotReport::contactForce ( ) const

virtual

The perceived force of the contact being reported.

Defaults to DtForceOther

virtual void DtSpotReport::setContactActivity ( DtU32  activityEnum )

virtual

The perceived activity of the contact being reported.

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

virtual DtU32 DtSpotReport::contactActivity ( ) const

virtual

The perceived activity of the contact being reported.

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

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

virtual

The object name of the contact being reported, if the contact represents an actual object in the simulation.

Included to facilitate sensor fusion type operations.

virtual DtString DtSpotReport::contactName ( ) const

virtual

The object name of the contact being reported, if the contact represents an actual object in the simulation.

Included to facilitate sensor fusion type operations.

virtual void DtSpotReport::setSpotterName ( const DtString &  name )

virtual

The object name of the entity which initially reported the contact.

If the report is forwarded up the chain of command, this name should remain the same.

virtual DtString DtSpotReport::spotterName ( ) const

virtual

The object name of the entity which initially reported the contact.

If the report is forwarded up the chain of command, this name should remain the same.

virtual void DtSpotReport::setTimeOfReport ( DtTime  t )

virtual

The simulation time the report was initially generated.

If a report is not immediately sent upon contact, this time will be later than timeOfContact.

virtual DtTime DtSpotReport::timeOfReport ( ) const

virtual

The simulation time the report was initially generated.

If a report is not immediately sent upon contact, this time will be later than timeOfContact.

virtual void DtSpotReport::setTimeOfContact ( DtTime  t )

virtual

The simulation time of the data about the contact contained in this report.

virtual DtTime DtSpotReport::timeOfContact ( ) const

virtual

The simulation time of the data about the contact contained in this report.

virtual void DtSpotReport::setCombatIdentificationLevel ( int  t )

virtual

The identification level of the contact.

virtual int DtSpotReport::combatIdentificationLevel ( ) const

virtual

The identification level of the contact.

virtual void DtSpotReport::setDetectionError ( double  detectionErrorIn )

virtual

The identification detection error.

virtual double DtSpotReport::detectionError ( ) const

virtual

The identification detection error.

virtual void DtSpotReport::setContactInfo ( const DtRwSensorContactInfo &  info )

virtual

Accessor for the contact info.

virtual const DtRwSensorContactInfo& DtSpotReport::contactInfo ( ) const

virtual

Accessor for the contact info.

virtual DtRwSensorContactInfo& DtSpotReport::contactInfo ( )

virtual

Accessor for the contact info.

virtual int DtSpotReport::netRepSize ( ) const

virtual

Adds current size of this message to size reported by base class.

Implements DtSimReport.

virtual bool DtSpotReport::setFromNet ( const char *  networkBuffer, unsigned  contentSize  )

virtual

Extracts elements of this report from the network buffer.

Implements DtSimReport.

virtual bool DtSpotReport::setToNet ( )

virtual

Encodes contents of this report into the network buffer.

Implements DtSimReport.

static DtSimReport* DtSpotReport::creator ( )

static

Returns a new instance of DtSpotReport.

virtual DtString DtSpotReport::stringRep ( ) const

virtual

Reimplemented from DtSimReport.

Member Data Documentation

DtRwSensorContactInfo DtSpotReport::myContactInfo

protected

DtRwString DtSpotReport::mySpotterName

protected

DtRwReal DtSpotReport::myTimeOfReport

protected

Time report was generated.

---

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

• include/vrftasks/spotReport.h