rviz::PluginlibFactory< Type > Class Template Reference

#include <pluginlib_factory.h>

Inheritance diagram for rviz::PluginlibFactory< Type >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

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 QList< QString > getDeclaredClassIds ()
 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

pluginlib::ClassLoader< Type > * class_loader_

Detailed Description

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

Definition at line 46 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 49 of file pluginlib_factory.h.

template<class Type>
virtual rviz::PluginlibFactory< Type >::~PluginlibFactory (  )  [inline, virtual]

Definition at line 53 of file pluginlib_factory.h.


Member Function Documentation

template<class Type>
virtual QString rviz::PluginlibFactory< Type >::getClassDescription ( const QString &  class_id  )  const [inline, virtual]

Implements rviz::Factory.

Reimplemented in rviz::DisplayFactory.

Definition at line 69 of file pluginlib_factory.h.

template<class Type>
virtual QString rviz::PluginlibFactory< Type >::getClassName ( const QString &  class_id  )  const [inline, virtual]

Implements rviz::Factory.

Reimplemented in rviz::DisplayFactory.

Definition at line 74 of file pluginlib_factory.h.

template<class Type>
virtual QString rviz::PluginlibFactory< Type >::getClassPackage ( const QString &  class_id  )  const [inline, virtual]

Implements rviz::Factory.

Reimplemented in rviz::DisplayFactory.

Definition at line 79 of file pluginlib_factory.h.

template<class Type>
virtual QList<QString> rviz::PluginlibFactory< Type >::getDeclaredClassIds (  )  [inline, virtual]

Implements rviz::Factory.

Reimplemented in rviz::DisplayFactory.

Definition at line 58 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 96 of file pluginlib_factory.h.


Member Data Documentation

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

Definition at line 115 of file pluginlib_factory.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines


rviz
Author(s): Dave Hershberger, Josh Faust
autogenerated on Wed Jun 6 11:25:48 2012