#include <hpp/pinocchio/joint.hh>

Public Member Functions
DeviceConstPtr_t	robot () const
	Access robot owning the object. More...

DevicePtr_t	robot ()
	Access robot owning the object. More...

std::ostream &	display (std::ostream &os) const
	Display joint. More...

LiegroupSpacePtr_t	configurationSpace () const
	Get configuration space of joint. More...

LiegroupSpacePtr_t	RnxSOnConfigurationSpace () const

Name
const std::string &	name () const
	Get name. More...

Position
const Transform3f &	currentTransformation () const
	Joint transformation. More...

const Transform3f &	currentTransformation (const DeviceData &data) const
	Joint transformation. More...

Size and rank
size_type	numberDof () const
	Return number of degrees of freedom. More...

size_type	configSize () const
	Return number of degrees of freedom. More...

size_type	rankInConfiguration () const
	Return rank of the joint in the configuration vector. More...

size_type	rankInVelocity () const
	Return rank of the joint in the velocity vector. More...

Kinematic chain
JointPtr_t	parentJoint () const
	Get a pointer to the parent joint (if any). More...

std::size_t	numberChildJoints () const
	Number of child joints. More...

JointPtr_t	childJoint (std::size_t rank) const
	Get child joint. More...

const Transform3f &	positionInParentFrame () const
	Get (constant) placement of joint in parent frame, i.e. model.jointPlacement[idx]. More...

Bounds
void	isBounded (size_type rank, bool bounded)

bool	isBounded (size_type rank) const
	Get whether given degree of freedom is bounded. More...

value_type	lowerBound (size_type rank) const
	Get lower bound of given degree of freedom. More...

value_type	upperBound (size_type rank) const
	Get upper bound of given degree of freedom. More...

void	lowerBound (size_type rank, value_type lowerBound)
	Set lower bound of given degree of freedom. More...

void	upperBound (size_type rank, value_type upperBound)
	Set upper bound of given degree of freedom. More...

void	lowerBounds (vectorIn_t lowerBounds)
	Set lower bounds. More...

void	upperBounds (vectorIn_t upperBounds)
	Set upper bounds. More...

value_type	upperBoundLinearVelocity () const

value_type	upperBoundAngularVelocity () const

const value_type &	maximalDistanceToParent () const
	Maximal distance of joint origin to parent origin. More...

Jacobian
JointJacobian_t &	jacobian (const bool localFrame=true) const

JointJacobian_t &	jacobian (DeviceData &data, const bool localFrame=true) const

Body linked to the joint
BodyPtr_t	linkedBody () const
	Get linked body. More...

Pinocchio API
const JointIndex &	index () const

const JointModel &	jointModel () const

Protected Member Functions
void	computeMaximalDistanceToParent ()
	Compute the maximal distance. More...

void	setChildList ()
	Store list of childrens. More...

Model &	model ()

const Model &	model () const

DeviceData &	data () const

void	selfAssert () const
	Assert that the members of the struct are valid (no null pointer, etc). More...

Protected Attributes
value_type	maximalDistanceToParent_

DeviceWkPtr_t	devicePtr

JointIndex	jointIndex

std::vector< JointIndex >	children

Friends
class	Device

Construction and copy and destruction
static JointPtr_t	create (DeviceWkPtr_t device, JointIndex indexInJointList)

	Joint (DeviceWkPtr_t device, JointIndex indexInJointList)

	~Joint ()

Detailed Description

Robot joint

A joint maps an input vector to a transformation of SE(3) from the parent frame to the joint frame.

The input vector is provided through the configuration vector of the robot the joint belongs to. The joint input vector is composed of the components of the robot configuration starting at Joint::rankInConfiguration.

The joint input vector represents an element of a Lie group, either

a vector space for JointTranslation, and bounded JointRotation,
the unit circle for non-bounded JointRotation joints,
an element of SO(3) for JointSO3, represented by a unit quaternion.

This class is a wrapper to pinocchio::JointModelTpl.

Constructor & Destructor Documentation

◆ Joint()

hpp::pinocchio::Joint::Joint	(	DeviceWkPtr_t	device,
		JointIndex	indexInJointList
	)

Constructor

Parameters

indexInJointList index in pinocchio vector of joints (pinocchio::ModelTpl::joints). Should be > 0.

Note: indices of device start at 1 since 0 corresponds to "universe".

◆ ~Joint()

hpp::pinocchio::Joint::~Joint ( )

inline

Member Function Documentation

◆ childJoint()

JointPtr_t hpp::pinocchio::Joint::childJoint ( std::size_t rank ) const

Get child joint.

◆ computeMaximalDistanceToParent()

void hpp::pinocchio::Joint::computeMaximalDistanceToParent ( )

protected

Compute the maximal distance.

