onboardapi  9.10.0
by Rheinmetall
M_ObjectManager::IClient Class Reference

Public Member Functions

virtual ~IClient ()
 
virtual void ReportObjectManagerSettings (M_ObjectManager::ObjectManagerSettingsType const &Settings)
 
virtual void ResponsePosition (M_Common::ObjectIdType const &PosId, M_Common::PositionType const &TargetPosition)
 
virtual void ReportOwnInfo (std::string const &KeyPlatformId, M_ObjectManager::OwnInfoType const &Obj, bool IsRemoved)
 
virtual void ReportPoint (M_Common::ObjectIdType const &KeyId, M_ObjectManager::PointObjectType const &Obj, bool IsRemoved)
 
virtual void ReportMultiPoint (M_Common::ObjectIdType const &KeyId, M_ObjectManager::MultiPointObjectType const &Obj, bool IsRemoved)
 
virtual void ReportCoordinateTransformations (M_Common::CoordinateTransformationListType const &CoordinateTransformationList, bool IsRemoved)
 
virtual void EventObjectChanged (M_Common::ObjectIdType const &KeyId, M_ObjectManager::ParameterDifferenceType const &Difference)
 

Detailed Description

ObjectManager Client interface. Contains operations from the ObjectManager Service to the Client(s).

Constructor & Destructor Documentation

◆ ~IClient()

M_ObjectManager::IClient::~IClient ( )
virtual

Member Function Documentation

◆ EventObjectChanged()

void M_ObjectManager::IClient::EventObjectChanged ( M_Common::ObjectIdType const &  KeyId,
M_ObjectManager::ParameterDifferenceType const &  Difference 
)
virtual

Reports changes to the specified object's data upon the occurrence of that change.

Parameters
KeyIdThe unique ID of the object.
DifferenceChange in object parameters.

◆ ReportCoordinateTransformations()

void M_ObjectManager::IClient::ReportCoordinateTransformations ( M_Common::CoordinateTransformationListType const &  CoordinateTransformationList,
bool  IsRemoved 
)
virtual

Reports a list of the transformations between specified coordinate frames.

Parameters
CoordinateTransformationListList of coordinate transformations.
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.

◆ ReportMultiPoint()

void M_ObjectManager::IClient::ReportMultiPoint ( M_Common::ObjectIdType const &  KeyId,
M_ObjectManager::MultiPointObjectType const &  Obj,
bool  IsRemoved 
)
virtual

Reports a multi-point object.

Parameters
KeyIdThe unique ID of the object.
ObjMulti-point object with positional data.
IsRemovedIndicates if the object no longer exists. Note: After this has been set to true, the object will no longer be available to late joiners.

◆ ReportObjectManagerSettings()

void M_ObjectManager::IClient::ReportObjectManagerSettings ( M_ObjectManager::ObjectManagerSettingsType const &  Settings)
virtual

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

Parameters
SettingsObject Manager settings data.

◆ ReportOwnInfo()

void M_ObjectManager::IClient::ReportOwnInfo ( std::string const &  KeyPlatformId,
M_ObjectManager::OwnInfoType const &  Obj,
bool  IsRemoved 
)
virtual

Reports information relating to own vehicle.

Parameters
KeyPlatformIdIdentifies the platform whose navigation data is being reported. Note: This should correspond to its navigation service name.
ObjInformation relating to own vehicle. Contains information such as position, heading, unit name etc for own vehicle.
IsRemovedIndicates if the status no longer exists. Note: After this has been set to true, the status will no longer be available to late joiners.

◆ ReportPoint()

void M_ObjectManager::IClient::ReportPoint ( M_Common::ObjectIdType const &  KeyId,
M_ObjectManager::PointObjectType const &  Obj,
bool  IsRemoved 
)
virtual

Reports a point object.

Parameters
KeyIdThe unique ID of the object.
ObjPoint object with positional data.
IsRemovedIndicates if the object no longer exists. Note: After this has been set to true, the object will no longer be available to late joiners.

◆ ResponsePosition()

void M_ObjectManager::IClient::ResponsePosition ( M_Common::ObjectIdType const &  PosId,
M_Common::PositionType const &  TargetPosition 
)
virtual

Response to a request for the service to transform a position from one coordinate frame to another.

Parameters
PosIdThe unique ID of the position. This is the same ID provided in the request from the client.
TargetPositionCoordinates relative to the specified target coordinate frame in the request.