Constraint of relative pose between two frames on a kinematic chain. More...

#include <hpp/constraints/implicit/relative-pose.hh>

Inheritance diagram for hpp::constraints::implicit::RelativePose:

Collaboration diagram for hpp::constraints::implicit::RelativePose:

Public Member Functions
virtual ImplicitPtr_t	copy () const
	Copy object and return shared pointer to copy. More...

const JointConstPtr_t &	joint1 () const
	Get joint1. More...

const JointConstPtr_t &	joint2 () const
	Get joint2. More...

Public Member Functions inherited from hpp::constraints::Implicit
bool	operator== (const Implicit &other) const
	Operator equality. More...

virtual	~Implicit ()

DifferentiableFunction &	function () const
	Return a reference to function \(h\). More...

const DifferentiableFunctionPtr_t &	functionPtr () const
	Return a reference to function \(h\). More...

void	rightHandSideFromConfig (ConfigurationIn_t config)
	Set the right hand side from a configuration. More...

void	rightHandSide (vectorIn_t rhs)
	Set the right hand side of the equation. More...

vectorIn_t	rightHandSide () const
	Return the right hand side of the equation. More...

size_type	rhsSize () const HPP_CONSTRAINTS_DEPRECATED
	Return the dimension of the left hand side function tangent output space. More...

size_type	parameterSize () const
	Get size of parameter defining the right hand side of the constraint. More...

size_type	rightHandSideSize () const
	Get size of right hand side of the constraint. More...

const ComparisonTypes_t &	comparisonType () const
	Return the ComparisonType. More...

void	comparisonType (const ComparisonTypes_t &comp)
	Set the comparison type. More...

bool	constantRightHandSide () const HPP_CONSTRAINTS_DEPRECATED
	Whether right hand side is constant. More...

vectorOut_t	rightHandSide ()
	Return a modifiable reference to right hand side of equation. More...

vectorOut_t	nonConstRightHandSide () HPP_CONSTRAINTS_DEPRECATED
	Return a modifiable reference to right hand side of equation. More...

void	rightHandSideFunction (const DifferentiableFunctionPtr_t &rhsF)
	Set time-varying right hand side. More...

const DifferentiableFunctionPtr_t &	rightHandSideFunction () const
	Get time-varying right hand side. More...

vectorIn_t	rightHandSideAt (const value_type &s)
	Evaluate and set right hand side at given time. More...

Static Public Member Functions
static RelativePosePtr_t	create (const std::string &name, const DevicePtr_t &robot, const JointConstPtr_t &joint1, const JointConstPtr_t &joint2, const Transform3f &frame1, const Transform3f &frame2, std::vector< bool > mask=std::vector< bool >(6, true), ComparisonTypes_t comp=std::vector< ComparisonType >(), vectorIn_t rhs=vector_t())
	Create instance and return shared pointer. More...

static RelativePosePtr_t	createCopy (const RelativePosePtr_t &other)

Static Public Member Functions inherited from hpp::constraints::Implicit
static ImplicitPtr_t	create (const DifferentiableFunctionPtr_t &function)
	Create a shared pointer to a new instance. More...

static ImplicitPtr_t	create (const DifferentiableFunctionPtr_t &function, ComparisonTypes_t comp)
	Create a shared pointer to a new instance. More...

static ImplicitPtr_t	create (const DifferentiableFunctionPtr_t &function, ComparisonTypes_t comp, vectorIn_t rhs)
	Create a shared pointer to a new instance. More...

static ImplicitPtr_t	createCopy (const ImplicitPtr_t &other)
	Create a copy and return shared pointer. More...

Protected Member Functions
	RelativePose (const std::string &name, const DevicePtr_t &robot, const JointConstPtr_t &joint1, const JointConstPtr_t &joint2, const Transform3f &frame1, const Transform3f &frame2, std::vector< bool > mask=std::vector< bool >(6, true), ComparisonTypes_t comp=std::vector< ComparisonType >(), vectorIn_t rhs=vector_t())
	Constructor. More...

	RelativePose (const RelativePose &other)
	Copy constructor. More...

