Class for constraints on the orientation of a link. More...

#include <kinematic_constraint.h>

Inheritance diagram for kinematic_constraints::OrientationConstraint:

Collaboration diagram for kinematic_constraints::OrientationConstraint:

Public Member Functions
	OrientationConstraint (const moveit::core::RobotModelConstPtr &model)
	Constructor. More...

bool	configure (const moveit_msgs::msg::OrientationConstraint &oc, const moveit::core::Transforms &tf)
	Configure the constraint based on a moveit_msgs::msg::OrientationConstraint. More...

bool	equal (const KinematicConstraint &other, double margin) const override
	Check if two orientation constraints are the same. More...

void	clear () override
	Clear the stored constraint. More...

ConstraintEvaluationResult	decide (const moveit::core::RobotState &state, bool verbose=false) const override
	Decide whether the constraint is satisfied in the indicated state. More...

bool	enabled () const override
	This function returns true if this constraint is configured and able to decide whether states do meet the constraint or not. If this function returns false it means that decide() will always return true – there is no constraint to be checked. More...

void	print (std::ostream &out=std::cout) const override
	Print the constraint data. More...

const moveit::core::LinkModel *	getLinkModel () const
	Gets the subject link model. More...

const std::string &	getReferenceFrame () const
	The target frame of the planning_models::Transforms class, for interpreting the rotation frame. More...

bool	mobileReferenceFrame () const
	Whether or not a mobile reference frame is being employed. More...

const Eigen::Matrix3d &	getDesiredRotationMatrix () const
	The rotation target in the reference frame. More...

double	getXAxisTolerance () const
	Gets the X axis tolerance. More...

double	getYAxisTolerance () const
	Gets the Y axis tolerance. More...

double	getZAxisTolerance () const
	Gets the Z axis tolerance. More...

int	getParameterizationType () const

Public Member Functions inherited from kinematic_constraints::KinematicConstraint
	KinematicConstraint (const moveit::core::RobotModelConstPtr &model)
	Constructor. More...

virtual	~KinematicConstraint ()

ConstraintType	getType () const
	Get the type of constraint. More...

double	getConstraintWeight () const
	The weight of a constraint is a multiplicative factor associated to the distance computed by the decide() function. More...

const moveit::core::RobotModelConstPtr &	getRobotModel () const

Protected Attributes
const moveit::core::LinkModel *	link_model_
	The target link model. More...

Eigen::Matrix3d	desired_rotation_matrix_
	The desired rotation matrix in the tf frame. Guaranteed to be valid rotation matrix. More...

Eigen::Matrix3d	desired_rotation_matrix_inv_
	The inverse of the desired rotation matrix, precomputed for efficiency. Guaranteed to be valid rotation matrix. More...

std::string	desired_rotation_frame_id_
	The target frame of the transform tree. More...

bool	mobile_frame_
	Whether or not the header frame is mobile or fixed. More...

int	parameterization_type_
	Parameterization type for orientation tolerance. More...

double	absolute_x_axis_tolerance_

double	absolute_y_axis_tolerance_

double	absolute_z_axis_tolerance_
	Storage for the tolerances. More...

Protected Attributes inherited from kinematic_constraints::KinematicConstraint
ConstraintType	type_
	The type of the constraint. More...

moveit::core::RobotModelConstPtr	robot_model_
	The kinematic model associated with this constraint. More...

double	constraint_weight_
	The weight of a constraint is a multiplicative factor associated to the distance computed by the decide() function More...

Additional Inherited Members
Public Types inherited from kinematic_constraints::KinematicConstraint
enum	ConstraintType { UNKNOWN_CONSTRAINT , JOINT_CONSTRAINT , POSITION_CONSTRAINT , ORIENTATION_CONSTRAINT , VISIBILITY_CONSTRAINT }
	Enum for representing a constraint. More...

Detailed Description

Class for constraints on the orientation of a link.

This class expresses an orientation constraint on a particular link. The constraint is specified in terms of a quaternion, with tolerances on X,Y, and Z axes. The rotation difference is computed based on the XYZ Euler angle formulation (intrinsic rotations) or as a rotation vector. This depends on the Parameterization type. The header on the quaternion can be specified in terms of either a fixed or a mobile frame. The type value will return ORIENTATION_CONSTRAINT.

