DtEngagementReportGeneratorController Class Reference

DtEngagementReportGeneratorController is a controller that sends engagement reports based on the current engagements this unit is involved in.

End User Description: This controller monitors the unit's attack list in the state repository and sends engagement reports to the network when new attacks are detected on the list. An engagement report is sent for each target listed. Engagement reports are resent on a periodic basis, based on a setting in the descriptor. Engagement reports are sent to the local radio network using the default radio. The contents of an engagement report are defined in the DtEngagementReport class.

Engagement reporting can be enabled and disabled though the DtSetEngagementReportingRequest set data request.

Uses Descriptor Type: DtEngagementReportGeneratorControllerDescriptor

Inheritance diagram for DtEngagementReportGeneratorController:

Public Member Functions
	DtEngagementReportGeneratorController (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtEngagementReportGeneratorController () override
virtual bool	init () override
virtual const char *	type () const override
virtual void	tick () override
virtual void	processSetEngagementReporting (DtSimMessage *msg)
virtual void	setLocalEnabled (bool on)
virtual void	setGlobalEnabledOverridingLocal ()
Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtControllerComponent () override
virtual bool	postAddComponentsInit () override
virtual DtSimRadio *	radio ()
virtual void	taskNotify (const DtSimTask &task)
virtual void	clearTask ()
virtual void	enableTaskTypes ()
virtual void	enableScriptedTask (const DtString &scriptId)
virtual void	disableTaskTypes ()
virtual void	enable () override
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSimComponent () override
virtual void	setParentSystem (DtComponentSystem *system)
DtComponentSystem *	parentSystem () const
virtual void	registerAttributeFunctions ()
virtual void	preFirstTickInit ()
virtual void	postTick ()
virtual void	timedTick ()
virtual void	setMinTickPeriod (double minTickPeriod, double minTickPeriodVariance)
virtual void	setupFirstTickTime ()
virtual void	setEntity (DtLocalObject *entity)
virtual DtSimComponent *	nextComponent ()
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
virtual DtListItem *	listItem ()
virtual void	putData (std::string &fp, int indentLevel=0) override
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
virtual void	addInputPort (DtInputPort *port)
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
virtual DtList	inputPortList () const
virtual void	addOutputPort (DtOutputPort *port)
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
virtual DtList	outputPortList () const
virtual void	addInputPortGroup (DtInputPortGroup *group)
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
virtual DtList	inputPortGroupList () const
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
virtual DtList	outputPortGroupList () const
virtual int	priority () const
virtual void	setPriority (int priority)
double	dT () const
virtual void	setDT (double deltaT)
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
virtual const DtComponentDescriptor *	componentDescriptor () const
virtual bool	tickWhileDestroyed () const
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual const DtSymbolString &	componentFullName () const
DtPhysicalWorld *	physicalWorld ()
const DtPhysicalWorld *	physicalWorld () const
const DtAttachedTerrain *	terrainAttachedTo () const
DtLocalObject *	entity ()
const DtLocalObject *	entity () const
DtSimulationServices *	simulationServices ()
const DtSimulationServices *	simulationServices () const
const Coordinate_System *	coordinateSystem () const
virtual void	isClutterChanged ()
virtual bool	taskVisualizationsActive () const
virtual bool	taskVisualizationsEnabled () const
makVrf::DtTaskVisualizationMap &	taskVisualizations ()
virtual void	updateImgui ()
virtual bool	debugActive () const
virtual void	disable ()
virtual bool	isEnabled ()
virtual void	setIsEnabled (bool yesNo)
virtual DtOutputStream &	objectConsoleDebug (const DtString &channel="") const
virtual DtOutputStream &	objectConsoleVerbose (const DtString &channel="") const
virtual DtOutputStream &	objectConsoleInfo (const DtString &channel="") const
virtual DtOutputStream &	objectConsoleWarn (const DtString &channel="") const
virtual DtOutputStream &	objectConsoleError (const DtString &channel="") const
virtual int	notifyLevel () const
virtual DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
VRF4API_METHOD const DtSimulationServices *	simManager () const
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 void	setEngagementReportingCallback (DtSimMessage *msg, void *usr)
static DtSimComponent *	creator (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
Static Public Member Functions inherited from DtSimComponent
static DtSimComponentFactory *	factory ()
static void	setFactory (DtSimComponentFactory *factory)
static DtSimComponent *	createComponent (const DtString &name, const DtString &type, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentSystem *parentSystem, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
static void	addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
static VRF4API_METHOD DtSimComponent *	MarkThreadSafe (DtSimComponent *comp)
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 Member Functions
DtEngagementReport *	engagementReport ()
virtual bool	createPSR ()
virtual void	registerRadioMessageCallbacks ()
virtual void	generateAndSendEngagementReport (const DtRwPropertiesList *attacks, const DtRwPropertiesList *limitedMunitionAttacks, const DtRwPropertiesList *attacksDefended)
virtual DtRwEngagementInfo *	createEngagementInfoForTarget (const DtUUID &targetName, const DtSimObject *target)
virtual void	updateEngagementInfoForTarget (DtRwEngagementInfo &engagement, const DtUUID &targetName, const DtSimObject *target, bool engagementComplete=false)
virtual void	sendEngagementReport (bool superiorOnly)
virtual bool	engagementReportNeedsUpdateAndResend ()
virtual const DtSimReportMessageType &	engagementReportTypeString () const
virtual void	readGlobalEnabledSetting (const DtBoolSetting *enabledSetting)
virtual bool	reportingEnabled () const
Protected Member Functions inherited from DtControllerComponent
	DtControllerComponent ()
	DtControllerComponent (const DtControllerComponent &orig)
const DtControllerComponent &	operator= (const DtControllerComponent &orig)
virtual void	onRestore () override
virtual void	initializeTargetingControlTableFromDescriptor (const DtReaderWriter *)
virtual void	setRadio (DtSimRadio *radio)
virtual void	sendCapableSetsAndTasks ()
Protected Member Functions inherited from DtSimComponent
virtual void	setupTimedTickLogic (double minTickPeriod, double minTickPeriodVariance)
virtual double	computeCurrentTime ()
bool	testInvariant () const
virtual bool	createPortGroups ()
virtual bool	createPorts ()
DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
virtual void	updateTaskVisualizations ()
virtual void	destroyTaskVisualizations ()
virtual void	destroyTaskVisualization (const DtString &name)
virtual makVrf::DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)
virtual makVrf::DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)
virtual makVrf::DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)
virtual makVrf::DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)
double	calculateNextTaskVisTickTime () const
DtVrfObjectStateRepository *	localStateRepository ()
const DtVrfObjectStateRepository *	localStateRepository () const
DtPropertyInterface *	cachedNextFrameStateProperty (DtPropertyInterface **prop, const DtString &propName)
template<typename ValType >
void	setCachedNextFrameStatePropertyValue (DtPropertyInterface **prop, const DtString &propName, ValType value)
const DtPropertyInterface *	cachedCurrentFrameStateProperty (const DtPropertyInterface **prop, const DtString &propName) const
template<typename ValType >
bool	getCachedCurrentFrameStatePropertyValue (const DtPropertyInterface **prop, const DtString &propName, ValType &value) const
void	addSimObjectPredicateCallback (DtSimObjectReference, DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)
void	removeSimObjectPredicateCallback (const DtSimObject *, DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)
void	invokeSimObjectPredicateCallbacks ()
virtual void	clearPredicateCallbacks ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Static Protected Member Functions
static void	settingConsumerCallback (const DtSettingsObject *settingsObject, void *usr)

