Tesseract 0.28.4
Loading...
Searching...
No Matches
tesseract::collision::ContactManagersPluginFactory Class Reference

Public Member Functions

 ContactManagersPluginFactory (const ContactManagersPluginFactory &)=default
ContactManagersPluginFactory & operator= (const ContactManagersPluginFactory &)=default
 ContactManagersPluginFactory (ContactManagersPluginFactory &&)=default
ContactManagersPluginFactory & operator= (ContactManagersPluginFactory &&)=default
 ContactManagersPluginFactory (YAML::Node config, const tesseract::common::ResourceLocator &locator)
 Load plugins from yaml node.
 ContactManagersPluginFactory (const std::filesystem::path &config, const tesseract::common::ResourceLocator &locator)
 Load plugins from file path.
 ContactManagersPluginFactory (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 clearSearchPaths ()
 Clear the 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 clearSearchLibraries ()
 Clean the search libraries.
void addDiscreteContactManagerPlugin (const std::string &name, tesseract::common::PluginInfo plugin_info)
 Add a discrete contact manager plugin.
bool hasDiscreteContactManagerPlugins () const
 Check if it has discrete contact manager plugins.
tesseract::common::PluginInfoMap getDiscreteContactManagerPlugins () const
 Get the map of discrete contact manager plugin.
void removeDiscreteContactManagerPlugin (const std::string &name)
 Remove discrete contact manager plugin.
void setDefaultDiscreteContactManagerPlugin (const std::string &name)
 Set a default discrete contact manager.
std::string getDefaultDiscreteContactManagerPlugin () const
 Get the default discrete contact manager.
void addContinuousContactManagerPlugin (const std::string &name, tesseract::common::PluginInfo plugin_info)
 Add a continuous contact manager plugin.
bool hasContinuousContactManagerPlugins () const
 Check if it has continuous contact manager plugins.
tesseract::common::PluginInfoMap getContinuousContactManagerPlugins () const
 Get the map of continuous contact manager plugin.
void removeContinuousContactManagerPlugin (const std::string &name)
 Remove continuous contact manager plugin.
void setDefaultContinuousContactManagerPlugin (const std::string &name)
 Set a default continuous contact manager.
std::string getDefaultContinuousContactManagerPlugin () const
 Get the default continuous contact manager.
std::unique_ptr< DiscreteContactManager > createDiscreteContactManager (const std::string &name) const
 Get discrete contact manager object given name.
std::unique_ptr< DiscreteContactManager > createDiscreteContactManager (const std::string &name, const tesseract::common::PluginInfo &plugin_info) const
 Get discrete contact manager object given plugin info.
std::unique_ptr< ContinuousContactManager > createContinuousContactManager (const std::string &name) const
 Get continuous contact manager object given name.
std::unique_ptr< ContinuousContactManager > createContinuousContactManager (const std::string &name, const tesseract::common::PluginInfo &plugin_info) const
 Get continuous contact manager 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

◆ ContactManagersPluginFactory() [1/3]

tesseract::collision::ContactManagersPluginFactory::ContactManagersPluginFactory ( YAML::Node config,
const tesseract::common::ResourceLocator & locator )

Load plugins from yaml node.

Parameters
configThe config node

◆ ContactManagersPluginFactory() [2/3]

tesseract::collision::ContactManagersPluginFactory::ContactManagersPluginFactory ( const std::filesystem::path & config,
const tesseract::common::ResourceLocator & locator )

Load plugins from file path.

Parameters
configThe config file path

◆ ContactManagersPluginFactory() [3/3]

tesseract::collision::ContactManagersPluginFactory::ContactManagersPluginFactory ( const std::string & config,
const tesseract::common::ResourceLocator & locator )

Load plugins from string.

Parameters
configThe config string

Member Function Documentation

◆ addSearchPath()

void tesseract::collision::ContactManagersPluginFactory::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::collision::ContactManagersPluginFactory::getSearchPaths ( ) const

Get the plugin search paths.

Returns
The search paths

◆ addSearchLibrary()

void tesseract::collision::ContactManagersPluginFactory::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::collision::ContactManagersPluginFactory::getSearchLibraries ( ) const

Get the plugin search libraries.

Returns
The search libraries

◆ addDiscreteContactManagerPlugin()

void tesseract::collision::ContactManagersPluginFactory::addDiscreteContactManagerPlugin ( const std::string & name,
tesseract::common::PluginInfo plugin_info )

Add a discrete contact manager plugin.

Parameters
nameThe name
plugin_infoThe plugin information

◆ hasDiscreteContactManagerPlugins()

bool tesseract::collision::ContactManagersPluginFactory::hasDiscreteContactManagerPlugins ( ) const

Check if it has discrete contact manager plugins.

Returns
True if discrete PluginInfoMap is not empty, otherwise fale

◆ getDiscreteContactManagerPlugins()

tesseract::common::PluginInfoMap tesseract::collision::ContactManagersPluginFactory::getDiscreteContactManagerPlugins ( ) const

Get the map of discrete contact manager plugin.

Returns
A map of plugins

◆ removeDiscreteContactManagerPlugin()

void tesseract::collision::ContactManagersPluginFactory::removeDiscreteContactManagerPlugin ( const std::string & name)

Remove discrete contact manager plugin.

Parameters
nameThe name of the contact manager to remove

◆ setDefaultDiscreteContactManagerPlugin()

void tesseract::collision::ContactManagersPluginFactory::setDefaultDiscreteContactManagerPlugin ( const std::string & name)

Set a default discrete contact manager.

Parameters
nameThe name

◆ getDefaultDiscreteContactManagerPlugin()

std::string tesseract::collision::ContactManagersPluginFactory::getDefaultDiscreteContactManagerPlugin ( ) const

Get the default discrete contact manager.

Returns
The default discrete contact manager

◆ addContinuousContactManagerPlugin()

void tesseract::collision::ContactManagersPluginFactory::addContinuousContactManagerPlugin ( const std::string & name,
tesseract::common::PluginInfo plugin_info )

Add a continuous contact manager plugin.

Parameters
nameThe name
plugin_infoThe plugin information

◆ hasContinuousContactManagerPlugins()

bool tesseract::collision::ContactManagersPluginFactory::hasContinuousContactManagerPlugins ( ) const

Check if it has continuous contact manager plugins.

Returns
True if continuous PluginInfoMap is not empty, otherwise fale

◆ getContinuousContactManagerPlugins()

tesseract::common::PluginInfoMap tesseract::collision::ContactManagersPluginFactory::getContinuousContactManagerPlugins ( ) const

Get the map of continuous contact manager plugin.

Returns
A map of plugins

◆ removeContinuousContactManagerPlugin()

void tesseract::collision::ContactManagersPluginFactory::removeContinuousContactManagerPlugin ( const std::string & name)

Remove continuous contact manager plugin.

Parameters
nameThe name of the contact manager to remove

◆ setDefaultContinuousContactManagerPlugin()

void tesseract::collision::ContactManagersPluginFactory::setDefaultContinuousContactManagerPlugin ( const std::string & name)

Set a default continuous contact manager.

Parameters
nameThe name

◆ getDefaultContinuousContactManagerPlugin()

std::string tesseract::collision::ContactManagersPluginFactory::getDefaultContinuousContactManagerPlugin ( ) const

Get the default continuous contact manager.

Returns
The default continuous contact manager name

◆ createDiscreteContactManager() [1/2]

std::unique_ptr< DiscreteContactManager > tesseract::collision::ContactManagersPluginFactory::createDiscreteContactManager ( const std::string & name) const

Get discrete contact manager object given name.

This looks for discrete contact manager plugin info. If not found nullptr is returned.

Parameters
nameThe name

◆ createDiscreteContactManager() [2/2]

std::unique_ptr< DiscreteContactManager > tesseract::collision::ContactManagersPluginFactory::createDiscreteContactManager ( const std::string & name,
const tesseract::common::PluginInfo & plugin_info ) const

Get discrete contact manager object given plugin info.

Parameters
nameThe name
plugin_infoThe plugin information to create kinematics object

◆ createContinuousContactManager() [1/2]

std::unique_ptr< ContinuousContactManager > tesseract::collision::ContactManagersPluginFactory::createContinuousContactManager ( const std::string & name) const

Get continuous contact manager object given name.

This looks for continuous contact manager plugin info. If not found nullptr is returned.

Parameters
nameThe name

◆ createContinuousContactManager() [2/2]

std::unique_ptr< ContinuousContactManager > tesseract::collision::ContactManagersPluginFactory::createContinuousContactManager ( const std::string & name,
const tesseract::common::PluginInfo & plugin_info ) const

Get continuous contact manager object given plugin info.

Parameters
nameThe name
plugin_infoThe plugin information to create kinematics object

◆ saveConfig()

void tesseract::collision::ContactManagersPluginFactory::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::collision::ContactManagersPluginFactory::getConfig ( ) const

Get the plugin information config as a yaml node.

Returns
The plugin information config yaml node/