ActionTransition Class Reference

This class handle a transition between two states (including previous/next buttons). More...

#include <ActionTransition.h>

Inheritance diagram for ActionTransition:

Public Member Functions
	ActionTransition (QObject *sender, const char *signal, QState *sourceState=0, QString buttonText="", bool applyPreviousAction=true, QTextStream *logStream=NULL)
	constructor: takes at least the state and signal considered for the transition More...
void	addComponentToClose (QString compName, QString compType, bool force=false)
	add a component's name and type to the list of component to close during the transition. More...
QString	getButtonText ()
	get the transition button's text More...
virtual void	onTransition (QEvent *e)
	called during the transition More...
void	setButtonText (QString buttonText)
	the transition button's text More...

Private Attributes
bool	applyPreviousAction
	should the action be applied during the transition (default set to true) More...
QString	buttonText
	the text of the push button displayed in the ASM More...
QMap< QString, QString >	componentsToClose
	Map containing all the name/type of the components to be closed during the transition. More...
QStringList	componentsToForceClose
	list of the components' name that should be closed even if they are modified More...
QTextStream *	logStream
	local pointer to the log stream More...
QTime *	startTime
	Keep track of time (needed for the log) More...

Detailed Description

This class handle a transition between two states (including previous/next buttons).

Specific things can happen for CamiTK SCXML transition (e.g., apply the selected action before going to the next, closing components...)

Example:

<camitk:onTransition>
    <!-- Closing some components -->
    <camitk:close>
        <camitk:component type="ImageComponent" name="inputImage"/>
        <!-- even if image2 is modified, it will be closed without asking the user for a filename -->
        <camitk:component type="ImageComponent" name="generatedImage" force="true"/>
    </camitk:close>
</camitk:onTransition>

Constructor & Destructor Documentation

ActionTransition::ActionTransition	(	QObject *	sender,
		const char *	signal,
		QState *	sourceState = 0,
		QString	buttonText = "",
		bool	applyPreviousAction = true,
		QTextStream *	logStream = NULL
	)

constructor: takes at least the state and signal considered for the transition

Member Function Documentation

void ActionTransition::addComponentToClose	(	QString	compName,
		QString	compType,
		bool	force = false
	)

add a component's name and type to the list of component to close during the transition.

Set force to "true" in order to close the component independently of its modified flag.

QString ActionTransition::getButtonText

(

)

get the transition button's text

virtual void ActionTransition::onTransition ( QEvent *  e )

virtual

called during the transition

void ActionTransition::setButtonText

(

QString

buttonText

)

the transition button's text

Member Data Documentation

bool ActionTransition::applyPreviousAction

private

should the action be applied during the transition (default set to true)

QString ActionTransition::buttonText

private

the text of the push button displayed in the ASM

QMap<QString, QString> ActionTransition::componentsToClose

private

Map containing all the name/type of the components to be closed during the transition.

QStringList ActionTransition::componentsToForceClose

private

list of the components' name that should be closed even if they are modified

QTextStream* ActionTransition::logStream

private

local pointer to the log stream

QTime* ActionTransition::startTime

private

Keep track of time (needed for the log)

---

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

• ActionTransition.h