A report indicating that this entity can no longer sense another entity about which it was sending spot reports.

Inheritance diagram for DtStopSpottingReport:

Public Member Functions
	DtStopSpottingReport (const DtString &rwName, DtReaderWriterRegistry *parentRegistry=0)

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

virtual	~DtStopSpottingReport ()

const DtStopSpottingReport &	operator= (const DtStopSpottingReport &orig)

virtual const DtSimReportMessageType &	type () const

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

virtual void	setContactMarkingText (const DtString &)

virtual const DtString &	contactMarkingText () const

virtual int	netRepSize () const

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

virtual bool	setToNet ()

virtual DtString	stringRep () const

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())


virtual void	setContact (const DtUUID &)

virtual const DtUUID &	contact () const


virtual void	setSpotter (const DtUUID &)

virtual const DtUUID &	spotter () const


virtual void	setSpotterMarkingText (const DtString &)

virtual const DtString &	spotterMarkingText () const


virtual DtTime	timeOfReport () const


virtual void	setDateAndTimeOfReport (DtTime t)

virtual DtTime	dateAndTimeOfReport () const


virtual void	setSimulationTime (double)

virtual double	simulationTime () const

Public Member Functions inherited from DtSimReport
virtual	~DtSimReport ()

virtual bool	init ()

virtual void	putData (std::string &fp, int indentLevel=0)

virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual char *	netRep ()

virtual void	clearNetRep ()

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

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

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs) const

virtual	~DtReaderWriter ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual void	reset ()

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual const char *	readerWriterType () const

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

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())

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static DtSimReport *	creator ()

Static Public Member Functions inherited from DtSimReport
static DtSimReport *	createReport (const DtSimReportMessageType &reportTypeString)

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 (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 ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Attributes
DtRwString	mySpotterMarkingText

DtRwUUID	mySpotter

DtRwString	myContactMarkingText

DtRwUUID	myContact

DtRwReal	myDateAndTimeOfReport

DtRwReal	mySimulationTime

Protected Attributes inherited from DtSimReport
char *	myNetRep

Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName

DtReaderWriterRegistry	myRegistry

DtReaderWriterRegistry *	myParentRegistry

bool	myValueSpecified

bool	myReadOnlyFlag

bool	myIsVariableReference

DtSymbolString	myVariableName

bool	myVariableIsBound

DtReaderWriter *	myDefaultValue

aliasContainer	myAliases

bool	myInvalid

bool	myChangedFlag

Private Member Functions
	DtStopSpottingReport ()

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::vector< DtFilename >	SearchPaths

typedef std::pair < DtSymbolString, DtString >	DtVariableNameType

typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()

Protected Member Functions inherited from DtSimReport
	DtSimReport ()

	DtSimReport (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)

	DtSimReport (const DtString &writeName, const DtSimReport &orig, DtReaderWriterRegistry *parentRegistry=0)

const DtSimReport &	operator= (const DtSimReport &orig)

virtual char *	createNetworkBuffer ()

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Static Protected Attributes inherited from DtSimReport
static DtSimReportFactory *	myFactory

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

static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

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

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

virtual DtStopSpottingReport::~DtStopSpottingReport ( )

virtual

DtStopSpottingReport::DtStopSpottingReport ( )

private

Default constructor is private since it is not implemented.

Member Function Documentation

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

virtual const DtSimReportMessageType& DtStopSpottingReport::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: DtStopSpottingReportType

Implements DtSimReport.

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

virtual

make a copy of this report

Implements DtSimReport.

virtual void DtStopSpottingReport::setContact ( const DtUUID & )

virtual

The object of the contact being reported, if the contact represents an actual object in the simulation. Included to facilitate sensor fusion type operations.

virtual const DtUUID& DtStopSpottingReport::contact ( ) const

virtual

The object of the contact being reported, if the contact represents an actual object in the simulation. Included to facilitate sensor fusion type operations.

virtual void DtStopSpottingReport::setContactMarkingText ( const DtString & )

virtual

Marking text of the contact. To be used when UUID might not be available on logger tape.

virtual const DtString& DtStopSpottingReport::contactMarkingText ( ) const

virtual

virtual void DtStopSpottingReport::setSpotter ( const DtUUID & )

virtual

The entity which initially reported the contact. If the report is forwarded up the chain of command, this name should remain the same.

virtual const DtUUID& DtStopSpottingReport::spotter ( ) const

virtual

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 DtStopSpottingReport::setSpotterMarkingText ( const DtString & )

virtual

Used for logger tape recordings. This information can be used when the UUID is not known, in the case where the vrfObjectData is not recorded to the tape.

virtual const DtString& DtStopSpottingReport::spotterMarkingText ( ) const

virtual

Used for logger tape recordings. This information can be used when the UUID is not known, in the case where the vrfObjectData is not recorded to the tape.

virtual DtTime DtStopSpottingReport::timeOfReport ( ) const

virtual

The time of day when the report was sent. This corresponds to the day only part of the dateAndTimeOfReport() method. It is expressed in seconds passed midnight.

virtual void DtStopSpottingReport::setDateAndTimeOfReport ( DtTime t )

virtual

The epoch time of the report was initially generated (date and time of day).

virtual DtTime DtStopSpottingReport::dateAndTimeOfReport ( ) const

virtual

The epoch time of the report was initially generated (date and time of day).

virtual void DtStopSpottingReport::setSimulationTime ( double )

virtual

The simulation time this report was generated.

virtual double DtStopSpottingReport::simulationTime ( ) const

virtual

The simulation time this report was generated.

virtual int DtStopSpottingReport::netRepSize ( ) const

virtual

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

Implements DtSimReport.

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

virtual

Extracts elements of this report from the network buffer.

Implements DtSimReport.

virtual bool DtStopSpottingReport::setToNet ( )

virtual

Encodes contents of this report into the network buffer.

Implements DtSimReport.

static DtSimReport* DtStopSpottingReport::creator ( )

static

Returns a new instance of DtSpotReport.

virtual DtString DtStopSpottingReport::stringRep ( ) const

virtual

Reimplemented from DtSimReport.

virtual void DtStopSpottingReport::getSelf	(	DtlObjPtr	args,
		const DtReaderWriter::SearchPaths &	searchPaths = `SearchPaths()`,
		const DtVariableBindingsList &	variableBindings = `nullVariableReference()`
	)

virtual

Top level to read itself from an input stream. searchPath is passed down to all DtReaderWriter members in its DtReaderWriterRegistry (collection of child DtReaderWriter nodes). If a given member in the registry is of type DtReaderWriterFile, and the searchPath is specified with a non-NULL string, then file to be read in is searched for in the given path.

Reimplemented from DtReaderWriter.

Member Data Documentation

DtRwString DtStopSpottingReport::mySpotterMarkingText

protected

DtRwUUID DtStopSpottingReport::mySpotter

protected

DtRwString DtStopSpottingReport::myContactMarkingText

protected

DtRwUUID DtStopSpottingReport::myContact

protected

DtRwReal DtStopSpottingReport::myDateAndTimeOfReport

protected

Time report was generated.

DtRwReal DtStopSpottingReport::mySimulationTime

protected

Simulation time that the report was generated.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrftasks/stopSpottingReport.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation