DtStopSpottingReport Class Reference

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

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
	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 void	setContactMarkingText (const DtString &)
	Marking text of the contact. To be used when UUID might not be available on logger tape.
virtual const DtString &	contactMarkingText () const
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	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	setContact (const DtUUID &)
	The object of the contact being reported, if the contact represents an actual object in the simulation.
virtual const DtUUID &	contact () const
virtual void	setSpotter (const DtUUID &)
	The entity which initially reported the contact.
virtual const DtUUID &	spotter () const
virtual void	setSpotterMarkingText (const DtString &)
	Used for logger tape recordings.
virtual const DtString &	spotterMarkingText () const
virtual DtTime	timeOfReport () const
	The time of day when the report was sent.
virtual void	setDateAndTimeOfReport (DtTime t)
	The epoch time of the report was initially generated (date and time of day).
virtual DtTime	dateAndTimeOfReport () const
virtual void	setSimulationTime (double)
	The simulation time this report was generated.
virtual double	simulationTime () const
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 (std::string &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 DtReaderWriter::SearchPaths &searchPaths, 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)
	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	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	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	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 void	writeSelf (std::string &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 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 original 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 *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
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 bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called.
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
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 DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class.
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 &)
	Restores 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.

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 (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 void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
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 Attributes
DtRwString	mySpotterMarkingText
DtRwUUID	mySpotter
DtRwString	myContactMarkingText
DtRwUUID	myContact
DtRwReal	myDateAndTimeOfReport
	Time report was generated.
DtRwReal	mySimulationTime
	Simulation time that the report was generated.
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
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked.

Private Member Functions
	DtStopSpottingReport ()
	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::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
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

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

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

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

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

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

virtual void DtStopSpottingReport::setSimulationTime ( double  )

virtual

The simulation time this report was generated.

virtual double DtStopSpottingReport::simulationTime ( ) const

virtual

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrftasks/stopSpottingReport.h