AdmittanceControllerParams Struct

Struct representing admittance controller parameters. More...

Declaration

struct AdmittanceControllerParams { ... }

Included Headers

#include <set_admittance_parameters.hpp>

Public Member Functions Index

std::string	getParamDimensionStr (const size_t idx) const
	Helper function to convert index to a dimension (position or rotation) an axis (x, y, or z). More...
std::string	getParamLimitStr (const double vmin, const double vmax) const
std::string	validateVectorParameter (std::string_view name, const std::vector< double > &vec, const std::pair< double, double > &pos_limits, const std::pair< double, double > &rot_limits) const
	Helper function to validate a 6-element vector admittance parameter. More...
tl::expected< void, std::string >	validate () const
	Validates the numeric parameter values against their limits. More...

Public Member Attributes Index

std::string	end_effector_frame = ""
	End effector frame used for kinematics calculation. More...
std::string	control_frame = ""
	Admittance control frame. More...
std::vector< bool >	enabled_axes { false, false, false, false, false }
	Enabled admittance axes (x, y, z, rx, ry, rz). More...
std::vector< double >	mass { 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 }
	Admittance control mass (x, y, z, rx, ry, rz), with limits. More...
std::pair< double, double >	mass_position_limits { 0.0, 0.0 }
std::pair< double, double >	mass_rotation_limits { 0.0, 0.0 }
std::vector< double >	stiffness { 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 }
	Admittance control stiffness (x, y, z, rx, ry, rz), with limits. More...
std::pair< double, double >	stiffness_position_limits { 0.0, 0.0 }
std::pair< double, double >	stiffness_rotation_limits { 0.0, 0.0 }
std::vector< double >	damping_ratio { 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 }
	Admittance control damping ratio (x, y, z, rx, ry, rz), with limits. More...
std::pair< double, double >	damping_ratio_position_limits { 0.0, 0.0 }
std::pair< double, double >	damping_ratio_rotation_limits { 0.0, 0.0 }
double	joint_damping = 0.0
	Joint damping used in admittance calculation, with limits. More...
std::pair< double, double >	joint_damping_limits { 0.0, 0.0 }

Description

Struct representing admittance controller parameters.

Definition at line 17 of file set_admittance_parameters.hpp.

Public Member Functions

getParamDimensionStr()

std::string AdmittanceControllerParams::getParamDimensionStr (const size_t idx)

inline

Helper function to convert index to a dimension (position or rotation) an axis (x, y, or z).

Parameters

idx	Index number (should be 0 through 6).

Returns

A formatted string such as "rotation x" or "position y".

Definition at line 50 of file set_admittance_parameters.hpp.

getParamLimitStr()

std::string AdmittanceControllerParams::getParamLimitStr (const double vmin, const double vmax)

inline

Helper function to convert limits to a printable string.

Parameters

vmin	The minimum value.
vmax	The maximum value.

Returns

A formatted string such in the form "[min - max]".

Definition at line 73 of file set_admittance_parameters.hpp.

validate()

tl::expected< void, std::string > AdmittanceControllerParams::validate ()

Validates the numeric parameter values against their limits.

Returns

Nothing if successful, else an error describing the violated limits.

Declaration at line 90 of file set_admittance_parameters.hpp, definition at line 93 of file set_admittance_parameters.cpp.

validateVectorParameter()

std::string AdmittanceControllerParams::validateVectorParameter (std::string_view name, const std::vector< double > & vec, const std::pair< double, double > & pos_limits, const std::pair< double, double > & rot_limits)

Helper function to validate a 6-element vector admittance parameter.

Parameters

name	The name to use for printing validation messages on this parameter.
vec	The vector containing the parameter values.
pos_limits	The pair containing the position value limits.
rot_limits	The pair containing the rotation value limits.

Returns

A string containing any validation messages to pass to its caller.

Declaration at line 84 of file set_admittance_parameters.hpp, definition at line 39 of file set_admittance_parameters.cpp.

Public Member Attributes

control_frame

std::string AdmittanceControllerParams::control_frame = ""

Admittance control frame.

Definition at line 23 of file set_admittance_parameters.hpp.

damping_ratio

std::vector<double> AdmittanceControllerParams::damping_ratio { 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 }

Admittance control damping ratio (x, y, z, rx, ry, rz), with limits.

Definition at line 39 of file set_admittance_parameters.hpp.

damping_ratio_position_limits

std::pair<double, double> AdmittanceControllerParams::damping_ratio_position_limits { 0.0, 0.0 }

Definition at line 40 of file set_admittance_parameters.hpp.

damping_ratio_rotation_limits

std::pair<double, double> AdmittanceControllerParams::damping_ratio_rotation_limits { 0.0, 0.0 }

Definition at line 41 of file set_admittance_parameters.hpp.

enabled_axes

std::vector<bool> AdmittanceControllerParams::enabled_axes { false, false, false, false, false }

Enabled admittance axes (x, y, z, rx, ry, rz).

Definition at line 26 of file set_admittance_parameters.hpp.

end_effector_frame

std::string AdmittanceControllerParams::end_effector_frame = ""

End effector frame used for kinematics calculation.

Definition at line 20 of file set_admittance_parameters.hpp.

joint_damping

double AdmittanceControllerParams::joint_damping = 0.0

Joint damping used in admittance calculation, with limits.

Definition at line 44 of file set_admittance_parameters.hpp.

joint_damping_limits

std::pair<double, double> AdmittanceControllerParams::joint_damping_limits { 0.0, 0.0 }

Definition at line 45 of file set_admittance_parameters.hpp.

mass

std::vector<double> AdmittanceControllerParams::mass { 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 }

Admittance control mass (x, y, z, rx, ry, rz), with limits.

Definition at line 29 of file set_admittance_parameters.hpp.

mass_position_limits

std::pair<double, double> AdmittanceControllerParams::mass_position_limits { 0.0, 0.0 }

Definition at line 30 of file set_admittance_parameters.hpp.

mass_rotation_limits

std::pair<double, double> AdmittanceControllerParams::mass_rotation_limits { 0.0, 0.0 }

Definition at line 31 of file set_admittance_parameters.hpp.

stiffness

std::vector<double> AdmittanceControllerParams::stiffness { 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 }

Admittance control stiffness (x, y, z, rx, ry, rz), with limits.

Definition at line 34 of file set_admittance_parameters.hpp.

stiffness_position_limits

std::pair<double, double> AdmittanceControllerParams::stiffness_position_limits { 0.0, 0.0 }

Definition at line 35 of file set_admittance_parameters.hpp.

stiffness_rotation_limits

std::pair<double, double> AdmittanceControllerParams::stiffness_rotation_limits { 0.0, 0.0 }

Definition at line 36 of file set_admittance_parameters.hpp.

---

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

• set_admittance_parameters.hpp
• set_admittance_parameters.cpp

---

Generated via doxygen2docusaurus 2.2.2 by Doxygen 1.9.8.