DtEngagementReport; subclass of DtSimReport.

A report information about a current engagement a unit is involved in. 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.

Inheritance diagram for DtEngagementReport:

[legend]

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

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

virtual	~DtEngagementReport ()

const DtEngagementReport &	operator= (const DtEngagementReport &orig)

virtual const DtSimReportMessageType &	type () const

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

virtual int	netRepSize () const

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

virtual bool	setToNet ()

virtual DtString	stringRep () const


virtual void	setReporter (const DtUUID &)

virtual const DtUUID &	reporter () const


virtual void	setSimTimeOfReport (DtTime t)

virtual DtTime	simTimeOfReport () const


virtual void	setDateAndTimeOfReport (double utcTime)

virtual double	dateAndTimeOfReport () const


virtual void	setEngagements (const DtRwEngagementInfoList &engList)

virtual const DtRwEngagementInfoList &	engagements () 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
DtRwUUID	myReporter

DtRwReal	myTimeOfReport

DtRwReal	myDateAndTime

DtRwEngagementInfoList	myEngagements

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

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

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

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

virtual DtEngagementReport::~DtEngagementReport ( )

virtual

DtEngagementReport::DtEngagementReport ( )

private

Default constructor is private since it is not implemented.

Member Function Documentation

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

virtual const DtSimReportMessageType& DtEngagementReport::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: DtEngagementReportType

Implements DtSimReport.

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

virtual

make a copy of this report

Implements DtSimReport.

virtual void DtEngagementReport::setReporter ( const DtUUID & )

virtual

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

virtual const DtUUID& DtEngagementReport::reporter ( ) const

virtual

Was: reporterName.

virtual void DtEngagementReport::setSimTimeOfReport ( DtTime t )

virtual

The simulation time the report was initially generated.

virtual DtTime DtEngagementReport::simTimeOfReport ( ) const

virtual

The simulation time the report was initially generated.

virtual void DtEngagementReport::setDateAndTimeOfReport ( double utcTime )

virtual

The date and time that the report was initially generated. UTC time from 01/01/1970 midnight.

virtual double DtEngagementReport::dateAndTimeOfReport ( ) const

virtual

The date and time that the report was initially generated. UTC time from 01/01/1970 midnight.

virtual void DtEngagementReport::setEngagements ( const DtRwEngagementInfoList & engList )

virtual

The list of current engagements for reporter.

virtual const DtRwEngagementInfoList& DtEngagementReport::engagements ( ) const

virtual

The list of current engagements for reporter.

virtual int DtEngagementReport::netRepSize ( ) const

virtual

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

Implements DtSimReport.

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

virtual

Extracts elements of this report from the network buffer.

Implements DtSimReport.

virtual bool DtEngagementReport::setToNet ( )

virtual

Encodes contents of this report into the network buffer.

Implements DtSimReport.

static DtSimReport* DtEngagementReport::creator ( )

static

Returns a new instance of DtEngagementReport.

virtual DtString DtEngagementReport::stringRep ( ) const

virtual

Reimplemented from DtSimReport.

Member Data Documentation

DtRwUUID DtEngagementReport::myReporter

protected

DtRwReal DtEngagementReport::myTimeOfReport

protected

DtRwReal DtEngagementReport::myDateAndTime

protected

DtRwEngagementInfoList DtEngagementReport::myEngagements

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrftasks/engagementReport.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