onboardapi  9.10.0
by Rheinmetall
M_GenericInputOutput::IService Class Reference

Public Member Functions

virtual ~IService ()
 
virtual void ConfigInterfaceProperties (std::string const &KeySource, M_GenericInputOutput::InputOutputConfiguration const &Config, bool IsRemoved)
 
virtual void CmdRead ()
 
virtual void CmdWriteData (M_GenericInputOutput::InputOutputData const &Data)
 
virtual void CmdReadRegister (std::string const &KeyId)
 
virtual void CmdWriteRegister (std::string const &KeyId, M_Common::PropertyType const &Value)
 
virtual void CmdStopWriting ()
 Command to stop writing. More...
 

Detailed Description

GenericInputOutput service interface Contains operations that a client can command the generic IO service to perform.

Constructor & Destructor Documentation

◆ ~IService()

M_GenericInputOutput::IService::~IService ( )
virtual

Member Function Documentation

◆ CmdRead()

void M_GenericInputOutput::IService::CmdRead ( )
virtual

Commands to read binary data Note: The service will perform a read operation on the I/O device and will provide the read data in the EventDataReceived operation to the client.

◆ CmdReadRegister()

void M_GenericInputOutput::IService::CmdReadRegister ( std::string const &  KeyId)
virtual

Commands to read a speicified register

Parameters
KeyIdIdentifier of the register

◆ CmdStopWriting()

void M_GenericInputOutput::IService::CmdStopWriting ( )
virtual

Command to stop writing.

◆ CmdWriteData()

void M_GenericInputOutput::IService::CmdWriteData ( M_GenericInputOutput::InputOutputData const &  Data)
virtual

Commands to write binary data to the interface

Parameters
DataBinary data to write to the interface

◆ CmdWriteRegister()

void M_GenericInputOutput::IService::CmdWriteRegister ( std::string const &  KeyId,
M_Common::PropertyType const &  Value 
)
virtual

Command to write to a specified register

Parameters
KeyIdIdentifier of the register
ValueValue to write

◆ ConfigInterfaceProperties()

void M_GenericInputOutput::IService::ConfigInterfaceProperties ( std::string const &  KeySource,
M_GenericInputOutput::InputOutputConfiguration const &  Config,
bool  IsRemoved 
)
virtual

Configure the interface properties

Parameters
KeySourceThe source of the configuration
ConfigThe configuration to be applied
IsRemovedIndicates if the configuration shall be removed