lsst.daf.base  16.0-7-gc370964+2
PropertyList.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 
25 #ifndef LSST_DAF_BASE_PROPERTYLIST
26 #define LSST_DAF_BASE_PROPERTYLIST
27 
47 #include <list>
48 #include <memory>
49 #include <string>
50 #include <typeinfo>
51 #include <unordered_map>
52 #include <vector>
53 
54 #include "boost/any.hpp"
55 
56 #include "lsst/base.h"
58 
59 namespace lsst {
60 namespace daf {
61 
62 namespace persistence {
63 class PropertyListFormatter;
64 } // namespace persistence
65 
66 namespace base {
67 
68 #if defined(__ICC)
69 #pragma warning(push)
70 #pragma warning(disable : 444)
71 #endif
72 
74 public:
75  // Typedefs
78 
80  PropertyList(void);
82  virtual ~PropertyList(void);
83 
84  // Accessors
85 
91  virtual PropertySet::Ptr deepCopy(void) const;
92 
93  // I can't make copydoc work for this so...
105  template <typename T>
106  T get(std::string const& name) const;
107 
108  // I can't make copydoc work for this so...
121  template <typename T>
122  T get(std::string const& name, T const& defaultValue) const;
123 
125  template <typename T>
126  std::vector<T> getArray(std::string const& name) const;
127 
135  std::string const& getComment(std::string const& name) const;
136 
138  std::vector<std::string> getOrderedNames(void) const;
139 
141  std::list<std::string>::const_iterator begin(void) const;
142 
145 
147  virtual std::string toString(bool topLevelOnly = false, std::string const& indent = "") const;
148 
149  // Modifiers
150 
152  template <typename T>
153  void set(std::string const& name, T const& value);
154 
163  void set(std::string const& name, PropertySet::Ptr const& value);
164 
166  template <typename T>
167  void set(std::string const& name, std::vector<T> const& value);
168 
170  void set(std::string const& name, char const* value);
171 
173  template <typename T>
174  void add(std::string const& name, T const& value);
175 
177  template <typename T>
178  void add(std::string const& name, std::vector<T> const& value);
179 
181  void add(std::string const& name, char const* value);
182 
191  template <typename T>
192  void set(std::string const& name, T const& value, std::string const& comment);
193 
202  template <typename T>
203  void set(std::string const& name, std::vector<T> const& value, std::string const& comment);
204 
213  void set(std::string const& name, char const* value, std::string const& comment);
214 
223  template <typename T>
224  void add(std::string const& name, T const& value, std::string const& comment);
225 
234  template <typename T>
235  void add(std::string const& name, std::vector<T> const& value, std::string const& comment);
236 
245  void add(std::string const& name, char const* value, std::string const& comment);
246 
248  template <typename T>
249  void set(std::string const& name, T const& value, char const* comment) {
250  set(name, value, std::string(comment));
251  }
252 
254  template <typename T>
255  void set(std::string const& name, std::vector<T> const& value, char const* comment) {
256  set(name, value, std::string(comment));
257  }
258 
260  void set(std::string const& name, char const* value, char const* comment) {
261  set(name, value, std::string(comment));
262  }
263 
265  template <typename T>
266  void add(std::string const& name, T const& value, char const* comment) {
267  add(name, value, std::string(comment));
268  }
270  template <typename T>
271  void add(std::string const& name, std::vector<T> const& value, char const* comment) {
272  add(name, value, std::string(comment));
273  }
274 
276  void add(std::string const& name, char const* value, char const* comment) {
277  add(name, value, std::string(comment));
278  }
279 
281  virtual void copy(std::string const& dest, PropertySet::ConstPtr source, std::string const& name,
282  bool asScalar = false);
283 
285  virtual void combine(PropertySet::ConstPtr source);
286 
288  virtual void remove(std::string const& name);
289 
290 private:
291  LSST_PERSIST_FORMATTER(lsst::daf::persistence::PropertyListFormatter)
292 
294 
295  virtual void _set(std::string const& name, std::shared_ptr<std::vector<boost::any> > vp);
296  virtual void _moveToEnd(std::string const& name);
297  virtual void _commentOrderFix(std::string const& name, std::string const& comment);
298 
299  CommentMap _comments;
300  std::list<std::string> _order;
301 };
302 
303 #if defined(__ICC)
304 #pragma warning(pop)
305 #endif
306 }
307 } // namespace daf
308 } // namespace lsst
309 
310 #endif
Class for storing ordered metadata with comments.
Definition: PropertyList.h:73
STL class.
std::shared_ptr< PropertyList const > ConstPtr
Definition: PropertyList.h:77
std::shared_ptr< PropertyList > Ptr
Definition: PropertyList.h:76
void add(std::string const &name, std::vector< T > const &value, char const *comment)
Version of add vector value that accepts a comment.
Definition: PropertyList.h:271
STL class.
STL class.
void add(std::string const &name, char const *value, char const *comment)
Version of add char* value that accepts a comment.
Definition: PropertyList.h:276
Class for storing generic metadata.
Definition: PropertySet.h:73
#define LSST_PERSIST_FORMATTER(formatter...)
Macro used to connect the persistable class with the Formatter and boost::serialization.
Definition: Persistable.h:99
#define LSST_EXPORT
void add(std::string const &name, T const &value, char const *comment)
Version of add scalar value that accepts a comment.
Definition: PropertyList.h:266