onboardapi  9.10.0
by Rheinmetall
M_ObjectManager::IService Class Reference

Public Member Functions

virtual ~IService ()
 
virtual void RequestPosition (M_Common::ObjectIdType const &PosId, M_Common::PositionType const &SourcePosition, std::string const &TargetCoordinateFrame)
 
virtual void CmdAddUpdatePoint (M_Common::ObjectIdType const &KeyId, M_ObjectManager::PointObjectType const &Obj)
 
virtual void CmdModifyPoint (M_Common::ObjectIdType const &KeyId, M_ObjectManager::ModifyPointType const &Obj)
 
virtual void CmdAddUpdateMultiPoint (M_Common::ObjectIdType const &KeyId, M_ObjectManager::MultiPointObjectType const &Obj)
 
virtual void CmdModifyMultiPoint (M_Common::ObjectIdType const &KeyId, M_ObjectManager::ModifyMultiPointType const &Obj)
 
virtual void CmdRemove (M_Common::ObjectIdType const &KeyId)
 

Detailed Description

ObjectManager Service interface. Contains operations that a Client can use for CRUD operations to the ObjectManager Service.

Note: These functions should normally only be used for manual operations. Data from sensors should NOT be created or removed with the Service interface.

Constructor & Destructor Documentation

◆ ~IService()

M_ObjectManager::IService::~IService ( )
virtual

Member Function Documentation

◆ CmdAddUpdateMultiPoint()

void M_ObjectManager::IService::CmdAddUpdateMultiPoint ( M_Common::ObjectIdType const &  KeyId,
M_ObjectManager::MultiPointObjectType const &  Obj 
)
virtual

Cmd to add or replace an existing multi-point object. Note: If the object with the same ID already exists it will be replaced.

Parameters
KeyIdThe unique ID of the object.
ObjMulti-point object with positional data relative to own vehicle.

◆ CmdAddUpdatePoint()

void M_ObjectManager::IService::CmdAddUpdatePoint ( M_Common::ObjectIdType const &  KeyId,
M_ObjectManager::PointObjectType const &  Obj 
)
virtual

Cmd to add or replace an existing point object. Note: If the object with the same ID already exists it will be replaced.

Parameters
KeyIdThe unique ID of the object.
ObjPoint object with positional data relative to own vehicle.

◆ CmdModifyMultiPoint()

void M_ObjectManager::IService::CmdModifyMultiPoint ( M_Common::ObjectIdType const &  KeyId,
M_ObjectManager::ModifyMultiPointType const &  Obj 
)
virtual

Cmd to modify an existing multi-point object. Note: This command can only be used to modify an already existing object.

Parameters
KeyIdThe unique ID of the object.
ObjThe data to modify for an existing multi-point object.

◆ CmdModifyPoint()

void M_ObjectManager::IService::CmdModifyPoint ( M_Common::ObjectIdType const &  KeyId,
M_ObjectManager::ModifyPointType const &  Obj 
)
virtual

Cmd to modify an existing point object. Note: This command can only be used to modify an already existing object.

Parameters
KeyIdThe unique ID of the object.
ObjThe data to modify for an existing point object.

◆ CmdRemove()

void M_ObjectManager::IService::CmdRemove ( M_Common::ObjectIdType const &  KeyId)
virtual

Cmd to remove an existing object. Note: This can be used to remove a relative point, sector or polygon object.

Parameters
KeyIdThe unique ID of the object.

◆ RequestPosition()

void M_ObjectManager::IService::RequestPosition ( M_Common::ObjectIdType const &  PosId,
M_Common::PositionType const &  SourcePosition,
std::string const &  TargetCoordinateFrame 
)
virtual

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

Parameters
PosIdThe unique ID of the position. The same ID will be used in the response from the service.
SourcePositionPosition relative to a specified source coordinate frame.
TargetCoordinateFrameIdentifies the coordinate frame in which the resulting position vector should be resolved.