Definition at line 347 of file kinematic_constraint.h.

Constructor & Destructor Documentation

◆ OrientationConstraint()

kinematic_constraints::OrientationConstraint::OrientationConstraint ( const moveit::core::RobotModelConstPtr & model )

inline

Constructor.

Parameters

[in] model The kinematic model used for constraint evaluation

Definition at line 358 of file kinematic_constraint.h.

Member Function Documentation

◆ clear()

void kinematic_constraints::OrientationConstraint::clear ( )

overridevirtual

Clear the stored constraint.

Implements kinematic_constraints::KinematicConstraint.

Definition at line 655 of file kinematic_constraint.cpp.

Here is the caller graph for this function:

◆ configure()

bool kinematic_constraints::OrientationConstraint::configure	(	const moveit_msgs::msg::OrientationConstraint &	oc,
		const moveit::core::Transforms &	tf
	)

Configure the constraint based on a moveit_msgs::msg::OrientationConstraint.

For the configure command to be successful, the link must exist in the kinematic model. Note that if the absolute tolerance values are left as 0.0 only values less than a very small epsilon will evaluate to satisfied.

Parameters

[in] oc OrientationConstraint for configuration

Returns: True if constraint can be configured from oc

Definition at line 558 of file kinematic_constraint.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ decide()

ConstraintEvaluationResult kinematic_constraints::OrientationConstraint::decide	(	const moveit::core::RobotState &	state,
		bool	verbose = `false`
	)		const

overridevirtual

Decide whether the constraint is satisfied in the indicated state.

Parameters

[in]	state	The kinematic state used for evaluation
[in]	verbose	Whether or not to print output

Returns

Implements kinematic_constraints::KinematicConstraint.

Definition at line 670 of file kinematic_constraint.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enabled()

bool kinematic_constraints::OrientationConstraint::enabled ( ) const

overridevirtual

This function returns true if this constraint is configured and able to decide whether states do meet the constraint or not. If this function returns false it means that decide() will always return true – there is no constraint to be checked.

Implements kinematic_constraints::KinematicConstraint.

Definition at line 665 of file kinematic_constraint.cpp.

◆ equal()

bool kinematic_constraints::OrientationConstraint::equal	(	const KinematicConstraint &	other,
		double	margin
	)		const

overridevirtual

Check if two orientation constraints are the same.

This means that the types are the same, the subject of the constraint is the same, and all values associated with the constraint are within a margin. The other constraint must also be enabled. For this to be true of orientation constraints:

The link must be the same
The rotations specified by the quaternions must be within the margin
The tolerances must all be within the margin

Parameters

[in]	other	The other constraint to test
[in]	margin	The margin to apply to all values associated with constraint

Returns: True if equal, otherwise false

Implements kinematic_constraints::KinematicConstraint.

Definition at line 637 of file kinematic_constraint.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDesiredRotationMatrix()

const Eigen::Matrix3d& kinematic_constraints::OrientationConstraint::getDesiredRotationMatrix ( ) const

inline

The rotation target in the reference frame.

Returns: The target rotation.

The returned matrix is always a valid rotation matrix.

Definition at line 442 of file kinematic_constraint.h.

◆ getLinkModel()

const moveit::core::LinkModel* kinematic_constraints::OrientationConstraint::getLinkModel ( ) const

inline

Gets the subject link model.

Returns: Returns the current link model

Definition at line 408 of file kinematic_constraint.h.

Here is the caller graph for this function:

◆ getParameterizationType()

int kinematic_constraints::OrientationConstraint::getParameterizationType ( ) const

inline

Definition at line 481 of file kinematic_constraint.h.

Here is the caller graph for this function:

◆ getReferenceFrame()

const std::string& kinematic_constraints::OrientationConstraint::getReferenceFrame ( ) const

inline

The target frame of the planning_models::Transforms class, for interpreting the rotation frame.

Returns: The reference frame.

Definition at line 419 of file kinematic_constraint.h.

◆ getXAxisTolerance()

double kinematic_constraints::OrientationConstraint::getXAxisTolerance ( ) const

inline

Gets the X axis tolerance.

Returns: The X axis tolerance

