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
PolicyFile.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_FILE_H
37 #define LSST_PEX_POLICY_FILE_H
38 
39 #include <boost/shared_ptr.hpp>
40 #include <boost/regex.hpp>
41 #include <boost/filesystem/path.hpp>
42 #include <boost/filesystem/operations.hpp>
43 
47 
48 namespace lsst {
49 namespace pex {
50 namespace policy {
51 
59 public:
60 
62 
76  explicit PolicyFile(const std::string& filepath,
78  explicit PolicyFile(const char *filepath,
80  explicit PolicyFile(const boost::filesystem::path& filepath,
83 
85 
95  PolicyFile(const std::string& filepath,
96  const PolicyParserFactory::Ptr& parserFactory);
97  PolicyFile(const boost::filesystem::path& filepath,
98  const PolicyParserFactory::Ptr& parserFactory);
100 
102 
121  PolicyFile(const std::string& filepath,
122  const boost::filesystem::path& reposDir,
123  const SupportedFormats::Ptr& fmts = defaultFormats);
124  PolicyFile(const boost::filesystem::path& filepath,
125  const boost::filesystem::path& reposDir,
126  const SupportedFormats::Ptr& fmts = defaultFormats);
128 
130 
145  PolicyFile(const std::string& filepath,
146  const boost::filesystem::path& reposDir,
147  const PolicyParserFactory::Ptr& parserFactory);
148  PolicyFile(const boost::filesystem::path& filepath,
149  const boost::filesystem::path& reposDir,
150  const PolicyParserFactory::Ptr& parserFactory);
152 
159 
160 
161 // /*
162 // * determine the format that the data is stored in and return its format
163 // * type identifier. Note that UNKNOWN will be returned
164 // * if the format is supported--that is, the data can be read into a
165 // * Policy object--but otherwise does not have a defined type identifier
166 // * defined. This may cause the first few records of the source to
167 // * be read.
168 // * @exception IOError if an error occurs while reading the first few
169 // * characters of the source stream.
170 // */
171 // virtual FormatType getFormatType();
172 
176  const std::string getPath() const { return _file.string(); }
177 
181  bool exists() const { return boost::filesystem::exists(_file); }
182 
192  virtual const std::string& getFormatName();
193  const std::string& getFormatName() const {
194  return const_cast<PolicyFile*>(this)->getFormatName();
195  }
196 
198 
205  virtual void load(Policy& policy) const;
206  virtual void load(Policy& policy) {
207  ((const PolicyFile*) this)->load(policy); // delegate to const version
208  }
210 
211  static const std::string EXT_PAF;
212  static const std::string EXT_XML;
213 
214  static const boost::regex SPACE_RE;
215  static const boost::regex COMMENT;
216 
220  static const boost::regex CONTENTID;
221 
222 protected:
226  boost::filesystem::path _file;
227 
228 private:
229  const std::string& cacheName(const std::string& name) {
230  _format = name;
231  return _format;
232  }
233 
234  std::string _format;
236 
237  // inherits SupportedFormats _formats from PolicySource
238 };
239 
240 
241 }}} // end namespace lsst::pex::policy
242 
243 #endif // LSST_PEX_POLICY_FILE_H
244 
245 
definition of the PolicySource class
const std::string getPath() const
Definition: PolicyFile.h:176
table::Key< std::string > name
Definition: ApCorrMap.cc:71
static SupportedFormats::Ptr defaultFormats
Definition: PolicySource.h:135
PolicyParserFactory::Ptr _pfact
Definition: PolicyFile.h:235
a container for holding hierarchical configuration data in memory.
Definition: Policy.h:169
virtual void load(Policy &policy) const
const std::string & cacheName(const std::string &name)
Definition: PolicyFile.h:229
static const boost::regex COMMENT
reg-exp for an empty line
Definition: PolicyFile.h:215
boost::shared_ptr< SupportedFormats > Ptr
an abstract class representing a source of serialized Policy parameter data. This might be a file or ...
Definition: PolicySource.h:53
virtual void load(Policy &policy)
Definition: PolicyFile.h:206
definition of the SupportedFormats class
static const std::string EXT_PAF
Definition: PolicyFile.h:211
virtual const std::string & getFormatName()
Interface for Persistable base class.
const std::string & getFormatName() const
Definition: PolicyFile.h:193
def exists
Definition: cuda.py:53
boost::filesystem::path _file
Definition: PolicyFile.h:226
Base class for all persistable classes.
Definition: Persistable.h:74
boost::shared_ptr< PolicyParserFactory > Ptr
static const boost::regex SPACE_RE
the XML file extension, &quot;.xml&quot;
Definition: PolicyFile.h:214
a representation of a file containing Policy parameter data.
Definition: PolicyFile.h:58
PolicyFile(const std::string &filepath, const SupportedFormats::Ptr &fmts=defaultFormats)
static const boost::regex CONTENTID
reg-exp for the start of a comment
Definition: PolicyFile.h:220
static const std::string EXT_XML
the PAF file extension, &quot;.paf&quot;
Definition: PolicyFile.h:212