Protected Attributes
DtEngagementReport *	myEngagementReport
const DtEngagementReportGeneratorControllerDescriptor *	myDescriptor
DtEngagementReportGeneratorControllerPSR *	myProcessState
bool	myGlobalEnabled
Protected Attributes inherited from DtControllerComponent
DtSimRadio *	myRadio
bool	myTaskTypesEnabled
bool	myInitialized
Protected Attributes inherited from DtSimComponent
DtLocalObject *	myEntity
DtComponentSystem *	mySystem
DtListItem *	myListItem
DtInputPortMap	myInputPortList
DtOutputPortMap	myOutputPortList
DtInputPortGroupMap	myInputPortGroupList
DtOutputPortGroupMap	myOutputPortGroupList
int	myPriority
double	myLastTickSimTime
std::unique_ptr< DtTimedTickLogic >	myTimedTickLogic
double	myDT
bool	myIsEnabled
bool	myFirstTick
const DtComponentDescriptor *	myComponentDescriptor
std::list < DtVrfProcessStateRepository * >	myComponentPsrs
makVrf::DtTaskVisualizationMap	myTaskVisualizations
double	myNextTaskVisTickTime
DtSymbolString	myFullComponentName
DtSimulationServices *	mySimServices
DtPredicateCallbackManager *	myPredicateCallbackManager
boost::signals2::scoped_connection	myIsClutterChangedConnection
bool	myLocalDebug
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
	DtEngagementReportGeneratorController ()
	DtEngagementReportGeneratorController (const DtEngagementReportGeneratorController &orig)
