rviz::PluginlibFactory< Type > Class Template Reference

#include <pluginlib_factory.h>

Inheritance diagram for rviz::PluginlibFactory< Type >:

List of all members.

Classes
struct	BuiltInClassRecord
Public Member Functions
virtual void	addBuiltInClass (const QString &package, const QString &name, const QString &description, Type *(*factory_function)())
virtual QString	getClassDescription (const QString &class_id) const
virtual QString	getClassName (const QString &class_id) const
virtual QString	getClassPackage (const QString &class_id) const
virtual QStringList	getDeclaredClassIds ()
virtual QIcon	getIcon (const QString &class_id) const
	PluginlibFactory (const QString &package, const QString &base_class_type)
virtual	~PluginlibFactory ()
Protected Member Functions
virtual Type *	makeRaw (const QString &class_id, QString *error_return=NULL)
	Instantiate and return a instance of a subclass of Type using our pluginlib::ClassLoader.
Private Attributes
QHash< QString, BuiltInClassRecord >	built_ins_
pluginlib::ClassLoader< Type > *	class_loader_

---

Detailed Description

template<class Type>
class rviz::PluginlibFactory< Type >

Definition at line 48 of file pluginlib_factory.h.

---

Constructor & Destructor Documentation

template<class Type>

rviz::PluginlibFactory< Type >::PluginlibFactory	(	const QString &	package,
		const QString &	base_class_type
	)		[inline]

Definition at line 61 of file pluginlib_factory.h.

template<class Type>

virtual rviz::PluginlibFactory< Type >::~PluginlibFactory

(

)

[inline, virtual]

Definition at line 65 of file pluginlib_factory.h.

---

Member Function Documentation

template<class Type>

virtual void rviz::PluginlibFactory< Type >::addBuiltInClass	(	const QString &	package,
		const QString &	name,
		const QString &	description,
		Type *(*)()	factory_function
	)		[inline, virtual]

Definition at line 132 of file pluginlib_factory.h.

template<class Type>

virtual QString rviz::PluginlibFactory< Type >::getClassDescription

(

const QString &

class_id

)

const [inline, virtual]

Implements rviz::Factory.

Definition at line 86 of file pluginlib_factory.h.

template<class Type>

virtual QString rviz::PluginlibFactory< Type >::getClassName

(

const QString &

class_id

)

const [inline, virtual]

Implements rviz::Factory.

Definition at line 96 of file pluginlib_factory.h.

template<class Type>

virtual QString rviz::PluginlibFactory< Type >::getClassPackage

(

const QString &

class_id

)

const [inline, virtual]

Implements rviz::Factory.

Definition at line 106 of file pluginlib_factory.h.

template<class Type>

virtual QStringList rviz::PluginlibFactory< Type >::getDeclaredClassIds

(

)

[inline, virtual]

Implements rviz::Factory.

Definition at line 70 of file pluginlib_factory.h.

template<class Type>

virtual QIcon rviz::PluginlibFactory< Type >::getIcon

(

const QString &

class_id

)

const [inline, virtual]

Implements rviz::Factory.

Definition at line 116 of file pluginlib_factory.h.

template<class Type>

virtual Type* rviz::PluginlibFactory< Type >::makeRaw	(	const QString &	class_id,
		QString *	error_return = NULL
	)		[inline, protected, virtual]

Instantiate and return a instance of a subclass of Type using our pluginlib::ClassLoader.

Parameters:

class_id	A string identifying the class uniquely among classes of its parent class. rviz::GridDisplay might be rviz/Grid, for example.
error_return	If non-NULL and there is an error, *error_return is set to a description of the problem.

Returns:

A new instance of the class identified by class_id, or NULL if there was an error.

If makeRaw() returns NULL and error_return is not NULL, *error_return will be set. On success, *error_return will not be changed.

Implements rviz::ClassIdRecordingFactory< Type >.

Reimplemented in rviz::DisplayFactory, and rviz::MockDisplayFactory.

Definition at line 156 of file pluginlib_factory.h.

---

Member Data Documentation

template<class Type>

QHash<QString, BuiltInClassRecord> rviz::PluginlibFactory< Type >::built_ins_ [private]

Definition at line 186 of file pluginlib_factory.h.

template<class Type>

pluginlib::ClassLoader<Type>* rviz::PluginlibFactory< Type >::class_loader_ [private]

Definition at line 185 of file pluginlib_factory.h.

---

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

• pluginlib_factory.h