LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
LSST Data Management Base Package
Loading...
Searching...
No Matches
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
46
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
59namespace lsst {
60namespace daf {
61namespace base {
62
63#if defined(__ICC)
64#pragma warning(push)
65#pragma warning(disable : 444)
66#endif
67
69public:
70 // Typedefs
73
76
78 virtual ~PropertyList() noexcept;
79
80 // Accessors
81
87 virtual std::shared_ptr<PropertySet> 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
163 void set(std::string const& name, std::shared_ptr<PropertySet> 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 }
269
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
282 virtual void copy(std::string const& dest, PropertySet const & source, std::string const& name,
283 bool asScalar = false);
285
287
288 virtual void combine(PropertySet const & source);
290
292 virtual void remove(std::string const& name);
293
294private:
295
297
298 virtual void _set(std::string const& name, std::shared_ptr<std::vector<std::any> > vp);
299 virtual void _moveToEnd(std::string const& name);
300 virtual void _commentOrderFix(std::string const& name, std::string const& comment);
301
302 CommentMap _comments;
304};
305
306#if defined(__ICC)
307#pragma warning(pop)
308#endif
309}
310} // namespace daf
311} // namespace lsst
312
313#endif
Basic LSST definitions.
#define LSST_EXPORT
Make a symbol visible even if visiblity is hidden (e.g.
Definition base.h:37
std::list< std::string >::const_iterator end() const
End iterator over the list of property names, in the order they were added.
void set(std::string const &name, std::vector< T > const &value, char const *comment)
Version of set vector value that accepts a comment.
PropertyList()
Construct an empty PropertyList.
std::shared_ptr< PropertyList > Ptr
void set(std::string const &name, T const &value)
Replace all values for a property name (possibly hierarchical) with a new scalar value.
T get(std::string const &name) const
Get the last value for a property name (possibly hierarchical).
void add(std::string const &name, T const &value, char const *comment)
Version of add scalar value that accepts a comment.
virtual std::shared_ptr< PropertySet > deepCopy() const
Make a deep copy of the PropertyList and all of its contents.
void add(std::string const &name, T const &value)
Append a single value to the vector of values for a property name (possibly hierarchical).
void add(std::string const &name, std::vector< T > const &value, char const *comment)
Version of add vector value that accepts a comment.
std::shared_ptr< PropertyList const > ConstPtr
std::string const & getComment(std::string const &name) const
Get the comment for a string property name (possibly hierarchical).
std::vector< T > getArray(std::string const &name) const
Get the vector of values for a property name (possibly hierarchical).
std::vector< std::string > getOrderedNames() const
Get the list of property names, in the order they were added.
void add(std::string const &name, char const *value, char const *comment)
Version of add char* value that accepts a comment.
virtual ~PropertyList() noexcept
Destructor.
virtual std::string toString(bool topLevelOnly=false, std::string const &indent="") const
Generate a string representation of the PropertySet.
std::list< std::string >::const_iterator begin() const
Begin iterator over the list of property names, in the order they were added.
void set(std::string const &name, char const *value, char const *comment)
Version of set char* value that accepts a comment.
Class for storing generic metadata.
Definition PropertySet.h:67
PropertySet(bool flat=false)
Construct an empty PropertySet.
STL namespace.