Definition at line 454 of file kinematic_constraint.h.

◆ getYAxisTolerance()

double kinematic_constraints::OrientationConstraint::getYAxisTolerance ( ) const

inline

Gets the Y axis tolerance.

Returns: The Y axis tolerance

Definition at line 465 of file kinematic_constraint.h.

◆ getZAxisTolerance()

double kinematic_constraints::OrientationConstraint::getZAxisTolerance ( ) const

inline

Gets the Z axis tolerance.

Returns: The Z axis tolerance

Definition at line 476 of file kinematic_constraint.h.

◆ mobileReferenceFrame()

bool kinematic_constraints::OrientationConstraint::mobileReferenceFrame ( ) const

inline

Whether or not a mobile reference frame is being employed.

Returns: True if a mobile reference frame is being employed, and otherwise false.

Definition at line 430 of file kinematic_constraint.h.

Here is the caller graph for this function:

◆ print()

void kinematic_constraints::OrientationConstraint::print ( std::ostream & = std::cout ) const

overridevirtual

Print the constraint data.

Parameters

[in] out The file descriptor for printing

Reimplemented from kinematic_constraints::KinematicConstraint.

Definition at line 746 of file kinematic_constraint.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ absolute_x_axis_tolerance_

double kinematic_constraints::OrientationConstraint::absolute_x_axis_tolerance_

protected

Definition at line 495 of file kinematic_constraint.h.

◆ absolute_y_axis_tolerance_

double kinematic_constraints::OrientationConstraint::absolute_y_axis_tolerance_

protected

Definition at line 495 of file kinematic_constraint.h.

◆ absolute_z_axis_tolerance_

double kinematic_constraints::OrientationConstraint::absolute_z_axis_tolerance_

protected

Storage for the tolerances.

Definition at line 496 of file kinematic_constraint.h.

◆ desired_rotation_frame_id_

std::string kinematic_constraints::OrientationConstraint::desired_rotation_frame_id_

protected

The target frame of the transform tree.

Definition at line 492 of file kinematic_constraint.h.

◆ desired_rotation_matrix_

Eigen::Matrix3d kinematic_constraints::OrientationConstraint::desired_rotation_matrix_

protected

The desired rotation matrix in the tf frame. Guaranteed to be valid rotation matrix.

Definition at line 488 of file kinematic_constraint.h.

◆ desired_rotation_matrix_inv_

Eigen::Matrix3d kinematic_constraints::OrientationConstraint::desired_rotation_matrix_inv_

protected

The inverse of the desired rotation matrix, precomputed for efficiency. Guaranteed to be valid rotation matrix.

Definition at line 490 of file kinematic_constraint.h.

◆ link_model_

const moveit::core::LinkModel* kinematic_constraints::OrientationConstraint::link_model_

protected

The target link model.

Definition at line 487 of file kinematic_constraint.h.

◆ mobile_frame_

bool kinematic_constraints::OrientationConstraint::mobile_frame_

protected

Whether or not the header frame is mobile or fixed.

Definition at line 493 of file kinematic_constraint.h.

◆ parameterization_type_

int kinematic_constraints::OrientationConstraint::parameterization_type_

protected

Parameterization type for orientation tolerance.

Definition at line 494 of file kinematic_constraint.h.

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

moveit_core/kinematic_constraints/include/moveit/kinematic_constraints/kinematic_constraint.h
moveit_core/kinematic_constraints/src/kinematic_constraint.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OrientationConstraint()

Member Function Documentation

◆ clear()

◆ configure()

◆ decide()

◆ enabled()

◆ equal()

◆ getDesiredRotationMatrix()

◆ getLinkModel()

◆ getParameterizationType()

◆ getReferenceFrame()

◆ getXAxisTolerance()

◆ getYAxisTolerance()

◆ getZAxisTolerance()

◆ mobileReferenceFrame()

◆ print()

Member Data Documentation

◆ absolute_x_axis_tolerance_

◆ absolute_y_axis_tolerance_

◆ absolute_z_axis_tolerance_

◆ desired_rotation_frame_id_

◆ desired_rotation_matrix_

◆ desired_rotation_matrix_inv_

◆ link_model_

◆ mobile_frame_

◆ parameterization_type_