itk::fem::FEMObjectFactory< T > Class Template Reference
Create objects of derived classes by specifying a class ID. More...
#include <itkFEMObjectFactory.h>
Classes | |
| class | Dummy |
| This class is defined in FEMObjectFactory just to get rid of some warnings about destructor being private in gcc. | |
Static Public Member Functions | |
| static T::Pointer | Create (int id) |
| static StrClassName | ID2ClassName (int id) |
| static int | ClassName2ID (StrClassName str) |
| static int | Register (COF f, const char *str) |
Friends | |
| class | Dummy |
Detailed Description
template<class T>
class itk::fem::FEMObjectFactory< T >
Create objects of derived classes by specifying a class ID.
ObjectFactory is used to create various objects of derived classes by specifying an ID of a derived class. Before the objects can be created by object factory, you should first call the Register method for each class:
int ID_Derived=FEMObjectFactory<BaseClass>.Register( NewDerivedClass, "NewDerivedClassName" );
- BaseClass: Base class from which the registered classes are derived
- ID_Derived: Integer returned by the Register function that specifies the derived class' ID. Class ID's are assigned automatically.
- NewDerivedClass: Function that creates a new instance of a derived class and returns a pointer to it as a pointer to the base class. Normally you should define this function as:
- BaseClass* NewDerivedClass() { return new DerivedClass; }
- NewDerivedClassname: String with a name of a derived class.
You should also put the NewDerivedClass function in an anonymous namespace and make it static. So a complete registration of a derived class looks like:
- namespace { static Base* NewDerivedClass() { return new DerivedClass; } } const int OF_Derived=FEMObjectFactory<BaseClass>Register( NewDerivedClass, "NewDerivedObjectName" );
Definition at line 66 of file itkFEMObjectFactory.h.
Member Function Documentation
| static int itk::fem::FEMObjectFactory< T >::ClassName2ID | ( | StrClassName | str | ) | [inline, static] |
Find the ID of the class with specified name (this is a slow function). If you have to create many objects of the same class, obtain the class ID with this function first and then use that ID with the Create member function.
Definition at line 127 of file itkFEMObjectFactory.h.
| static T::Pointer itk::fem::FEMObjectFactory< T >::Create | ( | int | id | ) | [inline, static] |
Create a new object based on class identifier id and return a pointer to it.
Definition at line 91 of file itkFEMObjectFactory.h.
| static StrClassName itk::fem::FEMObjectFactory< T >::ID2ClassName | ( | int | id | ) | [inline, static] |
Return the name of the class (as a string) for the given ID.
Definition at line 116 of file itkFEMObjectFactory.h.
| static int itk::fem::FEMObjectFactory< T >::Register | ( | COF | f, | |
| const char * | str | |||
| ) | [inline, static] |
Register the class with the factory. A pointer to a 'create' function and class name as a string must be provided. Function returns the newly assigned ID of the class, which can be later used to create objects of that class.
Definition at line 102 of file itkFEMObjectFactory.h.
Friends And Related Function Documentation
friend class Dummy [friend] |
By defining a Dummy friend class, some warnings in gcc about destructor being private are eliminated.
Definition at line 196 of file itkFEMObjectFactory.h.
The documentation for this class was generated from the following file:
