onboardapi  9.10.0
by Rheinmetall
M_AnalogueIo::IService Class Reference

Public Member Functions

virtual ~IService ()
 
virtual void ConfigSignalCorridor (std::string const &KeyName, M_AnalogueIo::SignalCorridorType const &Corridor, bool IsRemoved)
 
virtual void NotifySignal (std::string const &KeyName, M_AnalogueIo::SignalType const &Signal)
 

Detailed Description

Analogue input/output service interface. Contains operations that a client can command the analogue input/output service to perform.

Constructor & Destructor Documentation

◆ ~IService()

M_AnalogueIo::IService::~IService ( )
virtual

Member Function Documentation

◆ ConfigSignalCorridor()

void M_AnalogueIo::IService::ConfigSignalCorridor ( std::string const &  KeyName,
M_AnalogueIo::SignalCorridorType const &  Corridor,
bool  IsRemoved 
)
virtual

Configure a specified pin/channel's signal corridor.

Parameters
KeyNamePin or channel name.
CorridorSignal offset and bounds.
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.

◆ NotifySignal()

void M_AnalogueIo::IService::NotifySignal ( std::string const &  KeyName,
M_AnalogueIo::SignalType const &  Signal 
)
virtual

Set a specified pin/channel's signal data.

Parameters
KeyNamePin or channel name.
SignalSignal data.