DtTaskCompleteReport Class Reference

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.

Inheritance diagram for DtTaskCompleteReport:

Public Member Functions
	DtTaskCompleteReport ()
	DtTaskCompleteReport (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	DtTaskCompleteReport (const DtString &writeName, const DtTaskCompleteReport &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtTaskCompleteReport &	operator= (const DtTaskCompleteReport &orig)
virtual	~DtTaskCompleteReport ()
virtual const DtSimReportMessageType &	type () const
virtual DtSimTaskMessageType	taskCompleted () const
virtual void	setTaskCompleted (const DtSimTaskMessageType &taskCompleted)
virtual DtSimReport *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual DtString	stringRep () const
virtual void	setTaskId (int id)
virtual int	taskId () const
virtual void	setSubtaskId (int id)
virtual int	subtaskId () const
virtual void	setSuccess (bool b)
virtual bool	success () const
virtual void	setTaskTrackingNumber (int n)
virtual int	taskTrackingNumber () 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)
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	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
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	wasUpdatedSince (DtTime t) 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	myTaskCompleted
DtRwInt	myTaskId
DtRwBoolean	mySuccess
DtRwInt	myTaskTrackingNumber
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

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

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

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

virtual void DtTaskCompleteReport::setSubtaskId ( int  id )

virtual

Deprecated:

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

virtual int DtTaskCompleteReport::subtaskId ( ) const

virtual

Deprecated:

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

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

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

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 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.vrf5-0-branch/include/vrftasks/taskCompleteReport.h