void	init (RelativePoseWkPtr_t weak)
	Store shared pointer to itself. More...

Protected Member Functions inherited from hpp::constraints::Implicit
	Implicit (const DifferentiableFunctionPtr_t &function, ComparisonTypes_t comp)
	Constructor. More...

	Implicit (const DifferentiableFunctionPtr_t &function, ComparisonTypes_t comp, vectorIn_t rhs)
	Constructor. More...

	Implicit (const Implicit &other)
	Copy constructor. More...

virtual bool	isEqual (const Implicit &other, bool swapAndTest) const
	Test equality with other instance. More...

void	init (const ImplicitWkPtr_t &weak)

Detailed Description

Constraint of relative pose between two frames on a kinematic chain.

Constructor & Destructor Documentation

◆ RelativePose() [1/2]

hpp::constraints::implicit::RelativePose::RelativePose	(	const std::string &	name,
		const DevicePtr_t &	robot,
		const JointConstPtr_t &	joint1,
		const JointConstPtr_t &	joint2,
		const Transform3f &	frame1,
		const Transform3f &	frame2,
		std::vector< bool >	mask = `std::vector< bool >(6, true)`,
		ComparisonTypes_t	comp = `std::vector< ComparisonType >()`,
		vectorIn_t	rhs = `vector_t()`
	)

protected

Constructor.

Parameters

name	the name of the constraints,
robot	the robot the constraints is applied to,
joint1	the first joint the transformation of which is constrained,
joint2	the second joint the transformation of which is constrained,
frame1	position of a fixed frame in joint 1,
frame2	position of a fixed frame in joint 2,
mask	vector of 6 boolean defining which coordinates of the error vector to take into account.

Note: if joint1 is 0x0, joint 1 frame is considered to be the global frame.

◆ RelativePose() [2/2]

hpp::constraints::implicit::RelativePose::RelativePose ( const RelativePose & other )

protected

Copy constructor.

Member Function Documentation

◆ copy()

virtual ImplicitPtr_t hpp::constraints::implicit::RelativePose::copy ( ) const

virtual

Copy object and return shared pointer to copy.

Reimplemented from hpp::constraints::Implicit.

Reimplemented in hpp::constraints::explicit_::RelativePose.

◆ create()

static RelativePosePtr_t hpp::constraints::implicit::RelativePose::create	(	const std::string &	name,
		const DevicePtr_t &	robot,
		const JointConstPtr_t &	joint1,
		const JointConstPtr_t &	joint2,
		const Transform3f &	frame1,
		const Transform3f &	frame2,
		std::vector< bool >	mask = `std::vector< bool >(6, true)`,
		ComparisonTypes_t	comp = `std::vector< ComparisonType >()`,
		vectorIn_t	rhs = `vector_t()`
	)

static

Create instance and return shared pointer.

Parameters

name	the name of the constraints,
robot	the robot the constraints is applied to,
joint1	the first joint the transformation of which is constrained,
joint2	the second joint the transformation of which is constrained,
frame1	position of a fixed frame in joint 1,
frame2	position of a fixed frame in joint 2,
mask	vector of 6 boolean defining which coordinates of the error vector to take into account.

Note: if joint1 is 0x0, joint 1 frame is considered to be the global frame.

◆ createCopy()

static RelativePosePtr_t hpp::constraints::implicit::RelativePose::createCopy ( const RelativePosePtr_t & other )

static

◆ init()

void hpp::constraints::implicit::RelativePose::init ( RelativePoseWkPtr_t weak )

protected

Store shared pointer to itself.

◆ joint1()

const JointConstPtr_t& hpp::constraints::implicit::RelativePose::joint1 ( ) const

inline

Get joint1.

◆ joint2()

const JointConstPtr_t& hpp::constraints::implicit::RelativePose::joint2 ( ) const

inline

Get joint2.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ RelativePose() [1/2]

◆ RelativePose() [2/2]

Member Function Documentation

◆ copy()

◆ create()

◆ createCopy()

◆ init()

◆ joint1()

◆ joint2()