Defines a controller component. More...

#include <arcscontrollercomponent.h>

Inheritance diagram for ARCSControllerComponent:

Collaboration diagram for ARCSControllerComponent:

Public Member Functions
virtual QStringList	getSlots ()
	Returns the names of the available slots.

virtual QStringList	getSignals ()
	Returns the names of the availables signals.

virtual QString	toString ()
	Defines a basic seralization mechanism. More...

virtual bool	parseString (QString s)
	Defines a basic seralization mechanism. More...

ARCSStateMachine *	getStateMachine ()

Public Member Functions inherited from ARCSAbstractComponent
bool	instanciate ()
	Instanciates the real component.

bool	isInstanciated ()
	Determines wether the component is instanciated or not.

void	destroy ()
	Destroys the real component.

ARCSAbstractComponent *	clone ()
	Kage bunshin no jutsu ! More...

virtual bool	connect (QString sig, ARCSAbstractComponent *dst, QString slt, bool queued=false)
	This method connects two components by the indicated signals and slots. More...

bool	disconnect (QString sig, ARCSAbstractComponent *dst, QString slt)
	This method disconnects two components by the indicated signals and slots. More...

bool	init (QString slt, QVariant *var)
	Initializes a component. More...

virtual bool	loadFile (QString fn)
	Defines a way to load a component description from a file. More...

virtual bool	saveFile (QString fn)
	Defines a way to save a component description inside a file. More...

void	setProperty (QString name, QVariant value)
	Sets a meta-property on this component. More...

QVariant	getProperty (QString name)
	Gets a meta-property from this component. More...

void	removeProperty (QString name)
	Removes a meta-property from this component. More...

void	resetProperties ()
	Sets the property list to a blank list.

QStringList	getProperties ()

void	setFamily (QString s)

QString	getFamily ()

void	setType (QString s)

QString	getType ()

virtual QVariant	getGenuineComponentInstance ()

Protected Member Functions
virtual void	getProxySlot (QString slot, ObjectList &obj, QStringList &proxySlot)
	Creates a proxy slot to interface a component to native ARCS components. More...

virtual void	getProxySignal (QString signal, ObjectList &obj, QStringList &proxySignal)
	Creates a proxy signal to interface a component to native ARCS components. More...

virtual bool	genuineInstanciate ()
	This method should implement the instanciation of the actual component. More...

virtual void	genuineDestroy ()
	This method should implement the destruction of the actual component. More...

Protected Member Functions inherited from ARCSAbstractComponent
virtual bool	genuineConnect (QString, ARCSAbstractComponent *, QString, bool=false)
	This method connects two components by the indicated signals and slots. More...

virtual bool	genuineDisconnect (QString, ARCSAbstractComponent *, QString)
	This method disconnects two components by the indicated signals and slots. More...

Additional Inherited Members
Static Protected Member Functions inherited from ARCSAbstractComponent
static void	getProxySlot (ARCSAbstractComponent *cmp, QString slot, ObjectList &obj, QStringList &proxySlot)
	Wrapper for getProxySlot()

static void	getProxySignal (ARCSAbstractComponent *cmp, QString signal, ObjectList &obj, QStringList &proxySignal)
	Wrapper for getProxySignal()

Static Protected Attributes inherited from ARCSAbstractComponent
static const QString	slotPrefix = "1"

static const QString	signalPrefix = "2"

Detailed Description

Defines a controller component.

Controllers are, as for now, only state machines and are parsed as statemachines. Possible future release may change the underlying mechanism.

Author: Jean-Yves Didier

Date: January, the 17th, 2009

Definition at line 45 of file arcscontrollercomponent.h.

Member Function Documentation

void ARCSControllerComponent::genuineDestroy ( )

protectedvirtual

This method should implement the destruction of the actual component.

Should be overloaded by each subclasses.

Implements ARCSAbstractComponent.

Definition at line 70 of file arcscontrollercomponent.cpp.

bool ARCSControllerComponent::genuineInstanciate ( )

protectedvirtual

This method should implement the instanciation of the actual component.

Should be overloaded by each subclasses.

Implements ARCSAbstractComponent.

Definition at line 64 of file arcscontrollercomponent.cpp.

virtual void ARCSControllerComponent::getProxySignal	(	QString	signal,
		ObjectList &	obj,
		QStringList &	proxySignal
	)

inlineprotectedvirtual

Creates a proxy signal to interface a component to native ARCS components.

This function should be overriden by subclasses. It is used in the case the abstracted component is not from the same family as another component to connect to. In this case, the abstracted component should offer a wrapper using a QObject to communicate with other components as if it was a native component of the ARCS runtime.

Parameters

sig	the signal name of the current component
obj	a list of QObject wrappers returned by this method
proxySignal	the list of the real slot names associated to the QObjects returned by this method.

Implements ARCSAbstractComponent.

Definition at line 66 of file arcscontrollercomponent.h.

virtual void ARCSControllerComponent::getProxySlot	(	QString	slot,
		ObjectList &	obj,
		QStringList &	proxySlot
	)

inlineprotectedvirtual

Creates a proxy slot to interface a component to native ARCS components.

This function should be overriden by subclasses. It is used in the case the abstracted component is not from the same family as another component to connect to. In this case, the abstracted component should offer a wrapper using a QObject to communicate with other components as if it was a native component of the ARCS runtime.

Parameters

slot	the slot name of the current component
obj	a list of QObject wrappers returned by this method
proxySlot	the list of the real slot names associated to the QObjects returned by this method.

Implements ARCSAbstractComponent.

Definition at line 62 of file arcscontrollercomponent.h.

ARCSStateMachine* ARCSControllerComponent::getStateMachine ( )

inline

Returns the controller's associated statemachine

Definition at line 57 of file arcscontrollercomponent.h.

Here is the caller graph for this function: