DtSpotReportGeneratorController Class Reference

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

Inheritance diagram for DtSpotReportGeneratorController:

Public Member Functions
	DtSpotReportGeneratorController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtSpotReportGeneratorController ()
	Destructor.
virtual bool	init ()
	Init.
virtual const char *	type () const
	Returns a string identifies the class type of component.
virtual void	tick ()
	This components simulation tick.
virtual void	processSetSpotReporting (DtSimMessage *msg)
virtual void	setLocalEnabled (bool on)
	When called, this controller will no longer send spot reports according to the global spot reports setting.
virtual void	setGlobalEnabledOverridingLocal ()
	When called, this controller will use the global spot reports setting to determine if it should send spot reports.
virtual void	resendSpotReports (unsigned long requestId)
	Resends all spot reports currently in the PSR.
Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtControllerComponent ()
	destructor
virtual DtSimRadio *	radio ()
	The radio this component is listening to.
virtual void	taskNotify (const DtSimTask &task)
	This is used by the entity to notify all controllers that a new task has been received.
virtual void	clearTask ()
	Called when you want to clear out this component's task state.
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSimComponent ()
	destructor
void	setParentSystem (DtComponentSystem *system)
	Sets the parent system of this component.
virtual bool	postAddComponentsInit ()
	Called after all components have been created, initialized and added to the component manager.
virtual void	registerAttributeFunctions ()
	Called to register functions that provide system attribute values.
virtual void	preFirstTickInit ()
	This function can be overridden to initialize a component before it is ticked for the first time.
virtual void	postTick ()
	This function is called immediately after tick() is called.
virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as
virtual double	minTickPeriod () const
	access the minimum tick period
virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time
virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period
virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally.
virtual double	nextTickTime () const
	access the next tick time
virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double	calculateFirstTickTime () const
	Returns the first time value that the component should tick at.
virtual void	setEntity (DtVrfObject *entity)
	The entity's state repository is the place that actuator components make updates and other components look to see our current state.
virtual DtSimComponent *	nextComponent ()
	List management functions.
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
	Used by DtComponentList.
