LSSTApplications  19.0.0-11-g2ce9f25+4,20.0.0+1,20.0.0+10,20.0.0+11,20.0.0+13,20.0.0+2,20.0.0+3,20.0.0+4,20.0.0+6,20.0.0-1-g10df615+10,20.0.0-1-g253301a+5,20.0.0-1-g596936a+11,20.0.0-1-g8a53f90+1,20.0.0-1-gc96f8cb+12,20.0.0-1-gd1c87d7+1,20.0.0-17-g41c5faf,20.0.0-2-g04cfba9+4,20.0.0-2-gd11eeda,20.0.0-2-gec03fae+3,20.0.0-3-g082faa5+1,20.0.0-3-gbdbfa727+3,20.0.0-3-gc53c7b6,20.0.0-4-gde602ef96+4,20.0.0-4-ge48a6ca+6,20.0.0-4-ge987224+1,20.0.0-8-g7eef53f7+7,20.0.0-9-g8e1b333,w.2020.28
LSSTDataManagementBasePackage
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 namespace base {
62 
63 #if defined(__ICC)
64 #pragma warning(push)
65 #pragma warning(disable : 444)
66 #endif
67 
69 public:
70  // Typedefs
73 
75  PropertyList();
76 
78  virtual ~PropertyList() noexcept;
79 
80  // Accessors
81 
87  virtual PropertySet::Ptr deepCopy() const;
88 
89  // I can't make copydoc work for this so...
101  template <typename T>
102  T get(std::string const& name) const;
103 
104  // I can't make copydoc work for this so...
117  template <typename T>
118  T get(std::string const& name, T const& defaultValue) const;
119 
121  template <typename T>
122  std::vector<T> getArray(std::string const& name) const;
123 
131  std::string const& getComment(std::string const& name) const;
132 
134  std::vector<std::string> getOrderedNames() const;
135 
137  std::list<std::string>::const_iterator begin() const;
138 
140  std::list<std::string>::const_iterator end() const;
141 
143  virtual std::string toString(bool topLevelOnly = false, std::string const& indent = "") const;
144 
145  // Modifiers
146 
148  template <typename T>
149  void set(std::string const& name, T const& value);
150 
159  void set(std::string const& name, PropertySet::Ptr const& value);
160 
162  template <typename T>
163  void set(std::string const& name, std::vector<T> const& value);
164 
166  void set(std::string const& name, char const* value);
167 
169  template <typename T>
170  void add(std::string const& name, T const& value);
171 
173  template <typename T>
174  void add(std::string const& name, std::vector<T> const& value);
175 
177  void add(std::string const& name, char const* value);
178 
187  template <typename T>
188  void set(std::string const& name, T const& value, std::string const& comment);
189 
198  template <typename T>
199  void set(std::string const& name, std::vector<T> const& value, std::string const& comment);
200 
209  void set(std::string const& name, char const* value, std::string const& comment);
210 
219  template <typename T>
220  void add(std::string const& name, T const& value, std::string const& comment);
221 
230  template <typename T>
231  void add(std::string const& name, std::vector<T> const& value, std::string const& comment);
232 
241  void add(std::string const& name, char const* value, std::string const& comment);
242 
244  template <typename T>
245  void set(std::string const& name, T const& value, char const* comment) {
246  set(name, value, std::string(comment));
247  }
248 
250  template <typename T>
251  void set(std::string const& name, std::vector<T> const& value, char const* comment) {
252  set(name, value, std::string(comment));
253  }
254 
256  void set(std::string const& name, char const* value, char const* comment) {
257  set(name, value, std::string(comment));
258  }
259 
261  template <typename T>
262  void add(std::string const& name, T const& value, char const* comment) {
263  add(name, value, std::string(comment));
264  }
266  template <typename T>
267  void add(std::string const& name, std::vector<T> const& value, char const* comment) {
268  add(name, value, std::string(comment));
269  }
270 
272  void add(std::string const& name, char const* value, char const* comment) {
273  add(name, value, std::string(comment));
274  }
275 
277  virtual void copy(std::string const& dest, PropertySet::ConstPtr source, std::string const& name,
278  bool asScalar = false);
279 
281  virtual void combine(PropertySet::ConstPtr source);
282 
284  virtual void remove(std::string const& name);
285 
286 private:
287 
289 
290  virtual void _set(std::string const& name, std::shared_ptr<std::vector<boost::any> > vp);
291  virtual void _moveToEnd(std::string const& name);
292  virtual void _commentOrderFix(std::string const& name, std::string const& comment);
293 
294  CommentMap _comments;
295  std::list<std::string> _order;
296 };
297 
298 #if defined(__ICC)
299 #pragma warning(pop)
300 #endif
301 }
302 } // namespace daf
303 } // namespace lsst
304 
305 #endif
std::string
STL class.
std::shared_ptr
STL class.
std::list< std::string >
std::vector
STL class.
lsst::daf::base::PropertyList
Class for storing ordered metadata with comments.
Definition: PropertyList.h:68
lsst::daf::base::PropertyList::ConstPtr
std::shared_ptr< PropertyList const > ConstPtr
Definition: PropertyList.h:72
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
lsst::daf::base::PropertyList::set
void set(std::string const &name, char const *value, char const *comment)
Version of set char* value that accepts a comment.
Definition: PropertyList.h:256
end
int end
Definition: BoundedField.cc:105
ast::detail::source
const char * source()
Source function that allows astChannel to source from a Stream.
Definition: Stream.h:224
lsst::daf::base::PropertyList::add
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:267
PropertySet.h
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::daf::base::PropertyList::set
void set(std::string const &name, std::vector< T > const &value, char const *comment)
Version of set vector value that accepts a comment.
Definition: PropertyList.h:251
lsst::daf::base::PropertyList::add
void add(std::string const &name, T const &value, char const *comment)
Version of add scalar value that accepts a comment.
Definition: PropertyList.h:262
lsst::daf::base::PropertyList::add
void add(std::string const &name, char const *value, char const *comment)
Version of add char* value that accepts a comment.
Definition: PropertyList.h:272
list
daf::base::PropertyList * list
Definition: fits.cc:913
std
STL namespace.
base.h
lsst::daf::base::PropertyList::Ptr
std::shared_ptr< PropertyList > Ptr
Definition: PropertyList.h:71
lsst::daf::base::PropertySet
Class for storing generic metadata.
Definition: PropertySet.h:67
lsst::daf::base::PropertyList::~PropertyList
virtual ~PropertyList() noexcept
Destructor.
LSST_EXPORT
#define LSST_EXPORT
Make a symbol visible even if visiblity is hidden (e.g.
Definition: base.h:54
std::unordered_map< std::string, std::string >
set
daf::base::PropertySet * set
Definition: fits.cc:912