ActionState.h

Go to the documentation of this file.

/*****************************************************************************
 * $CAMITK_LICENCE_BEGIN$
 *
 * CamiTK - Computer Assisted Medical Intervention ToolKit
 * (c) 2001-2018 Univ. Grenoble Alpes, CNRS, TIMC-IMAG UMR 5525 (GMCAO)
 *
 * Visit http://camitk.imag.fr for more information
 *
 * This file is part of CamiTK.
 *
 * CamiTK is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * CamiTK is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with CamiTK.  If not, see <http://www.gnu.org/licenses/>.
 *
 * $CAMITK_LICENCE_END$
 ****************************************************************************/
#ifndef ACTIONSTATE_H
#define ACTIONSTATE_H

// Qt stuff
#include <QTime>
#include <QState>
#include <QVector>
#include <QTextStream>

//CamiTK stuff
#include <Action.h>

// Local stuff
#include "ActionStateWidget.h"
#include "ActionTransition.h"
class ActionState : public QState {

    Q_OBJECT

public:
    ActionState(QState* parent, QString name, QString description, QTextStream* logStream = nullptr);

    void setAction(camitk::Action* action,
                   QMap<QString, QVariant> parameters,
                   QMap<QString, QString> inputComponentNames,
                   QMap<QString, QString> outputComponentNames);

    QString getName();

    QString getDescription();

    void setAlternativeDesc(QString altDescText, QVector<camitk::Action::ApplyStatus> statusList);

    virtual camitk::Action::ApplyStatus applyAction();

    ActionTransition* addActionTransition(QString transitionName, QAbstractState* nextState,
                                          bool applyAction = true, QVector<camitk::Action::ApplyStatus> disableConditions = QVector<camitk::Action::ApplyStatus>());

    // get the whole action state widget (used by the ActionStateViewer)
    ActionStateWidget* getWidget();

    // set the status of previous action and modify description/possible action accordingly
    void setPreviousActionStatus(camitk::Action::ApplyStatus status);

    const QMap<QString, QString>& getInputComponents();

    const QMap<QString, QString>& getOutputComponents();

    void autoNextEntry();

    void autoNextExit();

protected:
    void onEntry(QEvent* event) override;

    void onExit(QEvent* event) override;

    QString name;

    QString description;

    camitk::Action* myAction;

    QMap<QString, QString> inputComponentNames;

    QMap<QString, QString> outputComponentNames;

    QMap<QString, QVariant> parameters;

    QMap<camitk::Action::ApplyStatus, QVector<QPushButton* > > conditionalButtons;

    QMap<camitk::Action::ApplyStatus, QString> conditionalDescriptions;

    ActionStateWidget* myStateWidget;

    QTextStream* logStream;

    QTime* startTime;

};
#endif // ACTIONSTATE_H