StateFactory Class Reference

#include <state_factory.h>

List of all members.

Static Public Member Functions
static State *	createState (factory::StateType type, std::string actor, EventSink *parent=NULL)
static factory::StateType	getStartState (std::string type)
static std::string	getType (factory::StateType type)

---

Detailed Description

This class provides a factory method which creates State objects. It also provides the enumeration for which the factory method bases its creation process off of.

Author:

Brett Ponsler (bponsler (at) wpi (dot) edu)

Definition at line 101 of file state_factory.h.

---

Member Function Documentation

State * StateFactory::createState	(	factory::StateType	type,
		std::string	actor,
		EventSink *	parent = NULL
	)			[static]

The State factory method.

This function takes the enumeration type which enables the creation process to determine which type of State object to create. This function allows the Actor object of the State to also be specified. This function also takes an optional argument allowing the creation to specify the parent EventSink object for the created Recognizer.

Parameters:

	type	The type of State to create
	actor	The Actor object
	parent	The optional parent EventSink object

Returns:

The created State

Definition at line 64 of file state_factory.cpp.

factory::StateType StateFactory::getStartState

(

std::string

type

)

[static]

Return the start state for the particular recognizer type.

Parameters:

type

The recognizer type

Returns:

The start state for this recognizer

Definition at line 181 of file state_factory.cpp.

std::string StateFactory::getType

(

factory::StateType

type

)

[static]

Return the type of the State from the given StateType.

Parameters:

type

The type of state

Returns:

The type of the given State

Definition at line 123 of file state_factory.cpp.

---

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

• engagement_recognition/src/recognition/states/state_factory.h
• engagement_recognition/src/recognition/states/state_factory.cpp