Class to define a positions of the joints. More...

#include <JointPositions.hpp>

Inheritance diagram for state_representation::JointPositions:

Public Member Functions
const Eigen::VectorXd &	get_velocities () const =delete

double	get_velocity (unsigned int joint_index) const =delete

double	get_velocity (const std::string &joint_name) const =delete

void	set_velocities (const Eigen::VectorXd &velocities)=delete

void	set_velocities (const std::vector< double > &velocities)=delete

void	set_velocity (double velocity, unsigned int joint_index) const =delete

void	set_velocity (double velocity, const std::string &joint_name) const =delete

const Eigen::VectorXd &	get_accelerations () const =delete

double	get_acceleration (unsigned int joint_index) const =delete

double	get_acceleration (const std::string &joint_name) const =delete

void	set_accelerations (const Eigen::VectorXd &accelerations)=delete

void	set_accelerations (const std::vector< double > &accelerations)=delete

void	set_acceleration (double acceleration, unsigned int joint_index) const =delete

void	set_acceleration (double acceleration, const std::string &joint_name) const =delete

const Eigen::VectorXd &	get_torques () const =delete

double	get_torque (unsigned int joint_index) const =delete

double	get_torque (const std::string &joint_name) const =delete

void	set_torques (const Eigen::VectorXd &torques)=delete

void	set_torques (const std::vector< double > &torques)=delete

void	set_torque (double torque, unsigned int joint_index) const =delete

void	set_torque (double torque, const std::string &joint_name) const =delete

	JointPositions ()
	Empty constructor. More...

	JointPositions (const std::string &robot_name, unsigned int nb_joints=0)
	Constructor with name and number of joints provided. More...

	JointPositions (const std::string &robot_name, const std::vector< std::string > &joint_names)
	Constructor with name and list of joint names provided. More...

	JointPositions (const std::string &robot_name, const Eigen::VectorXd &positions)
	Constructor with name and position values provided. More...

	JointPositions (const std::string &robot_name, const std::vector< std::string > &joint_names, const Eigen::VectorXd &positions)
	Constructor with name, a list of joint names and position values provided. More...

	JointPositions (const JointPositions &positions)
	Copy constructor. More...

	JointPositions (const JointState &state)
	Copy constructor from a JointState. More...

	JointPositions (const JointVelocities &velocities)
	Integration constructor from a JointVelocities by considering that it is equivalent to multiplying the velocities by 1 second. More...

JointPositions &	operator= (const JointPositions &positions)=default
	Copy assignment operator that have to be defined to the custom assignment operator. More...

JointPositions &	operator+= (const JointPositions &positions)
	Overload the += operator. More...

JointPositions	operator+ (const JointPositions &positions) const
	Overload the + operator. More...

JointPositions &	operator-= (const JointPositions &positions)
	Overload the -= operator. More...

JointPositions	operator- (const JointPositions &positions) const
	Overload the - operator. More...

JointPositions &	operator*= (double lambda)
	Overload the *= operator with a double gain. More...

JointPositions	operator* (double lambda) const
	Overload the * operator with a double gain. More...

JointPositions &	operator*= (const Eigen::ArrayXd &lambda)
	Overload the *= operator with an array of gains. More...

JointPositions	operator* (const Eigen::ArrayXd &lambda) const
	Overload the *= operator with an array of gains. More...

JointPositions &	operator*= (const Eigen::MatrixXd &lambda)
	Overload the *= operator with a matrix of gains. More...

JointPositions	operator* (const Eigen::MatrixXd &lambda) const
	Overload the * operator with a matrix of gains. More...

JointPositions &	operator/= (double lambda)
	Overload the /= operator with a scalar. More...

JointPositions	operator/ (double lambda) const
	Overload the / operator with a scalar. More...

JointVelocities	operator/ (const std::chrono::nanoseconds &dt) const
	Overload the / operator with a time period. More...

JointPositions	copy () const
	Return a copy of the JointPositions. More...

Eigen::VectorXd	data () const override
	Returns the positions data as an Eigen vector. More...

virtual void	set_data (const Eigen::VectorXd &data) override
	Set the positions data from an Eigen vector. More...