See also: maximalDistanceToParent

◆ configSize()

size_type hpp::pinocchio::Joint::configSize ( ) const

Return number of degrees of freedom.

◆ configurationSpace()

LiegroupSpacePtr_t hpp::pinocchio::Joint::configurationSpace ( ) const

Get configuration space of joint.

◆ create()

static JointPtr_t hpp::pinocchio::Joint::create	(	DeviceWkPtr_t	device,
		JointIndex	indexInJointList
	)

static

Create a new joint

Parameters

indexInJointList index in pinocchio vector of joints (pinocchio::ModelTpl::joints)

Returns: shared pointer to result if indexInJointList > 0, empty shared pointer if indexInJointList == 0.

Note: indices of device start at 1 since 0 corresponds to "universe".

◆ currentTransformation() [1/2]

const Transform3f& hpp::pinocchio::Joint::currentTransformation ( ) const

inline

Joint transformation.

◆ currentTransformation() [2/2]

const Transform3f& hpp::pinocchio::Joint::currentTransformation ( const DeviceData & data ) const

Joint transformation.

◆ data()

DeviceData& hpp::pinocchio::Joint::data ( ) const

protected

◆ display()

std::ostream& hpp::pinocchio::Joint::display ( std::ostream & os ) const

Display joint.

◆ index()

const JointIndex& hpp::pinocchio::Joint::index ( ) const

inline

◆ isBounded() [1/2]

void hpp::pinocchio::Joint::isBounded	(	size_type	rank,
		bool	bounded
	)

Set whether given degree of freedom is bounded

Warning: Joint always has bounds. When bounded == false, the bounds are -infinity and infinity.

◆ isBounded() [2/2]

bool hpp::pinocchio::Joint::isBounded ( size_type rank ) const

Get whether given degree of freedom is bounded.

◆ jacobian() [1/2]

JointJacobian_t& hpp::pinocchio::Joint::jacobian ( const bool localFrame = true ) const

inline

Get non const reference to Jacobian

Parameters

localFrame if true, compute the jacobian (6d) in the local frame, whose linear part corresponds to the velocity of the center of the frame. If false, the jacobian is expressed in the global frame and its linear part corresponds to the value of the velocity vector field at the center of the world.

◆ jacobian() [2/2]

JointJacobian_t& hpp::pinocchio::Joint::jacobian	(	DeviceData &	data,
		const bool	localFrame = `true`
	)		const

Get reference to Jacobian

Parameters

data	a DeviceData (see hpp::pinocchio::DeviceSync for details).
localFrame	if true, compute the jacobian (6d) in the local frame, whose linear part corresponds to the velocity of the center of the frame. If false, the jacobian is expressed in the global frame and its linear part corresponds to the value of the velocity vector field at the center of the world.

◆ jointModel()

const JointModel& hpp::pinocchio::Joint::jointModel ( ) const

◆ linkedBody()

BodyPtr_t hpp::pinocchio::Joint::linkedBody ( ) const

Get linked body.

◆ lowerBound() [1/2]

value_type hpp::pinocchio::Joint::lowerBound ( size_type rank ) const

Get lower bound of given degree of freedom.

◆ lowerBound() [2/2]

void hpp::pinocchio::Joint::lowerBound	(	size_type	rank,
		value_type	lowerBound
	)

Set lower bound of given degree of freedom.

◆ lowerBounds()

void hpp::pinocchio::Joint::lowerBounds ( vectorIn_t lowerBounds )

Set lower bounds.

◆ maximalDistanceToParent()

const value_type& hpp::pinocchio::Joint::maximalDistanceToParent ( ) const

inline

Maximal distance of joint origin to parent origin.

◆ model() [1/2]

Model& hpp::pinocchio::Joint::model ( )

protected

◆ model() [2/2]

const Model& hpp::pinocchio::Joint::model ( ) const

protected

◆ name()

const std::string& hpp::pinocchio::Joint::name ( ) const

Get name.

◆ numberChildJoints()

std::size_t hpp::pinocchio::Joint::numberChildJoints ( ) const

Number of child joints.

◆ numberDof()

size_type hpp::pinocchio::Joint::numberDof ( ) const

Return number of degrees of freedom.

◆ parentJoint()

JointPtr_t hpp::pinocchio::Joint::parentJoint ( ) const

Get a pointer to the parent joint (if any).

◆ positionInParentFrame()

const Transform3f& hpp::pinocchio::Joint::positionInParentFrame ( ) const

Get (constant) placement of joint in parent frame, i.e. model.jointPlacement[idx].

◆ rankInConfiguration()

size_type hpp::pinocchio::Joint::rankInConfiguration ( ) const

Return rank of the joint in the configuration vector.

◆ rankInVelocity()

size_type hpp::pinocchio::Joint::rankInVelocity ( ) const

