The asm application uses a state machine. More...

#include <SaveActionState.h>

Classes
struct	saveComponentsInfo

Public Member Functions
virtual camitk::Action::ApplyStatus	applyAction ()
	apply the action encapsulated by this action state
	SaveActionState (QState parent, QString name, QString description, QString defaultSaveDirName, QTextStream logStream=nullptr)
void	setInput (QVector< saveComponentsInfo > inputComponentsInfo)
Public Member Functions inherited from ActionState
	ActionState (QState parent, QString name, QString description, QTextStream logStream=nullptr)
ActionTransition *	addActionTransition (QString transitionName, QAbstractState *nextState, bool applyAction=true, QVector< camitk::Action::ApplyStatus > disableConditions=QVector< camitk::Action::ApplyStatus >())
	Adds a possible transition from this action.
void	autoNextEntry ()
	programmatically call the onEntry() method (used during autonext)
void	autoNextExit ()
	programmatically call the onExit() method (used during autonext)
QString	getDescription ()
	Returns the description of the action state (may be different from the description of the actual action).
const QMap< QString, QString > &	getInputComponents ()
	get the names and type of all input components
QString	getName ()
	Returns the name of the action state (may be different from the name of the actual action).
const QMap< QString, QString > &	getOutputComponents ()
	get the names and type of all output components
ActionStateWidget *	getWidget ()
void	setAction (camitk::Action *action, QMap< QString, QVariant > parameters, QMap< QString, QString > inputComponentNames, QMap< QString, QString > outputComponentNames)
void	setAlternativeDesc (QString altDescText, QVector< camitk::Action::ApplyStatus > statusList)
	May change its description according to the previous action result.
void	setPreviousActionStatus (camitk::Action::ApplyStatus status)

Additional Inherited Members
Protected Member Functions inherited from ActionState
void	onEntry (QEvent *event) override
	Reimplemented from QState.
void	onExit (QEvent *event) override
Protected Attributes inherited from ActionState
QTime	actionTimer
	Keep track of time...
QMap< camitk::Action::ApplyStatus, QVector< QPushButton * > >	conditionalButtons
	Buttons that should be disabled if the previous aciton state did not happen correctly.
QMap< camitk::Action::ApplyStatus, QString >	conditionalDescriptions
	Descriptions that should be displaied if the previous action state did not happen correctly.
QString	description
	Description of the state action may not be the same as the action's description but complementary.
QMap< QString, QString >	inputComponentNames
	names of all the input compenent, this is a map <name, type>
QTextStream *	logStream
	Log stream to write report on logFile.
camitk::Action *	myAction
	Actual CamiTK action.
ActionStateWidget *	myStateWidget
	Widget containing:
QString	name
	Name of the state action (may not be the same as the action's name).
QMap< QString, QString >	outputComponentNames
	names of all the output compenent, this is a map <name, type>
QMap< QString, QVariant >	parameters
	name and value of preset parameters

Detailed Description

The asm application uses a state machine.

This class implements the state of action save.

Constructor & Destructor Documentation

◆ SaveActionState()

SaveActionState::SaveActionState	(	QState *	parent,
		QString	name,
		QString	description,
		QString	defaultSaveDirName,
		QTextStream *	logStream = nullptr )

References ActionState::ActionState(), ActionState::description, camitk::Application::getAction(), ActionState::logStream, ActionState::myAction, and ActionState::name.

Member Function Documentation

◆ applyAction()

Action::ApplyStatus SaveActionState::applyAction ( )

virtual

apply the action encapsulated by this action state

Reimplemented from ActionState.

References CAMITK_ERROR, camitk::Action::ERROR, camitk::Application::getAllComponents(), camitk::Action::getStatusAsString(), ActionState::getWidget(), ActionState::logStream, ActionState::myAction, camitk::Application::refresh(), camitk::Action::SUCCESS, and camitk::Action::TRIGGERED.

◆ setInput()

void SaveActionState::setInput ( QVector< saveComponentsInfo > inputComponentsInfo )

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

Classes