virtual void	set_data (const std::vector< double > &data) override
	Set the positions data from a std vector. More...

void	clamp (double max_absolute_value, double noise_ratio=0.)
	Clamp inplace the magnitude of the positions to the value in argument. More...

JointPositions	clamped (double max_absolute_value, double noise_ratio=0.) const
	Return the position clamped to the value in argument. More...

void	clamp (const Eigen::ArrayXd &max_absolute_value_array, const Eigen::ArrayXd &noise_ratio_array)
	Clamp inplace the magnitude of the positions to the values in argument. More...

JointPositions	clamped (const Eigen::ArrayXd &max_absolute_value_array, const Eigen::ArrayXd &noise_ratio_array) const
	Return the position clamped to the values in argument. More...

Public Member Functions inherited from state_representation::JointState
	JointState ()
	Empty constructor for a JointState. More...

	JointState (const std::string &robot_name, unsigned int nb_joints=0)
	Constructor with name and number of joints provided. More...

	JointState (const std::string &robot_name, const std::vector< std::string > &joint_names)
	Constructor with name and list of joint names provided. More...

	JointState (const JointState &state)=default
	Copy constructor of a JointState. More...

JointState &	operator= (const JointState &state)
	Copy assignment operator that have to be defined to the custom assignment operator. More...

unsigned int	get_size () const
	Getter of the size from the attributes. More...

const std::vector< std::string > &	get_names () const
	Getter of the names attribute. More...

void	set_names (unsigned int nb_joints)
	Setter of the names attribute from the number of joints. More...

void	set_names (const std::vector< std::string > &names)
	Setter of the names attribute. More...

unsigned int	get_joint_index (const std::string &joint_name) const
	Get joint index by the name of the joint, if it exists. More...

const Eigen::VectorXd &	get_positions () const
	Getter of the positions attribute. More...

double	get_position (const std::string &joint_name) const
	Get the position of a joint by its name, if it exists. More...

double	get_position (unsigned int joint_index) const
	Get the position of a joint by its index, if it exists. More...

void	set_positions (const Eigen::VectorXd &positions)
	Setter of the positions attribute. More...

void	set_positions (const std::vector< double > &positions)
	Setter of the positions from std vector. More...

void	set_position (double position, const std::string &joint_name)
	Set the position of a joint by its name. More...

void	set_position (double position, unsigned int joint_index)
	Set the position of a joint by its index. More...

const Eigen::VectorXd &	get_velocities () const
	Getter of the velocities attribute. More...

double	get_velocity (const std::string &joint_name) const
	Get the velocity of a joint by its name, if it exists. More...

double	get_velocity (unsigned int joint_index) const
	Get the velocity of a joint by its index, if it exists. More...

void	set_velocities (const Eigen::VectorXd &velocities)
	Setter of the velocities attribute. More...

void	set_velocities (const std::vector< double > &velocities)
	Setter of the velocities from std vector. More...

void	set_velocity (double velocity, const std::string &joint_name)
	Set the velocity of a joint by its name. More...

void	set_velocity (double velocity, unsigned int joint_index)
	Set the velocity of a joint by its index. More...

const Eigen::VectorXd &	get_accelerations () const
	Getter of the accelerations attribute. More...

double	get_acceleration (const std::string &joint_name) const
	Get the acceleration of a joint by its name, if it exists. More...

double	get_acceleration (unsigned int joint_index) const
	Get the acceleration of a joint by its index, if it exists. More...

void	set_accelerations (const Eigen::VectorXd &accelerations)
	Setter of the accelerations attribute. More...

void	set_accelerations (const std::vector< double > &accelerations)
	Setter of the accelerations from std vector. More...

void	set_acceleration (double acceleration, const std::string &joint_name)
	Set the acceleration of a joint by its name. More...

void	set_acceleration (double acceleration, unsigned int joint_index)
	Set the acceleration of a joint by its index. More...

const Eigen::VectorXd &	get_torques () const
	Getter of the torques attribute. More...

double	get_torque (const std::string &joint_name) const
	Get the torque of a joint by its name, if it exists. More...

double	get_torque (unsigned int joint_index) const
	Get the torque of a joint by its index, if it exists. More...

void	set_torques (const Eigen::VectorXd &torques)
	Setter of the torques attribute. More...

void	set_torques (const std::vector< double > &torques)
	Setter of the torques attributes. More...

void	set_torque (double torque, const std::string &joint_name)
	Set the torque of a joint by its name. More...

void	set_torque (double torque, unsigned int joint_index)
	Set the torque of a joint by its index. More...

bool	is_compatible (const State &state) const
	Check if the state is compatible for operations with the state given as argument. More...

void	initialize ()
	Initialize the State to a zero value. More...

void	set_zero ()
	Set the JointState to a zero value. More...

void	clamp_state_variable (double max_absolute_value, const JointStateVariable &state_variable_type, double noise_ratio=0)
	Clamp inplace the magnitude of the a specific joint state variable. More...

void	clamp_state_variable (const Eigen::ArrayXd &max_absolute_value_array, const JointStateVariable &state_variable_type, const Eigen::ArrayXd &noise_ratio_array)
	Clamp inplace the magnitude of the a specific joint state variable for each individual joint. More...

JointState	copy () const
	Return a copy of the JointState. More...

virtual Eigen::VectorXd	data () const
	Returns the data as the concatenation of all the state variables in a single vector. More...

virtual void	set_data (const Eigen::VectorXd &data) override
	Set the data of the state from all the state variables in a single Eigen vector. More...

virtual void	set_data (const std::vector< double > &data) override
	Set the data of the state from all the state variables in a single std vector. More...

Eigen::ArrayXd	array () const
	Returns the data vector as an Eigen Array. More...

JointState &	operator+= (const JointState &state)
	Overload the += operator. More...

JointState	operator+ (const JointState &state) const
	Overload the + operator. More...

JointState &	operator-= (const JointState &state)
	Overload the -= operator. More...

JointState	operator- (const JointState &state) const
	Overload the - operator. More...

JointState &	operator*= (double lambda)
	Overload the *= operator with a double gain. More...

JointState	operator* (double lambda) const
	Overload the * operator with a double gain. More...

JointState &	operator*= (const Eigen::ArrayXd &lambda)
	Overload the *= operator with an array of gains. More...

JointState	operator* (const Eigen::ArrayXd &lambda) const
	Overload the * operator with an array of gains. More...

JointState &	operator*= (const Eigen::MatrixXd &lambda)
	Overload the *= operator with a matrix of gains. More...

JointState	operator* (const Eigen::MatrixXd &lambda) const
	Overload the * operator with a matrix of gains. More...

JointState &	operator/= (double lambda)
	Overload the /= operator with a scalar. More...

JointState	operator/ (double lambda) const
	Overload the / operator with a scalar. More...

double	dist (const JointState &state, const JointStateVariable &state_variable_type=JointStateVariable::ALL) const
	Compute the distance to another state as the sum of distances between each attribute. More...

std::vector< double >	to_std_vector () const
	Return the joint state as a std vector of floats. More...

Public Member Functions inherited from state_representation::State
	State ()
	Empty constructor. More...

	State (const StateType &type)
	Constructor only specifying the type of the state from the StateType enumeration. More...

	State (const StateType &type, const std::string &name, const bool &empty=true)
	Constructor with name specification. More...

	State (const State &state)
	Copy constructor from another State. More...

virtual	~State ()=default
	Virtual destructor.

State &	operator= (const State &state)
	Copy assignment operator that have to be defined to the custom assignment operator. More...

const StateType &	get_type () const
	Getter of the type attribute. More...

bool	is_empty () const
	Getter of the empty attribute. More...

void	set_empty (bool empty=true)
	Setter of the empty attribute. More...

void	set_filled ()
	Setter of the empty attribute to false and also reset the timestamp. More...

const std::chrono::time_point< std::chrono::steady_clock > &	get_timestamp () const
	Getter of the timestamp attribute. More...

void	set_timestamp (const std::chrono::time_point< std::chrono::steady_clock > &timepoint)
	Setter of the timestamp attribute. More...

void	reset_timestamp ()
	Reset the timestamp attribute to now. More...

const std::string &	get_name () const
	Getter of the name as const reference. More...

virtual void	set_name (const std::string &name)
	Setter of the name. More...

