DtSpotReportGeneratorControllerDescriptor Class Reference

DtSpotReportGeneratorControllerDescriptor; descriptor for the DtSpotReportGeneratorController component.

Instances of DtSpotReportGeneratorControllerDescriptor are used to specify the parameters for a DtSpotReportGeneratorController object.

Inheritance diagram for DtSpotReportGeneratorControllerDescriptor:

Public Member Functions
	DtSpotReportGeneratorControllerDescriptor (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtSpotReportGeneratorControllerDescriptor (const DtSpotReportGeneratorControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
DtSpotReportGeneratorControllerDescriptor &	operator= (const DtSpotReportGeneratorControllerDescriptor &orig)
virtual	~DtSpotReportGeneratorControllerDescriptor ()
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString	type () const
virtual bool	sendStopSpottingReports () const
virtual void	setSendStopSpottingReports (const bool &newValue)
virtual bool	forwardSubordinateReports () const
virtual void	setForwardSubordinateReports (const bool &newValue)
virtual const DtRwSpotReportDeltaCheckList &	spotReportMovementDeltaCheckList () const
virtual void	setSpotReportMovementDeltaCheckList (const DtRwSpotReportDeltaCheckList &list)
virtual const DtRwSpotReportDeltaCheckList &	spotReportHeartbeatDeltaCheckList () const
virtual void	setSpotReportHeartbeatDeltaCheckList (const DtRwSpotReportDeltaCheckList &list)
virtual const DtRwObjectTypeList &	objTypesToSpot () const
virtual void	setObjTypesToSpot (const DtRwObjectTypeList &list)
virtual bool	reportOnOwnForce () const
virtual void	setReportOnOwnForce (bool newVal)
virtual bool	reportOnHostileForces () const
virtual void	setReportOnHostileForces (bool newVal)
virtual bool	sendSpotReportsOnScenarioLoad () const
virtual void	setSendSpotReportsOnScenarioLoad (bool newVal)
virtual bool	sendOnlyOnDataChange () const
virtual void	setSendOnlyOnDataChange (bool newVal)
virtual bool	sendToFrontEndOnly () const
virtual void	setSendToFrontEndOnly (bool newVal)
virtual bool	reportOnNeutralForces () const
virtual void	setReportOnNeutralForces (bool newVal)
virtual bool	onlyOneDestroyedReport () const
virtual void	setOnlyOneDestroyedReport (bool newVal)
virtual bool	broadcast () const
virtual void	setBroadcast (bool newVal)
virtual double	reportResendPeriod () const
virtual void	setReportResendPeriod (const double &newValue)
virtual DtString	radioName () const
virtual void	setRadioName (const DtString &name)
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
virtual	~DtComponentDescriptor ()
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual bool	init ()
virtual const DtString &	stateAndParameterDataPrefix () const
bool	operator== (const DtComponentDescriptor &) const
	DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
virtual void	setComponentType (const DtString &componentType)
virtual const DtString &	componentType () const
virtual void	setMinTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTickPeriod () const
virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)
virtual DtReal	minTickPeriodVariance () const
virtual void	setPeriodicTickWhilePaused (bool value)
virtual bool	periodicTickWhilePaused () const
virtual const DtString &	processStateRepositoryName () const
virtual void	setProcessStateRepositoryName (const DtString &name)
virtual const DtString &	processStateRepositoryType () const
virtual void	setProcessStateRepositoryType (const DtString &type)
virtual void	setIsEnabled (bool yesNo)
virtual bool	isEnabled () const
virtual void	setIsEnabledForClutterEntities (bool yesNo)
virtual bool	isEnabledForClutterEntities () const
virtual void	setDebugActive (bool active)
virtual bool	debugActive () const
virtual void	setMinTaskVisualizationTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTaskVisualizationTickPeriod () const
virtual void	setTaskVisualizationsEnabled (bool enabled)
virtual bool	taskVisualizationsEnabled () const
virtual void	setCreateComponent (bool yesNo)
virtual bool	createComponent () const
virtual void	setCreateOnRemoteObject (bool yesNo)
virtual bool	createOnRemoteObject () const
virtual const DtRwNLengthStringVector &	scriptIds () const
virtual DtRwNLengthStringVector &	scriptIds ()
virtual const DtRwScriptVariablesList &	scriptVariables () const
virtual DtRwScriptVariablesList &	scriptVariables ()
virtual const DtRwProperties &	parameterData () const
virtual DtRwProperties &	parameterData ()
virtual const DtRwProperties &	stateData () const
virtual DtRwProperties &	stateData ()
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	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	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 DtComponentDescriptor *	creator ()
Static Public Member Functions inherited from DtComponentDescriptor
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
static DtComponentDescriptor *	creator ()
static DtComponentDescriptorFactory *	factory ()
static void	setFactory (DtComponentDescriptorFactory *factory)
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)

