BipedalLocomotion::IK::R3Task class
#include <BipedalLocomotion/IK/R3Task.h>

R3Task is a concrete implementation of the Task.

Please use this element if you want to control the position of a given frame rigidly attached to the robot. The task assumes perfect control of the robot velocity that contains the base linear and angular velocity expressed in mixed representation and the joint velocities. The task represents the following equation

where is the linear part robot jacobian and is the desired velocity. The desired velocity is chosen such that the frame position will asymptotically converge to the desired trajectory and is computed with a standard Proportional controller in .

Base classes

struct IKLinearTask: IKLinearTask specializes a LinearTask in the case of Inverse Kinematics.
struct BipedalLocomotion::System::ITaskControllerManager: ITaskControllerManager is an interface that can help you to handle tasks containing controllers.

Public types

using Mode = System::ITaskControllerManager::Mode

Public functions

auto initialize(std::weak_ptr<const ParametersHandler::IParametersHandler> paramHandler) -> bool override: Initialize the task.
auto setKinDyn(std::shared_ptr<iDynTree::KinDynComputations> kinDyn) -> bool override: Set the kinDynComputations object.
auto setVariablesHandler(const System::VariablesHandler& variablesHandler) -> bool override: Set the set of variables required by the task.
auto update() -> bool override: Update the content of the element.
auto setSetPoint(Eigen::Ref<const Eigen::Vector3d> I_p_F, Eigen::Ref<const Eigen::Vector3d> velocity = Eigen::Vector3d::Zero()) -> bool: Set the desired set-point of the trajectory.
auto size() const -> std::size_t override: Get the size of the task.
auto type() const -> Type override: The SE3Task is an equality task.
auto isValid() const -> bool override: Determines the validity of the objects retrieved with getA() and getB()
void setTaskControllerMode(Mode mode) override: Set the task controller mode.
auto getTaskControllerMode() const -> Mode override: Get the task controller mode.

Function documentation

bool BipedalLocomotion::IK::R3Task::initialize(std::weak_ptr<const ParametersHandler::IParametersHandler> paramHandler) override

Initialize the task.

Parameters
paramHandler	pointer to the parameters handler.
Returns	True in case of success, false otherwise. Where the generalized robot velocity is a vector containing the base spatial-velocity (expressed in mixed representation) and the joint velocities.

Note

the following parameters are required by the class

Parameter Name	Type	Description	Mandatory
`robot_velocity_variable_name`	`string`	Name of the variable contained in `VariablesHandler` describing the robot velocity	Yes
`frame_name`	`string`	Name of the frame controlled by the SE3Task	Yes
`kp_linear`	`double` or `vector<double>`	Gain of the position controller	Yes
`mask`	`vector<bool>`	Mask representing the linear DoFs controlled. E.g. [1,0,1] will enable the control on the x and z coordinates only. (Default value, [1,1,1])	No

bool BipedalLocomotion::IK::R3Task::setKinDyn(std::shared_ptr<iDynTree::KinDynComputations> kinDyn) override

Set the kinDynComputations object.

Parameters
kinDyn	pointer to a kinDynComputations object.
Returns	True in case of success, false otherwise.

bool BipedalLocomotion::IK::R3Task::setVariablesHandler(const System::VariablesHandler& variablesHandler) override

Set the set of variables required by the task.

Parameters
variablesHandler	reference to a variables handler.
Returns	True in case of success, false otherwise.

The variables are stored in the System::VariablesHandler.

bool BipedalLocomotion::IK::R3Task::update() override

Update the content of the element.

Returns	True in case of success, false otherwise.

bool BipedalLocomotion::IK::R3Task::setSetPoint(Eigen::Ref<const Eigen::Vector3d> I_p_F, Eigen::Ref<const Eigen::Vector3d> velocity = Eigen::Vector3d::Zero())

Set the desired set-point of the trajectory.

Parameters
I_p_F	position of the origin of the frame with respect to the inertial frame.
velocity
Returns	True in case of success, false otherwise.

std::size_t BipedalLocomotion::IK::R3Task::size() const override

Get the size of the task.

Returns	the size of the task.

(I.e the number of rows of the vector b)

Type BipedalLocomotion::IK::R3Task::type() const override

The SE3Task is an equality task.

Returns	the size of the task.

bool BipedalLocomotion::IK::R3Task::isValid() const override

Determines the validity of the objects retrieved with getA() and getB()

Returns	True if the objects are valid, false otherwise.

void BipedalLocomotion::IK::R3Task::setTaskControllerMode(Mode mode) override

Set the task controller mode.

Please use this method to disable/enable the Proportional controller implemented in this task.

Mode BipedalLocomotion::IK::R3Task::getTaskControllerMode() const override

Get the task controller mode.

Returns	the state of the controller