Developer Description: DtSpotReportReceiver listens to spot reports arriving on the radio, and tracks them. More...

Inheritance diagram for DtSpotReportReceiver:

Public Member Functions
	DtSpotReportReceiver (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)
	(const DtString&,DtVrfObject,DtSimManager,
virtual	~DtSpotReportReceiver ()
	destructor
virtual bool	init ()
	Calls createPorts and createPortGroups Initializes myLastTickSimTime.
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	tick ()
	This gives the thread of control to the component.
virtual bool	tickWhileDestroyed () const
Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)
	(const DtString&,DtVrfObject,DtSimManager,
Protected Member Functions
virtual bool	createPorts ()
	Creates the target list port.
virtual DtObjectSensorPSR *	createPSR ()
	Creates myProcessState data member, and adds it to our process state repository manager.
virtual bool	createAndInitSensorMonitor ()
	Creates a DtObjectSensorMonitor, and calls init() on it.
virtual bool	mergeSpotReportWithCurrentData (const DtSpotReport *spotReport)
	Merges data from the specified spot report with the current list of contacts.
virtual bool	pruneOldReports ()
	Looks though the current spot reports and removes any that are beyond the age limit.
Protected Attributes
DtObjectSensorPSR *	myProcessState
	Container for state data associated with this component.
DtObjectSensorMonitor *	myMonitor
bool	myContactsChanged
const DtSpotReportReceiverDescriptor *	mySpotReportReceiverDescriptor
Ports and Port Groups
DtSensorContactListOutputPort *	myContactsListPort
	Outputs: Output Port Name: contacts Output Port Description: The list of contacts that have been collected by this receiver.
Private Member Functions

	DtSpotReportReceiver ()
	Not Implemented.
	DtSpotReportReceiver (const DtSpotReportReceiver &orig)
	Not Implemented.
const DtSpotReportReceiver &	operator= (const DtSpotReportReceiver &orig)
	Not Implemented.
virtual void	processSpotReport (const DtVrfObjectMessage *msg)
	Calls mergeSpotReportWithCurrentData().
static void	spotReportCallback (const DtVrfObjectMessage msg, void usr)
	Processes spot reports coming off the radio.

Detailed Description

Developer Description: DtSpotReportReceiver listens to spot reports arriving on the radio, and tracks them.

The data from the spot reports is provided on an output port in the same way that a sensor provides a contact list. This list can then be used by a fusion controller to create a combined list of contacts. Spot reports are kept on the local list until they reach an age since last reported contact time, then removed. The age is specified in the descriptor.

Uses Descriptor Type: DtSpotReportReceiverDescriptor

Constructor & Destructor Documentation

DtSpotReportReceiver::DtSpotReportReceiver ( ) [private]

Not Implemented.

DtSpotReportReceiver::DtSpotReportReceiver ( const DtSpotReportReceiver & orig ) [private]

Not Implemented.

DtSpotReportReceiver::DtSpotReportReceiver	(	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 DtSpotReportReceiver::~DtSpotReportReceiver ( ) [virtual]

destructor

Member Function Documentation

const DtSpotReportReceiver& DtSpotReportReceiver::operator= ( const DtSpotReportReceiver & orig ) [private]

Not Implemented.

virtual bool DtSpotReportReceiver::init ( ) [virtual]

Calls createPorts and createPortGroups Initializes myLastTickSimTime.

Reimplemented from DtSimComponent.

virtual DtString DtSpotReportReceiver::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.

Returns:: DtSpotReportReceiverType

Reimplemented from DtSimComponent.

virtual void DtSpotReportReceiver::tick ( ) [virtual]

This gives the thread of control to the component.

The component is ticked once each simulation from by the component list it's on. This base class tick has no functionality.

Reimplemented from DtSimComponent.

virtual bool DtSpotReportReceiver::tickWhileDestroyed ( ) const [virtual]

Returns:: true.

Reimplemented from DtSimComponent.

static DtSimComponent* DtSpotReportReceiver::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 bool DtSpotReportReceiver::createPorts ( ) [protected, virtual]

Creates the target list port.

Reimplemented from DtSimComponent.

virtual DtObjectSensorPSR* DtSpotReportReceiver::createPSR ( ) [protected, virtual]

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 bool DtSpotReportReceiver::createAndInitSensorMonitor ( ) [protected, virtual]

Creates a DtObjectSensorMonitor, and calls init() on it.

static void DtSpotReportReceiver::spotReportCallback	(	const DtVrfObjectMessage *	msg,
		void *	usr
	)		`[static, protected]`

Processes spot reports coming off the radio.

virtual void DtSpotReportReceiver::processSpotReport ( const DtVrfObjectMessage * msg ) [protected, virtual]

Calls mergeSpotReportWithCurrentData().

virtual bool DtSpotReportReceiver::mergeSpotReportWithCurrentData ( const DtSpotReport * spotReport ) [protected, virtual]

Merges data from the specified spot report with the current list of contacts.

Returns:: True if the current list was modified (data added and/or any entries altered). Otherwise false. This implementation uses the mergeContactInfo() method.

virtual bool DtSpotReportReceiver::pruneOldReports ( ) [protected, virtual]

Looks though the current spot reports and removes any that are beyond the age limit.