Static Public Attributes
static const DtString	theDefaultRadioName

Protected Attributes
DtRwSpotReportDeltaCheckList	mySpotReportHeartbeatDeltaCheckList
DtRwBoolean	mySendSpotReportsOnScenarioLoad
DtRwBoolean	mySendToFrontEndOnly
DtRwBoolean	myOnlyOneDestroyedReport
DtRwBoolean	mySendOnlyOnDataChange
DtRwBoolean	mySendStopSpottingReports
parameters
These parameters are available for setting in the OPD files.
DtRwBoolean	myForwardSubordinateReports
DtRwReal	myReportResendPeriod
DtRwObjectTypeList	myObjTypesToSpot
DtRwBoolean	mySendReportsOnOwnForce
DtRwBoolean	mySendReportsOnHostileForces
DtRwBoolean	mySendReportsOnNeutralForces
DtRwBoolean	myBroadcast
DtRwString	myRadioName
DtRwSpotReportDeltaCheckList	mySpotReportMovementDeltaCheckList
Protected Attributes inherited from DtComponentDescriptor
bool	myPrefixAppliedToStateAndParamData
DtRwString	myComponentType
DtRwReal	myMinTickPeriod
DtRwReal	myMinTickPeriodVariance
DtRwBoolean	myPeriodicTickWhilePaused
DtRwString	myProcessStateRepositoryName
DtRwString	myProcessStateRepositoryType
DtRwBoolean	myIsEnabled
DtRwBoolean	myIsEnabledForClutterEntities
DtRwBoolean	myDebug
DtRwReal	myMinTaskVisualizationTickPeriod
DtRwBoolean	myTaskVisualizationsEnabled
DtRwBoolean	myCreateComponent
DtRwBoolean	myCreateOnRemoteObject
DtRwProperties	myParameterData
DtRwProperties	myStateData
DtRwString	myStateAndParameterDataPrefix
DtRwNLengthStringVector	myScriptIds
DtRwScriptVariablesList	myScriptVariables
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 DtComponentDescriptor
	DtComponentDescriptor ()
void	addPrefixToStateAndParameterData ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	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

