DtTaskCompleteReport Class Reference

DtTaskCompleteReport represents a report from an entity that it has completed the last task assigned to it. More...

Inheritance diagram for DtTaskCompleteReport:

Public Member Functions
	DtTaskCompleteReport ()
	default constructor More...
	DtTaskCompleteReport (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the writeName will preface the task. More...
	DtTaskCompleteReport (const DtString &writeName, const DtTaskCompleteReport &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor More...
const DtTaskCompleteReport &	operator= (const DtTaskCompleteReport &orig)
	assignment operator More...
virtual	~DtTaskCompleteReport ()
virtual const DtSimReportMessageType &	type () const
	What kind of report am I? Returns a character string representing the kind of report. More...
virtual DtSimTaskMessageType	taskCompleted () const
	The task (task type) completed by the entity. More...
virtual void	setTaskCompleted (const DtSimTaskMessageType &taskCompleted)
virtual DtSimReport *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
	Creates a copy of this report. More...
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual DtString	stringRep () const
virtual void	setTaskId (int id)
	Identifier used to associate task complete report with a particular DtSimTask. More...
virtual int	taskId () const
virtual void	setSubtaskId (int id)
virtual int	subtaskId () const
virtual void	setSuccess (bool b)
	Indicates whether the task was completed successfully or not. More...
virtual bool	success () const
virtual void	setTaskTrackingNumber (int n)
	This value is the same as the taskTrackingNumber passed in the original task message that started the task. More...
virtual int	taskTrackingNumber () const
Public Member Functions inherited from DtSimReport
virtual	~DtSimReport ()
	destructor More...
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. More...
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. More...
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. More...
virtual char *	netRep ()
virtual void	clearNetRep ()
	Clears the stored netRep. More...
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor More...
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream. More...
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor More...
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator More...
bool	operator== (const DtReaderWriter &) const
	Equivalence operator. More...
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor More...
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. More...
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op. More...
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op. More...
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream. More...
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op. More...
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op. More...
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. More...
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object. More...
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object. More...
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. More...
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. More...
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment. More...
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false. More...
virtual void	setName (const DtString &)
	Set the name of the object. More...
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable. More...
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children. More...
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. More...
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference. More...
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. More...
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated. More...
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time. More...
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called. More...
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values. More...
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively. More...
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference. More...
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. More...
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...
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. More...
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object. More...
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. More...
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename. More...
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid. More...
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file. More...
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data. More...
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference. More...
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. More...
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. More...
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference. More...

Static Public Member Functions
static DtSimReport *	creator ()
Static Public Member Functions inherited from DtSimReport
static DtSimReport *	createReport (const DtSimReportMessageType &reportTypeString)
	Static functions. More...
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. More...
static const DtFilename &	appPath ()
	Gets the current working directory. More...
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory. More...
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)
	Given a filename, returns a newly created reader/writer object from the object found within. More...
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within. More...
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP. More...

Protected Attributes
DtRwString	myTaskCompleted
DtRwInt	myTaskId
DtRwBoolean	mySuccess
DtRwInt	myTaskTrackingNumber
	This is the task tracking number that was in the original task message that started this task. More...
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. More...
bool	myInvalid
	Set to true if there is a problem reading this item. More...
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...

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. More...
	DtSimReport (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor if you have a task 'put' itself, the write name will preface the task. More...
	DtSimReport (const DtString &writeName, const DtSimReport &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor More...
const DtSimReport &	operator= (const DtSimReport &orig)
	assignment operator; same as copy constructor More...
virtual char *	createNetworkBuffer ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter. More...
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

Detailed Description

DtTaskCompleteReport represents a report from an entity that it has completed the last task assigned to it.

The task name is part of the report. Task Complete reports are generated and sent automatically. Local entities have a taskComplete() member function, in which a DtTaskCompleteReport message gets created and sent to the sender of the task. For a retask operation sent by a user from the GUI, the task complete report gets sent to the Simulation Manager. If the task was originally issued by the entity’s superior, then the Task Complete report gets sent to the superior. It places the report (addressed to the entity’s superior) on the entity’s radio net. The DtSimLocalEntity::taskComplete() member function gets called by the task controller that is handling the task in the DtTaskControllerComponent::taskComplete() member function. In derived task controllers, you should make sure you call the taskComplete() member function when you are finished performing the task. This ensures that a DtTaskCompleteReport gets created and sent to the sender of the task.

task-type: DtTaskCompletedReportType

parameters: task completed - The integer of the task (task type) completed by the entity. See radioMsgTypes.h for a list all task types.

Constructor & Destructor Documentation

DtTaskCompleteReport::DtTaskCompleteReport

(

)

default constructor

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

constructor If you have a task 'put' itself, the writeName will preface the task.

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

copy constructor

virtual DtTaskCompleteReport::~DtTaskCompleteReport ( )

virtual

Member Function Documentation

const DtTaskCompleteReport& DtTaskCompleteReport::operator=

(

const DtTaskCompleteReport &

orig

)

assignment operator

virtual const DtSimReportMessageType& DtTaskCompleteReport::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.

Implements DtSimReport.

virtual DtSimTaskMessageType DtTaskCompleteReport::taskCompleted ( ) const

virtual

The task (task type) completed by the entity.

See radioMsgTypes.h for a list all task types.

virtual void DtTaskCompleteReport::setTaskCompleted ( const DtSimTaskMessageType &  taskCompleted )

virtual

virtual void DtTaskCompleteReport::setTaskId ( int  id )

virtual

Identifier used to associate task complete report with a particular DtSimTask.

virtual int DtTaskCompleteReport::taskId ( ) const

virtual

virtual void DtTaskCompleteReport::setSubtaskId ( int  id )

virtual

Deprecated:

As of VRF 3.12. Use setTaskId() and taskId() instead.

virtual int DtTaskCompleteReport::subtaskId ( ) const

virtual

virtual void DtTaskCompleteReport::setSuccess ( bool  b )

virtual

Indicates whether the task was completed successfully or not.

A task complete report with success being false indicates that the task has failed and is no longer being processed.

Note

Defaults to True.

virtual bool DtTaskCompleteReport::success ( ) const

virtual

virtual void DtTaskCompleteReport::setTaskTrackingNumber ( int  n )

virtual

This value is the same as the taskTrackingNumber passed in the original task message that started the task.

This is designed for uses such as an aggregate starting issuing tasks to a subordinate, and providing unique identifiers to the tasks so their completion can be tracked.

Note

This is different from taskId, since taskId is assigned by the entity carrying out the task, can cannot be known at the time of issuing the task.

virtual int DtTaskCompleteReport::taskTrackingNumber ( ) const

virtual

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

virtual

Creates a copy of this report.

Implements DtSimReport.

virtual int DtTaskCompleteReport::netRepSize ( ) const

virtual

Implements DtSimReport.

virtual bool DtTaskCompleteReport::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

virtual

Implements DtSimReport.

virtual bool DtTaskCompleteReport::setToNet ( )

virtual

Implements DtSimReport.

virtual DtString DtTaskCompleteReport::stringRep ( ) const

virtual

Reimplemented from DtSimReport.

static DtSimReport* DtTaskCompleteReport::creator ( )

static

Member Data Documentation

DtRwString DtTaskCompleteReport::myTaskCompleted

protected

DtRwInt DtTaskCompleteReport::myTaskId

protected

DtRwBoolean DtTaskCompleteReport::mySuccess

protected

DtRwInt DtTaskCompleteReport::myTaskTrackingNumber

protected

This is the task tracking number that was in the original task message that started this task.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrftasks/taskCompleteReport.h