ControllerWrapper< T > Class Template Reference

Wrapper class for an NJointController proxy. More...

#include <armarx/control/client/ControllerWrapper.h>

+ Inheritance diagram for ControllerWrapper< T >:

Public Types

using AronConfigT = typename ControllerDescriptionType::AronDTO
 
using Base = detail::ControllerWrapperBase
 
using ControllerDescriptionType = ControllerDescription< T >
 
- Public Types inherited from ControllerWrapperBase
using ControllerPrx = armarx::control::ConfigurableNJointControllerInterfacePrx
 

Public Member Functions

 ControllerWrapper ()=delete
 
 ControllerWrapper (const ControllerPrx &controller, const std::string &controllerName, const memory::config::Writer &configWriter, AronConfigT config)
 Constructor for ControllerWrapper. More...
 
 ControllerWrapper (const ControllerWrapper &)=delete
 
AronConfigT getConfig ()
 
ControllerWrapperoperator= (ControllerWrapper const &)=delete
 
void updateConfig ()
 Updates the configuration of the controller. More...
 
- Public Member Functions inherited from ControllerWrapperBase
void activate ()
 Requests the activation of the controller in the RobotUnit. More...
 
 ControllerWrapperBase ()=delete
 
 ControllerWrapperBase (const ControllerPrx &controller, const std::string &controllerName, const std::string &controllerTypeName, const memory::config::Writer &configWriter)
 Constructor for the ControllerWrapperBase class. More...
 
ControllerPrxctrl ()
 Returns the "raw" controller object. More...
 
void daemonize (bool daemonize=true)
 Sets whether the controller should be daemonized. More...
 
void deactivate ()
 Requests the deactivation of the controller in the RobotUnit. More...
 
bool isActive ()
 Check the status of the controller. More...
 
 ~ControllerWrapperBase ()
 Destructor for the ControllerWrapperBase class. More...
 

Public Attributes

AronConfigT config
 

Additional Inherited Members

- Protected Member Functions inherited from ControllerWrapperBase
void updateConfig (const armarx::aron::codegenerator::cpp::AronGeneratedObjectBase &config)
 Updates the configuration of the controller. More...
 

Detailed Description

template<auto T>
class armarx::control::client::ControllerWrapper< T >

Wrapper class for an NJointController proxy.

This class provides a wrapper for a controller, allowing easy access and life-cicle management. It holds the controller configuration which can be modified and updated accordingly.

Template Parameters
TThe type of the controller description.

Definition at line 127 of file ControllerWrapper.h.

Member Typedef Documentation

◆ AronConfigT

using AronConfigT = typename ControllerDescriptionType::AronDTO

Definition at line 131 of file ControllerWrapper.h.

◆ Base

Definition at line 136 of file ControllerWrapper.h.

◆ ControllerDescriptionType

Constructor & Destructor Documentation

◆ ControllerWrapper() [1/3]

ControllerWrapper ( )
delete

◆ ControllerWrapper() [2/3]

ControllerWrapper ( const ControllerWrapper< T > &  )
delete

◆ ControllerWrapper() [3/3]

ControllerWrapper ( const ControllerPrx controller,
const std::string &  controllerName,
const memory::config::Writer &  configWriter,
AronConfigT  config 
)
inline

Constructor for ControllerWrapper.

Parameters
controllerThe NJointController controller proxy.
controllerNameThe name of the controller.
configWriterThe configuration writer used to store the controller configs in the memory.
configThe initial configuration for the controller.

Definition at line 152 of file ControllerWrapper.h.

Member Function Documentation

◆ getConfig()

AronConfigT getConfig ( )
inline

Definition at line 176 of file ControllerWrapper.h.

+ Here is the call graph for this function:

◆ operator=()

ControllerWrapper& operator= ( ControllerWrapper< T > const &  )
delete

◆ updateConfig()

void updateConfig ( )
inline

Updates the configuration of the controller.

Definition at line 171 of file ControllerWrapper.h.

+ Here is the call graph for this function:

Member Data Documentation

◆ config

AronConfigT config

Definition at line 164 of file ControllerWrapper.h.


The documentation for this class was generated from the following file: