Computer Assited Medical Intervention Tool Kit  version 3.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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-2013 UJF-Grenoble 1, CNRS, TIMC-IMAG UMR 5525 (GMCAO)
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 // The following content describes the index.html page of the API documentation.
30 // It uses CMake variable (surrounded by the '@' pattern), replaced by their content using the CONFIGURE_FILE CMake command
31 // This file is configured in camitk/cmake/modules/CamiTKApiDoc.cmake into the CamiTKVersion.h file.
32 
82 // Here are the related pages of the documention
104 // -- Core stuff
105 #include "CamiTKAPI.h"
106 #include "HistoryItem.h"
107 
108 // -- Qt stuff
109 #include <QStack>
110 
111 namespace camitk {
122 public:
123 
126 
132  static const QStringList getComponentDirectories();
133 
140  static const QStringList getActionDirectories();
141 
154  static const QString getTestDataDir();
155 
162  static const QStringList getInstallDirectories(QString suffix);
163 
165  static const QString getConfig();
166 
168  static const QString getPaths();
169 
171  static const QString getGlobalInstallDir();
172 
174  static const QString getUserInstallDir();
175 
177  static const QString getCurrentWorkingDir();
178 
180 
185  static const bool isDebugBuild();
187 
188 
192  static const char *version;
194  static const char *shortVersion;
196  static const char *soVersion;
198  static const char *debugPostfix;
200 
202  // TODO CAMITK_OBSOLETE. This section list all the methods marked as obsolete. They are to be removed in CamiTK 4.0
207  static const QString getComponentDir();
208 
213  static const QString getActionDir();
214 
220  static const QString getModuleDir(const QString & subpath = QString());
221 
225  static const QString getCoreLibDir();
227 
228 };
229 
230 }
231 
232 #endif // CAMITKCORE_H
233