virtual DtListItem *	listItem ()
virtual void	putData (FILE *fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actual stored.
virtual void	addInputPort (DtInputPort *port)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
	Returns a pointer to the input port registered on this component with the specified name.
virtual DtList	inputPortList () const
	Returns the list of DtInputPorts registered on this component.
virtual void	addOutputPort (DtOutputPort *port)
	Adds this output port to the components output port list so that other components can look it up and attach to it.
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
	Returns a pointer to the output port registered on this component with the specified name.
virtual DtList	outputPortList () const
	Returns the list of DtOutputPorts registered on this component.
virtual void	addInputPortGroup (DtInputPortGroup *group)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
	Returns a pointer the input port group registered on this component with the specified name.
virtual DtList	inputPortGroupList () const
	Returns the list of DtInputPortGroups registered on this component.
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
	Adds this output port group to the components output port group list so that other components can look it up and attach to it.
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
	Returns a pointer the output port group registered on this component with the specified name.
virtual DtList	outputPortGroupList () const
	Returns the list of DtOutputPortGroups registered on this component.
virtual int	priority () const
	Return the current connection priority for this component.
virtual void	setPriority (int priority)
	Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.
double	dT () const
	This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
virtual void	setDT (double deltaT)
	Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
	The component descriptor specified in the order of battle file or parameter file that was used to create this component.
virtual const DtComponentDescriptor *	componentDescriptor () const
virtual bool	tickWhileDestroyed () const
	If the component returns true here, it will be ticked regardless of the destroyed state of the host entity.
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual DtString	componentFullName () const
virtual DtPhysicalWorld *	physicalWorld ()
	Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorld *	physicalWorld () const
virtual DtAttachedTerrain *	terrainAttachedTo ()
	Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrain *	terrainAttachedTo () const
virtual DtVrfObject *	entity ()
	Gets the entity.
virtual const DtVrfObject *	entity () const
virtual DtSimManager *	simManager ()
	Gets the sim manager.
virtual const DtSimManager *	simManager () const
virtual const Coordinate_System *	coordinateSystem () const
	Gets the coordinate system, as it should always exist if the physical world is in a valid state!
virtual Coordinate_System *	coordinateSystem ()
virtual DtVrfObjectStateRepository *	localStateRepository ()
	Gets the local state repository.
virtual const DtVrfObjectStateRepository *	localStateRepository () const
virtual void	enable ()
	Is this component enabled or not.
virtual void	disable ()
	Is this component enabled or not.
virtual bool	isEnabled ()
	Is this component enabled or not.
virtual void	setIsEnabled (bool yesNo)
	Is this component enabled or not.
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 DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static void	setSpotReportingCallback (DtSimMessage *msg, void *usr)
	Calls processSetSpotReporting().
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,

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

Protected Member Functions
virtual bool	createPorts ()
	Creates and initializes ports.
virtual bool	createPSR ()
	Creates myProcessState data member, and adds it to our process state repository manager.
virtual void	processObjectAboutToBeRemoved (DtVrfObject *object)
virtual void	registerRadioMessageCallbacks ()
	Registers for setSpotReportingRequest messages from the local entity's radio.
virtual void	sendDestroyedReports (unsigned long resendId, bool queueMissing=false)
	Sends out destroyed reports (if there are any).
virtual DtSpotReport *	createDestroyedReport (unsigned long resendId, const DtUUID &entity, bool &objectIsNoLongerDestroyed)
	Returns true either if a report is sent.
virtual void	generateAndSendSpotReports ()
	Walks the fusedSensorContacts list.
virtual bool	isTypeAndForceForReport (DtRwSensorContactInfo *contact)
	Check to see if the contact is of the type and force that we want to send a report for.
virtual DtSpotReport *	createSpotReportForContact (const DtRwSensorContactInfo &contactInfo)
	Creates a new spot report instance using the report type returned from spotReportTypeString(), and fills it in with data from the contact info.
virtual void	updateSpotReportForContact (DtSpotReport &spotReport, const DtRwSensorContactInfo &contact)
	Updates an existing spot report with data from a sensor contact.
virtual void	sendSpotReport (DtSpotReport &spotReport, bool superiorOnly)
	Uses the default radio on the entity to send the spot report.
virtual void	sendSpotReports (const std::vector< DtSimReport * > &spotReports, bool superiorOnly)
	Send a group of spot reports as a single message to expected receivers.
virtual bool	spotReportNeedsUpdateAndResend (const DtSpotReport &spotRep, const DtRwSensorContactInfo &contact, DtSpotReport::Reason &reason) const
virtual double	heartbeatDeltaFor (const DtSpotReport &spotRep, const DtRwSensorContactInfo &contact) const
	Returns the heartbeat delta for the given spot report.
virtual const DtSimReportMessageType &	spotReportTypeString () const
	Returns the type string that will be used in the DtSimReport factory to generate new instances of spot reports.
virtual void	readGlobalEnabledSetting (const DtBoolSetting *enabledSetting)
	If myProcessState::globalEnabledOverridingLocal() is true, the global state from the given settings object will be applied to this controller.
virtual bool	reportingEnabled () const
	Returns true if the sending of spot reports is enabled.
virtual bool	checkSpotReportUpdateConditions (const DtSpotReport &spotRep, const DtRwSensorContactInfo &contact, DtSpotReport::Reason &reason) const
	Checks conditions (and returns true) if the spot report should be updated based on conditions.
virtual bool	checkDeltaDistanceConditions (const DtSpotReport &spotRep, const DtRwSensorContactInfo &contact) const
	Return true if this entity has moved distance greater than distance needed to send spot report.
virtual bool	checkDeltaHeartbeatConditions (const DtSpotReport &spotRep, const DtRwSensorContactInfo &contact) const
	Return true if this entity has not sent a report for it's specific timeout perios.
virtual bool	entityHasUpdateRate (const DtRwSensorContactInfo &contactInfo) const
	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	timedTick ()
	See if spot reports need to be resent.
virtual void	processObjectAdded (DtVrfObject *)
virtual void	processRequestSpotReports (DtSimMessage *msg)
virtual void	turnSpotReportingOn ()
	Performs the internal processing necessary to change the spot reporting enabled state.
virtual void	turnSpotReportingOff ()
	Performs the internal processing necessary to change the spot reporting enabled state.
Protected Member Functions inherited from DtControllerComponent
	DtControllerComponent ()
	default constructor
	DtControllerComponent (const DtControllerComponent &orig)
	copy constructor
const DtControllerComponent &	operator= (const DtControllerComponent &orig)
	assignment operator
virtual void	setRadio (DtSimRadio *radio)
Protected Member Functions inherited from DtSimComponent
virtual double	computeCurrentTime ()
	Compute current time and myDT.
bool	testInvariant () const
virtual bool	createPortGroups ()
	Called by init.
DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
	Creates a PSR for this component and registers it with the PSR manager.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()
Protected Member Functions inherited from DtObjectDebugger< DtSimComponent >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Static Protected Member Functions
static void	objectAboutToBeRemovedCallback (DtVrfObject *object, void *usr)
	Added when there are destroyed reports to keep track of – remove if the object is removed from the simulation.
static void	settingConsumerCallback (const DtSettingsObject *settingsObject, void *usr)
	This is the DtSettingsConsumerFcn registered with the DtVrfSimSettingsManager to get updates when the global spot reports enabled setting changes.
static void	objectAddedCb (DtVrfObject *, void *usr)
	Called when an object is added, if waiting to send a destroyed report for send it out.
static void	requestSpotReportsCallback (DtSimMessage *msg, void *usr)

Protected Attributes
const DtSpotReportGeneratorControllerDescriptor *	myDescriptor
	Pointer to this components descriptor.
DtSpotReportGeneratorControllerPSR *	myProcessState
	Container for state data associated with this component.
int	myCurrentForceType
DtSensorContactInfoListChangeMonitor	myContactListMonitor
bool	myHostilitiesChangeFlag
	Flag which gets set to true when hostilities changed, and cleared the following tick.
bool	myGlobalEnabled
	Holds a copy of the global spot reports enabled setting.
double	myLastHeartbeatTime
bool	myNeedsSpotReportFlush
MissingDestroyedObjectsMap	myMissingDestroyedObjectsMap
Ports and Port Groups
Port I/O Interface: Inputs: DtSensorContactListMultiInputPort : detected-objects Outputs: DtObjectTypesListOutputPort() : object-types-to-spot-report.
DtObjectTypesListOutputPort *	myTypesToDetectOutputPort
	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.
Protected Attributes inherited from DtControllerComponent
DtSimRadio *	myRadio
	Controller components can send messages.
Protected Attributes inherited from DtSimComponent
DtVrfObject *	myEntity
DtVrfObjectStateRepository *	myLocalStateRepository
DtSimManager *	mySimManager
DtComponentSystem *	mySystem
	Pointer to the DtComponentSystem that this component belongs.
DtListItem *	myListItem
DtInputPortMap	myInputPortList
DtOutputPortMap	myOutputPortList
DtInputPortGroupMap	myInputPortGroupList
DtOutputPortGroupMap	myOutputPortGroupList
int	myPriority
double	myMinTickPeriod
double	myMinTickPeriodVariance
double	myNextTickTime
double	myLastTickSimTime
double	myDT
bool	myIsEnabled
	Indicates whether this component should be enabled for ticking or not.
bool	myFirstTick
	Initialized to true in the constructor, set to false by the first call to postTick.
bool	myIsThreadSafe
	Whether this component can be use the DtCriticalSection versions of the tick functions and be ticked in parallel with other components Defaults to false.
const DtComponentDescriptor *	myComponentDescriptor
std::list < DtVrfProcessStateRepository * >	myComponentPsrs
	List of PSRs made using createComponentPsr() that will be deleted by this component when it is destroyed.
bool	myTickEveryFrame
	Flag indicating that tickPeriod is set to 0, and the component will tick every frame.
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
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Private Member Functions
	DtSpotReportGeneratorController ()
	Not Implemented.
	DtSpotReportGeneratorController (const DtSpotReportGeneratorController &orig)
	Not Implemented.
DtSpotReportGeneratorController &	operator= (const DtSpotReportGeneratorController &orig)
	Not Implemented.
virtual void	processHostilitiesChanged (DtU8 force)
	Callback method invoked by the hostility manager when the hostilities between various forces have changed.
static void	hostilitiesChangedCallback (DtU8 force, void *usr)
	Callback method invoked by the hostility manager when the hostilities between various forces have changed.

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

Detailed Description

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

Member Typedef Documentation

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

protected

Constructor & Destructor Documentation

DtSpotReportGeneratorController::DtSpotReportGeneratorController ( )

private

Not Implemented.

DtSpotReportGeneratorController::DtSpotReportGeneratorController ( const DtSpotReportGeneratorController &  orig )

private

Not Implemented.

DtSpotReportGeneratorController::DtSpotReportGeneratorController	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject 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).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

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, DtVrfObject *  owner, DtSimManager *  simManager, DtComponentDescriptor *  desc = 0, DtReaderWriterRegistry *  parentRegistry = 0  )

static

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject 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).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

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.

static void DtSpotReportGeneratorController::objectAboutToBeRemovedCallback ( DtVrfObject *  object, void *  usr  )

staticprotected

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

virtual void DtSpotReportGeneratorController::processObjectAboutToBeRemoved ( DtVrfObject *  object )

protectedvirtual

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.

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

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.

static void DtSpotReportGeneratorController::objectAddedCb ( DtVrfObject *  , void *  usr  )

staticprotected

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

virtual void DtSpotReportGeneratorController::processObjectAdded ( DtVrfObject *  )

protectedvirtual

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

staticprotected

virtual void DtSpotReportGeneratorController::processRequestSpotReports ( DtSimMessage *  msg )

protectedvirtual

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

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmodel/spotReportGeneratorController.h