template<typename DurationT >
bool	is_deprecated (const std::chrono::duration< int64_t, DurationT > &time_delay)
	Check if the state is deprecated given a certain time delay. More...

virtual bool	is_compatible (const State &state) const
	Check if the state is compatible for operations with the state given as argument. More...

virtual void	initialize ()
	Initialize the State to a zero value. More...

virtual void	set_data (const Eigen::VectorXd &data)
	Set the data of the state from a single Eigen vector. More...

virtual void	set_data (const std::vector< double > &data)
	Set the data of the state from a single std vector. More...

virtual void	set_data (const Eigen::MatrixXd &data)
	Set the data of the state from an Eigen matrix. More...

	operator bool () const noexcept
	Boolean operator for the truthiness of a state. More...

Static Public Member Functions
static JointPositions	Zero (const std::string &robot_name, unsigned int nb_joints)
	Constructor for the zero JointPositions. More...

static JointPositions	Zero (const std::string &robot_name, const std::vector< std::string > &joint_names)
	Constructor for the zero JointPositions. More...

static JointPositions	Random (const std::string &robot_name, unsigned int nb_joints)
	Constructor for the random JointPositions. More...

static JointPositions	Random (const std::string &robot_name, const std::vector< std::string > &joint_names)
	Constructor for the random JointPositions. More...

Static Public Member Functions inherited from state_representation::JointState
static JointState	Zero (const std::string &robot_name, unsigned int nb_joints)
	Constructor for a zero JointState. More...

static JointState	Zero (const std::string &robot_name, const std::vector< std::string > &joint_names)
	Constructor for a zero JointState. More...

static JointState	Random (const std::string &robot_name, unsigned int nb_joints)
	Constructor for a random JointState. More...

static JointState	Random (const std::string &robot_name, const std::vector< std::string > &joint_names)
	Constructor for a random JointState. More...

Friends
std::ostream &	operator<< (std::ostream &os, const JointPositions &positions)
	Overload the ostream operator for printing. More...

JointPositions	operator* (double lambda, const JointPositions &positions)
	Overload the * operator with a scalar. More...

JointPositions	operator* (const Eigen::ArrayXd &lambda, const JointPositions &positions)
	Overload the * operator with an array of gains. More...

JointPositions	operator* (const Eigen::MatrixXd &lambda, const JointPositions &positions)
	Overload the * operator with a matrix of gains. More...

Additional Inherited Members
Protected Member Functions inherited from state_representation::JointState
void	multiply_state_variable (const Eigen::ArrayXd &lambda, const JointStateVariable &state_variable_type)
	Proxy function that multiply the specified state variable by an array of gain. More...

void	multiply_state_variable (const Eigen::MatrixXd &lambda, const JointStateVariable &state_variable_type)
	Proxy function that multiply the specified state variable by an array of gain. More...

Eigen::VectorXd	get_state_variable (const JointStateVariable &state_variable_type) const
	Getter of the variable value corresponding to the input. More...

void	set_state_variable (const Eigen::VectorXd &new_value, const JointStateVariable &state_variable_type)
	Setter of the variable value corresponding to the input. More...

Protected Member Functions inherited from state_representation::State
void	set_type (const StateType &type)
	Override the state type. More...

Detailed Description

Class to define a positions of the joints.

Definition at line 13 of file JointPositions.hpp.

Constructor & Destructor Documentation

◆ JointPositions() [1/8]

state_representation::JointPositions::JointPositions ( )

explicit

Empty constructor.

Definition at line 8 of file JointPositions.cpp.

◆ JointPositions() [2/8]

state_representation::JointPositions::JointPositions	(	const std::string &	robot_name,
		unsigned int	nb_joints = `0`
	)

explicit

Constructor with name and number of joints provided.

name the name of the state

nb_joints the number of joints for initialization

Definition at line 12 of file JointPositions.cpp.

◆ JointPositions() [3/8]

state_representation::JointPositions::JointPositions	(	const std::string &	robot_name,
		const std::vector< std::string > &	joint_names
	)

explicit

Constructor with name and list of joint names provided.

name the name of the state

joint_names list of joint names

Definition at line 23 of file JointPositions.cpp.

◆ JointPositions() [4/8]

