DtSpotReportGeneratorController Class Reference

DtSpotReportGeneratorController is a controller that sends spot reports based on the contact list in the entity state repository.

End User Description: This controller monitors the object contact list in the state repository, and sends spot reports to the network when new contacts are detected on the list. A spot report is sent for each sensor contact listed. Spot reports are resent on a periodic basis, based on a setting in the descriptor. Spot reports are sent to the local radio network using the default radio. The contents of a spot report are defined in the DtSpotReport class.

Spot reporting can be enabled and disabled though the DtSetSpotReportingRequest set data request.

Uses Descriptor Type: DtSpotReportGeneratorControllerDescriptor

Inheritance diagram for DtSpotReportGeneratorController:

Public Member Functions
	DtSpotReportGeneratorController (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSpotReportGeneratorController ()
virtual bool	init ()
virtual const char *	type () const
virtual void	tick ()
virtual void	processSetSpotReporting (DtSimMessage *msg)
virtual void	setLocalEnabled (bool on)
virtual void	setGlobalEnabledOverridingLocal ()
virtual void	resendSpotReports (unsigned long requestId)
Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtControllerComponent ()
virtual bool	postAddComponentsInit ()
virtual DtSimRadio *	radio ()
virtual void	taskNotify (const DtSimTask &task)
virtual void	clearTask ()
virtual void	enableTaskTypes ()
virtual void	disableTaskTypes ()
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSimComponent ()
virtual void	setParentSystem (DtComponentSystem *system)
DtComponentSystem *	parentSystem () const
virtual void	registerAttributeFunctions ()
virtual void	preFirstTickInit ()
virtual void	postTick ()
virtual void	setMinTickPeriod (double minTickPeriod)
virtual double	minTickPeriod () const
virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
virtual double	minTickPeriodVariance () const
virtual void	setNextTickTime (double nextTickTime)
virtual double	nextTickTime () const
virtual double	calculateNextTickTime () const
virtual double	calculateFirstTickTime () const
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)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
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 bool	taskVisualizationsActive () const
virtual bool	taskVisualizationsEnabled () const
makVrf::DtTaskVisualizationMap &	taskVisualizations ()
virtual void	enable ()
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)
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 void	setSpotReportingCallback (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 Types
typedef std::map< DtUUID, std::vector< unsigned long > >	MissingDestroyedObjectsMap
typedef std::map< DtUUID, boost::signals2::connection >	RemovalSignalsMap
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

Protected Member Functions
virtual bool	createPorts ()
virtual bool	createPSR ()
virtual void	processObjectAboutToBeRemoved (const DtSimObject *object)
virtual void	registerRadioMessageCallbacks ()
virtual void	sendDestroyedReports (unsigned long resendId, bool queueMissing=false)
virtual DtSpotReport *	createDestroyedReport (unsigned long resendId, const DtUUID &entity, bool &objectIsNoLongerDestroyed)
virtual void	generateAndSendSpotReports ()
virtual bool	isTypeAndForceForReport (DtRwSensorContactInfo *contact)
virtual DtSpotReport *	createSpotReportForContact (const DtRwSensorContactInfo &contactInfo)
virtual void	updateSpotReportForContact (DtSpotReport &spotReport, const DtRwSensorContactInfo &contact)
virtual void	sendSpotReport (DtSpotReport &spotReport, bool superiorOnly)
std::vector< DtUUID >	getSpotReportSuperiorPeers ()
virtual void	sendSpotReports (const std::vector< DtSimReport * > &spotReports, bool superiorOnly)
virtual void	sendStopSpottingReports (const std::map< DtUUID, DtString > &stoppedSpotting)
virtual bool	spotReportNeedsUpdateAndResend (const DtSpotReport &spotRep, const DtRwSensorContactInfo &contact, DtSpotReport::Reason &reason) const
virtual double	heartbeatDeltaFor (const DtSpotReport &spotRep, const DtRwSensorContactInfo &contact) const
virtual const DtSimReportMessageType &	spotReportTypeString () const
virtual const DtSimReportMessageType &	stopSpottingReportTypeString () const
virtual void	readGlobalEnabledSetting (const DtBoolSetting *enabledSetting)
virtual bool	reportingEnabled () const
virtual bool	checkSpotReportUpdateConditions (const DtSpotReport &spotRep, const DtRwSensorContactInfo &contact, DtSpotReport::Reason &reason) const
virtual bool	checkDeltaDistanceConditions (const DtSpotReport &spotRep, const DtRwSensorContactInfo &contact) const
virtual bool	checkDeltaHeartbeatConditions (const DtSpotReport &spotRep, const DtRwSensorContactInfo &contact) const
virtual bool	entityHasUpdateRate (const DtRwSensorContactInfo &contactInfo) const
virtual void	timedTick ()
virtual void	processSimObjectAdded (DtSimObjectReference)
virtual void	processRequestSpotReports (DtSimMessage *msg)
virtual void	processSetRemoteSensorReceiver (DtSimMessage *msg)
virtual void	turnSpotReportingOn ()
virtual void	turnSpotReportingOff ()
Protected Member Functions inherited from DtControllerComponent
	DtControllerComponent ()
	DtControllerComponent (const DtControllerComponent &orig)
const DtControllerComponent &	operator= (const DtControllerComponent &orig)
virtual void	onRestore ()
virtual void	initializeTargetingControlTableFromDescriptor (const DtReaderWriter *)
virtual void	setRadio (DtSimRadio *radio)
virtual void	sendCapableSetsAndTasks ()
Protected Member Functions inherited from DtSimComponent
virtual double	computeCurrentTime ()
bool	testInvariant () const
virtual bool	createPortGroups ()
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
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)
static void	requestSpotReportsCallback (DtSimMessage *msg, void *usr)
static void	setRemoteSensorReceiverCallback (DtSimMessage *msg, void *usr)

