YARP  2.3.70
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 ()
 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
 

Private Attributes

Bottle plugins
 
Bottle search_path
 
Property config
 
yarp::os::Mutex mutex
 

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 29 of file YarpPluginSelector.h.

Constructor & Destructor Documentation

◆ ~YarpPluginSelector()

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

Destructor.

Definition at line 41 of file YarpPluginSelector.h.

Member Function Documentation

◆ getSearchPath()

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

Definition at line 78 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 67 of file YarpPluginSelector.h.

◆ scan()

void YarpPluginSelector::scan ( )

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

Definition at line 157 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::os::Carriers::Private, DriversHelper, and MonitorSelector.

Definition at line 50 of file YarpPluginSelector.h.

Member Data Documentation

◆ config

Property yarp::os::YarpPluginSelector::config
private

Definition at line 33 of file YarpPluginSelector.h.

◆ mutex

yarp::os::Mutex yarp::os::YarpPluginSelector::mutex
mutableprivate

Definition at line 34 of file YarpPluginSelector.h.

◆ plugins

Bottle yarp::os::YarpPluginSelector::plugins
private

Definition at line 31 of file YarpPluginSelector.h.

◆ search_path

Bottle yarp::os::YarpPluginSelector::search_path
private

Definition at line 32 of file YarpPluginSelector.h.


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