state_representation::JointPositions::JointPositions	(	const std::string &	robot_name,
		const Eigen::VectorXd &	positions
	)

explicit

Constructor with name and position values provided.

name the name of the state

positions the vector of positions

Definition at line 17 of file JointPositions.cpp.

◆ JointPositions() [5/8]

state_representation::JointPositions::JointPositions	(	const std::string &	robot_name,
		const std::vector< std::string > &	joint_names,
		const Eigen::VectorXd &	positions
	)

explicit

Constructor with name, a list of joint names and position values provided.

name the name of the state

joint_names list of joint names

positions the vector of positions

Definition at line 28 of file JointPositions.cpp.

◆ JointPositions() [6/8]

state_representation::JointPositions::JointPositions ( const JointPositions & positions )

Copy constructor.

Definition at line 43 of file JointPositions.cpp.

◆ JointPositions() [7/8]

state_representation::JointPositions::JointPositions ( const JointState & state )

Copy constructor from a JointState.

Definition at line 35 of file JointPositions.cpp.

◆ JointPositions() [8/8]

state_representation::JointPositions::JointPositions ( const JointVelocities & velocities )

Integration constructor from a JointVelocities by considering that it is equivalent to multiplying the velocities by 1 second.

Definition at line 46 of file JointPositions.cpp.

Member Function Documentation

◆ clamp() [1/2]

void state_representation::JointPositions::clamp	(	const Eigen::ArrayXd &	max_absolute_value_array,
		const Eigen::ArrayXd &	noise_ratio_array
	)

Clamp inplace the magnitude of the positions to the values in argument.

Parameters

max_absolute_value_array	the maximum value of position for each joint
noise_ratio_array	those values will be used to apply a dead zone relative to the maximum absolute value under which the position will be set to 0 for each individual joint

Definition at line 162 of file JointPositions.cpp.

◆ clamp() [2/2]

void state_representation::JointPositions::clamp	(	double	max_absolute_value,
		double	noise_ratio = `0.`
	)

Clamp inplace the magnitude of the positions to the value in argument.

Parameters

max_absolute_value	the maximum value of position for all the joints
noise_ratio	if provided, this value will be used to apply a dead zone relative to the maximum absolute value under which the position will be set to 0

Definition at line 152 of file JointPositions.cpp.

◆ clamped() [1/2]

JointPositions state_representation::JointPositions::clamped	(	const Eigen::ArrayXd &	max_absolute_value_array,
		const Eigen::ArrayXd &	noise_ratio_array
	)		const

Return the position clamped to the values in argument.

Parameters

max_absolute_value_array	the maximum value of position for each joint
noise_ratio_array	those values will be used to apply a dead zone relative to the maximum absolute value under which the position will be set to 0 for each individual joint

Returns: the clamped JointPositions

Definition at line 166 of file JointPositions.cpp.

◆ clamped() [2/2]

JointPositions state_representation::JointPositions::clamped	(	double	max_absolute_value,
		double	noise_ratio = `0.`
	)		const

Return the position clamped to the value in argument.

Parameters

max_absolute_value	the maximum value of position for all the joints
noise_ratio	if provided, this value will be used to apply a dead zone relative to the maximum absolute value under which the position will be set to 0

Returns: the clamped JointPositions

Definition at line 156 of file JointPositions.cpp.

◆ copy()

JointPositions state_representation::JointPositions::copy ( ) const

Return a copy of the JointPositions.

Returns: the copy

Definition at line 135 of file JointPositions.cpp.

◆ data()

Eigen::VectorXd state_representation::JointPositions::data ( ) const

overridevirtual

Returns the positions data as an Eigen vector.

Returns: the positions data vector

Reimplemented from state_representation::JointState.

Definition at line 140 of file JointPositions.cpp.

◆ operator*() [1/3]

JointPositions state_representation::JointPositions::operator* ( const Eigen::ArrayXd & lambda ) const

Overload the *= operator with an array of gains.

Parameters

lambda the gain array to multiply with

Returns: the JointPositions multiplied by lambda

Definition at line 97 of file JointPositions.cpp.

◆ operator*() [2/3]

JointPositions state_representation::JointPositions::operator* ( const Eigen::MatrixXd & lambda ) const

