LSSTApplications  20.0.0
LSSTDataManagementBasePackage
PolicySource.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 
34 #ifndef LSST_PEX_POLICY_SOURCE_H
35 #define LSST_PEX_POLICY_SOURCE_H
36 
37 #include "lsst/pex/policy/Policy.h"
40 
41 namespace lsst {
42 namespace pex {
43 namespace policy {
44 
52 class PolicySource {
53 public:
60  }
61 
65  virtual ~PolicySource();
66 
67  // /**
68  // * identifiers for the different supported formats
69  // */
70  // enum FormatType {
71 
72  // /** Unknown and unsupported */
73  // UNSUPPORTED,
74 
75  // /** XML format */
76  // XML,
77 
78  // /** Policy authoring format (PAF) */
79  // PAF,
80 
81  // /** Supported format but unknown */
82  // UNKNOWN
83  // };
84 
85  // /**
86  // * determine the format that the data is stored in and return its format
87  // * type identifier. Note that UNKNOWN will be returned
88  // * if the format is supported--that is, the data can be read into a
89  // * Policy object--but otherwise does not have a defined type identifier
90  // * defined. This may cause the first few records of the source to
91  // * be read.
92  // * @exception IOError if an error occurs while reading the first few
93  // * characters of the source stream.
94  // */
95  // virtual FormatType getFormatType();
96 
103  virtual const std::string& getFormatName() = 0;
104 
106 
113  virtual void load(Policy& policy) const = 0;
114  virtual void load(Policy& policy) = 0;
116 
117  // /**
118  // * returns true if the given string containing a content identifier
119  // * indicates that it contains dictionary data. Dictionary data has
120  // * a content id of "<?cfg ... dictionary ?>" (where ... indicates
121  // * the format); policy data has an id of "<?cfg ... policy ?>".
122  // */
123  // static bool indicatesDictionary(const std::string& contentid) {
124  // return regex_search(contentid, DICTIONARY_CONTENT);
125  // }
126 
131 
132  // static const regex DICTIONARY_CONTENT;
133 
134 protected:
136 };
137 
138 } // namespace policy
139 } // namespace pex
140 } // namespace lsst
141 
142 #endif // LSST_PEX_POLICY_SOURCE_H
PolicyParserFactory.h
a definition of the PolicyParserFactory class
std::string
STL class.
std::shared_ptr< SupportedFormats >
SupportedFormats.h
definition of the SupportedFormats class
lsst::pex::policy::PolicySource::PolicySource
PolicySource(SupportedFormats::Ptr fmts=defaultFormats)
create a Policy file that points a file with given path.
Definition: PolicySource.h:58
lsst::pex::policy::PolicySource::_formats
SupportedFormats::Ptr _formats
Definition: PolicySource.h:135
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::SupportedFormats::initDefaultFormats
static void initDefaultFormats(SupportedFormats &sf)
initialize a given SupportFormats instance with the formats known by default.
Definition: SupportedFormats.cc:40
lsst::pex::policy::PolicySource::load
virtual void load(Policy &policy)=0
lsst::pex::policy::PolicySource::~PolicySource
virtual ~PolicySource()
destroy the source
Definition: PolicySource.cc:35
Policy.h
lsst::pex::policy::PolicySource::getFormatName
virtual const std::string & getFormatName()=0
return the name of the format that the data is stored in.
lsst::pex::policy::PolicySource
an abstract class representing a source of serialized Policy parameter data.
Definition: PolicySource.h:52
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::pex::policy::PolicySource::defaultFormats
static SupportedFormats::Ptr defaultFormats
a default set of formats
Definition: PolicySource.h:130
lsst::pex::policy::PolicySource::load
virtual void load(Policy &policy) const =0
load the data from this Policy source into a Policy object