lsst.pex.policy  20.0.0+f48bb53858
PolicyParserFactory.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_PARSERFACTORY_H
33 #define LSST_PEX_POLICY_PARSERFACTORY_H
34 
35 #include <string>
36 
37 #include "lsst/pex/policy/Policy.h"
38 
39 #include <memory>
40 
41 namespace lsst {
42 namespace pex {
43 namespace policy {
44 
45 // forward declaration
46 class PolicyParser;
47 
48 // class PolicyParserFactory { // causing deletion problems
49 
58 public:
60 
65 
66  // PolicyParserFactory() { }
67 
71  virtual ~PolicyParserFactory();
72 
83  virtual PolicyParser* createParser(Policy& policy, bool strict = true) const = 0;
84 
91  virtual bool isRecognized(const std::string& leaders) const = 0;
92 
96  virtual const std::string& getFormatName();
97 
101  static const std::string UNRECOGNIZED;
102 };
103 
104 } // namespace policy
105 } // namespace pex
106 } // namespace lsst
107 
108 #endif // LSST_PEX_POLICY_PARSERFACTORY_H
lsst::pex::policy::PolicyParser
an abstract class for parsing serialized Policy data and loading it into a Policy object.
Definition: PolicyParser.h:46
std::string
STL class.
std::shared_ptr< PolicyParserFactory >
lsst::pex::policy::PolicyParserFactory::Ptr
std::shared_ptr< PolicyParserFactory > Ptr
Definition: PolicyParserFactory.h:59
lsst::pex::policy::PolicyParserFactory::PolicyParserFactory
PolicyParserFactory()
create a factory
Definition: PolicyParserFactory.h:64
lsst::pex::policy::Policy
a container for holding hierarchical configuration data in memory.
Definition: Policy.h:167
lsst::pex::policy::PolicyParserFactory::isRecognized
virtual bool isRecognized(const std::string &leaders) const =0
analyze the given string assuming contains the leading characters from the data stream and return tru...
lsst::pex::policy::PolicyParserFactory::createParser
virtual PolicyParser * createParser(Policy &policy, bool strict=true) const =0
create a new PolicyParser class and return a pointer to it.
lsst::pex::policy::PolicyParserFactory::UNRECOGNIZED
static const std::string UNRECOGNIZED
an empty string representing an unrecognized format
Definition: PolicyParserFactory.h:101
lsst::pex::policy::PolicyParserFactory
an abstract factory class for creating PolicyParser instances.
Definition: PolicyParserFactory.h:57
Policy.h
lsst::pex::policy::PolicyParserFactory::~PolicyParserFactory
virtual ~PolicyParserFactory()
destroy this factory
Definition: PolicyParserFactory.cc:45
lsst
lsst::pex::policy::PolicyParserFactory::getFormatName
virtual const std::string & getFormatName()
return the name for the format supported by the parser
Definition: PolicyParserFactory.cc:50