Protected Attributes
const DtSpotReportGeneratorControllerDescriptor *	myDescriptor
DtSpotReportGeneratorControllerPSR *	myProcessState
int	myCurrentForceType
DtSensorContactInfoListChangeMonitor	myContactListMonitor
bool	myHostilitiesChangeFlag
bool	myGlobalEnabled
double	myLastHeartbeatTime
bool	myNeedsSpotReportFlush
MissingDestroyedObjectsMap	myMissingDestroyedObjectsMap
RemovalSignalsMap	myRemovalSignalsMap
boost::signals2::scoped_connection	mySimObjectAddedConnection
Ports and Port Groups
Port I/O Interface: Inputs: DtSensorContactListMultiInputPort : detected-objects Outputs: DtObjectTypesListOutputPort() : object-types-to-spot-report.
DtObjectTypesListOutputPort *	myTypesToDetectOutputPort
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	myMinTickPeriod
double	myMinTickPeriodVariance
double	myNextTickTime
double	myLastTickSimTime
double	myDT
bool	myIsEnabled
bool	myFirstTick
const DtComponentDescriptor *	myComponentDescriptor
std::list < DtVrfProcessStateRepository * >	myComponentPsrs
bool	myTickEveryFrame
makVrf::DtTaskVisualizationMap	myTaskVisualizations
double	myNextTaskVisTickTime
DtSymbolString	myFullComponentName
DtSimulationServices *	mySimServices
DtPredicateCallbackManager	myPredicateCallbackManager
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
	DtSpotReportGeneratorController ()
	DtSpotReportGeneratorController (const DtSpotReportGeneratorController &orig)
DtSpotReportGeneratorController &	operator= (const DtSpotReportGeneratorController &orig)
virtual void	processHostilitiesChanged (DtU8 force)
static void	hostilitiesChangedCallback (DtU8 force, void *usr)

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

Member Typedef Documentation

