M_ScanCtrl::IService Class Reference

Public Member Functions
virtual	~IService ()
virtual void	CmdScanPattern (std::string const &PatternName, M_ScanCtrl::ScanPatternOptionalType const &ScanPattern)
virtual void	CmdScanAction (M_ScanCtrl::ScanCtrlMode::Type Action)
virtual void	ConfigStoreScanPattern (std::string const &KeyPatternName, M_ScanCtrl::ScanPatternType const &ScanPattern, bool IsRemoved)
virtual void	CmdDeleteScanPattern (std::string const &PatternName)

Detailed Description

Scan Control Service interface. Contains operations that a client can command the Scan Control Service to perform.

The default use case of this interface is that a scan can be conducted around an assignment position (e.g. assignment of a mount). All scan pattern positions are w.r.t. to the assigned position (e.g. scan sector is around assignment position).

In other use cases, both sides of an interface have to mutually agree upon the reference coordinate frame for scans.

ScanCtrl State Chart

Constructor & Destructor Documentation

~IService()

M_ScanCtrl::IService::~IService ( )

virtual

Member Function Documentation

CmdDeleteScanPattern()

void M_ScanCtrl::IService::CmdDeleteScanPattern ( std::string const &  PatternName )

virtual

Delete a specified scan pattern

Parameters

PatternName

Identifies the scan pattern

CmdScanAction()

void M_ScanCtrl::IService::CmdScanAction ( M_ScanCtrl::ScanCtrlMode::Type  Action )

virtual

Set scan action.

Parameters

Action

Type of action to perform.

CmdScanPattern()

void M_ScanCtrl::IService::CmdScanPattern ( std::string const &  PatternName, M_ScanCtrl::ScanPatternOptionalType const &  ScanPattern  )

virtual

Command the pattern to be used for the next or running scan.

Parameters

PatternName	Identifies the scan pattern
ScanPattern	Scan pattern. If pattern is set, it is used even if stored pattern with same name exists.

ConfigStoreScanPattern()

void M_ScanCtrl::IService::ConfigStoreScanPattern ( std::string const &  KeyPatternName, M_ScanCtrl::ScanPatternType const &  ScanPattern, bool  IsRemoved  )

virtual

Store a specific scan pattern.

Parameters

KeyPatternName	Identifies the scan pattern to be stored.
ScanPattern	The scan pattern to be stored.
IsRemoved	Indicates if the payload is no longer available Note: This will always be set to true when the instance has been shut down After this has been set to true, the payload will no longer be available to late joiners.