M_VideoTrackerLosCtrl::IClient Class Reference

Public Member Functions
virtual	~IClient ()
virtual void	ReportLosCtrlStatus (M_VideoTracker::LosCtrlStatusType const &LosCtrlStatus, bool IsRemoved)
virtual void	ReportRate (M_Common::AngularVelocityType const &AngularVelocity, bool IsCoasting, bool IsRemoved)
virtual void	ReportPosError (M_Common::PositionType const &PosError, bool IsCoasting, bool IsRemoved)
virtual void	ReportMaxCenteringRate (M_Common::AngularVelocityType const &AngularVelocity)
virtual void	ReportApd (M_Common::PositionType const &ApdOffset)

Detailed Description

Line-of-Sight Control (LOS) Client interface. Contains callback operations from the Line-of-Sight Control (LOS) Service to the Client.

Constructor & Destructor Documentation

~IClient()

M_VideoTrackerLosCtrl::IClient::~IClient ( )

virtual

Member Function Documentation

ReportApd()

void M_VideoTrackerLosCtrl::IClient::ReportApd ( M_Common::PositionType const &  ApdOffset )

virtual

Report current aim point offset, which was set by APD commands.

Parameters

ApdOffset

Current offset between leading object centre and aligned image centre point.

ReportLosCtrlStatus()

void M_VideoTrackerLosCtrl::IClient::ReportLosCtrlStatus ( M_VideoTracker::LosCtrlStatusType const &  LosCtrlStatus, bool  IsRemoved  )

virtual

Report with the current LoS-Ctrl VideoTracker status. This will be continually updated every time a value is changed.

Parameters

LosCtrlStatus	Current status of the LoS client.
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.

ReportMaxCenteringRate()

void M_VideoTrackerLosCtrl::IClient::ReportMaxCenteringRate ( M_Common::AngularVelocityType const &  AngularVelocity )

virtual

Report current maximum centring rate. Note: This value can be used to command the Mount Service to limit the centring rate in the image plane.

Parameters

AngularVelocity

Angular velocity (rotational speed) around the X, Y, Z axes.

ReportPosError()

void M_VideoTrackerLosCtrl::IClient::ReportPosError ( M_Common::PositionType const &  PosError, bool  IsCoasting, bool  IsRemoved  )

virtual

Report position error between leading object and aim point. Note: This value can be used in a mount control loop to hold the LoS on the leading object.

Parameters

PosError	Difference of currently followed object with regard to aligned image centre + aim point offset.
IsCoasting	Coasting flag.
IsRemoved	Indicates if the leading track is no longer available. Note: Whenever this report is available the VideoTracker has valid data to lead a mount.

ReportRate()

void M_VideoTrackerLosCtrl::IClient::ReportRate ( M_Common::AngularVelocityType const &  AngularVelocity, bool  IsCoasting, bool  IsRemoved  )

virtual

Report current angular velocity. Note: This value can be used to command the Mount Service to hold the LoS on the leading object.

Parameters

AngularVelocity	Angular velocity (rotational speed) around the X, Y, Z axes.
IsCoasting	Coasting flag.
IsRemoved	Indicates if the leading track is no longer available. Note: Whenever this report is available the VideoTracker has valid data to lead a mount.