M_MultiMount::IClient Class Reference

Inheritance diagram for M_MultiMount::IClient:

Public Member Functions
virtual	~IClient ()
virtual void	ReportMountSettings (M_MultiMount::MountSettingsType const &Settings)
virtual void	ReportMountStatus (M_MultiMount::MountStatusType const &Status, bool IsRemoved)
virtual void	ReportAssignmentPosition (M_Common::PositionType const &AssignmentPosition)
virtual void	ReportAssignmentVelocity (M_Common::LinearVelocityOptionalType const &AssignmentVelocity)
Public Member Functions inherited from M_KinematicChain::IClient
virtual void	ReportKinematicChainSettings (M_KinematicChain::KinematicChainSettingsType const &Settings)
virtual void	ReportKinematicChainStatus (M_KinematicChain::KinematicChainStatusType const &Status, bool IsRemoved)
virtual void	ReportAxisRotationConstraints (M_KinematicChain::AxisRotationConstraintsListType const &AxisRotationConstraints)
virtual void	ReportAxisRotations (M_KinematicChain::AxisRotationListType const &AxisRotations)

Detailed Description

Mount Client interface. Contains callback operations from the Mount Service to the Client.

Constructor & Destructor Documentation

~IClient()

M_MultiMount::IClient::~IClient ( )

virtual

Reimplemented from M_KinematicChain::IClient.

Member Function Documentation

ReportAssignmentPosition()

void M_MultiMount::IClient::ReportAssignmentPosition ( M_Common::PositionType const &  AssignmentPosition )

virtual

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

Parameters

AssignmentPosition

Current assignment position

ReportAssignmentVelocity()

void M_MultiMount::IClient::ReportAssignmentVelocity ( M_Common::LinearVelocityOptionalType const &  AssignmentVelocity )

virtual

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

Parameters

AssignmentVelocity

Current assignment velocity.

ReportMountSettings()

void M_MultiMount::IClient::ReportMountSettings ( M_MultiMount::MountSettingsType const &  Settings )

virtual

Report with static Mount settings. This should be provided at startup and in the event of degraded functionality, e.g. due to an internal failure.

Parameters

Settings

Mount settings data.

ReportMountStatus()

void M_MultiMount::IClient::ReportMountStatus ( M_MultiMount::MountStatusType const &  Status, bool  IsRemoved  )

virtual

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

Parameters

Status	Current status data for Mount.
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.