List of all members | Public Types | Public Member Functions
ControllerBuilder< T > Class Template Reference

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

Public Types

using AronDTO = typename ControllerDescriptionType::AronDTO
 
using ControllerDescriptionType = ControllerDescription< T >
 

Public Member Functions

ControllerBuilder & allowReuse (const bool allowReuse)
 
AronDTO & config ()
 
 ControllerBuilder (const armarx::RobotUnitInterfacePrx &controllerCreator, const memory::config::Reader &configProvider, const memory::config::Writer &configWriter, const std::string &controllerNamePrefix)
 
std::optional< ControllerWrapper< T > > create ()
 Creates the controller with the default name. More...
 
std::optional< ControllerWrapper< T > > create (const std::string &name)
 
std::string getControllerName ()
 
ControllerBuilder & withConfig (const armarx::armem::MemoryID &memoryId)
 
ControllerBuilder & withConfig (const AronDTO &dto)
 
ControllerBuilder & withConfig (const std::filesystem::path &filename)
 
ControllerBuilder & withDefaultConfig (const std::string &name="default")
 
ControllerBuilder & withNamePrefix (const std::string &namePrefix)
 
ControllerBuilder & withNodeSet (const std::string &nodeSetName)
 

Detailed Description

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

Definition at line 51 of file ControllerBuilder.h.

Member Typedef Documentation

◆ AronDTO

using AronDTO = typename ControllerDescriptionType::AronDTO

Definition at line 57 of file ControllerBuilder.h.

◆ ControllerDescriptionType

using ControllerDescriptionType = ControllerDescription<T>

Definition at line 54 of file ControllerBuilder.h.

Constructor & Destructor Documentation

◆ ControllerBuilder()

ControllerBuilder ( const armarx::RobotUnitInterfacePrx &  controllerCreator,
const memory::config::Reader &  configProvider,
const memory::config::Writer &  configWriter,
const std::string &  controllerNamePrefix 
)
inline

Definition at line 64 of file ControllerBuilder.h.

Member Function Documentation

◆ allowReuse()

ControllerBuilder& allowReuse ( const bool  allowReuse)
inline

Definition at line 303 of file ControllerBuilder.h.

◆ config()

AronDTO& config ( )
inline

Definition at line 137 of file ControllerBuilder.h.

+ Here is the caller graph for this function:

◆ create() [1/2]

std::optional<ControllerWrapper<T> > create ( )
inline

Creates the controller with the default name.

Returns
std::optional<ControllerWrapper<AronDTO, ct>>

Definition at line 166 of file ControllerBuilder.h.

◆ create() [2/2]

std::optional<ControllerWrapper<T> > create ( const std::string &  name)
inline

Definition at line 174 of file ControllerBuilder.h.

+ Here is the call graph for this function:

◆ getControllerName()

std::string getControllerName ( )
inline

Definition at line 309 of file ControllerBuilder.h.

◆ withConfig() [1/3]

ControllerBuilder& withConfig ( const armarx::armem::MemoryID &  memoryId)
inline

Definition at line 94 of file ControllerBuilder.h.

◆ withConfig() [2/3]

ControllerBuilder& withConfig ( const AronDTO &  dto)
inline

Definition at line 130 of file ControllerBuilder.h.

◆ withConfig() [3/3]

ControllerBuilder& withConfig ( const std::filesystem::path &  filename)
inline

Definition at line 103 of file ControllerBuilder.h.

◆ withDefaultConfig()

ControllerBuilder& withDefaultConfig ( const std::string &  name = "default")
inline

Definition at line 79 of file ControllerBuilder.h.

◆ withNamePrefix()

ControllerBuilder& withNamePrefix ( const std::string &  namePrefix)
inline

Definition at line 152 of file ControllerBuilder.h.

◆ withNodeSet()

ControllerBuilder& withNodeSet ( const std::string &  nodeSetName)
inline

Definition at line 145 of file ControllerBuilder.h.

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