M_Sensor::IClient Class Reference

Inheritance diagram for M_Sensor::IClient:

Public Member Functions
virtual	~IClient ()
virtual void	ReportSensorSettings (M_Sensor::SensorSettingsType const &Settings)
virtual void	ReportSensorStatus (M_Sensor::SensorStatusType const &Status, bool IsRemoved)
virtual void	ReportSensorCoverage (M_Common::ObjectIdType const &KeyId, M_Sensor::SensorCoverageType const &Coverage, bool IsRemoved)
virtual void	EventSensorDetection (M_Common::ObjectIdType const &DetectionId, M_Sensor::SensorDetectionType const &Detection)
virtual void	ReportSensorTrack (M_Common::ObjectIdType const &KeyId, M_Sensor::SensorDetectionType const &Track, bool IsRemoved)

Detailed Description

Client interface. Contains operations reported by a sensor service.

Constructor & Destructor Documentation

~IClient()

M_Sensor::IClient::~IClient ( )

virtual

Reimplemented in M_VideoTrackerCommon::IClient, and M_LaserRangeFinder::IClient.

Member Function Documentation

EventSensorDetection()

void M_Sensor::IClient::EventSensorDetection ( M_Common::ObjectIdType const &  DetectionId, M_Sensor::SensorDetectionType const &  Detection  )

virtual

Event of a detected object.

Parameters

DetectionId	Identifies the detection for the location measurement. Note: Since an event does not have a lifetime, it cannot be updated/deleted, but multiple locations can belong to the same detection and will then have the same detection ID.
Detection	Detection data.

ReportSensorCoverage()

void M_Sensor::IClient::ReportSensorCoverage ( M_Common::ObjectIdType const &  KeyId, M_Sensor::SensorCoverageType const &  Coverage, bool  IsRemoved  )

virtual

Report current coverage of the sensor.

Parameters

KeyId	The unique ID of the coverage.
Coverage	Sensor coverage.
IsRemoved	Indicates if the coverage is no longer available. Note: This will always be set to True when a Service has been shut down. After this has been set to True the status will no longer be available to late joiners.

ReportSensorSettings()

void M_Sensor::IClient::ReportSensorSettings ( M_Sensor::SensorSettingsType const &  Settings )

virtual

Report static settings of the sensor.

Parameters

Settings

Sensor settings data.

ReportSensorStatus()

void M_Sensor::IClient::ReportSensorStatus ( M_Sensor::SensorStatusType const &  Status, bool  IsRemoved  )

virtual

Report current status of the sensor.

Parameters

Status	Current status data for sensor.
IsRemoved	Indicates if the status is no longer available. Note: This will always be set to True when a Service has been shut down. After this has been set to True the status will no longer be available to late joiners.

ReportSensorTrack()

void M_Sensor::IClient::ReportSensorTrack ( M_Common::ObjectIdType const &  KeyId, M_Sensor::SensorDetectionType const &  Track, bool  IsRemoved  )

virtual

Report an object tracked by the sensor (i.e. a track). A tracked object has a lifetime and updates to the same tracked object will be reported with the same KeyId. When an object is no longer tracked (i.e. lost), it should be reported with IsRemoved set to true.

Note: If the sensor does NOT have the ability to track objects then a detection should be reported via the EventSensorDetection() operation instead.

Parameters

KeyId	The unique track ID.
Track	Tracked object data.
IsRemoved	Indicates if the sensor track has been lost (i.e. no longer tracked by sensor). Note: After this has been set to True the track will no longer be available to late joiners.