Public Types | Public Member Functions | Static Protected Member Functions | 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]

Public Types

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

Public Member Functions

virtual std::unique_ptr< ForwardKinematicscreate (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...
 
virtual ~FwdKinFactory ()=default
 

Static Protected Member Functions

static std::string getSection ()
 

Friends

class boost_plugin_loader::PluginLoader
 

Detailed Description

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

Definition at line 89 of file kinematics_plugin_factory.h.

Member Typedef Documentation

◆ ConstPtr

Definition at line 93 of file kinematics_plugin_factory.h.

◆ Ptr

Definition at line 92 of file kinematics_plugin_factory.h.

Constructor & Destructor Documentation

◆ ~FwdKinFactory()

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

Member Function Documentation

◆ create()

virtual std::unique_ptr<ForwardKinematics> 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.

◆ getSection()

std::string tesseract_kinematics::FwdKinFactory::getSection ( )
staticprotected

Definition at line 52 of file kinematics_plugin_factory.cpp.

Friends And Related Function Documentation

◆ boost_plugin_loader::PluginLoader

friend class boost_plugin_loader::PluginLoader
friend

Definition at line 113 of file kinematics_plugin_factory.h.


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


tesseract_kinematics
Author(s): Levi Armstrong
autogenerated on Sun May 18 2025 03:02:14