moveit2
The MoveIt Motion Planning Framework for ROS 2.
Public Member Functions | Public Attributes | List of all members
kinematic_constraints::ConstraintEvaluationResult Struct Reference

Struct for containing the results of constraint evaluation. More...

#include <kinematic_constraint.h>

Public Member Functions

 ConstraintEvaluationResult (bool result_satisfied=false, double dist=0.0)
 Constructor. More...
 

Public Attributes

bool satisfied
 Whether or not the constraint or constraints were satisfied. More...
 
double distance
 The distance evaluation from the constraint or constraints. More...
 

Detailed Description

Struct for containing the results of constraint evaluation.

Definition at line 55 of file kinematic_constraint.h.

Constructor & Destructor Documentation

◆ ConstraintEvaluationResult()

kinematic_constraints::ConstraintEvaluationResult::ConstraintEvaluationResult ( bool  result_satisfied = false,
double  dist = 0.0 
)
inline

Constructor.

Parameters
[in]result_satisfiedTrue if the constraint evaluated to true, otherwise false
[in]distThe distance evaluated by the constraint
Returns

Definition at line 65 of file kinematic_constraint.h.

Member Data Documentation

◆ distance

double kinematic_constraints::ConstraintEvaluationResult::distance

The distance evaluation from the constraint or constraints.

Definition at line 71 of file kinematic_constraint.h.

◆ satisfied

bool kinematic_constraints::ConstraintEvaluationResult::satisfied

Whether or not the constraint or constraints were satisfied.

Definition at line 70 of file kinematic_constraint.h.


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