rviz::ClassIdRecordingFactory< Type > Class Template Reference

Templated factory which informs objects created by it what their class identifier string was. calls a setClassId() function on any instances created by a protected makeRaw() function (pure virtual in this class). More...

#include <class_id_recording_factory.h>

Inheritance diagram for rviz::ClassIdRecordingFactory< Type >:

List of all members.

Public Member Functions
virtual Type *	make (const QString &class_id, QString *error_return=NULL)
	Instantiate and return a instance of a subclass of Type using makeRaw().
Protected Member Functions
virtual Type *	makeRaw (const QString &class_id, QString *error_return=NULL)=0

---

Detailed Description

template<class Type>
class rviz::ClassIdRecordingFactory< Type >

Templated factory which informs objects created by it what their class identifier string was. calls a setClassId() function on any instances created by a protected makeRaw() function (pure virtual in this class).

Definition at line 42 of file class_id_recording_factory.h.

---

Member Function Documentation

template<class Type>

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

Instantiate and return a instance of a subclass of Type using makeRaw().

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 make() returns NULL and error_return is not NULL, *error_return will be set. On success, *error_return will not be changed.

Definition at line 55 of file class_id_recording_factory.h.

template<class Type>

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

Implemented in rviz::PluginlibFactory< Type >, rviz::PluginlibFactory< Panel >, rviz::PluginlibFactory< ViewController >, rviz::PluginlibFactory< Tool >, rviz::PluginlibFactory< Display >, rviz::DisplayFactory, and rviz::MockDisplayFactory.

---

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

• class_id_recording_factory.h