DtEngagementReportGeneratorController &	operator= (const DtEngagementReportGeneratorController &orig)

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 Types inherited from DtSimComponent
typedef std::map< DtString, DtInputPort * >	DtInputPortMap
typedef std::map< DtString, DtOutputPort * >	DtOutputPortMap
typedef std::map< DtString, DtInputPortGroup * >	DtInputPortGroupMap
typedef std::map< DtString, DtOutputPortGroup * >	DtOutputPortGroupMap
Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	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

DtEngagementReportGeneratorController::DtEngagementReportGeneratorController ( )

private

Not Implemented.

DtEngagementReportGeneratorController::DtEngagementReportGeneratorController ( const DtEngagementReportGeneratorController &  orig )

private

Not Implemented.

DtEngagementReportGeneratorController::DtEngagementReportGeneratorController	(	const DtString &	name,
		DtLocalObject *	owner,
		DtSimulationServices *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

Parameters

name	Reader writer name of this component.
owner	The DtLocalObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

virtual DtEngagementReportGeneratorController::~DtEngagementReportGeneratorController ( )

overridevirtual

Destructor.

Member Function Documentation

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

private

Not Implemented.

virtual bool DtEngagementReportGeneratorController::init ( )

overridevirtual

Init. Call immediately after construction. If forwardSubordinateReports is true in the descriptor, calls registerEngagementReportCallback().

Reimplemented from DtControllerComponent.

virtual const char* DtEngagementReportGeneratorController::type ( ) const

overridevirtual

Returns a string identifies the class type of component. Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key. Warning: this function should always return the same pointer and it should be valid forever. This means the data should be static.

Returns

DtEngagementReportGeneratorControllerType

Implements DtControllerComponent.

virtual void DtEngagementReportGeneratorController::tick ( )

overridevirtual

This components simulation tick. ....

Reimplemented from DtSimComponent.

static void DtEngagementReportGeneratorController::setEngagementReportingCallback ( DtSimMessage *  msg, void *  usr  )

static

Calls processSetEngagementReporting().

virtual void DtEngagementReportGeneratorController::processSetEngagementReporting ( DtSimMessage *  msg )

virtual

virtual void DtEngagementReportGeneratorController::setLocalEnabled ( bool  on )

virtual

When called, this controller will no longer send engagement reports according to the global engagement reports setting. It will use the local setting specified until setGlobalEnabledOverridingLocal().

virtual void DtEngagementReportGeneratorController::setGlobalEnabledOverridingLocal ( )

virtual

When called, this controller will use the global engagement reports setting to determine if it should send engagement reports. If the global setting is already in use, this will have no effect. If the local setting is in use and it is different from the global setting, engagement reports will be enabled or disabled to match the global setting. To change the enabled setting for this controller only, call setLocalEnabled.

static DtSimComponent* DtEngagementReportGeneratorController::creator ( const DtString &  name, DtLocalObject *  owner, DtSimulationServices *  simManager, DtComponentDescriptor *  desc = 0, DtReaderWriterRegistry *  parentRegistry = 0  )

static

Parameters

name	Reader writer name of this component.
owner	The DtLocalObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

Returns

New instance of this class.

DtEngagementReport* DtEngagementReportGeneratorController::engagementReport ( )

protected

Returns the engagement report for this generator. Creates it if not already created.

virtual bool DtEngagementReportGeneratorController::createPSR ( )

protectedvirtual

Creates myProcessState data member, and adds it to our process state repository manager. Passes in the name and type specified in the component descriptor (if they exist) to the DtVrfProcessStateRepository::createRepository factory method. If name and/or type is not specified, uses the appropriate default strings defined in psrTypes.h.

virtual void DtEngagementReportGeneratorController::registerRadioMessageCallbacks ( )

protectedvirtual

Registers for setEngagementReportingRequest messages from the local entity's radio.

virtual void DtEngagementReportGeneratorController::generateAndSendEngagementReport ( const DtRwPropertiesList *  attacks, const DtRwPropertiesList *  limitedMunitionAttacks, const DtRwPropertiesList *  attacksDefended  )

protectedvirtual

Generate an engagement report based on the current list of attacks the unit is making and defending against..

virtual DtRwEngagementInfo* DtEngagementReportGeneratorController::createEngagementInfoForTarget ( const DtUUID &  targetName, const DtSimObject *  target  )

protectedvirtual

Creates new engagement info using the report type returned from engagementReportTypeString(). Override this method to add custom data to a engagement info.

virtual void DtEngagementReportGeneratorController::updateEngagementInfoForTarget ( DtRwEngagementInfo &  engagement, const DtUUID &  targetName, const DtSimObject *  target, bool  engagementComplete = false  )

protectedvirtual

Updates an existing engagement report with new data.

virtual void DtEngagementReportGeneratorController::sendEngagementReport ( bool  superiorOnly )

protectedvirtual

Uses the default radio on the entity to send the engagement report.

Parameters

superiorOnly

If this is true, then the engagement report is addressed directly to the entity's superior. Otherwise, it is broadcast to the local network.

virtual bool DtEngagementReportGeneratorController::engagementReportNeedsUpdateAndResend ( )

protectedvirtual

Returns

true if the engagement report (which was previously sent) needs to be updated and resent. Default implementation checks the report time against the resend period in the descriptor. Override this method if you need engagement reports resent on "significant changes" to the target entity, or something similar.

virtual const DtSimReportMessageType& DtEngagementReportGeneratorController::engagementReportTypeString ( ) const

protectedvirtual

Returns the type string that will be used in the DtSimReport factory to generate new instances of engagement reports. If you wish to use a custom engagement report, override this method to return the new type. In order for this component to work, the report created MUST be a subclass of DtEngagementReport.

Returns

DtEngagementReportTypeString

static void DtEngagementReportGeneratorController::settingConsumerCallback ( const DtSettingsObject *  settingsObject, void *  usr  )

staticprotected

This is the DtSettingsConsumerFcn registered with the DtVrfSimSettingsManager to get updates when the global engagement reports enabled setting changes. It calls readGlobalEnabledSetting.

virtual void DtEngagementReportGeneratorController::readGlobalEnabledSetting ( const DtBoolSetting *  enabledSetting )

protectedvirtual

If myProcessState::globalEnabledOverridingLocal() is true, the global state from the given settings object will be applied to this controller.

virtual bool DtEngagementReportGeneratorController::reportingEnabled ( ) const

protectedvirtual

Returns true if the sending of engagement reports is enabled. If DtEngagementReportGeneratorControllerPSR::globalEnabledOverridingLocal is true, myGlobalEnabled is returned and otherwise DtEngagementReportGeneratorControllerPSR::localEnabled is returned.

Member Data Documentation

DtEngagementReport* DtEngagementReportGeneratorController::myEngagementReport

protected

The engagement report.

const DtEngagementReportGeneratorControllerDescriptor* DtEngagementReportGeneratorController::myDescriptor

protected

Pointer to this components descriptor.

DtEngagementReportGeneratorControllerPSR* DtEngagementReportGeneratorController::myProcessState

protected

Container for state data associated with this component. This state is saved and restored as part of a scenario (or checkpoint).

bool DtEngagementReportGeneratorController::myGlobalEnabled

protected

Holds a copy of the global engagement reports enabled setting. When the global value changes, this value will be updated by.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfmodel/engagementReportGeneratorController.h