M_Sensor::IService Class Reference

Inheritance diagram for M_Sensor::IService:

Public Member Functions
virtual	~IService ()
virtual void	CmdIsSensorAlive ()
virtual void	CmdDeleteTracks (M_Common::ObjectIdListType const &KeyIdList)
virtual void	CmdDeleteAllTracks ()
virtual void	CmdDeactivateSensor (bool Deactivate)
virtual void	ConfigSensorCoverage (M_Common::ObjectIdType const &KeyId, M_Sensor::SensorCoverageType const &Coverage, bool IsRemoved)
virtual void	CmdSetPreset (M_Common::ObjectIdOptionalType const &Preset)
virtual void	CmdLockOnTracks (M_Common::ObjectIdListType const &KeyIdList)

Detailed Description

Service interface. Contains operations that a client can command the sensor service to perform.

Constructor & Destructor Documentation

~IService()

M_Sensor::IService::~IService ( )

virtual

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

Member Function Documentation

CmdDeactivateSensor()

void M_Sensor::IService::CmdDeactivateSensor ( bool  Deactivate )

virtual

Deactivate sensor. This can be used to avoid erroneous detection from a sensor when performing certain actions, such as avoiding acoustic detections when firing our own gun.

Parameters

Deactivate

Indicates if sensor should be deactivated (true) or activated (false).

CmdDeleteAllTracks()

void M_Sensor::IService::CmdDeleteAllTracks ( )

virtual

Delete/Abort all tracks. Note: This function can only be used if the sensor supports tracking.

CmdDeleteTracks()

void M_Sensor::IService::CmdDeleteTracks ( M_Common::ObjectIdListType const &  KeyIdList )

virtual

Delete/Abort one or more tracks. Note: This function can only be used if the sensor supports tracking.

Parameters

KeyIdList

Identifies the objects to delete.

CmdIsSensorAlive()

void M_Sensor::IService::CmdIsSensorAlive ( )

virtual

Cmd to check if service is alive. If the service is not available then an exception will be thrown.

CmdLockOnTracks()

void M_Sensor::IService::CmdLockOnTracks ( M_Common::ObjectIdListType const &  KeyIdList )

virtual

Set which Tracks shall be locked-on.

Parameters

KeyIdList

Identifies the tracks to lock-on.

CmdSetPreset()

void M_Sensor::IService::CmdSetPreset ( M_Common::ObjectIdOptionalType const &  Preset )

virtual

Set current preset.

Parameters

Preset

The preset id to activate. Optional: Do not set the preset to clear the current active preset.

ConfigSensorCoverage()

void M_Sensor::IService::ConfigSensorCoverage ( M_Common::ObjectIdType const &  KeyId, M_Sensor::SensorCoverageType const &  Coverage, bool  IsRemoved  )

virtual

Config the sensor coverage.

Parameters

KeyId	The unique ID of the coverage.
Coverage	Sensor coverage.
IsRemoved	Indicates if the config 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.