ltdl wrapper for factory-like classes More...

#include <mc_rtc/loader.h>

Inheritance diagram for mc_rtc::ObjectLoader< T >:

Collaboration diagram for mc_rtc::ObjectLoader< T >:

Classes
struct	ObjectDeleter

Public Types
using	unique_ptr = std::unique_ptr< T, ObjectDeleter >

Public Member Functions
	ObjectLoader (const std::string &class_name, const std::vector< std::string > &paths, bool verbose, Loader::callback_t cb=Loader::default_cb)

	~ObjectLoader ()

bool	has_object (const std::string &name) const

std::vector< std::string >	objects () const

void	load_libraries (const std::vector< std::string > &paths, Loader::callback_t cb=Loader::default_cb)

void	clear ()

void	set_verbosity (bool verbose)

template<typename RetT , typename... Args>
void	register_object (const std::string &name, std::function< RetT *(const Args &...)> callback)

template<typename... Args>
std::shared_ptr< T >	create_object (const std::string &name, Args... args)

std::string	get_object_runtime_directory (const std::string &name) const noexcept

template<typename... Args>
unique_ptr	create_unique_object (const std::string &name, Args... args)

Protected Member Functions
template<typename... Args>
T *	create (const std::string &name, Args... args)

template<typename... Args>
T *	create_from_handles (const std::string &name, Args... args)

template<typename... Args>
T *	create_from_callbacks (const std::string &name, Args... args)

Protected Attributes
std::string	class_name

bool	verbose

Loader::handle_map_t	handles_

mc_rtc::DataStore	callbacks_

std::unordered_map< std::string, ObjectDeleter >	deleters_

Detailed Description

template<typename T>
class mc_rtc::ObjectLoader< T >

ltdl wrapper for factory-like classes

Member Typedef Documentation

◆ unique_ptr

template<typename T >

using mc_rtc::ObjectLoader< T >::unique_ptr = std::unique_ptr<T, ObjectDeleter>

Constructor & Destructor Documentation

◆ ObjectLoader()

template<typename T >

mc_rtc::ObjectLoader< T >::ObjectLoader	(	const std::string &	class_name,
		const std::vector< std::string > &	paths,
		bool	verbose,
		Loader::callback_t	cb = `Loader::default_cb`
	)

Create ObjectLoader instance

Parameters

class_name	Symbol used to distinguish the relevant libraries
paths	directories searched for libraries
verbose	If true, output some warning information
cb	Function called when a new object is loaded

◆ ~ObjectLoader()

template<typename T >

mc_rtc::ObjectLoader< T >::~ObjectLoader ( )

Destructor

Member Function Documentation

◆ clear()

template<typename T >

void mc_rtc::ObjectLoader< T >::clear ( )

Remove all loaded libraries

◆ create()

template<typename T >

template<typename... Args>

T* mc_rtc::ObjectLoader< T >::create	(	const std::string &	name,
		Args...	args
	)

protected

Internal function to create a raw pointer

◆ create_from_callbacks()

template<typename T >

template<typename... Args>

T* mc_rtc::ObjectLoader< T >::create_from_callbacks	(	const std::string &	name,
		Args...	args
	)

protected

Internal function to create a raw pointer from a registered callback

◆ create_from_handles()

template<typename T >

template<typename... Args>

T* mc_rtc::ObjectLoader< T >::create_from_handles	(	const std::string &	name,
		Args...	args
	)

protected

Internal function to create a raw pointer from an handle

◆ create_object()

template<typename T >

template<typename... Args>

std::shared_ptr<T> mc_rtc::ObjectLoader< T >::create_object	(	const std::string &	name,
		Args...	args
	)

Create a new object of type name

Parameters

name	the object's name
Args	argument required by the constructor

Returns: a shared pointer properly equipped to destroy the pointer

Exceptions

LoaderException throw if the name does not exist or if symbol resolution fails

◆ create_unique_object()

template<typename T >

template<typename... Args>

unique_ptr mc_rtc::ObjectLoader< T >::create_unique_object	(	const std::string &	name,
		Args...	args
	)

Create a new object of type name

Parameters

name	the object's name
Args	arguments required by the constructor

Returns: a unique pointer with a destructor provided by the library

Exceptions

LoaderException if the name does not exist or if symbol resolution fails

◆ get_object_runtime_directory()

template<typename T >

std::string mc_rtc::ObjectLoader< T >::get_object_runtime_directory ( const std::string & name ) const

noexcept

Returns the runtime directory of an object

Returns an empty string when the object is registered via a callback or if the object is unknown

Parameters

name	Name of the object

◆ has_object()

template<typename T >

bool mc_rtc::ObjectLoader< T >::has_object ( const std::string & name ) const

Returns true if the loader has the name object

Parameters

name	Name to be tested

◆ load_libraries()

template<typename T >

void mc_rtc::ObjectLoader< T >::load_libraries	(	const std::vector< std::string > &	paths,
		Loader::callback_t	cb = `Loader::default_cb`
	)

Load libraries from the paths provided

Parameters

paths	directories searched for libraries
verbose	If true, output some warning information

◆ objects()

template<typename T >

std::vector<std::string> mc_rtc::ObjectLoader< T >::objects ( ) const

Returns the list of available objects

Returns: A list of available objects

◆ register_object()

template<typename T >

template<typename RetT , typename... Args>

void mc_rtc::ObjectLoader< T >::register_object	(	const std::string &	name,
		std::function< RetT *(const Args &...)>	callback
	)

Register a new loading function

Parameters

name	Name that will be used to create new instance
callback	Callback that will be used to create the object

Template Parameters

RetT	Must be derived from T

Exceptions

LoaderException if the object is already registered

◆ set_verbosity()

template<typename T >

void mc_rtc::ObjectLoader< T >::set_verbosity ( bool verbose )

Set the verbosity

Parameters

verbose If true, loader will be more verbose

Member Data Documentation

◆ callbacks_

template<typename T >

mc_rtc::DataStore mc_rtc::ObjectLoader< T >::callbacks_

protected

◆ class_name

template<typename T >

std::string mc_rtc::ObjectLoader< T >::class_name

protected

◆ deleters_

template<typename T >

std::unordered_map<std::string, ObjectDeleter> mc_rtc::ObjectLoader< T >::deleters_

protected

◆ handles_

template<typename T >

Loader::handle_map_t mc_rtc::ObjectLoader< T >::handles_

protected

◆ verbose

template<typename T >

bool mc_rtc::ObjectLoader< T >::verbose

protected

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

include/mc_rtc/loader.h

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<typename T> class mc_rtc::ObjectLoader< T >

Member Typedef Documentation

◆ unique_ptr

Constructor & Destructor Documentation

◆ ObjectLoader()

◆ ~ObjectLoader()

Member Function Documentation

◆ clear()

◆ create()

◆ create_from_callbacks()

◆ create_from_handles()

◆ create_object()

◆ create_unique_object()

◆ get_object_runtime_directory()

◆ has_object()

◆ load_libraries()

◆ objects()

◆ register_object()

◆ set_verbosity()

Member Data Documentation

◆ callbacks_

◆ class_name

◆ deleters_

◆ handles_

◆ verbose

template<typename T>
class mc_rtc::ObjectLoader< T >