Computer Assited Medical Intervention Tool Kit  version 5.0
SaveActionState Class Reference

The asm application uses a state machine. This class implements the state of action save. More...

#include <SaveActionState.h>

+ Inheritance diagram for SaveActionState:
+ Collaboration diagram for SaveActionState:

Classes

struct  saveComponentsInfo
 

Public Member Functions

virtual camitk::Action::ApplyStatus applyAction ()
 apply the action encapsulated by this action state More...
 
 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)
 
ActionTransitionaddActionTransition (QString transitionName, QAbstractState *nextState, bool applyAction=true, QVector< camitk::Action::ApplyStatus > disableConditions=QVector< camitk::Action::ApplyStatus >())
 Adds a possible transition from this action. More...
 
void autoNextEntry ()
 programmatically call the onEntry() method (used during autonext) More...
 
void autoNextExit ()
 programmatically call the onExit() method (used during autonext) More...
 
QString getDescription ()
 Returns the description of the action state (may be different from the description of the actual action) More...
 
const QMap< QString, QString > & getInputComponents ()
 get the names and type of all input components More...
 
QString getName ()
 Returns the name of the action state (may be different from the name of the actual action) More...
 
const QMap< QString, QString > & getOutputComponents ()
 get the names and type of all output components More...
 
ActionStateWidgetgetWidget ()
 
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. More...
 
void setPreviousActionStatus (camitk::Action::ApplyStatus status)
 

Private Attributes

QString defaultSaveDirName
 
QVector< saveComponentsInfoinputComponentsInfo
 

Additional Inherited Members

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

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 
)

Member Function Documentation

◆ applyAction()

Action::ApplyStatus SaveActionState::applyAction ( )
virtual

apply the action encapsulated by this action state

Reimplemented from ActionState.

References camitk::Action::applyInPipeline(), CAMITK_ERROR, defaultSaveDirName, camitk::Action::getName(), ActionState::getWidget(), inputComponentsInfo, ActionState::logStream, ActionState::myAction, camitk::refresh(), and camitk::Action::setInputComponents().

+ Here is the call graph for this function:

◆ setInput()

void SaveActionState::setInput ( QVector< saveComponentsInfo inputComponentsInfo)

References inputComponentsInfo.

Referenced by ActionStateMachine::setCamiTKSaveAction().

+ Here is the caller graph for this function:

Member Data Documentation

◆ defaultSaveDirName

QString SaveActionState::defaultSaveDirName
private

Referenced by applyAction(), and SaveActionState().

◆ inputComponentsInfo

QVector<saveComponentsInfo> SaveActionState::inputComponentsInfo
private

Referenced by applyAction(), and setInput().


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