LSSTApplications  20.0.0
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;
35 
36 namespace lsst {
37 namespace pex {
38 namespace policy {
39 
40 DefaultPolicyFile::DefaultPolicyFile(const char* const productName, const std::string& filepath,
41  const std::string& repos, bool strict)
42  : PolicyFile(), _repos(), _strict(strict) {
43  _repos = getInstallPath(productName);
44  if (repos.length() > 0) _repos /= repos;
45  _file = _repos / filepath;
46 }
47 
48 fs::path DefaultPolicyFile::getInstallPath(const char* const productName) {
49  return DefaultPolicyFile::installPathFor(productName);
50 }
51 
52 /*
53  * return the file path to the installation directory of a given
54  * named product. The installation directory will be taken from
55  * the value of an environment variable PRODUCTNAME_DIR where
56  * PRODUCTNAME is the given name of the product with all letters
57  * converted to upper case.
58  * @exception lsst::pex::exception::NotFoundError if the
59  * environement variable is not defined.
60  */
61 fs::path DefaultPolicyFile::installPathFor(const char* const productName) {
62  std::string productName_DIR(productName);
63 
64  // transform to upper case
65  std::transform(productName_DIR.begin(), productName_DIR.end(), productName_DIR.begin(),
66  std::ptr_fun<int, int>(std::toupper));
67 
68  // append _DIR
69  productName_DIR += "_DIR";
70 
71  // get installation directory from environment
72  const char* ipath = getenv(productName_DIR.c_str());
73  if (ipath == 0)
74  throw LSST_EXCEPT(pexExcept::NotFoundError, productName_DIR + ": environment variable not set");
75 
76  return fs::path(ipath);
77 }
78 
79 /*
80  * load the data from this Policy source into a Policy object. This
81  * implementation will automatically de-reference any file include
82  * directives in the policy file.
83  * @param policy the policy object to load the data into
84  * @exception ParserException if an error occurs while parsing the data
85  * @exception IOError if an I/O error occurs while reading from the
86  * source stream.
87  */
88 void DefaultPolicyFile::load(Policy& policy) const {
89  PolicyFile::load(policy);
90  policy.loadPolicyFiles(_repos, _strict);
91 }
92 
93 } // namespace policy
94 } // namespace pex
95 } // namespace lsst
lsst::pex::policy::DefaultPolicyFile::load
virtual void load(Policy &policy) const
load the data from this Policy source into a Policy object.
Definition: DefaultPolicyFile.cc:88
std::string
STL class.
lsst::pex::policy::Policy::loadPolicyFiles
int loadPolicyFiles(bool strict=true)
Recursively replace all PolicyFile values with the contents of the files they refer to.
Definition: Policy.h:747
std::string::length
T length(T... args)
lsst::pex::exceptions::NotFoundError
Reports attempts to access elements using an invalid key.
Definition: Runtime.h:151
lsst::pex::policy::DefaultPolicyFile::getInstallPath
virtual boost::filesystem::path getInstallPath(const char *const productName)
return the file path to the installation directory of a given named product.
Definition: DefaultPolicyFile.cc:48
DefaultPolicyFile.h
the definition of the DefaultPolicyFile class
lsst::pex::policy::Policy
a container for holding hierarchical configuration data in memory.
Definition: Policy.h:167
boost::filesystem
Definition: PolicyFile.cc:47
pex
Definition: __init__.py:1
lsst::pex::policy::PolicyFile::_file
boost::filesystem::path _file
the path to the underlying policy file
Definition: PolicyFile.h:214
std::string::c_str
T c_str(T... args)
std::transform
T transform(T... args)
std::toupper
T toupper(T... args)
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
LSST_EXCEPT
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
lsst::pex::policy::PolicyFile::load
virtual void load(Policy &policy) const
load the data from this Policy source into a Policy object
std::string::begin
T begin(T... args)
lsst::pex::policy::DefaultPolicyFile::installPathFor
static boost::filesystem::path installPathFor(const char *const productName)
return the file path to the installation directory of a given named product.
Definition: DefaultPolicyFile.cc:61
lsst::pex::policy::PolicyFile
a representation of a file containing Policy parameter data.
Definition: PolicyFile.h:58
lsst::pex::exceptions
Definition: Exception.h:37
std::string::end
T end(T... args)
exceptions.h
lsst::pex::policy::DefaultPolicyFile::DefaultPolicyFile
DefaultPolicyFile(const char *const productName, const std::string &filepath, const std::string &repos="", bool strict=true)
define a default policy file
Definition: DefaultPolicyFile.cc:40