DtSpotReportGeneratorControllerDescriptor::DtSpotReportGeneratorControllerDescriptor	(	const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

Constructor.

DtSpotReportGeneratorControllerDescriptor::DtSpotReportGeneratorControllerDescriptor	(	const DtSpotReportGeneratorControllerDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

Copy constructor.

virtual DtSpotReportGeneratorControllerDescriptor::~DtSpotReportGeneratorControllerDescriptor ( )

virtual

Destructor.

Member Function Documentation

DtSpotReportGeneratorControllerDescriptor& DtSpotReportGeneratorControllerDescriptor::operator=

(

const DtSpotReportGeneratorControllerDescriptor &

orig

)

Assignment operator.

virtual DtComponentDescriptor* DtSpotReportGeneratorControllerDescriptor::clone ( DtReaderWriterRegistry *  parentRegistry = 0 ) const

virtual

Returns a copy of this class using the copy constructor.

Reimplemented from DtComponentDescriptor.

virtual DtString DtSpotReportGeneratorControllerDescriptor::type ( ) const

virtual

Returns the type of component this descriptor describes. Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns

DtSpotReportGeneratorControllerDescriptorType

Reimplemented from DtComponentDescriptor.

static DtComponentDescriptor* DtSpotReportGeneratorControllerDescriptor::creator ( )

static

Returns

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

virtual bool DtSpotReportGeneratorControllerDescriptor::sendStopSpottingReports ( ) const

virtual

Accessor/mutator for mySendStopSpottingReports.

virtual void DtSpotReportGeneratorControllerDescriptor::setSendStopSpottingReports ( const bool &  newValue )

virtual

Accessor/mutator for mySendStopSpottingReports.

virtual bool DtSpotReportGeneratorControllerDescriptor::forwardSubordinateReports ( ) const

virtual

Accessor/mutator for myForwardSubordinateReports.

virtual void DtSpotReportGeneratorControllerDescriptor::setForwardSubordinateReports ( const bool &  newValue )

virtual

Accessor/mutator for myForwardSubordinateReports.

virtual const DtRwSpotReportDeltaCheckList& DtSpotReportGeneratorControllerDescriptor::spotReportMovementDeltaCheckList ( ) const

virtual

Accessor/mutator for mySpotReportMovementDeltaCheckList.

virtual void DtSpotReportGeneratorControllerDescriptor::setSpotReportMovementDeltaCheckList ( const DtRwSpotReportDeltaCheckList &  list )

virtual

Accessor/mutator for mySpotReportMovementDeltaCheckList.

virtual const DtRwSpotReportDeltaCheckList& DtSpotReportGeneratorControllerDescriptor::spotReportHeartbeatDeltaCheckList ( ) const

virtual

Accessor/mutator for mySpotReportHeartbeatDeltaCheckList.

virtual void DtSpotReportGeneratorControllerDescriptor::setSpotReportHeartbeatDeltaCheckList ( const DtRwSpotReportDeltaCheckList &  list )

virtual

Accessor/mutator for mySpotReportHeartbeatDeltaCheckList.

virtual const DtRwObjectTypeList& DtSpotReportGeneratorControllerDescriptor::objTypesToSpot ( ) const

virtual

Accessor/mutator for #myObjTypesToSpotRep.

virtual void DtSpotReportGeneratorControllerDescriptor::setObjTypesToSpot ( const DtRwObjectTypeList &  list )

virtual

Accessor/mutator for #myObjTypesToSpotRep.

virtual bool DtSpotReportGeneratorControllerDescriptor::reportOnOwnForce ( ) const

virtual

Accessor/mutator for mySendReportsOnOwnForce.

virtual void DtSpotReportGeneratorControllerDescriptor::setReportOnOwnForce ( bool  newVal )

virtual

Accessor/mutator for mySendReportsOnOwnForce.

virtual bool DtSpotReportGeneratorControllerDescriptor::reportOnHostileForces ( ) const

virtual

See #mySendSpotReportsOnHostileForces.

virtual void DtSpotReportGeneratorControllerDescriptor::setReportOnHostileForces ( bool  newVal )

virtual

See #mySendSpotReportsOnHostileForces.

virtual bool DtSpotReportGeneratorControllerDescriptor::sendSpotReportsOnScenarioLoad ( ) const

virtual

See mySendSpotReportsOnScenarioLoad.

virtual void DtSpotReportGeneratorControllerDescriptor::setSendSpotReportsOnScenarioLoad ( bool  newVal )

virtual

See mySendSpotReportsOnScenarioLoad.

virtual bool DtSpotReportGeneratorControllerDescriptor::sendOnlyOnDataChange ( ) const

virtual

See mySendOnlyOnDataChange.

virtual void DtSpotReportGeneratorControllerDescriptor::setSendOnlyOnDataChange ( bool  newVal )

virtual

See mySendOnlyOnDataChange.

virtual bool DtSpotReportGeneratorControllerDescriptor::sendToFrontEndOnly ( ) const

virtual

See #mySendToFrontEndOnl.

virtual void DtSpotReportGeneratorControllerDescriptor::setSendToFrontEndOnly ( bool  newVal )

virtual

See #mySendToFrontEndOnl.

virtual bool DtSpotReportGeneratorControllerDescriptor::reportOnNeutralForces ( ) const

virtual

See #mySendSpotReportsOnNeutralForces.

virtual void DtSpotReportGeneratorControllerDescriptor::setReportOnNeutralForces ( bool  newVal )

virtual

See #mySendSpotReportsOnNeutralForces.

virtual bool DtSpotReportGeneratorControllerDescriptor::onlyOneDestroyedReport ( ) const

virtual

See myOnlyOneDestroyedReport.

virtual void DtSpotReportGeneratorControllerDescriptor::setOnlyOneDestroyedReport ( bool  newVal )

virtual

See myOnlyOneDestroyedReport.

virtual bool DtSpotReportGeneratorControllerDescriptor::broadcast ( ) const

virtual

See myBroadcast.

virtual void DtSpotReportGeneratorControllerDescriptor::setBroadcast ( bool  newVal )

virtual

See myBroadcast.

virtual double DtSpotReportGeneratorControllerDescriptor::reportResendPeriod ( ) const

virtual

Accessor/mutator for myReportResendPeriod.

virtual void DtSpotReportGeneratorControllerDescriptor::setReportResendPeriod ( const double &  newValue )

virtual

Accessor/mutator for myReportResendPeriod.

virtual DtString DtSpotReportGeneratorControllerDescriptor::radioName ( ) const

virtual

See Also

myRadioName

virtual void DtSpotReportGeneratorControllerDescriptor::setRadioName ( const DtString &  name )

virtual

See Also

myRadioName

Member Data Documentation

const DtString DtSpotReportGeneratorControllerDescriptor::theDefaultRadioName

static

Name used to indicate the default radio name in myRadioName.

DtRwBoolean DtSpotReportGeneratorControllerDescriptor::myForwardSubordinateReports

protected

Parameter Name: "forward-subordinate-reports"
Parameter Description: Flag indicating whether reports from subordinates should be forwarded to the superior.
Default Value: False.

DtRwReal DtSpotReportGeneratorControllerDescriptor::myReportResendPeriod

protected

Parameter Name: "report-resend-period"
Parameter Description: Heartbeat interval at which a given report should be resent for a given contact.
Default Value: 60.0 Parameter Units: seconds.

DtRwObjectTypeList DtSpotReportGeneratorControllerDescriptor::myObjTypesToSpot

protected

Parameter Name: "object-types-to-spot-report"
Parameter Description: List of object types to be reported about from this spot report generator.
.

DtRwBoolean DtSpotReportGeneratorControllerDescriptor::mySendReportsOnOwnForce

protected

Parameter Name: "send-spot-reports-on-own-force"
Parameter Description: Flag indicating whether entity should send spot reports on entities of it's own force type.
Default Value: False.

DtRwBoolean DtSpotReportGeneratorControllerDescriptor::mySendReportsOnHostileForces

protected

Parameter Name: "send-spot-reports-on-hostile-forces"
Parameter Description: Flag indicating whether entity should send spot reports on entities that are designated hostile to this entity.
Default Value: True.

DtRwBoolean DtSpotReportGeneratorControllerDescriptor::mySendReportsOnNeutralForces

protected

Parameter Name: "send-spot-reports-on-neutral-forces"
Parameter Description: Flag indicating whether entity should send spot reports on entities of other neutral forces. This does not include the entities own force.
Default Value: True.

DtRwBoolean DtSpotReportGeneratorControllerDescriptor::myBroadcast

protected

Parameter Name: "broadcast"
Parameter Description: If true send to the front-end and all entities. Default is to only send to front-end.
Default Value: True.

DtRwString DtSpotReportGeneratorControllerDescriptor::myRadioName

protected

Parameter Name: "radio-name"
Parameter Description: The name of the radio on which the spot reports will be sent. This name matches the names in the radio block of the OPE file.
Default Value: "default".

DtRwSpotReportDeltaCheckList DtSpotReportGeneratorControllerDescriptor::mySpotReportMovementDeltaCheckList

protected

Parameter Name: "send-spot-reports-on-movement-delta"
Parameter Description: Entries in this list will be checked for movement delta change from the last time a spot report was given on this item. If the change is greater than the delta then a spot report will be sent for this item.
.

DtRwSpotReportDeltaCheckList DtSpotReportGeneratorControllerDescriptor::mySpotReportHeartbeatDeltaCheckList

protected

Parameter Name: "send-spot-reports-heartbeat-delta"
Parameter Description: Entries in this list will be checked for time delta change from the last time a spot report was given on this item. If the time change is greater than the delta then a spot report will be sent for this item.
.

DtRwBoolean DtSpotReportGeneratorControllerDescriptor::mySendSpotReportsOnScenarioLoad

protected

Parameter Name: "send-spot-reports-on-scenario-load"
Parameter Description: If this value is true, sends out all spot reports in this controller on scenario load
Default Value: True
.

DtRwBoolean DtSpotReportGeneratorControllerDescriptor::mySendToFrontEndOnly

protected

Parameter Name: "send-to-front-end-only"
Parameter Description: If true send the spot reports only to the front end
Default Value: True
.

DtRwBoolean DtSpotReportGeneratorControllerDescriptor::myOnlyOneDestroyedReport

protected

Parameter Name: "only-one-destroyed-report"
Parameter Description: Only send one destroyed report if sensing destroyed entities Default Value: False
.

DtRwBoolean DtSpotReportGeneratorControllerDescriptor::mySendOnlyOnDataChange

protected

Parameter Name: "send-only-on-data-change"
Parameter Description: Send spot reports only when data on the contact list changes Default Value: True
.

DtRwBoolean DtSpotReportGeneratorControllerDescriptor::mySendStopSpottingReports

protected

Parameter Name: "send-stop-spotting-reports"
Parameter Description: For those items without spot report receivers, send a stop spotting report to broadcast Default Value: False
.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjparam/spotReportGeneratorControllerDescriptor.h