GWE::GWorldEngineFactory Class Reference

Construct and initialize a GWE Server. More...

#include <GWorldEngineFactory.h>

Inheritance diagram for GWE::GWorldEngineFactory:

[legend]Collaboration diagram for GWE::GWorldEngineFactory:

[legend]List of all members.

Public Slots
GweController *	init ()
GweController *	initDefault ()
GXmlDataController *	initTestDataController (QString jid, QString pwd)
Signals
void	initSucceeded (GweController *controller)
void	initFailed (QString error_description)
Public Member Functions
	GWorldEngineFactory (QObject *parent=0)
virtual	~GWorldEngineFactory ()
void	setDeleteControllersInDestructor (bool delete_in_destructor)
bool	getDeleteControllersInDestructor () const
QList< GWE::GweController * >	getInitializedControllers ()
GweFactoryOption *	getRootOption ()
const GweFactoryOption *	getRootOption () const
Protected Attributes
QList< GweController * >	GweControllers
GweFactoryOption *	RootOption
bool	DeleteControllersInDestructor

---

Detailed Description

Construct and initialize a GWE Server.

Author:

Raphael Langerhorst

---

Constructor & Destructor Documentation

GWE::GWorldEngineFactory::GWorldEngineFactory

(

QObject *

parent = 0

)

Constructor.

GWE::GWorldEngineFactory::~GWorldEngineFactory

(

)

[virtual]

Virtual Destructor.

---

Member Function Documentation

bool GWE::GWorldEngineFactory::getDeleteControllersInDestructor

(

)

const

Returns:

true when all controllers are deleted in the destructor.

QList< GweController * > GWE::GWorldEngineFactory::getInitializedControllers

(

)

Returns:

a list of all initialized GWE Controllers.

const GweFactoryOption * GWE::GWorldEngineFactory::getRootOption

(

)

const

Returns:

the root of the options tree.

See also:

RootOption

GweFactoryOption * GWE::GWorldEngineFactory::getRootOption

(

)

Returns:

the root of the options tree.

See also:

RootOption

GweController * GWE::GWorldEngineFactory::init

(

)

[slot]

Initializes the GWE according to the defined Options.

See also:

Options

Returns:

the initialized GWE Controller (or NULL if failed)

GweController * GWE::GWorldEngineFactory::initDefault

(

)

[slot]

Initializes the GWE with predefined values, all options are set to default values.

See also:

Options

Returns:

the initialized GWE Controller (or NULL if failed)

void GWE::GWorldEngineFactory::initFailed

(

QString

error_description

)

[signal]

In case Initialization fails this signal is emitted. It is made sure that either this signal or initSucceeded() is emitted.

Parameters:

error_description

contains information about the failure.

void GWE::GWorldEngineFactory::initSucceeded

(

GweController *

controller

)

[signal]

In case Initialization succeeds this signal is emitted. It is made sure that either this signal or initFailed() is emitted.

Parameters:

controller

is a valid pointer to the initialized GWE Controller

GXmlDataController * GWE::GWorldEngineFactory::initTestDataController	(	QString	jid,
		QString	pwd
	)			[slot]

Initializes a GDataController with testvalues

Returns:

the initialized GDataController (or NULL if failed)

void GWE::GWorldEngineFactory::setDeleteControllersInDestructor

(

bool

delete_in_destructor

)

Parameters:

delete_in_destructor

whether to delete controllers in the destructor.

---

Member Data Documentation

bool GWE::GWorldEngineFactory::DeleteControllersInDestructor [protected]

If set to true, all controllers are deleted in the destructor of the factory. Default is false.

GweFactoryOption* GWE::GWorldEngineFactory::RootOption [protected]

Before initializing the GWE various options can be set. The factory holds one root options which expands to an options tree.

See also:

GweFactoryOption, init, initDefault

---

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

• GWorldEngineFactory.h
• GWorldEngineFactory.cpp

---