vigir_pluginlib::PluginAggregator< PluginClass > Class Template Reference

#include <plugin_aggregator.h>

List of all members.

Public Types
typedef boost::shared_ptr < const PluginAggregator < PluginClass > >	ConstPtr
typedef boost::weak_ptr< const PluginAggregator< PluginClass > >	ConstWeakPtr
typedef boost::shared_ptr < PluginAggregator < PluginClass > >	Ptr
typedef boost::weak_ptr < PluginAggregator < PluginClass > >	WeakPtr
Public Member Functions
virtual std::vector < boost::shared_ptr < PluginClass > >	getPlugins () const
	Returns a list of all known plugins of type T.
virtual bool	loadParams (const vigir_generic_params::ParameterSet &params)
	Loads parameters on all known plugins.
virtual void	loadPlugins ()
	Collects all plugins from PluginManager matching the type T.
	PluginAggregator (const std::string &name=std::string("PluginAggregator"))
virtual size_t	size () const
	Returns the number of known plugins of type T.
Protected Attributes
std::string	name_
std::vector< boost::shared_ptr < PluginClass > >	plugins_

---

Detailed Description

template<class PluginClass>
class vigir_pluginlib::PluginAggregator< PluginClass >

Definition at line 43 of file plugin_aggregator.h.

---

Member Typedef Documentation

template<class PluginClass >

typedef boost::shared_ptr<const PluginAggregator<PluginClass> > vigir_pluginlib::PluginAggregator< PluginClass >::ConstPtr

Definition at line 48 of file plugin_aggregator.h.

template<class PluginClass >

typedef boost::weak_ptr<const PluginAggregator<PluginClass> > vigir_pluginlib::PluginAggregator< PluginClass >::ConstWeakPtr

Definition at line 50 of file plugin_aggregator.h.

template<class PluginClass >

typedef boost::shared_ptr<PluginAggregator<PluginClass> > vigir_pluginlib::PluginAggregator< PluginClass >::Ptr

Definition at line 47 of file plugin_aggregator.h.

template<class PluginClass >

typedef boost::weak_ptr<PluginAggregator<PluginClass> > vigir_pluginlib::PluginAggregator< PluginClass >::WeakPtr

Definition at line 49 of file plugin_aggregator.h.

---

Constructor & Destructor Documentation

template<class PluginClass >

vigir_pluginlib::PluginAggregator< PluginClass >::PluginAggregator

(

const std::string &

name = std::string("PluginAggregator< PluginClass >")

)

[inline]

Definition at line 52 of file plugin_aggregator.h.

---

Member Function Documentation

template<class PluginClass >

virtual std::vector<boost::shared_ptr<PluginClass> > vigir_pluginlib::PluginAggregator< PluginClass >::getPlugins

(

)

const [inline, virtual]

Returns a list of all known plugins of type T.

Returns:

List of all known plugins of type T

Definition at line 80 of file plugin_aggregator.h.

template<class PluginClass >

virtual bool vigir_pluginlib::PluginAggregator< PluginClass >::loadParams

(

const vigir_generic_params::ParameterSet &

params

)

[inline, virtual]

Loads parameters on all known plugins.

Parameters:

params

Parameter set to load

Returns:

false when error occurs, otherwise true

Definition at line 99 of file plugin_aggregator.h.

template<class PluginClass >

virtual void vigir_pluginlib::PluginAggregator< PluginClass >::loadPlugins

(

)

[inline, virtual]

Collects all plugins from PluginManager matching the type T.

Definition at line 58 of file plugin_aggregator.h.

template<class PluginClass >

virtual size_t vigir_pluginlib::PluginAggregator< PluginClass >::size

(

)

const [inline, virtual]

Returns the number of known plugins of type T.

Returns:

Number of known plugins of type T

Definition at line 89 of file plugin_aggregator.h.

---

Member Data Documentation

template<class PluginClass >

std::string vigir_pluginlib::PluginAggregator< PluginClass >::name_ [protected]

Definition at line 113 of file plugin_aggregator.h.

template<class PluginClass >

std::vector<boost::shared_ptr<PluginClass> > vigir_pluginlib::PluginAggregator< PluginClass >::plugins_ [protected]

Definition at line 114 of file plugin_aggregator.h.

---

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

• plugin_aggregator.h