moveit2
The MoveIt Motion Planning Framework for ROS 2.
Public Member Functions | List of all members
ikfast::IkSolutionBase< T > Class Template Referenceabstract

The discrete solutions are returned in this structure. More...

#include <ikfast.h>

Inheritance diagram for ikfast::IkSolutionBase< T >:
Inheritance graph
[legend]

Public Member Functions

virtual ~IkSolutionBase ()
 
virtual void GetSolution (T *solution, const T *freevalues) const =0
 gets a concrete solution More...
 
virtual void GetSolution (std::vector< T > &solution, const std::vector< T > &freevalues) const
 std::vector version of GetSolution More...
 
virtual const std::vector< int > & GetFree () const =0
 Gets the indices of the configuration space that have to be preset before a full solution can be returned. More...
 
virtual int GetDOF () const =0
 the dof of the solution More...
 
virtual ~IkSolutionBase ()
 
virtual void GetSolution (T *solution, const T *freevalues) const =0
 gets a concrete solution More...
 
virtual void GetSolution (std::vector< T > &solution, const std::vector< T > &freevalues) const
 std::vector version of GetSolution More...
 
virtual const std::vector< int > & GetFree () const =0
 Gets the indices of the configuration space that have to be preset before a full solution can be returned. More...
 
virtual int GetDOF () const =0
 the dof of the solution More...
 

Detailed Description

template<typename T>
class ikfast::IkSolutionBase< T >

The discrete solutions are returned in this structure.

Sometimes the joint axes of the robot can align allowing an infinite number of solutions. Stores all these solutions in the form of free variables that the user has to set when querying the solution. Its prototype is:

Definition at line 72 of file ikfast.h.

Constructor & Destructor Documentation

◆ ~IkSolutionBase() [1/2]

template<typename T >
virtual ikfast::IkSolutionBase< T >::~IkSolutionBase ( )
inlinevirtual

Definition at line 75 of file ikfast.h.

◆ ~IkSolutionBase() [2/2]

template<typename T >
virtual ikfast::IkSolutionBase< T >::~IkSolutionBase ( )
inlinevirtual

Definition at line 72 of file ikfast.h.

Member Function Documentation

◆ GetDOF() [1/2]

template<typename T >
virtual int ikfast::IkSolutionBase< T >::GetDOF ( ) const
pure virtual

the dof of the solution

Implemented in ikfast::IkSolution< T >, and ikfast::IkSolution< T >.

Here is the caller graph for this function:

◆ GetDOF() [2/2]

template<typename T >
virtual int ikfast::IkSolutionBase< T >::GetDOF ( ) const
pure virtual

the dof of the solution

Implemented in ikfast::IkSolution< T >, and ikfast::IkSolution< T >.

◆ GetFree() [1/2]

template<typename T >
virtual const std::vector<int>& ikfast::IkSolutionBase< T >::GetFree ( ) const
pure virtual

Gets the indices of the configuration space that have to be preset before a full solution can be returned.

Returns
vector of indices indicating the free parameters

Implemented in ikfast::IkSolution< T >, and ikfast::IkSolution< T >.

Here is the caller graph for this function:

◆ GetFree() [2/2]

template<typename T >
virtual const std::vector<int>& ikfast::IkSolutionBase< T >::GetFree ( ) const
pure virtual

Gets the indices of the configuration space that have to be preset before a full solution can be returned.

Returns
vector of indices indicating the free parameters

Implemented in ikfast::IkSolution< T >, and ikfast::IkSolution< T >.

◆ GetSolution() [1/4]

template<typename T >
virtual void ikfast::IkSolutionBase< T >::GetSolution ( std::vector< T > &  solution,
const std::vector< T > &  freevalues 
) const
inlinevirtual

std::vector version of GetSolution

Reimplemented in ikfast::IkSolution< T >, and ikfast::IkSolution< T >.

Definition at line 85 of file ikfast.h.

Here is the call graph for this function:

◆ GetSolution() [2/4]

template<typename T >
virtual void ikfast::IkSolutionBase< T >::GetSolution ( std::vector< T > &  solution,
const std::vector< T > &  freevalues 
) const
inlinevirtual

std::vector version of GetSolution

Reimplemented in ikfast::IkSolution< T >, and ikfast::IkSolution< T >.

Definition at line 82 of file ikfast.h.

Here is the call graph for this function:

◆ GetSolution() [3/4]

template<typename T >
virtual void ikfast::IkSolutionBase< T >::GetSolution ( T *  solution,
const T *  freevalues 
) const
pure virtual

gets a concrete solution

Parameters
[out]solutionthe result
[in]freevaluesvalues for the free parameters \se GetFree

Implemented in ikfast::IkSolution< T >, and ikfast::IkSolution< T >.

Here is the caller graph for this function:

◆ GetSolution() [4/4]

template<typename T >
virtual void ikfast::IkSolutionBase< T >::GetSolution ( T *  solution,
const T *  freevalues 
) const
pure virtual

gets a concrete solution

Parameters
[out]solutionthe result
[in]freevaluesvalues for the free parameters \se GetFree

Implemented in ikfast::IkSolution< T >, and ikfast::IkSolution< T >.


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