onboardapi  9.10.0
by Rheinmetall
M_VideoObjectExport::IClient Class Reference

Public Member Functions

virtual ~IClient ()
 
virtual void ReportVideoObjectSettings (M_VideoObjectExport::VideoObjectSettingsType const &Settings)
 
virtual void ReportMountPosition (std::string const &KeyMountName, M_Common::StringListType const &VideoChannelList, M_Common::AngleDegreesType Azimuth, M_Common::AngleDegreesType Elevation, bool IsRemoved)
 
virtual void ReportCameraZoomFovRegion (std::string const &VideoChannel, M_Common::AngleDegreesType FovHorizontal, M_Common::AngleDegreesType FovVertical)
 
virtual void ReportMarkerObject (M_Common::ObjectIdType const &KeyId, M_VideoObjectExport::MarkerObjectType const &MarkerObject, bool IsRemoved)
 
virtual void ReportKinematicData (M_VideoObjectExport::KinematicInfoType const &Kinematics)
 

Detailed Description

Client interface. Contains callback operations from the Video Object Export Service to the Client.

Constructor & Destructor Documentation

◆ ~IClient()

M_VideoObjectExport::IClient::~IClient ( )
virtual

Member Function Documentation

◆ ReportCameraZoomFovRegion()

void M_VideoObjectExport::IClient::ReportCameraZoomFovRegion ( std::string const &  VideoChannel,
M_Common::AngleDegreesType  FovHorizontal,
M_Common::AngleDegreesType  FovVertical 
)
virtual

Report the current Camera Field of View used for a Video Channel.

Parameters
VideoChannelName of Video Channel for which the Field of View applies.
FovHorizontalCamera Field of View Horizontal.
FovVerticalCamera Field of View Vertical.

◆ ReportKinematicData()

void M_VideoObjectExport::IClient::ReportKinematicData ( M_VideoObjectExport::KinematicInfoType const &  Kinematics)
virtual

Reports kinematic information relating to own vehicle/platform.

Parameters
KinematicsKinematic information relating to own vehicle/platform. Contains information such as position, velocity, heading, etc for own vehicle/platform.

◆ ReportMarkerObject()

void M_VideoObjectExport::IClient::ReportMarkerObject ( M_Common::ObjectIdType const &  KeyId,
M_VideoObjectExport::MarkerObjectType const &  MarkerObject,
bool  IsRemoved 
)
virtual

Report the current Marker data (with positional data for the marker in one or more Video Channels).

Parameters
KeyIdObject Id of Marker.
MarkerObjectData for Marker object.
IsRemovedIndicates if Marker has been removed (true) and no longer exists, otherwise false

◆ ReportMountPosition()

void M_VideoObjectExport::IClient::ReportMountPosition ( std::string const &  KeyMountName,
M_Common::StringListType const &  VideoChannelList,
M_Common::AngleDegreesType  Azimuth,
M_Common::AngleDegreesType  Elevation,
bool  IsRemoved 
)
virtual

Report the current Azimuth and Elevation of the Sight System used for a Video Channel.

Parameters
KeyMountNameName of Mount which has moved.
VideoChannelListList of Video Channels for which the Mount position applies.
AzimuthAzimuth position of Mount (in degrees).
ElevationElevation position of Mount (in degrees).
IsRemovedIndicates if the payload is no longer available Note: This will always be set to true when the instance has been shut down After this has been set to true, the payload will no longer be available to late joiners.

◆ ReportVideoObjectSettings()

void M_VideoObjectExport::IClient::ReportVideoObjectSettings ( M_VideoObjectExport::VideoObjectSettingsType const &  Settings)
virtual

Static settings for the service reported once on startup.

Parameters
SettingsConfigured settings for the Video Object Export Service.