Return rank of the joint in the velocity vector.

◆ RnxSOnConfigurationSpace()

LiegroupSpacePtr_t hpp::pinocchio::Joint::RnxSOnConfigurationSpace ( ) const

Get configuration space of joint. Use R^n x SO(n) instead of SE(n).

◆ robot() [1/2]

DeviceConstPtr_t hpp::pinocchio::Joint::robot ( ) const

inline

Access robot owning the object.

◆ robot() [2/2]

DevicePtr_t hpp::pinocchio::Joint::robot ( )

inline

Access robot owning the object.

◆ selfAssert()

void hpp::pinocchio::Joint::selfAssert ( ) const

protected

Assert that the members of the struct are valid (no null pointer, etc).

◆ setChildList()

void hpp::pinocchio::Joint::setChildList ( )

protected

Store list of childrens.

◆ upperBound() [1/2]

value_type hpp::pinocchio::Joint::upperBound ( size_type rank ) const

Get upper bound of given degree of freedom.

◆ upperBound() [2/2]

void hpp::pinocchio::Joint::upperBound	(	size_type	rank,
		value_type	upperBound
	)

Set upper bound of given degree of freedom.

◆ upperBoundAngularVelocity()

value_type hpp::pinocchio::Joint::upperBoundAngularVelocity ( ) const

Get upper bound on angular velocity of the joint frame

Returns

coefficient $\lambda$ such that

$\begin{equation*} \forall \mathbf{q}_{joint}\ \ \ \ \ \ \|\omega\| \leq \lambda \|\mathbf{\dot{q}}_{joint}\| \end{equation*}$

where

$\mathbf{q}_{joint}$ is any joint configuration,
$\mathbf{\dot{q}}_{joint}$ is the joint velocity, and
$\omega = J(\mathbf{q})*\mathbf{\dot{q}}$ is the angular velocity of the joint frame.

◆ upperBoundLinearVelocity()

value_type hpp::pinocchio::Joint::upperBoundLinearVelocity ( ) const

Get upper bound on linear velocity of the joint frame

Returns

coefficient $\lambda$ such that

$\begin{equation*} \forall \mathbf{q}_{joint}\ \ \ \ \ \ \|\mathbf {v}\| \leq \lambda \|\mathbf{\dot{q}}_{joint}\| \end{equation*}$

where

$\mathbf{q}_{joint}$ is any joint configuration,
$\mathbf{\dot{q}}_{joint}$ is the joint velocity, and
$\mathbf{v} = J(\mathbf{q})*\mathbf{\dot{q}}$ is the linear velocity of the joint frame.

◆ upperBounds()

void hpp::pinocchio::Joint::upperBounds ( vectorIn_t upperBounds )

Set upper bounds.

Friends And Related Function Documentation

◆ Device

friend class Device

friend

Member Data Documentation

◆ children

std::vector<JointIndex> hpp::pinocchio::Joint::children

protected

◆ devicePtr

DeviceWkPtr_t hpp::pinocchio::Joint::devicePtr

protected

◆ jointIndex

JointIndex hpp::pinocchio::Joint::jointIndex

protected

◆ maximalDistanceToParent_

value_type hpp::pinocchio::Joint::maximalDistanceToParent_

protected

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

include/hpp/pinocchio/joint.hh

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Construction and copy and destruction

Detailed Description

Constructor & Destructor Documentation

◆ Joint()

◆ ~Joint()

Member Function Documentation

◆ childJoint()

◆ computeMaximalDistanceToParent()

◆ configSize()

◆ configurationSpace()

◆ create()

◆ currentTransformation() [1/2]

◆ currentTransformation() [2/2]

◆ data()

◆ display()

◆ index()

◆ isBounded() [1/2]

◆ isBounded() [2/2]

◆ jacobian() [1/2]

◆ jacobian() [2/2]

◆ jointModel()

◆ linkedBody()

◆ lowerBound() [1/2]

◆ lowerBound() [2/2]

◆ lowerBounds()

◆ maximalDistanceToParent()

◆ model() [1/2]

◆ model() [2/2]

◆ name()

◆ numberChildJoints()

◆ numberDof()

◆ parentJoint()

◆ positionInParentFrame()

◆ rankInConfiguration()

◆ rankInVelocity()

◆ RnxSOnConfigurationSpace()

◆ robot() [1/2]

◆ robot() [2/2]

◆ selfAssert()

◆ setChildList()

◆ upperBound() [1/2]

◆ upperBound() [2/2]

◆ upperBoundAngularVelocity()

◆ upperBoundLinearVelocity()

◆ upperBounds()

Friends And Related Function Documentation

◆ Device

Member Data Documentation

◆ children

◆ devicePtr

◆ jointIndex

◆ maximalDistanceToParent_