Computer Assisted Medical Intervention Tool Kit  version 6.0
Loading...
Searching...
No Matches
Core.h
Go to the documentation of this file.
1/*****************************************************************************
2 * $CAMITK_LICENCE_BEGIN$
3 *
4 * CamiTK - Computer Assisted Medical Intervention ToolKit
5 * (c) 2001-2025 Univ. Grenoble Alpes, CNRS, Grenoble INP - UGA, 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 CAMITKCORE_H
27#define CAMITKCORE_H
28
29
30
31// -- Core stuff
32#include "CamiTKAPI.h"
33#include "HistoryItem.h"
34
35// -- Qt stuff
36#include <QStack>
37
38
39
40namespace camitk {
74public:
75
78
84 static const QStringList getComponentDirectories();
85
92 static const QStringList getActionDirectories();
93
100 static const QStringList getViewerDirectories();
101
114 static const QString getTestDataDir();
115
129 static const QStringList getInstallDirectories(QString suffix, bool exitOnError = true);
130
135 static const QStringList getExtensionDirectories(QString extensionType);
136
138 static QStringList getExtensionFilter();
139
141 static const QString getConfig();
142
144 static const QJsonObject getConfigAsJson();
145
147 static const QString getPaths();
148
150 static const QJsonObject getPathsAsJson();
151
153 static const QString getGlobalInstallDir();
154
156 static const QString getUserInstallDir();
157
159 static const QString getCurrentWorkingDir();
160
162 static const QString getBugReport();
163
165 static const QString getPythonStatus();
167
172 static const bool isDebugBuild();
174
175
179 static const char* version();
181 static const char* shortVersion();
183 static const char* soVersion();
185 static const char* debugPostfix();
193 static const char* libDir();
195
196private:
197
198 // get the list of path information keys stored in the proper display order
199 static const QStringList getInformationPathKeys();
200};
201
202}
203
204#endif // CAMITKCORE_H
205
#define CAMITK_API
Definition CamiTKAPI.h:66
Core class specifies the basic static information for the CamiTK API.
Definition Core.h:73
static const QStringList getActionDirectories()
get all the action directories.
Definition Core.cpp:517
static const QStringList getInstallDirectories(QString suffix, bool exitOnError=true)
get all installation directories, suffixed by the given word.
Definition Core.cpp:463
static const char * debugPostfix()
debug postfix used on MSVC to distinguished between release and debug version
Definition CamiTKVersion.h:34
static const QString getUserInstallDir()
get the user config directory (this is the local installation directory)
Definition Core.cpp:589
static const char * libDir()
library folder set depending on the compiler and environment choice (it could be lib/ or lib64/ on Li...
Definition CamiTKVersion.h:35
static const char * version()
Definition CamiTKVersion.h:31
static const QString getPythonStatus()
get the python status
Definition Core.cpp:601
static const QString getGlobalInstallDir()
get the CAMITK_DIR (where camitk-config is installed)
Definition Core.cpp:547
static const QString getTestDataDir()
Get a valid camitk test data directory name.
Definition Core.cpp:532
static const QString getPaths()
get all important paths as a formatted string
Definition Core.cpp:133
static const char * shortVersion()
short version string (all in lower case, without the patch number)
Definition CamiTKVersion.h:32
static const QStringList getViewerDirectories()
get all the viewers directories.
Definition Core.cpp:527
static const QJsonObject getPathsAsJson()
get all important paths as a JSON string instead of the text/console version of getPaths()
Definition Core.cpp:76
static const bool isDebugBuild()
Definition Core.cpp:634
static const char * soVersion()
version used for so name
Definition CamiTKVersion.h:33
static QStringList getExtensionFilter()
return a list with all possible file extension for shared object/dynamic library/dll (....
Definition Core.cpp:446
static const QString getBugReport()
get a well formed bug report with all necessary information
Definition Core.cpp:610
static const QString getConfig()
get more information about installation, etc... as a formatted string
Definition Core.cpp:288
static const QStringList getComponentDirectories()
get all the component directories.
Definition Core.cpp:522
static const QStringList getExtensionDirectories(QString extensionType)
Used by getInstallDirectories to determine the list of extension repositories This method check both ...
Definition Core.cpp:496
static const QString getCurrentWorkingDir()
get the current working directory (during dev, this should be the build directory,...
Definition Core.cpp:595
static const QJsonObject getConfigAsJson()
get more information about installation, etc... as a JSON string instead of the text/console version ...
Definition Core.cpp:163
Definition Action.cpp:40