LSSTApplications  10.0-2-g4f67435,11.0.rc2+1,11.0.rc2+12,11.0.rc2+3,11.0.rc2+4,11.0.rc2+5,11.0.rc2+6,11.0.rc2+7,11.0.rc2+8
LSSTDataManagementBasePackage
DefaultPolicyFile.cc
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  * Copyright 2008, 2009, 2010 LSST Corporation.
4  *
5  * This product includes software developed by the
6  * LSST Project (http://www.lsst.org/).
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the LSST License Statement and
19  * the GNU General Public License along with this program. If not,
20  * see <http://www.lsstcorp.org/LegalNotices/>.
21  */
22 
27 #include "lsst/pex/exceptions.h"
28 
29 #include <algorithm>
30 #include <cctype>
31 #include <functional>
32 
33 namespace fs = boost::filesystem;
34 namespace pexExcept = lsst::pex::exceptions;
35 
36 namespace lsst {
37 namespace pex {
38 namespace policy {
39 
40 DefaultPolicyFile::DefaultPolicyFile(const char* const productName,
41  const std::string& filepath,
42  const std::string& repos,
43  bool strict)
44  : PolicyFile(), _repos(), _strict(strict)
45 {
46  _repos = getInstallPath(productName);
47  if (repos.length() > 0) _repos /= repos;
48  _file = _repos / filepath;
49 }
50 
51 fs::path DefaultPolicyFile::getInstallPath(const char* const productName) {
52  return DefaultPolicyFile::installPathFor(productName);
53 }
54 
55 /*
56  * return the file path to the installation directory of a given
57  * named product. The installation directory will be taken from
58  * the value of an environment variable PRODUCTNAME_DIR where
59  * PRODUCTNAME is the given name of the product with all letters
60  * converted to upper case.
61  * @exception lsst::pex::exception::NotFoundError if the
62  * environement variable is not defined.
63  */
64 fs::path DefaultPolicyFile::installPathFor(const char* const productName) {
65  std::string productName_DIR(productName);
66 
67  // transform to upper case
68  std::transform(productName_DIR.begin(), productName_DIR.end(),
69  productName_DIR.begin(),
70  std::ptr_fun<int, int>( std::toupper ));
71 
72  // append _DIR
73  productName_DIR += "_DIR";
74 
75  // get installation directory from environment
76  const char *ipath = getenv(productName_DIR.c_str());
77  if (ipath == 0)
78  throw LSST_EXCEPT(pexExcept::NotFoundError,
79  productName_DIR + ": environment variable not set");
80 
81  return fs::path(ipath);
82 }
83 
84 /*
85  * load the data from this Policy source into a Policy object. This
86  * implementation will automatically de-reference any file include
87  * directives in the policy file.
88  * @param policy the policy object to load the data into
89  * @exception ParserException if an error occurs while parsing the data
90  * @exception IOError if an I/O error occurs while reading from the
91  * source stream.
92  */
93 void DefaultPolicyFile::load(Policy& policy) const {
94  PolicyFile::load(policy);
96 }
97 
98 }}} // end namespace lsst::pex::policy
the definition of the DefaultPolicyFile class
a container for holding hierarchical configuration data in memory.
Definition: Policy.h:169
virtual void load(Policy &policy) const
virtual void load(Policy &policy) const
DefaultPolicyFile(const char *const productName, const std::string &filepath, const std::string &repos="", bool strict=true)
static boost::filesystem::path installPathFor(const char *const productName)
virtual boost::filesystem::path getInstallPath(const char *const productName)
#define LSST_EXCEPT(type,...)
Definition: Exception.h:46
boost::filesystem::path _file
Definition: PolicyFile.h:226
int loadPolicyFiles(bool strict=true)
Definition: Policy.h:775
a representation of a file containing Policy parameter data.
Definition: PolicyFile.h:58
Include files required for standard LSST Exception handling.