Computer Assited Medical Intervention Tool Kit  version 5.0
HistoryComponent.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 HISTORYCOMPONENT_H
27 #define HISTORYCOMPONENT_H
28 
29 // Qt stuffs
30 #include <QString>
31 
32 // CamiTK stuffs
33 #include <Component.h>
34 
35 namespace camitk {
36 
37 
59 class CAMITK_API HistoryComponent {
60 public:
73  enum Type {
74  IMAGE_COMPONENT,
75  MESH_COMPONENT,
76  OTHER
77  };
78 
79 private:
82 
84  QString name;
85 
88  Type type;
90 
91 public:
94 
99  HistoryComponent(Component* component);
101 
104 
107  QString getName() const;
108 
111  Type getType() const;
113 
114 
115 };
116 
117 }; // namespace camitk
118 
119 #endif // HISTORYCOMPONENT_H
camitk::HistoryComponent::type
Type type
The component's Type.
Definition: HistoryComponent.h:134
camitk::HistoryComponent::HistoryComponent
HistoryComponent(Component *component)
Construct a new History component from the input component.
Definition: HistoryComponent.cpp:34
HistoryComponent.h
camitk::ImageComponent
The manager of the Image Volume data. An image volume data has no concrete 3D representation,...
Definition: ImageComponent.h:77
camitk::HistoryComponent
HistoryComponent class describes the component information (name, type) stored in the history.
Definition: HistoryComponent.h:82
MeshComponent.h
camitk::HistoryComponent::name
QString name
The name of the Component.
Definition: HistoryComponent.h:130
camitk::Component::getName
QString getName() const override
get the name to be displayed
Definition: sdk/libraries/core/component/Component.h:907
camitk::HistoryComponent::IMAGE_COMPONENT
@ IMAGE_COMPONENT
this Component represents a volumic image and its subcomponents can be displayed as slices.
Definition: HistoryComponent.h:120
camitk::HistoryComponent::MESH_COMPONENT
@ MESH_COMPONENT
this Component represent a 3D mesh, it has a 3D representation which can be displayed in the 3D viewe...
Definition: HistoryComponent.h:121
camitk::MeshComponent
Basic component to manage any kind of mesh.
Definition: MeshComponent.h:53
camitk::HistoryComponent::OTHER
@ OTHER
this Component has no defined representation.
Definition: HistoryComponent.h:122
camitk::HistoryComponent::getType
Type getType() const
Get the Type of the Component associated to this item.
Definition: HistoryComponent.cpp:53
camitk::HistoryComponent::getName
QString getName() const
Get the the name of the Component associated to this item.
Definition: HistoryComponent.cpp:48
ImageComponent.h
camitk::HistoryComponent::Type
Type
Definition: HistoryComponent.h:119
camitk::Component
A Component represents something that could be included in the explorer view, the interactive 3D view...
Definition: sdk/libraries/core/component/Component.h:302
CAMITK_API
#define CAMITK_API
Definition: CamiTKAPI.h:49
camitk
Definition: Action.cpp:35