LSSTApplications  20.0.0
LSSTDataManagementBasePackage
PolicyString.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 
31 #ifndef LSST_PEX_POLICY_STRING_H
32 #define LSST_PEX_POLICY_STRING_H
33 
34 #include <memory>
35 #include <boost/regex.hpp>
36 
40 
41 namespace lsst {
42 namespace pex {
43 namespace policy {
44 
53 public:
62 
69 
73  const std::string& getData() const { return _data; }
74 
76 
85  virtual const std::string& getFormatName();
86  const std::string& getFormatName() const { return const_cast<PolicyString*>(this)->getFormatName(); }
88 
90 
97  virtual void load(Policy& policy);
98  void load(Policy& policy) const { const_cast<PolicyString*>(this)->load(policy); }
100 
101  static const boost::regex SPACE_RE;
102  static const boost::regex COMMENT;
103 
106  static const boost::regex CONTENTID;
107 
108 protected:
113 
114 private:
115  const std::string& cacheName(const std::string& name) {
116  _format = name;
117  return _format;
118  }
119 
120  std::string _format;
122 
123  // inherits SupportedFormats _formats from PolicySource
124 };
125 
126 } // namespace policy
127 } // namespace pex
128 } // namespace lsst
129 
130 #endif // LSST_PEX_POLICY_STRING_H
std::string
STL class.
std::shared_ptr< SupportedFormats >
SupportedFormats.h
definition of the SupportedFormats class
lsst::pex::policy::PolicyString::SPACE_RE
static const boost::regex SPACE_RE
Definition: PolicyString.h:101
lsst::pex::policy::Policy
a container for holding hierarchical configuration data in memory.
Definition: Policy.h:167
lsst::pex::policy::PolicyString
a representation of a string containing Policy parameter data
Definition: PolicyString.h:52
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
lsst::pex::policy::PolicyString::PolicyString
PolicyString(const SupportedFormats::Ptr &fmts=defaultFormats)
create a "null" Policy formed from an empty string.
pex
Definition: __init__.py:1
Persistable.h
Interface for Persistable base class.
data
char * data
Definition: BaseRecord.cc:62
lsst::pex::policy::PolicyString::getFormatName
const std::string & getFormatName() const
Definition: PolicyString.h:86
lsst::pex::policy::PolicySource
an abstract class representing a source of serialized Policy parameter data.
Definition: PolicySource.h:52
lsst::pex::policy::PolicyString::COMMENT
static const boost::regex COMMENT
reg-exp for an empty line
Definition: PolicyString.h:102
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::pex::policy::PolicyString::getData
const std::string & getData() const
return the wrapped policy data as a string
Definition: PolicyString.h:73
lsst::pex::policy::PolicyString::load
void load(Policy &policy) const
load the data from this Policy source into a Policy object
Definition: PolicyString.h:98
lsst::daf::base::Persistable
Base class for all persistable classes.
Definition: Persistable.h:75
lsst::pex::policy::PolicyString::PolicyString
PolicyString(const std::string &data, const SupportedFormats::Ptr &fmts=defaultFormats)
create a PolicyString that's wrapped around a given string.
PolicySource.h
definition of the PolicySource class
lsst::pex::policy::PolicyString::_data
std::string _data
the policy data
Definition: PolicyString.h:112
lsst::pex::policy::PolicyString::load
virtual void load(Policy &policy)
load the data from this Policy source into a Policy object
lsst::pex::policy::PolicyString::CONTENTID
static const boost::regex CONTENTID
reg-exp for the start of a comment
Definition: PolicyString.h:106
lsst::pex::policy::PolicySource::defaultFormats
static SupportedFormats::Ptr defaultFormats
a default set of formats
Definition: PolicySource.h:130
lsst::pex::policy::PolicyString::getFormatName
virtual const std::string & getFormatName()
return the name of the format that the data is stored in.