typedef std::map<DtUUID, std::vector<unsigned long> > DtSpotReportGeneratorController::MissingDestroyedObjectsMap

protected

typedef std::map<DtUUID, boost::signals2::connection> DtSpotReportGeneratorController::RemovalSignalsMap

protected

Constructor & Destructor Documentation

DtSpotReportGeneratorController::DtSpotReportGeneratorController ( )

private

Not Implemented.

DtSpotReportGeneratorController::DtSpotReportGeneratorController ( const DtSpotReportGeneratorController &  orig )

private

Not Implemented.

DtSpotReportGeneratorController::DtSpotReportGeneratorController	(	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 DtSpotReportGeneratorController::~DtSpotReportGeneratorController ( )

virtual

Destructor.

Member Function Documentation

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

private

Not Implemented.

virtual bool DtSpotReportGeneratorController::init ( )

virtual

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

Reimplemented from DtControllerComponent.

virtual const char* DtSpotReportGeneratorController::type ( ) const

virtual

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

DtSpotReportGeneratorControllerType

Implements DtControllerComponent.

virtual void DtSpotReportGeneratorController::tick ( )

virtual

This components simulation tick. If any connected sensor has provided new data since the last tick, fuseSensorContacts() and generateAndSendSpotReports() are called.

Reimplemented from DtSimComponent.

static void DtSpotReportGeneratorController::setSpotReportingCallback ( DtSimMessage *  msg, void *  usr  )

static

Calls processSetSpotReporting().

virtual void DtSpotReportGeneratorController::processSetSpotReporting ( DtSimMessage *  msg )

virtual

virtual void DtSpotReportGeneratorController::setLocalEnabled ( bool  on )

virtual

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

virtual void DtSpotReportGeneratorController::setGlobalEnabledOverridingLocal ( )

virtual

When called, this controller will use the global spot reports setting to determine if it should send spot 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, spot reports will be enabled or disabled to match the global setting. To change the enabled setting for this controller only, call setLocalEnabled.

virtual void DtSpotReportGeneratorController::resendSpotReports ( unsigned long  requestId )

virtual

Resends all spot reports currently in the PSR. No information about these reports is changed, including the last simulation time the spot report is sent. This is used to keep current expiration time consistent.

static DtSimComponent* DtSpotReportGeneratorController::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.

virtual void DtSpotReportGeneratorController::turnSpotReportingOn ( )

protectedvirtual

Performs the internal processing necessary to change the spot reporting enabled state. To change the state from another class, setLocalEnabled or setGlobalEnabledOverridingLocal should be called.

virtual void DtSpotReportGeneratorController::turnSpotReportingOff ( )

protectedvirtual

Performs the internal processing necessary to change the spot reporting enabled state. To change the state from another class, setLocalEnabled or setGlobalEnabledOverridingLocal should be called.

virtual bool DtSpotReportGeneratorController::createPorts ( )

protectedvirtual

Creates and initializes ports.

Reimplemented from DtSimComponent.

virtual bool DtSpotReportGeneratorController::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 procSRTypes.h.

virtual void DtSpotReportGeneratorController::processObjectAboutToBeRemoved ( const DtSimObject *  object )

protectedvirtual

Added when there are destroyed reports to keep track of – remove if the object is removed from the simulation.

virtual void DtSpotReportGeneratorController::registerRadioMessageCallbacks ( )

protectedvirtual

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

virtual void DtSpotReportGeneratorController::sendDestroyedReports ( unsigned long  resendId, bool  queueMissing = false  )

protectedvirtual

Sends out destroyed reports (if there are any). If objects are not found and the resendOnMissing flag is set then a queue will be created for any missing object and reports will be sent out when the object is discovered. If the flag is false then no action will be taken.

virtual DtSpotReport* DtSpotReportGeneratorController::createDestroyedReport ( unsigned long  resendId, const DtUUID &  entity, bool &  objectIsNoLongerDestroyed  )

protectedvirtual

Returns true either if a report is sent. If not sent, or if the object is no longer destroyed false is returned. If the object is no longer destroyed then the objectIsNoLongerDestroyed flag is set to true is the.

virtual void DtSpotReportGeneratorController::generateAndSendSpotReports ( )

protectedvirtual

Walks the fusedSensorContacts list. Any contacts that are not in the past spot report list trigger a new spot report to be generated using createSpotReportForContact() and send using sendSpotReport(). Any contacts that are in both lists are checked by a call to spotReportNeedsUpdateAndResend. If returns true, then updateSpotReportForContact() is called and the updated report is sent with sendSpotReport(). Any contacts that have been removed from the fusedSensorContacts list since the last update have their corresponding spot reports removed from the spot report list.

virtual bool DtSpotReportGeneratorController::isTypeAndForceForReport ( DtRwSensorContactInfo *  contact )

protectedvirtual

Check to see if the contact is of the type and force that we want to send a report for. This is used in generateAndSendSpotReports(). This check is necessary because sensors may generate contacts for forces or types that we don't want to send reports for. The ground truth type and force is used for the check. We assume that the filters in the descriptor are there to limit simulation computation and network traffic, not describe entity capabilities in the domain.

virtual DtSpotReport* DtSpotReportGeneratorController::createSpotReportForContact ( const DtRwSensorContactInfo &  contactInfo )

protectedvirtual

Creates a new spot report instance using the report type returned from spotReportTypeString(), and fills it in with data from the contact info. Override this method to add custom data to a spot report.

virtual void DtSpotReportGeneratorController::updateSpotReportForContact ( DtSpotReport &  spotReport, const DtRwSensorContactInfo &  contact  )

protectedvirtual

Updates an existing spot report with data from a sensor contact.

virtual void DtSpotReportGeneratorController::sendSpotReport ( DtSpotReport &  spotReport, bool  superiorOnly  )

protectedvirtual

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

Parameters

superiorOnly

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

std::vector<DtUUID> DtSpotReportGeneratorController::getSpotReportSuperiorPeers ( )

protected

virtual void DtSpotReportGeneratorController::sendSpotReports ( const std::vector< DtSimReport * > &  spotReports, bool  superiorOnly  )

protectedvirtual

Send a group of spot reports as a single message to expected receivers.

virtual void DtSpotReportGeneratorController::sendStopSpottingReports ( const std::map< DtUUID, DtString > &  stoppedSpotting )

protectedvirtual

Sends a report indicating that some contacts are no longer spotted.

virtual bool DtSpotReportGeneratorController::spotReportNeedsUpdateAndResend ( const DtSpotReport &  spotRep, const DtRwSensorContactInfo &  contact, DtSpotReport::Reason &  reason  ) const

protectedvirtual

Returns

true if the spot 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 spot reports resent on "significant changes" to the contacted entity, or something similar.

virtual double DtSpotReportGeneratorController::heartbeatDeltaFor ( const DtSpotReport &  spotRep, const DtRwSensorContactInfo &  contact  ) const

protectedvirtual

Returns the heartbeat delta for the given spot report. Used in conjunction with the simulation time to determine when this spot report expires.

virtual const DtSimReportMessageType& DtSpotReportGeneratorController::spotReportTypeString ( ) const

protectedvirtual

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

Returns

DtSpotReportTypeString

virtual const DtSimReportMessageType& DtSpotReportGeneratorController::stopSpottingReportTypeString ( ) const

protectedvirtual

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

Returns

DtStopSpottingReportTypeString

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

staticprotected

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

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

protectedvirtual

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

static void DtSpotReportGeneratorController::hostilitiesChangedCallback ( DtU8  force, void *  usr  )

staticprotected

Callback method invoked by the hostility manager when the hostilities between various forces have changed.

virtual void DtSpotReportGeneratorController::processHostilitiesChanged ( DtU8  force )

protectedvirtual

Callback method invoked by the hostility manager when the hostilities between various forces have changed.

virtual bool DtSpotReportGeneratorController::reportingEnabled ( ) const

protectedvirtual

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

virtual bool DtSpotReportGeneratorController::checkSpotReportUpdateConditions ( const DtSpotReport &  spotRep, const DtRwSensorContactInfo &  contact, DtSpotReport::Reason &  reason  ) const

protectedvirtual

Checks conditions (and returns true) if the spot report should be updated based on conditions. The only current condition is a distance delta. Override this method to make additional checks.

virtual bool DtSpotReportGeneratorController::checkDeltaDistanceConditions ( const DtSpotReport &  spotRep, const DtRwSensorContactInfo &  contact  ) const

protectedvirtual

Return true if this entity has moved distance greater than distance needed to send spot report.

virtual bool DtSpotReportGeneratorController::checkDeltaHeartbeatConditions ( const DtSpotReport &  spotRep, const DtRwSensorContactInfo &  contact  ) const

protectedvirtual

Return true if this entity has not sent a report for it's specific timeout perios.

virtual bool DtSpotReportGeneratorController::entityHasUpdateRate ( const DtRwSensorContactInfo &  contactInfo ) const

protectedvirtual

Returns true if the entity has an update rate associated with it. If it does it will not look at the default heartbeat rate.

virtual void DtSpotReportGeneratorController::timedTick ( )

protectedvirtual

See if spot reports need to be resent.

Reimplemented from DtSimComponent.

virtual void DtSpotReportGeneratorController::processSimObjectAdded ( DtSimObjectReference  )

protectedvirtual

Called when an object is added, if waiting to send a destroyed report for send it out.

static void DtSpotReportGeneratorController::requestSpotReportsCallback ( DtSimMessage *  msg, void *  usr  )

staticprotected

virtual void DtSpotReportGeneratorController::processRequestSpotReports ( DtSimMessage *  msg )

protectedvirtual

virtual void DtSpotReportGeneratorController::processSetRemoteSensorReceiver ( DtSimMessage *  msg )

protectedvirtual

Process a request to set a remote sensor receiver for this entity.

static void DtSpotReportGeneratorController::setRemoteSensorReceiverCallback ( DtSimMessage *  msg, void *  usr  )

staticprotected

Callback for a request to set a remote sensor receiver for this entity.

Member Data Documentation

DtObjectTypesListOutputPort* DtSpotReportGeneratorController::myTypesToDetectOutputPort

protected

Output Port Name: object-types-to-spot-report
Output Port Description: List of types of object the spot report controller should generate spot reports on. Connects to the sensors.
Output Port Range:
Output Port Default Value:
Output Group Parent:

const DtSpotReportGeneratorControllerDescriptor* DtSpotReportGeneratorController::myDescriptor

protected

Pointer to this components descriptor.

DtSpotReportGeneratorControllerPSR* DtSpotReportGeneratorController::myProcessState

protected

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

int DtSpotReportGeneratorController::myCurrentForceType

protected

DtSensorContactInfoListChangeMonitor DtSpotReportGeneratorController::myContactListMonitor

protected

bool DtSpotReportGeneratorController::myHostilitiesChangeFlag

protected

Flag which gets set to true when hostilities changed, and cleared the following tick.

bool DtSpotReportGeneratorController::myGlobalEnabled

protected

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

double DtSpotReportGeneratorController::myLastHeartbeatTime

protected

bool DtSpotReportGeneratorController::myNeedsSpotReportFlush

protected

MissingDestroyedObjectsMap DtSpotReportGeneratorController::myMissingDestroyedObjectsMap

protected

RemovalSignalsMap DtSpotReportGeneratorController::myRemovalSignalsMap

protected

boost::signals2::scoped_connection DtSpotReportGeneratorController::mySimObjectAddedConnection

protected

---

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

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