onboardapi  9.10.0
by Rheinmetall
M_Mount::IClient Class Reference

Public Member Functions

virtual ~IClient ()
 
virtual void ReportMountSettings (M_Mount::MountSettingsType const &Settings)
 
virtual void ReportMountStatus (M_Mount::MountStatusType const &Status, bool IsRemoved)
 
virtual void ReportMountPosition (M_Mount::MountPositionType const &Pos)
 
virtual void ReportTgtAssignmentSearchOffset (M_Common::SphericalPositionType const &Offset)
 
virtual void ReportTgtAssignmentPosition (M_Common::PositionType const &Position)
 
virtual void ReportTgtAssignmentVelocity (M_Common::LinearVelocityOptionalType const &Velocity)
 

Detailed Description

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

Constructor & Destructor Documentation

◆ ~IClient()

M_Mount::IClient::~IClient ( )
virtual

Member Function Documentation

◆ ReportMountPosition()

void M_Mount::IClient::ReportMountPosition ( M_Mount::MountPositionType const &  Pos)
virtual

Report with current Mount position (e.g. Line of Sight) information. This should always be called with the latest status updates since the last report can be read by late joiners.

Parameters
PosCurrent Mount positional data.

◆ ReportMountSettings()

void M_Mount::IClient::ReportMountSettings ( M_Mount::MountSettingsType const &  Settings)
virtual

Report with static Mount settings. This will only be provided on startup and the values will not be changed during runtime.

Parameters
SettingsMount settings data.

◆ ReportMountStatus()

void M_Mount::IClient::ReportMountStatus ( M_Mount::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
StatusCurrent status data for Mount.
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.

◆ ReportTgtAssignmentPosition()

void M_Mount::IClient::ReportTgtAssignmentPosition ( M_Common::PositionType const &  Position)
virtual

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

Parameters
PositionThe current target position

◆ ReportTgtAssignmentSearchOffset()

void M_Mount::IClient::ReportTgtAssignmentSearchOffset ( M_Common::SphericalPositionType const &  Offset)
virtual

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

Parameters
OffsetThe current offset between Target Assignment position and line of sight.

◆ ReportTgtAssignmentVelocity()

void M_Mount::IClient::ReportTgtAssignmentVelocity ( M_Common::LinearVelocityOptionalType const &  Velocity)
virtual

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

Parameters
VelocityThe current target velocity