Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04a91732dc+2945638123,g07dc498a13+7e3c5f68a2,g12483e3c20+e0fa9c8503,g1409bbee79+7e3c5f68a2,g1a7e361dbc+7e3c5f68a2,g1fd858c14a+9f35e23ec3,g35bb328faa+fcb1d3bbc8,g3ad4f90e5c+e0fa9c8503,g3bd4b5ce2c+36fb6ead7f,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g5477a8d5ce+db04660fe6,g60b5630c4e+e0fa9c8503,g75b6c65c88+55830bd904,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+4639f750a5,g89139ef638+7e3c5f68a2,g8f1d76f86f+11a01f47f4,g9125e01d80+fcb1d3bbc8,g919ac25b3e+28db628500,g95236ca021+f7a31438ed,g989de1cb63+7e3c5f68a2,g9f33ca652e+d1e6496fea,ga365f290ef+26a6f9aaf0,gaaedd4e678+7e3c5f68a2,gabe3b4be73+1e0a283bba,gb1101e3267+c09b629e83,gb4a253aaf5+0122250889,gb58c049af0+f03b321e39,gbaa7868d32+e0fa9c8503,gc99c83e5f0+76d20ab76d,gcf25f946ba+4639f750a5,gd6cbbdb0b4+c8606af20c,gde0f65d7ad+021d0de224,ge278dab8ac+932305ba37,gfba249425e+fcb1d3bbc8,w.2025.08
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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.