StateRegistrar< Derived > Class Template Reference

A template class for the registration of classes in the State family. More...

#include <registrar.h>

Public Member Functions
	StateRegistrar (std::string name)
	constructor More...

Static Public Member Functions
static State *	createFunc ()
	This function creates an object of the Derived class and returns a pointer to the State class. More...

Detailed Description

template<typename Derived>
class StateRegistrar< Derived >

A template class for the registration of classes in the State family.

The purpose of this class is to have a unified place to register objects in the State family. Registration means linking a state name (given in the argument list of the constructor) and a class in the State family. It is implemented as a template class to accomondate various child classes in the State family.

Author

Chen, Hsin-Chiang (morri.nosp@m.sche.nosp@m.n2008.nosp@m.@gma.nosp@m.il.co.nosp@m.m)

Version

1.0

Date

2014/08/08

Created on: 2014/06/07

Constructor & Destructor Documentation

template<typename Derived >

StateRegistrar< Derived >::StateRegistrar

(

std::string

name

)

constructor

Registers the name given in the argument list. Registration means linking name to a class in the Geometry family.

Parameters

name	a state name

Example usage: Registers a_name with class SomeState

StateRegistrar<SomeState> s("a_name");

Member Function Documentation

template<typename Derived >

State * StateRegistrar< Derived >::createFunc ( )

static

This function creates an object of the Derived class and returns a pointer to the State class.

Parameters

None

Returns

A State * pointer that points to an object of Derived class

---

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

• registrar.h