Fraxinus  16.5.0-fx-rc4
An IGT application
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
cxDataLocations.h
Go to the documentation of this file.
1 /*=========================================================================
2 This file is part of CustusX, an Image Guided Therapy Application.
3 
4 Copyright (c) 2008-2014, SINTEF Department of Medical Technology
5 All rights reserved.
6 
7 Redistribution and use in source and binary forms, with or without
8 modification, are permitted provided that the following conditions are met:
9 
10 1. Redistributions of source code must retain the above copyright notice,
11  this list of conditions and the following disclaimer.
12 
13 2. Redistributions in binary form must reproduce the above copyright notice,
14  this list of conditions and the following disclaimer in the documentation
15  and/or other materials provided with the distribution.
16 
17 3. Neither the name of the copyright holder nor the names of its contributors
18  may be used to endorse or promote products derived from this software
19  without specific prior written permission.
20 
21 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 =========================================================================*/
32 #ifndef CXDATALOCATIONS_H_
33 #define CXDATALOCATIONS_H_
34 
35 #include "cxResourceExport.h"
36 
37 #include <QString>
38 #include <QObject>
39 #include "boost/shared_ptr.hpp"
40 
41 class QSettings;
42 
43 namespace cx
44 {
45 
52 class cxResource_EXPORT DataLocations
53 {
54 public:
55  static QString getBundlePath();
56  static QString getRootConfigPath();
57  static QStringList getRootConfigPaths();
58 
59  static QString getTestDataPath();
60  static QString getLargeTestDataPath();
61  static QString getExistingTestData(QString pathRelativeToTestDataRoot, QString filename="");
62 
63  static QString getDocPath();
64  static QString getPersistentWritablePath();
65  static void deletePersistentWritablePath();
66  static QString getCachePath();
67  static QStringList getDefaultPluginsPath();
68 
69  static void setTestMode();
70  static QString findExecutableInStandardLocations(QString filename);
71 
72  static QStringList appendStringToAllElements(QStringList root, QString suffix);
73 
74  static QString findConfigFolder(QString pathRelativeToConfigRoot, QString alternativeAbsolutePath = "");
75  static QString findConfigFilePath(QString fileName, QString pathRelativeToConfigRoot, QString alternativeAbsolutePath = "");
76  static QString findConfigPath(QString fileName, QString pathRelativeToConfigRoot, QString alternativeAbsolutePath = "");
77 
78  static void setWebsiteURL(QString websiteUrl);
79  static QString getWebsiteURL();
80  static QString getUploadsUrl();
81  static QString getWebsiteUserDocumentationURL();
82 
83  static bool isRunFromBuildFolder();
84 
85 private:
86  static bool mTestMode;
87  static bool mRunFromBuildFolder;
88  static bool mBuildFolderChecked;
89  static QString mWebsiteUrl;
90  static QString readTestDataPathFromFile(QString filename);
91  static QString checkExecutableExist(QString path, QString filename);
92 
93 };
94 
95 } // namespace cx
96 
97 #endif /* CXDATALOCATIONS_H_ */