Tesseract 0.28.4
Loading...
Searching...
No Matches
tesseract::kinematics::InvKinFactory Class Referenceabstract

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

#include <kinematics_plugin_factory.h>

Inheritance diagram for tesseract::kinematics::InvKinFactory:

Public Types

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

Public Member Functions

std::unique_ptr< InverseKinematics > 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
 Create Inverse Kinematics Object.
virtual tesseract::common::PropertyTree schema () const
 Return the PropertyTree schema describing the config this factory accepts.

Protected Member Functions

virtual std::unique_ptr< InverseKinematics > createImpl (const std::string &solver_name, const tesseract::scene_graph::SceneGraph &scene_graph, const tesseract::scene_graph::SceneState &scene_state, const KinematicsPluginFactory &plugin_factory, const tesseract::common::PropertyTree &config) const =0

Static Protected Member Functions

static std::string getSection ()

Friends

class boost_plugin_loader::PluginLoader
class KinematicsPluginFactory

Detailed Description

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

Member Function Documentation

◆ create()

std::unique_ptr< InverseKinematics > tesseract::kinematics::InvKinFactory::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

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
The created kinematics object
Exceptions
tesseract::common::PropertyTreeValidationErrorif config does not match schema()
std::exceptionif the implementation fails to create the object

◆ schema()