Tesseract 0.28.4
Loading...
Searching...
No Matches
tesseract::kinematics::KinematicsPluginFactory Class Reference

Public Member Functions

 KinematicsPluginFactory (const KinematicsPluginFactory &)=default
KinematicsPluginFactory & operator= (const KinematicsPluginFactory &)=default
 KinematicsPluginFactory (KinematicsPluginFactory &&)=default
KinematicsPluginFactory & operator= (KinematicsPluginFactory &&)=default
 KinematicsPluginFactory (YAML::Node config, const tesseract::common::ResourceLocator &locator)
 Load plugins from yaml node.
 KinematicsPluginFactory (const std::filesystem::path &config, const tesseract::common::ResourceLocator &locator)
 Load plugins from file path.
 KinematicsPluginFactory (const std::string &config, const tesseract::common::ResourceLocator &locator)
 Load plugins from string.
void addSearchPath (const std::string &path)
 Add location for the plugin loader to search.
std::vector< std::string > getSearchPaths () const
 Get the plugin search paths.
void addSearchLibrary (const std::string &library_name)
 Add a library to search for plugin name.
std::vector< std::string > getSearchLibraries () const
 Get the plugin search libraries.
void addFwdKinPlugin (const std::string &group_name, const std::string &solver_name, tesseract::common::PluginInfo plugin_info)
 Add a forward kinematics plugin to the manager.
std::map< std::string, tesseract::common::PluginInfoContainer > getFwdKinPlugins () const
 Get the map of forward kinematic plugins.
void removeFwdKinPlugin (const std::string &group_name, const std::string &solver_name)
 remove forward kinematics plugin from the manager
void setDefaultFwdKinPlugin (const std::string &group_name, const std::string &solver_name)
 Set a groups default forward kinematics solver.
std::string getDefaultFwdKinPlugin (const std::string &group_name) const
 Get the default forward kinematics solver for a group.
void addInvKinPlugin (const std::string &group_name, const std::string &solver_name, tesseract::common::PluginInfo plugin_info)
 Add a inverse kinematics plugin to the manager.
std::map< std::string, tesseract::common::PluginInfoContainer > getInvKinPlugins () const
 Get the map of inverse kinematic plugins.
void removeInvKinPlugin (const std::string &group_name, const std::string &solver_name)
 remove inverse kinematics plugin from the manager
void setDefaultInvKinPlugin (const std::string &group_name, const std::string &solver_name)
 Set a groups default inverse kinematics solver.
std::string getDefaultInvKinPlugin (const std::string &group_name) const
 Get the default forward inverse solver for a group.
std::unique_ptr< ForwardKinematics > createFwdKin (const std::string &group_name, const std::string &solver_name, const tesseract::scene_graph::SceneGraph &scene_graph, const tesseract::scene_graph::SceneState &scene_state) const
 Get forward kinematics object given group name and solver name.
std::unique_ptr< InverseKinematics > createInvKin (const std::string &group_name, const std::string &solver_name, const tesseract::scene_graph::SceneGraph &scene_graph, const tesseract::scene_graph::SceneState &scene_state) const
 Get inverse kinematics object given group name and solver name.
std::unique_ptr< ForwardKinematics > createFwdKin (const std::string &solver_name, const tesseract::common::PluginInfo &plugin_info, const tesseract::scene_graph::SceneGraph &scene_graph, const tesseract::scene_graph::SceneState &scene_state) const
 Get forward kinematics object given plugin info.
std::unique_ptr< InverseKinematics > createInvKin (const std::string &solver_name, const tesseract::common::PluginInfo &plugin_info, const tesseract::scene_graph::SceneGraph &scene_graph, const tesseract::scene_graph::SceneState &scene_state) const
 Get inverse kinematics object given plugin info.
void saveConfig (const std::filesystem::path &file_path) const
 Save the plugin information to a yaml config file.
YAML::Node getConfig () const
 Get the plugin information config as a yaml node.

Constructor & Destructor Documentation

◆ KinematicsPluginFactory() [1/3]

tesseract::kinematics::KinematicsPluginFactory::KinematicsPluginFactory ( YAML::Node config,
const tesseract::common::ResourceLocator & locator )

Load plugins from yaml node.

Parameters
configThe config node

◆ KinematicsPluginFactory() [2/3]

tesseract::kinematics::KinematicsPluginFactory::KinematicsPluginFactory ( const std::filesystem::path & config,
const tesseract::common::ResourceLocator & locator )

Load plugins from file path.

Parameters
configThe config file path

◆ KinematicsPluginFactory() [3/3]

tesseract::kinematics::KinematicsPluginFactory::KinematicsPluginFactory ( const std::string & config,
const tesseract::common::ResourceLocator & locator )

Load plugins from string.

Parameters
configThe config string

Member Function Documentation

◆ addSearchPath()

void tesseract::kinematics::KinematicsPluginFactory::addSearchPath ( const std::string & path)

Add location for the plugin loader to search.

Parameters
pathThe full path to the directory

◆ getSearchPaths()

std::vector< std::string > tesseract::kinematics::KinematicsPluginFactory::getSearchPaths ( ) const

Get the plugin search paths.

Returns
The search paths

◆ addSearchLibrary()

void tesseract::kinematics::KinematicsPluginFactory::addSearchLibrary ( const std::string & library_name)

Add a library to search for plugin name.

Parameters
library_nameThe library name without the prefix or suffix

◆ getSearchLibraries()

std::vector< std::string > tesseract::kinematics::KinematicsPluginFactory::getSearchLibraries ( ) const

Get the plugin search libraries.

Returns
The search libraries

◆ addFwdKinPlugin()

