onboardapi  9.10.0
by Rheinmetall
M_GenericInputOutput::IClient Class Reference

Public Member Functions

virtual ~IClient ()
 
virtual void ReportInputOutputSettings (M_GenericInputOutput::InputOutputSettings const &Settings)
 
virtual void ReportInputOutputStatus (M_GenericInputOutput::InputOutputStatus const &Status, bool IsRemoved)
 
virtual void ReportRegister (std::string const &KeyId, M_Common::PropertyType const &Value, bool IsRemoved)
 
virtual void ReportActiveErrors (M_Common::StringListType const &ActiveErrors, bool IsRemoved)
 
virtual void EventDataReceived (M_GenericInputOutput::InputOutputData const &Data)
 

Detailed Description

GenericInputOutput client interface Contains callback operation from the generic input/output service to the client

Constructor & Destructor Documentation

◆ ~IClient()

M_GenericInputOutput::IClient::~IClient ( )
virtual

Member Function Documentation

◆ EventDataReceived()

void M_GenericInputOutput::IClient::EventDataReceived ( M_GenericInputOutput::InputOutputData const &  Data)
virtual

Event of read data by the interface service

Parameters
DataData read by the I/O interface

◆ ReportActiveErrors()

void M_GenericInputOutput::IClient::ReportActiveErrors ( M_Common::StringListType const &  ActiveErrors,
bool  IsRemoved 
)
virtual

Report all active errors

Parameters
ActiveErrorsList of all active errors
IsRemovedIndicates whether the errors are removed Note: If true, the errors are no longer present.

◆ ReportInputOutputSettings()

void M_GenericInputOutput::IClient::ReportInputOutputSettings ( M_GenericInputOutput::InputOutputSettings const &  Settings)
virtual

Report of generic I/O interface settings

Parameters
SettingsActive settings of the I/O interface

◆ ReportInputOutputStatus()

void M_GenericInputOutput::IClient::ReportInputOutputStatus ( M_GenericInputOutput::InputOutputStatus const &  Status,
bool  IsRemoved 
)
virtual

Report status of generic I/O interface

Parameters
StatusStatus of the generic I/O interface
IsRemovedIndicates whether the status is no longer present

◆ ReportRegister()

void M_GenericInputOutput::IClient::ReportRegister ( std::string const &  KeyId,
M_Common::PropertyType const &  Value,
bool  IsRemoved 
)
virtual

Report value of a register

Parameters
KeyIdIdentifier of the register
ValueValue of the register
IsRemovedIndicates whether the register value is removed