M_Alignment::IService Class Reference

Public Member Functions
virtual	~IService ()
virtual void	CmdAlignmentState (std::string const &ComponentId, bool IsActive, M_Common::BooleanOptionalType const &ParallaxCorrection)
virtual void	CmdLateralAlignment (std::string const &ComponentId, M_Common::SphericalPositionType const &Offset)
virtual void	CmdLongitudinalAlignment (std::string const &ComponentId, M_Common::AngleDegreesType Offset)
virtual void	CmdSaveAlignment (std::string const &ComponentId)
virtual void	CmdClearAlignment (std::string const &ComponentId)
virtual void	CmdAllowExternalAlignment (std::string const &ComponentId, bool IsAllowed)

Detailed Description

Alignment service interface. Contains operations that a client can command the alignment service to perform.

Constructor & Destructor Documentation

~IService()

M_Alignment::IService::~IService ( )

virtual

Member Function Documentation

CmdAlignmentState()

void M_Alignment::IService::CmdAlignmentState ( std::string const &  ComponentId, bool  IsActive, M_Common::BooleanOptionalType const &  ParallaxCorrection  )

virtual

Command state of alignment session. Note: On deactivation, all unsaved alignment values will be discarded.

Parameters

ComponentId	Identifies the device/component to be aligned.
IsActive	Activates (true) or deactivates (false) a alignment session.
ParallaxCorrection	Indicates if parallax correction should be used (true) or not (false).

CmdAllowExternalAlignment()

void M_Alignment::IService::CmdAllowExternalAlignment ( std::string const &  ComponentId, bool  IsAllowed  )

virtual

Command to allow external alignment.

Parameters

ComponentId	Identifies the device/component to be aligned.
IsAllowed	Indicates whether to allow external alignment.

CmdClearAlignment()

void M_Alignment::IService::CmdClearAlignment ( std::string const &  ComponentId )

virtual

Command to clear the current alignment values.

Parameters

ComponentId

Identifies the device/component to be aligned.

CmdLateralAlignment()

void M_Alignment::IService::CmdLateralAlignment ( std::string const &  ComponentId, M_Common::SphericalPositionType const &  Offset  )

virtual

Command to align laterally, i.e. in azimuth and elevation. Note: This operation should be chosen for boresighting.

Parameters

ComponentId	Identifies the device/component to be aligned.
Offset	Offset value to adjust. Note: This is an incremental value that sums up with previous values in one alignment session. Azimuth/elevation value cannot be smaller(greater) than the minimum(maximum) step size value reported by the settings.

CmdLongitudinalAlignment()

void M_Alignment::IService::CmdLongitudinalAlignment ( std::string const &  ComponentId, M_Common::AngleDegreesType  Offset  )

virtual

Command to align longitudinally, i.e. in roll. Note: This operation should be chosen for plumb travel alignment.

Parameters

ComponentId	Identifies the device/component to be aligned.
Offset	Offset value to adjust [deg]. Note: This is an incremental value that sums up with previous values in one alignment session. Roll value cannot be smaller(greater) than the minimum(maximum) step size value reported by the settings.

CmdSaveAlignment()

void M_Alignment::IService::CmdSaveAlignment ( std::string const &  ComponentId )

virtual

Command to save the current alignment values.

Parameters

ComponentId

Identifies the device/component to be aligned.