Overload the * operator with a matrix of gains.

Parameters

lambda the matrix to multiply with

Returns: the JointPositions multiplied by lambda

Definition at line 108 of file JointPositions.cpp.

◆ operator*() [3/3]

JointPositions state_representation::JointPositions::operator* ( double lambda ) const

Overload the * operator with a double gain.

Parameters

lambda the gain to multiply with

Returns: the JointPositions multiplied by lambda

Definition at line 88 of file JointPositions.cpp.

◆ operator*=() [1/3]

JointPositions & state_representation::JointPositions::operator*= ( const Eigen::ArrayXd & lambda )

Overload the *= operator with an array of gains.

Parameters

lambda the gain array to multiply with

Returns: the JointPositions multiplied by lambda

Definition at line 92 of file JointPositions.cpp.

◆ operator*=() [2/3]

JointPositions & state_representation::JointPositions::operator*= ( const Eigen::MatrixXd & lambda )

Overload the *= operator with a matrix of gains.

Parameters

lambda the matrix to multiply with

Returns: the JointPositions multiplied by lambda

Definition at line 103 of file JointPositions.cpp.

◆ operator*=() [3/3]

JointPositions & state_representation::JointPositions::operator*= ( double lambda )

Overload the *= operator with a double gain.

Parameters

lambda the gain to multiply with

Returns: the JointPositions multiplied by lambda

Definition at line 83 of file JointPositions.cpp.

◆ operator+()

JointPositions state_representation::JointPositions::operator+ ( const JointPositions & positions ) const

Overload the + operator.

Parameters

positions JointPositions to add

Returns: the current JointPositions added the JointPositions given in argument

Definition at line 70 of file JointPositions.cpp.

◆ operator+=()

JointPositions & state_representation::JointPositions::operator+= ( const JointPositions & positions )

Overload the += operator.

Parameters

positions JointPositions to add

Returns: the current JointPositions added the JointPositions given in argument

Definition at line 65 of file JointPositions.cpp.

◆ operator-()

JointPositions state_representation::JointPositions::operator- ( const JointPositions & positions ) const

Overload the - operator.

Parameters

positions JointPositions to subtract

Returns: the current JointPositions subtracted the JointPositions given in argument

Definition at line 79 of file JointPositions.cpp.

◆ operator-=()

JointPositions & state_representation::JointPositions::operator-= ( const JointPositions & positions )

Overload the -= operator.

Parameters

positions JointPositions to subtract

Returns: the current JointPositions subtracted the JointPositions given in argument

Definition at line 74 of file JointPositions.cpp.

◆ operator/() [1/2]

JointVelocities state_representation::JointPositions::operator/ ( const std::chrono::nanoseconds & dt ) const

Overload the / operator with a time period.

Parameters

dt	the time period to multiply with

Returns: the JointVelocities corresponding to the velocities over the time period

Definition at line 123 of file JointPositions.cpp.

◆ operator/() [2/2]

JointPositions state_representation::JointPositions::operator/ ( double lambda ) const

Overload the / operator with a scalar.

Parameters

lambda the scalar to divide with

Returns: the JointPositions divided by lambda

Definition at line 119 of file JointPositions.cpp.

◆ operator/=()

JointPositions & state_representation::JointPositions::operator/= ( double lambda )

Overload the /= operator with a scalar.

Parameters

lambda the scalar to divide with

Returns: the JointPositions divided by lambda

Definition at line 114 of file JointPositions.cpp.

◆ operator=()

JointPositions & state_representation::JointPositions::operator= ( const JointPositions & positions )

default

Copy assignment operator that have to be defined to the custom assignment operator.

Parameters

positions the state with value to assign

Returns: reference to the current state with new values

◆ Random() [1/2]

JointPositions state_representation::JointPositions::Random	(	const std::string &	robot_name,
		const std::vector< std::string > &	joint_names
	)

static

Constructor for the random JointPositions.

Parameters

robot_name	the name of the associated robot
joint_names	list of joint names

Returns: JointPositions with random positions values

Definition at line 61 of file JointPositions.cpp.

◆ Random() [2/2]

