1 /*=========================================================================
4 Module: $RCSfile: bbtkConfigurationFile.h,v $
6 Date: $Date: 2008/02/14 09:32:54 $
7 Version: $Revision: 1.4 $
9 Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
10 l'Image). All rights reserved. See doc/license.txt or
11 http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details.
13 This software is distributed WITHOUT ANY WARRANTY; without even
14 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 PURPOSE. See the above copyright notices for more information.
17 =========================================================================*/
20 *\brief Class bbtk::ConfigurationFile
23 *\class bbtk::ConfigurationFile
28 #ifndef __bbtkConfigurationFile_h__
29 #define __bbtkConfigurationFile_h__
31 #include "bbtkSystem.h"
36 #define _CRT_SECURE_NO_DEPRECATE
48 //==========================================================================
49 class BBTK_EXPORT ConfigurationException
52 ConfigurationException(const std::string& message) : mMessage(message) {}
56 //==========================================================================
58 //==========================================================================
59 class BBTK_EXPORT ConfigurationFile
63 static ConfigurationFile const &GetInstance()
65 static ConfigurationFile f;
76 inline const std::string& Get_description() const
77 { return mDescription;}
78 inline const std::string& Get_url() const
80 inline const std::string& Get_data_path() const
82 inline const std::string& Get_file_separator() const
83 { return mFile_separator;}
85 inline const std::string& Get_bin_path() const
87 inline const std::string& Get_install_path() const
88 { return mInstall_path;}
89 inline const std::string& Get_doc_path() const
91 inline const std::string& Get_rsc_path() const
94 inline const std::vector<std::string>& Get_bbs_paths() const
96 inline const std::vector<std::string>& Get_package_paths() const
97 { return mPackage_paths;}
98 inline const std::string& Get_config_xml_full_path() const
99 { return mConfig_xml_full_path;}
100 inline const std::string& Get_default_temp_dir() const
101 { return mDefault_temp_dir;}
104 void Read(const std::string& fileName);
105 std::string GetExecutablePath();
106 void CreateConfigXML( char *rootDirectory );
110 std::string mDescription;
111 /// Where is the file bbtk_config.xml
112 std::string mConfig_xml_full_path;
114 /// Set automatically :
115 /// The path to the executable (usually bbi)
116 std::string mBin_path;
117 /// The path to the install prefix (=mBinPath+"/..")
118 std::string mInstall_path;
119 /// The relative path to the doc folder (=BBTK_DOC_REL_PATH)
120 std::string mDoc_rel_path;
121 /// The path to the doc folder (=mInstall_path+"/"+mDoc_rel_path)
122 std::string mDoc_path;
123 /// The relative path to the doc folder (=BBTK_BBS_REL_PATH)
124 std::string mBbs_rel_path;
125 /// The path to the bbs folder (=mInstall_path+"/"+mBbs_rel_path)
126 std::string mBbs_path;
127 /// The relative path to the rsc folder (=BBTK_RSC_REL_PATH)
128 std::string mRsc_rel_path;
129 /// The path to the rsc folder (=mInstall_path+"/"+mRsc_rel_path)
130 std::string mRsc_path;
131 /// The path to the bbtk data folder
132 /// Initialized to mInstall_path+"/"+BBTK_DATA_REL_PATH
133 /// But can be overriden by value read from bbtk_config.xml
134 std::string mData_path;
136 /// / or \, depending on the OS
137 std::string mFile_separator;
139 /// Read from bbtk_config.xml file
143 std::vector<std::string> mBbs_paths;
145 std::vector<std::string> mPackage_paths;
146 /// If Packages link against extern dlls
147 std::vector<std::string> mExt_dll_paths;
148 /// Temp directory for generated data
149 std::string mDefault_temp_dir;