eMotion
 All Classes Functions Variables Enumerations
Public Member Functions | Static Public Member Functions | List of all members
ePersonalityHandler Class Reference

#include <ePersonalityHandler.h>

Public Member Functions

ePersonalitygetPersonality (unsigned int id)
 
unsigned int createPersonality (ePersonalityPattern const *personalityPattern)
 
bool removePersonality (unsigned int id)
 

Static Public Member Functions

static bool initPersonalityHandler (ePersonalityFactory *factory)
 
static ePersonalityHandlergetPersonalityHandler (void)
 

Detailed Description

Author
Florian Harde flori.nosp@m.anha.nosp@m.rde@y.nosp@m.ahoo.nosp@m..de

DESCRIPTION

A singleton handling the personalitys inside the datacenter. Part of the runtime environment.

Documantation optimized for doxygen.

Member Function Documentation

unsigned int ePersonalityHandler::createPersonality ( ePersonalityPattern const *  personalityPattern)

creates and adds a personality and a unique id

Parameters
personalityPatterna pattern from wich a persobality get created via the factory
Returns
the index of the personality, with which it can be adresses from outsied
ePersonality * ePersonalityHandler::getPersonality ( unsigned int  id)

returns a personality

Parameters
indexthe index of the desired personality
Returns
the personality or NULL, if an error occured
ePersonalityHandler * ePersonalityHandler::getPersonalityHandler ( void  )
static

returns the ePersonalityHandler instance, if it exists, if not, one will be created

Returns
the ePersonalityHandler instance
bool ePersonalityHandler::initPersonalityHandler ( ePersonalityFactory factory)
static

returns the ePersonalityHandler instance, if it exists, if not, one will be created

Parameters
factorya personality factory, responsible for creating personalitys
Returns
the ePersonalityHandler instance
bool ePersonalityHandler::removePersonality ( unsigned int  id)

removes a personality

Parameters
indexthe index of the personality, which should get reomoved
Returns
true, if everything worked as intended

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