M_ScanCtrl::IClient Class Reference

Public Member Functions
virtual	~IClient ()
virtual void	ReportScanCtrlSettings (M_ScanCtrl::ScanCtrlSettingsType const &Settings)
virtual void	ReportScanCtrlStatus (M_ScanCtrl::ScanCtrlStatusType const &Status, bool IsRemoved)
virtual void	ReportStoredScanPattern (std::string const &KeyPatternName, M_ScanCtrl::ScanPatternType const &ScanPattern, bool IsRemoved)
virtual void	ReportAssignmentSearchOffset (M_Common::PositionType const &Offset)

Detailed Description

Scan Control Client interface. Contains operations reported by the Scan Control Service.

Constructor & Destructor Documentation

~IClient()

M_ScanCtrl::IClient::~IClient ( )

virtual

Member Function Documentation

ReportAssignmentSearchOffset()

void M_ScanCtrl::IClient::ReportAssignmentSearchOffset ( M_Common::PositionType const &  Offset )

virtual

Report of current search position information. This should always be called with the latest status updates since the last report can be read by late joiners.

Parameters

Offset

The current offset between assignment position and line of sight.

ReportScanCtrlSettings()

void M_ScanCtrl::IClient::ReportScanCtrlSettings ( M_ScanCtrl::ScanCtrlSettingsType const &  Settings )

virtual

Report static settings for Scan Control Service.

Parameters

Settings

Scan Control Service settings data.

ReportScanCtrlStatus()

void M_ScanCtrl::IClient::ReportScanCtrlStatus ( M_ScanCtrl::ScanCtrlStatusType const &  Status, bool  IsRemoved  )

virtual

Report status for Scan Control Service.

Parameters

Status	Current status data for Scan Control Service.
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.

ReportStoredScanPattern()

void M_ScanCtrl::IClient::ReportStoredScanPattern ( std::string const &  KeyPatternName, M_ScanCtrl::ScanPatternType const &  ScanPattern, bool  IsRemoved  )

virtual

Report the scan pattern

Parameters

KeyPatternName	Identifies the scan pattern
ScanPattern	Scan pattern
IsRemoved	Indicates if the scan pattern 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 scan pattern will no longer be available to late joiners.