LSSTApplications  18.0.0+106,18.0.0+50,19.0.0,19.0.0+1,19.0.0+10,19.0.0+11,19.0.0+13,19.0.0+17,19.0.0+2,19.0.0-1-g20d9b18+6,19.0.0-1-g425ff20,19.0.0-1-g5549ca4,19.0.0-1-g580fafe+6,19.0.0-1-g6fe20d0+1,19.0.0-1-g7011481+9,19.0.0-1-g8c57eb9+6,19.0.0-1-gb5175dc+11,19.0.0-1-gdc0e4a7+9,19.0.0-1-ge272bc4+6,19.0.0-1-ge3aa853,19.0.0-10-g448f008b,19.0.0-12-g6990b2c,19.0.0-2-g0d9f9cd+11,19.0.0-2-g3d9e4fb2+11,19.0.0-2-g5037de4,19.0.0-2-gb96a1c4+3,19.0.0-2-gd955cfd+15,19.0.0-3-g2d13df8,19.0.0-3-g6f3c7dc,19.0.0-4-g725f80e+11,19.0.0-4-ga671dab3b+1,19.0.0-4-gad373c5+3,19.0.0-5-ga2acb9c+2,19.0.0-5-gfe96e6c+2,w.2020.01
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:
61  explicit PolicyString(const std::string& data, const SupportedFormats::Ptr& fmts = defaultFormats);
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
definition of the PolicySource class
virtual void load(Policy &policy)
load the data from this Policy source into a Policy object
a container for holding hierarchical configuration data in memory.
Definition: Policy.h:167
static const boost::regex COMMENT
reg-exp for an empty line
Definition: PolicyString.h:102
void load(Policy &policy) const
load the data from this Policy source into a Policy object
Definition: PolicyString.h:98
virtual const std::string & getFormatName()
return the name of the format that the data is stored in.
Interface for Persistable base class.
STL class.
an abstract class representing a source of serialized Policy parameter data.
Definition: PolicySource.h:52
a representation of a string containing Policy parameter data
Definition: PolicyString.h:52
static SupportedFormats::Ptr defaultFormats
returns true if the given string containing a content identifier indicates that it contains dictionar...
Definition: PolicySource.h:130
A base class for image defects.
char * data
Definition: BaseRecord.cc:62
PolicyString(const std::string &data, const SupportedFormats::Ptr &fmts=defaultFormats)
create a PolicyString that&#39;s wrapped around a given string.
static const boost::regex CONTENTID
reg-exp for the start of a comment
Definition: PolicyString.h:106
definition of the SupportedFormats class
Definition: __init__.py:1
static const boost::regex SPACE_RE
Definition: PolicyString.h:101
std::string _data
the policy data
Definition: PolicyString.h:112
const std::string & getFormatName() const
return the name of the format that the data is stored in.
Definition: PolicyString.h:86
const std::string & getData() const
return the wrapped policy data as a string
Definition: PolicyString.h:73
Base class for all persistable classes.
Definition: Persistable.h:75