onboardapi  9.10.0
by Rheinmetall
M_Manipulator::IClient Class Reference
Inheritance diagram for M_Manipulator::IClient:
M_CoordinateFrame::IClient M_KinematicChain::IClient M_ActuationCtrl::IClient

Public Member Functions

virtual ~IClient ()
 
virtual void ReportManipulatorSettings (M_Manipulator::ManipulatorSettingsType const &Settings)
 
virtual void ReportManipulatorStatus (M_Manipulator::ManipulatorStatusType const &Status, bool IsRemoved)
 
virtual void ReportLinkStatus (std::string const &LinkId, M_Manipulator::LinkStatusType const &Status)
 
- Public Member Functions inherited from M_CoordinateFrame::IClient
virtual void ReportCoordinateFrameSettings (M_CoordinateFrame::CoordinateFrameSettingsType const &Settings)
 
virtual void ReportCoordinateFrameStatus (M_CoordinateFrame::CoordinateFrameStatusType const &Status, bool IsRemoved)
 
virtual void ReportCoordinateTransformations (std::string const &KeyId, M_Common::CoordinateTransformationListType const &TransformationList, bool IsRemoved)
 
virtual void ReportPositions (std::string const &KeyId, M_Common::PositionListType const &PositionList, bool IsRemoved)
 
virtual void ReportAttitudes (std::string const &KeyId, M_Common::AttitudeListType const &AttitudeList, bool IsRemoved)
 
virtual void ReportLinearVelocities (std::string const &KeyId, M_Common::LinearVelocityListType const &LinearVelocityList, bool IsRemoved)
 
virtual void ReportAngularVelocities (std::string const &KeyId, M_Common::AngularVelocityListType const &AngularVelocityList, bool IsRemoved)
 
virtual void ReportLinearAccelerations (std::string const &KeyId, M_Common::LinearAccelerationListType const &LinearAccelerationList, bool IsRemoved)
 
virtual void ReportAngularAccelerations (std::string const &KeyId, M_Common::AngularAccelerationListType const &AngularAccelerationList, bool IsRemoved)
 
- 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)
 
- Public Member Functions inherited from M_ActuationCtrl::IClient
virtual void ReportActuationCtrlSettings (M_ActuationCtrl::ActuationCtrlSettingsType const &Settings)
 
virtual void ReportActuationComponentStatus (std::string const &KeyId, M_ActuationCtrl::ActuationStatusType const &Status, bool IsRemoved)
 

Detailed Description

Manipulator client interface. Contains callback operations from the manipulator service to the client.

Constructor & Destructor Documentation

◆ ~IClient()

M_Manipulator::IClient::~IClient ( )
virtual

Reimplemented from M_ActuationCtrl::IClient.

Member Function Documentation

◆ ReportLinkStatus()

void M_Manipulator::IClient::ReportLinkStatus ( std::string const &  LinkId,
M_Manipulator::LinkStatusType const &  Status 
)
virtual

Report current status of a specific link.

Parameters
LinkIdIdentifies the link.
StatusLink status.

◆ ReportManipulatorSettings()

void M_Manipulator::IClient::ReportManipulatorSettings ( M_Manipulator::ManipulatorSettingsType const &  Settings)
virtual

Report static manipulator settings.

Parameters
SettingsManipulator settings.

◆ ReportManipulatorStatus()

void M_Manipulator::IClient::ReportManipulatorStatus ( M_Manipulator::ManipulatorStatusType const &  Status,
bool  IsRemoved 
)
virtual

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

Parameters
StatusCurrent status data of the manipulator.
IsRemovedIndicates 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.