Tesseract
Motion Planning Environment
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Protected Attributes | Friends | List of all members
tesseract_kinematics::FwdKinFactory Class Referenceabstract

Define a forward kinematics plugin which the factory can create an instance. More...

#include <kinematics_plugin_factory.h>

Inheritance diagram for tesseract_kinematics::FwdKinFactory:
Inheritance graph
[legend]
Collaboration diagram for tesseract_kinematics::FwdKinFactory:
Collaboration graph
[legend]

Public Types

using Ptr = std::shared_ptr< FwdKinFactory >
 
using ConstPtr = std::shared_ptr< const FwdKinFactory >
 

Public Member Functions

virtual ~FwdKinFactory ()=default
 
virtual ForwardKinematics::UPtr create (const std::string &solver_name, const tesseract_scene_graph::SceneGraph &scene_graph, const tesseract_scene_graph::SceneState &scene_state, const KinematicsPluginFactory &plugin_factory, const YAML::Node &config) const =0
 Create Inverse Kinematics Object. More...
 

Static Protected Attributes

static const std::string SECTION_NAME = "FwdKin"
 

Friends

class PluginLoader
 

Detailed Description

Define a forward kinematics plugin which the factory can create an instance.

Member Typedef Documentation

◆ ConstPtr

◆ Ptr

Constructor & Destructor Documentation

◆ ~FwdKinFactory()

virtual tesseract_kinematics::FwdKinFactory::~FwdKinFactory ( )
virtualdefault

Member Function Documentation

◆ create()

virtual ForwardKinematics::UPtr tesseract_kinematics::FwdKinFactory::create ( const std::string &  solver_name,
const tesseract_scene_graph::SceneGraph scene_graph,
const tesseract_scene_graph::SceneState scene_state,
const KinematicsPluginFactory plugin_factory,
const YAML::Node &  config 
) const
pure virtual

Create Inverse Kinematics Object.

Parameters
solver_nameThe solver name of the kinematic object
scene_graphThe Tesseract Scene Graph
scene_stateThe state of the scene graph
plugin_factoryProvide access to the plugin factory so plugins and load plugins
Returns
If failed to create, nullptr is returned.

Implemented in tesseract_kinematics::KDLFwdKinChainFactory.

Friends And Related Function Documentation

◆ PluginLoader

friend class PluginLoader
friend

Member Data Documentation

◆ SECTION_NAME

const std::string tesseract_kinematics::FwdKinFactory::SECTION_NAME = "FwdKin"
staticprotected

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