LSSTApplications  20.0.0
LSSTDataManagementBasePackage
PolicyParser.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 
32 #ifndef LSST_PEX_POLICY_PARSER_H
33 #define LSST_PEX_POLICY_PARSER_H
34 
35 #include "lsst/pex/policy/Policy.h"
37 
38 namespace lsst {
39 namespace pex {
40 namespace policy {
41 
46 class PolicyParser {
47 public:
56  PolicyParser(Policy& policy, bool strict = true) : _pol(policy), _strict(strict) {}
57 
61  virtual ~PolicyParser();
62 
68  bool isStrict() { return _strict; }
69 
75  void setStrict(bool strict) { _strict = strict; }
76 
84  virtual int parse(std::istream& is) = 0;
85 
87 
90  Policy& getPolicy() { return _pol; }
91  const Policy& getPolicy() const { return _pol; }
93 
94 protected:
96  bool _strict;
97 };
98 
99 } // namespace policy
100 } // namespace pex
101 } // namespace lsst
102 
103 #endif // LSST_PEX_POLICY_PARSER_H
lsst::pex::policy::PolicyParser::_pol
Policy & _pol
Definition: PolicyParser.h:95
lsst::pex::policy::PolicyParser::PolicyParser
PolicyParser(Policy &policy, bool strict=true)
Create a Parser attached to a policy object to be loaded.
Definition: PolicyParser.h:56
lsst::pex::policy::PolicyParser
an abstract class for parsing serialized Policy data and loading it into a Policy object.
Definition: PolicyParser.h:46
lsst::pex::policy::PolicyParser::getPolicy
const Policy & getPolicy() const
Definition: PolicyParser.h:91
lsst::pex::policy::PolicyParser::parse
virtual int parse(std::istream &is)=0
parse data from the input stream and load results into the attached Policy.
lsst::pex::policy::PolicyParser::_strict
bool _strict
Definition: PolicyParser.h:96
PolicyParserFactory.h
a definition of the PolicyParserFactory class
lsst::pex::policy::PolicyParser::isStrict
bool isStrict()
return true if this parser will be strict in adhering to syntax rules.
Definition: PolicyParser.h:68
lsst::pex::policy::PolicyParser::~PolicyParser
virtual ~PolicyParser()
destroy this factory
Definition: PolicyParser.cc:43
lsst::pex::policy::Policy
a container for holding hierarchical configuration data in memory.
Definition: Policy.h:167
pex
Definition: __init__.py:1
lsst::pex::policy::PolicyParser::getPolicy
Policy & getPolicy()
return the policy object
Definition: PolicyParser.h:90
Policy.h
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::pex::policy::PolicyParser::setStrict
void setStrict(bool strict)
set whether this parser will be strict in adhering to syntax rules.
Definition: PolicyParser.h:75
std::istream
STL class.