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

Public Member Functions

virtual ~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)
 

Detailed Description

Coordinate frame client interface. Contains callback operations from the coordinate frame service to the client.

Constructor & Destructor Documentation

◆ ~IClient()

M_CoordinateFrame::IClient::~IClient ( )
virtual

Reimplemented in M_Manipulator::IClient.

Member Function Documentation

◆ ReportAngularAccelerations()

void M_CoordinateFrame::IClient::ReportAngularAccelerations ( std::string const &  KeyId,
M_Common::AngularAccelerationListType const &  AngularAccelerationList,
bool  IsRemoved 
)
virtual

Report angular acceleration in different coordinate frames.

Parameters
KeyIdIdentifies the moving entity associated with the angular acceleration. Note: This may also be the service name of another network participant. In this case, this associates the data with the device to which the service name belongs.
AngularAccelerationListAngular acceleration in different coordinate frames.
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.

◆ ReportAngularVelocities()

void M_CoordinateFrame::IClient::ReportAngularVelocities ( std::string const &  KeyId,
M_Common::AngularVelocityListType const &  AngularVelocityList,
bool  IsRemoved 
)
virtual

Report angular velocity in different coordinate frames.

Parameters
KeyIdIdentifies the moving entity associated with the angular velocity. Note: This may also be the service name of another network participant. In this case, this associates the data with the device to which the service name belongs.
AngularVelocityListAngular velocity in different coordinate frames.
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.

◆ ReportAttitudes()

void M_CoordinateFrame::IClient::ReportAttitudes ( std::string const &  KeyId,
M_Common::AttitudeListType const &  AttitudeList,
bool  IsRemoved 
)
virtual

Report attitude in different coordinate frames.

Parameters
KeyIdIdentifies the moving entity associated with the attitude. Note: This may also be the service name of another network participant. In this case, this associates the data with the device to which the service name belongs.
AttitudeListAttitude in different coordinate frames.
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.

◆ ReportCoordinateFrameSettings()

void M_CoordinateFrame::IClient::ReportCoordinateFrameSettings ( M_CoordinateFrame::CoordinateFrameSettingsType const &  Settings)
virtual

Report coordinate frame static settings.

Parameters
SettingsCoordinate frame settings.

◆ ReportCoordinateFrameStatus()

void M_CoordinateFrame::IClient::ReportCoordinateFrameStatus ( M_CoordinateFrame::CoordinateFrameStatusType const &  Status,
bool  IsRemoved 
)
virtual

Report current coordinate frame status.

Parameters
StatusCoordinateFrame status data.
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.

◆ ReportCoordinateTransformations()

void M_CoordinateFrame::IClient::ReportCoordinateTransformations ( std::string const &  KeyId,
M_Common::CoordinateTransformationListType const &  TransformationList,
bool  IsRemoved 
)
virtual

Report coordinate transformation in different coordinate system.

Parameters
KeyIdIdentifies the moving entity associated with the coordinate transformation. Note: This may also be the service name of another network participant. In this case, this associates the data with the device to which the service name belongs.
TransformationListTransformation specification in different coordinate frames.
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.

◆ ReportLinearAccelerations()

void M_CoordinateFrame::IClient::ReportLinearAccelerations ( std::string const &  KeyId,
M_Common::LinearAccelerationListType const &  LinearAccelerationList,
bool  IsRemoved 
)
virtual

Report linear acceleration in different coordinate frames.

Parameters
KeyIdIdentifies the moving entity associated with the linear acceleration. Note: This may also be the service name of another network participant. In this case, this associates the data with the device to which the service name belongs.
LinearAccelerationListLinear acceleration in different coordinate frames.
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.

◆ ReportLinearVelocities()

void M_CoordinateFrame::IClient::ReportLinearVelocities ( std::string const &  KeyId,
M_Common::LinearVelocityListType const &  LinearVelocityList,
bool  IsRemoved 
)
virtual

Report linear velocity in different coordinate frames.

Parameters
KeyIdIdentifies the moving entity associated with the linear velocity. Note: This may also be the service name of another network participant. In this case, this associates the data with the device to which the service name belongs.
LinearVelocityListLinear velocity in different coordinate frames.
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.

◆ ReportPositions()

void M_CoordinateFrame::IClient::ReportPositions ( std::string const &  KeyId,
M_Common::PositionListType const &  PositionList,
bool  IsRemoved 
)
virtual

Report position in different coordinate frames.

Parameters
KeyIdIdentifies the moving entity associated with the position. Note: This may also be the service name of another network participant. In this case, this associates the data with the device to which the service name belongs.
PositionListPosition in different coordinate frames.
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.