void tesseract::kinematics::KinematicsPluginFactory::addFwdKinPlugin ( const std::string & group_name,
const std::string & solver_name,
tesseract::common::PluginInfo plugin_info )

Add a forward kinematics plugin to the manager.

Parameters
group_nameThe group name
solver_nameThe solver name
plugin_infoThe plugin information

◆ getFwdKinPlugins()

std::map< std::string, tesseract::common::PluginInfoContainer > tesseract::kinematics::KinematicsPluginFactory::getFwdKinPlugins ( ) const

Get the map of forward kinematic plugins.

Returns
A map of plugins

◆ removeFwdKinPlugin()

void tesseract::kinematics::KinematicsPluginFactory::removeFwdKinPlugin ( const std::string & group_name,
const std::string & solver_name )

remove forward kinematics plugin from the manager

Parameters
group_nameThe group name
solver_nameThe solver name

◆ setDefaultFwdKinPlugin()

void tesseract::kinematics::KinematicsPluginFactory::setDefaultFwdKinPlugin ( const std::string & group_name,
const std::string & solver_name )

Set a groups default forward kinematics solver.

A group can have multiple inverse kinematics solvers

Parameters
group_nameThe group name
solver_nameThe solver name

◆ getDefaultFwdKinPlugin()

std::string tesseract::kinematics::KinematicsPluginFactory::getDefaultFwdKinPlugin ( const std::string & group_name) const

Get the default forward kinematics solver for a group.

Parameters
group_nameThe group
Returns
The default solver name

◆ addInvKinPlugin()

void tesseract::kinematics::KinematicsPluginFactory::addInvKinPlugin ( const std::string & group_name,
const std::string & solver_name,
tesseract::common::PluginInfo plugin_info )

Add a inverse kinematics plugin to the manager.

Parameters
group_nameThe group name
solver_nameThe solver name
plugin_infoThe plugin information

◆ getInvKinPlugins()

std::map< std::string, tesseract::common::PluginInfoContainer > tesseract::kinematics::KinematicsPluginFactory::getInvKinPlugins ( ) const

Get the map of inverse kinematic plugins.

Returns
A map of plugins

◆ removeInvKinPlugin()

void tesseract::kinematics::KinematicsPluginFactory::removeInvKinPlugin ( const std::string & group_name,
const std::string & solver_name )

remove inverse kinematics plugin from the manager

Parameters
group_nameThe group name
solver_nameThe solver name

◆ setDefaultInvKinPlugin()

void tesseract::kinematics::KinematicsPluginFactory::setDefaultInvKinPlugin ( const std::string & group_name,
const std::string & solver_name )

Set a groups default inverse kinematics solver.

A group can have multiple inverse kinematics solvers

Parameters
group_nameThe group name
solver_nameThe solver name

◆ getDefaultInvKinPlugin()

std::string tesseract::kinematics::KinematicsPluginFactory::getDefaultInvKinPlugin ( const std::string & group_name) const

Get the default forward inverse solver for a group.

Parameters
group_nameThe group
Returns
The default solver name

◆ createFwdKin() [1/2]

std::unique_ptr< ForwardKinematics > tesseract::kinematics::KinematicsPluginFactory::createFwdKin ( const std::string & group_name,
const std::string & solver_name,
const tesseract::scene_graph::SceneGraph & scene_graph,
const tesseract::scene_graph::SceneState & scene_state ) const

Get forward kinematics object given group name and solver name.

This looks for kinematics plugin info added using addFwdKinPlugin. If not found nullptr is returned.

Parameters
group_nameThe group name
solver_nameThe solver
scene_graphThe scene graph
scene_stateThe scene state

◆ createInvKin() [1/2]

std::unique_ptr< InverseKinematics > tesseract::kinematics::KinematicsPluginFactory::createInvKin ( const std::string & group_name,
const std::string & solver_name,
const tesseract::scene_graph::SceneGraph & scene_graph,
const tesseract::scene_graph::SceneState & scene_state ) const

Get inverse kinematics object given group name and solver name.

This looks for kinematics plugin info added using addInvKinPlugin. If not found nullptr is returned.

Parameters
group_nameThe group name
solver_nameThe solver
scene_graphThe scene graph
scene_stateThe scene state

◆ createFwdKin() [2/2]

std::unique_ptr< ForwardKinematics > tesseract::kinematics::KinematicsPluginFactory::createFwdKin ( const std::string & solver_name,
const tesseract::common::PluginInfo & plugin_info,
const tesseract::scene_graph::SceneGraph & scene_graph,
const tesseract::scene_graph::SceneState & scene_state ) const

Get forward kinematics object given plugin info.

Parameters
plugin_infoThe plugin information to create kinematics object
scene_graphThe scene graph
scene_stateThe scene state

◆ createInvKin() [2/2]

std::unique_ptr< InverseKinematics > tesseract::kinematics::KinematicsPluginFactory::createInvKin ( const std::string & solver_name,
const tesseract::common::PluginInfo & plugin_info,
const tesseract::scene_graph::SceneGraph & scene_graph,
const tesseract::scene_graph::SceneState & scene_state ) const

Get inverse kinematics object given plugin info.

Parameters
plugin_infoThe plugin information to create kinematics object
scene_graphThe scene graph
scene_stateThe scene state

◆ saveConfig()

void tesseract::kinematics::KinematicsPluginFactory::saveConfig ( const std::filesystem::path & file_path) const

Save the plugin information to a yaml config file.

Parameters
file_pathThe file path

◆ getConfig()

YAML::Node tesseract::kinematics::KinematicsPluginFactory::getConfig ( ) const

Get the plugin information config as a yaml node.

Returns
The plugin information config yaml node/