ControllerWrapperBase Class Reference

The base class for the ControllerWrapper which allows the private implementation to be in the .cpp file. More...

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

Inheritance diagram for ControllerWrapperBase:

Public Types
using	ControllerPrx = armarx::control::ConfigurableNJointControllerInterfacePrx

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

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

Detailed Description

The base class for the ControllerWrapper which allows the private implementation to be in the .cpp file.

Definition at line 44 of file ControllerWrapper.h.

Member Typedef Documentation

ControllerPrx

using ControllerPrx = armarx::control::ConfigurableNJointControllerInterfacePrx

Definition at line 47 of file ControllerWrapper.h.

Constructor & Destructor Documentation

ControllerWrapperBase() [1/2]

ControllerWrapperBase ( )

delete

Here is the call graph for this function:

Here is the caller graph for this function:

ControllerWrapperBase() [2/2]

ControllerWrapperBase	(	const ControllerPrx &	controller,
		const std::string &	controllerName,
		const std::string &	controllerTypeName,
		const memory::config::Writer &	configWriter )

Constructor for the ControllerWrapperBase class.

Parameters

controller	The controller object.
controllerName	The name of the controller.
controllerTypeName	The type name of the controller.
configWriter	The configuration writer object.

Definition at line 38 of file ControllerWrapper.cpp.

~ControllerWrapperBase()

~ControllerWrapperBase

(

)

Destructor for the ControllerWrapperBase class.

When invoked, the controller is deactivated and deleted unless being daemonized.

Definition at line 49 of file ControllerWrapper.cpp.

Here is the call graph for this function:

Member Function Documentation

activate()

void activate

(

)

Requests the activation of the controller in the RobotUnit.

Definition at line 79 of file ControllerWrapper.cpp.

ctrl()

ControllerWrapperBase::ControllerPrx & ctrl

(

)

Returns the "raw" controller object.

Returns

The controller object.

Definition at line 109 of file ControllerWrapper.cpp.

Here is the caller graph for this function:

daemonize()

void daemonize

(

bool

daemonize = true

)

Sets whether the controller should be daemonized.

Parameters

daemonize

Flag indicating whether to daemonize the controller.

Definition at line 102 of file ControllerWrapper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

deactivate()

void deactivate

(

)

Requests the deactivation of the controller in the RobotUnit.

Definition at line 94 of file ControllerWrapper.cpp.

isActive()

bool isActive

(

)

Check the status of the controller.

Definition at line 87 of file ControllerWrapper.cpp.

updateConfig()

void updateConfig ( const armarx::aron::codegenerator::cpp::AronGeneratedObjectBase & config )

protected

Updates the configuration of the controller.

This update is two-fold:

1. The configuration is sent to the controller in the RobotUnit.
2. The configuration is written to the memory (via the the configuration writer).

Parameters

config

The configuration object.

Definition at line 116 of file ControllerWrapper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• armarx/control/client/ControllerWrapper.h
• armarx/control/client/ControllerWrapper.cpp