onboardapi  9.10.0
by Rheinmetall
M_ActuationCtrl::IService Class Reference
Inheritance diagram for M_ActuationCtrl::IService:
M_Manipulator::IService

Public Member Functions

virtual ~IService ()
 
virtual void CmdIsActuationAlive ()
 
virtual void ConfigActuationComponentReference (std::string const &KeyId, M_ActuationCtrl::ActuationCommandType const &ReferenceState, bool StorePersistently, bool IsRemoved)
 
virtual void NotifyActuationComponentCommand (std::string const &KeyId, M_ActuationCtrl::ActuationCommandType const &Command)
 

Detailed Description

Actuator control service interface. Contains operations that a client can command the actuation control service to perform.

Constructor & Destructor Documentation

◆ ~IService()

M_ActuationCtrl::IService::~IService ( )
virtual

Reimplemented in M_Manipulator::IService.

Member Function Documentation

◆ CmdIsActuationAlive()

void M_ActuationCtrl::IService::CmdIsActuationAlive ( )
virtual

Command to check if actuation control service is alive. If the service is not available, then an exception will be thrown.

◆ ConfigActuationComponentReference()

void M_ActuationCtrl::IService::ConfigActuationComponentReference ( std::string const &  KeyId,
M_ActuationCtrl::ActuationCommandType const &  ReferenceState,
bool  StorePersistently,
bool  IsRemoved 
)
virtual

Notify to set the reference state of a specific actuation component.

Parameters
KeyIdIdentifies the actuation component.
ReferenceStateActuation component reference state.
StorePersistentlyIndicates whether to store the reference state persistently.
IsRemoved

◆ NotifyActuationComponentCommand()

void M_ActuationCtrl::IService::NotifyActuationComponentCommand ( std::string const &  KeyId,
M_ActuationCtrl::ActuationCommandType const &  Command 
)
virtual

Notify to command value of a specific actuation component.

Parameters
KeyIdIdentifies the actuation component.
CommandActuation component input.