YARP
Yet Another Robot Platform
yarp::os::YarpPluginSelector Class Reference

Pick out a set of relevant plugins. More...

#include <yarp/os/YarpPluginSelector.h>

+ Inheritance diagram for yarp::os::YarpPluginSelector:

Public Member Functions

virtual ~YarpPluginSelector ()=default
 Destructor. More...
 
virtual bool select (Searchable &options)
 Determine whether a plugin is of interest. More...
 
void scan ()
 Find plugin configuration files, and run [plugin] sections through the select method. More...
 
Bottle getSelectedPlugins () const
 
Bottle getSearchPath () const
 

Static Public Member Functions

static bool checkPlugin (const std::string &name, const std::string &type={})
 Checks if a pluigin of the given type is available. More...
 

Detailed Description

Pick out a set of relevant plugins.

Override the select function to define what "relevant" means. The select function will be called with [plugin] sections found in configuration files.

Definition at line 25 of file YarpPluginSelector.h.

Constructor & Destructor Documentation

◆ ~YarpPluginSelector()

virtual yarp::os::YarpPluginSelector::~YarpPluginSelector ( )
virtualdefault

Destructor.

Member Function Documentation

◆ checkPlugin()

static bool yarp::os::YarpPluginSelector::checkPlugin ( const std::string &  name,
const std::string &  type = {} 
)
inlinestatic

Checks if a pluigin of the given type is available.

Definition at line 80 of file YarpPluginSelector.h.

◆ getSearchPath()

Bottle yarp::os::YarpPluginSelector::getSearchPath ( ) const
inline
Returns
possible locations for plugin libraries found in [search] sections.

Definition at line 71 of file YarpPluginSelector.h.

◆ getSelectedPlugins()

Bottle yarp::os::YarpPluginSelector::getSelectedPlugins ( ) const
inline
Returns
a list of plugin sections that passed the select method during the last call to scan.

Definition at line 61 of file YarpPluginSelector.h.

◆ scan()

void YarpPluginSelector::scan ( )

Find plugin configuration files, and run [plugin] sections through the select method.

Definition at line 210 of file YarpPlugin.cpp.

◆ select()

virtual bool yarp::os::YarpPluginSelector::select ( Searchable options)
inlinevirtual

Determine whether a plugin is of interest.

Returns
true if plugin is of interest. By default, always returns true.

Reimplemented in yarp::dev::Drivers::Private.

Definition at line 44 of file YarpPluginSelector.h.


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