JointPositions state_representation::JointPositions::Random	(	const std::string &	robot_name,
		unsigned int	nb_joints
	)

static

Constructor for the random JointPositions.

Parameters

robot_name	the name of the associated robot
nb_joints	the number of joints for initialization

Returns: JointPositions with random positions values

Definition at line 57 of file JointPositions.cpp.

◆ set_data() [1/2]

void state_representation::JointPositions::set_data ( const Eigen::VectorXd & data )

overridevirtual

Set the positions data from an Eigen vector.

Parameters

the	positions data vector

Reimplemented from state_representation::JointState.

Definition at line 144 of file JointPositions.cpp.

◆ set_data() [2/2]

void state_representation::JointPositions::set_data ( const std::vector< double > & data )

overridevirtual

Set the positions data from a std vector.

Parameters

the	positions data vector

Reimplemented from state_representation::JointState.

Definition at line 148 of file JointPositions.cpp.

◆ Zero() [1/2]

JointPositions state_representation::JointPositions::Zero	(	const std::string &	robot_name,
		const std::vector< std::string > &	joint_names
	)

static

Constructor for the zero JointPositions.

Parameters

robot_name	the name of the associated robot
joint_names	list of joint names

Returns: JointPositions with zero positions values

Definition at line 53 of file JointPositions.cpp.

◆ Zero() [2/2]

JointPositions state_representation::JointPositions::Zero	(	const std::string &	robot_name,
		unsigned int	nb_joints
	)

static

Constructor for the zero JointPositions.

Parameters

robot_name	the name of the associated robot
nb_joints	the number of joints for initialization

Returns: JointPositions with zero positions values

Definition at line 49 of file JointPositions.cpp.

Friends And Related Function Documentation

◆ operator* [1/3]

JointPositions operator*	(	const Eigen::ArrayXd &	lambda,
		const JointPositions &	positions
	)

friend

Overload the * operator with an array of gains.

Parameters

lambda the array to multiply with

Returns: the JointPositions provided multiply by lambda

Definition at line 195 of file JointPositions.cpp.

◆ operator* [2/3]

JointPositions operator*	(	const Eigen::MatrixXd &	lambda,
		const JointPositions &	positions
	)

friend

Overload the * operator with a matrix of gains.

Parameters

lambda the matrix to multiply with

Returns: the JointPositions provided multiply by lambda

Definition at line 201 of file JointPositions.cpp.

◆ operator* [3/3]

JointPositions operator*	(	double	lambda,
		const JointPositions &	positions
	)

friend

Overload the * operator with a scalar.

Parameters

lambda the scalar to multiply with

Returns: the JointPositions provided multiply by lambda

Definition at line 189 of file JointPositions.cpp.

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		const JointPositions &	positions
	)

friend

Overload the ostream operator for printing.

Parameters

os	the ostream to append the string representing the state
positions	the state to print

Returns: the appended ostream

Definition at line 174 of file JointPositions.cpp.

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

/github/workspace/source/state_representation/include/state_representation/space/joint/JointPositions.hpp
/github/workspace/source/state_representation/src/space/joint/JointPositions.cpp

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ JointPositions() [1/8]

◆ JointPositions() [2/8]

◆ JointPositions() [3/8]

◆ JointPositions() [4/8]

◆ JointPositions() [5/8]

◆ JointPositions() [6/8]

◆ JointPositions() [7/8]

◆ JointPositions() [8/8]

Member Function Documentation

◆ clamp() [1/2]

◆ clamp() [2/2]

◆ clamped() [1/2]

◆ clamped() [2/2]

◆ copy()

◆ data()

◆ operator*() [1/3]

◆ operator*() [2/3]

◆ operator*() [3/3]

◆ operator*=() [1/3]

◆ operator*=() [2/3]

◆ operator*=() [3/3]

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator/() [1/2]

◆ operator/() [2/2]

◆ operator/=()

◆ operator=()

◆ Random() [1/2]

◆ Random() [2/2]

◆ set_data() [1/2]

◆ set_data() [2/2]

◆ Zero() [1/2]

◆ Zero() [2/2]

Friends And Related Function Documentation

◆ operator* [1/3]

◆ operator* [2/3]

◆ operator* [3/3]

◆ operator<<