LSSTApplications  20.0.0
LSSTDataManagementBasePackage
DefaultPolicyFile.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 
3 /*
4  * LSST Data Management System
5  * Copyright 2008, 2009, 2010 LSST Corporation.
6  *
7  * This product includes software developed by the
8  * LSST Project (http://www.lsst.org/).
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program 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 General Public License for more details.
19  *
20  * You should have received a copy of the LSST License Statement and
21  * the GNU General Public License along with this program. If not,
22  * see <http://www.lsstcorp.org/LegalNotices/>.
23  */
24 
36 #ifndef LSST_PEX_POLICY_DEFAULTPOLICYFILE_H
37 #define LSST_PEX_POLICY_DEFAULTPOLICYFILE_H
38 
40 
41 namespace lsst {
42 namespace pex {
43 namespace policy {
44 
69 class DefaultPolicyFile : public PolicyFile {
70 public:
88  DefaultPolicyFile(const char* const productName, const std::string& filepath,
89  const std::string& repos = "", bool strict = true);
90 
98  virtual boost::filesystem::path getInstallPath(const char* const productName);
99 
104  const boost::filesystem::path& getRepositoryPath() const { return _repos; }
105 
113  static boost::filesystem::path installPathFor(const char* const productName);
114 
124  virtual void load(Policy& policy) const;
125 
126 private:
127  boost::filesystem::path _repos;
128  bool _strict;
129 };
130 
131 } // namespace policy
132 } // namespace pex
133 } // namespace lsst
134 
135 #endif
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::DefaultPolicyFile
a representation of a default Policy file that is stored as a file in the installation directory of a...
Definition: DefaultPolicyFile.h:69
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
lsst::pex::policy::Policy
a container for holding hierarchical configuration data in memory.
Definition: Policy.h:167
pex
Definition: __init__.py:1
PolicyFile.h
definition of the PolicyFile class
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::pex::policy::DefaultPolicyFile::getRepositoryPath
const boost::filesystem::path & getRepositoryPath() const
return the full file path to the repository directory where this file will found.
Definition: DefaultPolicyFile.h:104
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::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