Computer Assited Medical Intervention Tool Kit  version 5.0
HistoryItem.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * $CAMITK_LICENCE_BEGIN$
3  *
4  * CamiTK - Computer Assisted Medical Intervention ToolKit
5  * (c) 2001-2021 Univ. Grenoble Alpes, CNRS, Grenoble INP, TIMC, 38000 Grenoble, France
6  *
7  * Visit http://camitk.imag.fr for more information
8  *
9  * This file is part of CamiTK.
10  *
11  * CamiTK is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * CamiTK is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU Lesser General Public License version 3 for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * version 3 along with CamiTK. If not, see <http://www.gnu.org/licenses/>.
22  *
23  * $CAMITK_LICENCE_END$
24  ****************************************************************************/
25 
26 #ifndef HISTORYITEM_H
27 #define HISTORYITEM_H
28 
29 // Qt stuffs
30 #include <QString>
31 #include <QVariant>
32 #include <QList>
33 
34 // CamiTK stuffs
35 #include <Component.h>
36 #include "HistoryComponent.h"
37 
38 namespace camitk {
39 
61 class CAMITK_API HistoryItem {
62 private:
63 
65  QString name;
66 
68  QMap<QByteArray, QVariant> properties;
70  QList<HistoryComponent> inputHistoryComponents;
72  QList<HistoryComponent> outputHistoryComponents;
73 
74 public:
76  HistoryItem() = default;
77 
81  HistoryItem(QString name);
82 
84  virtual ~HistoryItem() = default;
85 
88  QString getName();
89 
93  void addProperty(QByteArray name, QVariant value);
94 
95 
98  QList<HistoryComponent> getInputHistoryComponents();
99 
102  void setInputHistoryComponents(QList<HistoryComponent> inputHistoryComponents);
103 
106  QList<HistoryComponent> getOutputHistoryComponents();
107 
110  void setOutputHistoryComponents(QList<HistoryComponent> outputHistoryComponents);
111 
112 };
113 
114 }
115 
116 #endif // HISTORYITEM_H
camitk::HistoryItem::inputHistoryComponents
QList< HistoryComponent > inputHistoryComponents
The input components for this action.
Definition: HistoryItem.h:116
camitk::HistoryItem::getInputHistoryComponents
QList< HistoryComponent > getInputHistoryComponents()
Get the input components of the history item action.
Definition: HistoryItem.cpp:70
camitk::HistoryItem::getOutputHistoryComponents
QList< HistoryComponent > getOutputHistoryComponents()
Get the output components of the history item action.
Definition: HistoryItem.cpp:80
camitk::HistoryItem::addProperty
void addProperty(QByteArray name, QVariant value)
Add a property of the corresponding action to the history item.
Definition: HistoryItem.cpp:65
HistoryComponent.h
camitk::HistoryItem::setInputHistoryComponents
void setInputHistoryComponents(QList< HistoryComponent > inputHistoryComponents)
Set the input components of the history item action.
Definition: HistoryItem.cpp:75
camitk::HistoryItem::properties
QMap< QByteArray, QVariant > properties
The properties stored for this action.
Definition: HistoryItem.h:114
camitk::HistoryItem::setOutputHistoryComponents
void setOutputHistoryComponents(QList< HistoryComponent > outputHistoryComponents)
Set the output components of the history item action.
Definition: HistoryItem.cpp:85
camitk::HistoryItem::HistoryItem
HistoryItem()=default
Empty constructor.
camitk::HistoryItem
HistoryItem class describes the entry of an action used in a pipeline, in the history.
Definition: HistoryItem.h:84
camitk::HistoryItem::name
QString name
The name of the action in the pipeline.
Definition: HistoryItem.h:111
camitk::HistoryItem::outputHistoryComponents
QList< HistoryComponent > outputHistoryComponents
The outpu components for this action.
Definition: HistoryItem.h:118
HistoryItem.h
camitk::HistoryItem::getName
QString getName()
Get the name of the corresponding action in the pipeline.
Definition: HistoryItem.cpp:59
CAMITK_API
#define CAMITK_API
Definition: CamiTKAPI.h:49
camitk
Definition: Action.cpp:35