Loading [MathJax]/extensions/tex2jax.js
LSST Applications g0fba68d861+83433b07ee,g16d25e1f1b+23bc9e47ac,g1ec0fe41b4+3ea9d11450,g1fd858c14a+9be2b0f3b9,g2440f9efcc+8c5ae1fdc5,g35bb328faa+8c5ae1fdc5,g4a4af6cd76+d25431c27e,g4d2262a081+c74e83464e,g53246c7159+8c5ae1fdc5,g55585698de+1e04e59700,g56a49b3a55+92a7603e7a,g60b5630c4e+1e04e59700,g67b6fd64d1+3fc8cb0b9e,g78460c75b0+7e33a9eb6d,g786e29fd12+668abc6043,g8352419a5c+8c5ae1fdc5,g8852436030+60e38ee5ff,g89139ef638+3fc8cb0b9e,g94187f82dc+1e04e59700,g989de1cb63+3fc8cb0b9e,g9d31334357+1e04e59700,g9f33ca652e+0a83e03614,gabe3b4be73+8856018cbb,gabf8522325+977d9fabaf,gb1101e3267+8b4b9c8ed7,gb89ab40317+3fc8cb0b9e,gc0af124501+57ccba3ad1,gcf25f946ba+60e38ee5ff,gd6cbbdb0b4+1cc2750d2e,gd794735e4e+7be992507c,gdb1c4ca869+be65c9c1d7,gde0f65d7ad+c7f52e58fe,ge278dab8ac+6b863515ed,ge410e46f29+3fc8cb0b9e,gf35d7ec915+97dd712d81,gf5e32f922b+8c5ae1fdc5,gf618743f1b+747388abfa,gf67bdafdda+3fc8cb0b9e,w.2025.18
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
AliasMap.h
Go to the documentation of this file.
1// -*- lsst-c++ -*-
2#ifndef AFW_TABLE_AliasMap_h_INCLUDED
3#define AFW_TABLE_AliasMap_h_INCLUDED
4
5#include <map>
6#include <string>
7
8namespace lsst {
9namespace afw {
10namespace table {
11
12class BaseTable;
13
36class AliasMap final {
38
39public:
40 // Create an empty AliasMap
41 AliasMap() : _internal(), _table() {}
42
48 AliasMap(AliasMap const& other) : _internal(other._internal), _table() {}
49 // Delegate to copy-constructor for backwards compatibility
50 AliasMap(AliasMap&& other) : AliasMap(other) {}
51
52 AliasMap& operator=(AliasMap const&) = default;
54 ~AliasMap() = default;
55
57 using Iterator = std::map<std::string, std::string>::const_iterator;
58
60 Iterator begin() const { return _internal.begin(); }
61
63 Iterator end() const { return _internal.end(); }
64
66 std::size_t size() const { return _internal.size(); }
67
69 bool empty() const { return _internal.empty(); }
70
86 std::string apply(std::string const& name) const;
87
95 std::string get(std::string const& alias) const;
96
98 void set(std::string const& alias, std::string const& target);
99
105 bool erase(std::string const& alias);
106
108
111 bool operator==(AliasMap const& other) const;
112 bool operator!=(AliasMap const& other) const { return !(other == *this); }
114
116 std::size_t hash_value() const noexcept;
117
119 bool contains(AliasMap const& other) const;
120
121 std::shared_ptr<BaseTable> getTable() const { return _table.lock(); }
123
124private:
125 friend class Schema;
126 friend class SubSchema;
127
128 // Internal in-place implementation of apply()
129 void _apply(std::string& name) const;
130
131 Internal _internal;
132
133 // Table to notify of any changes. We can't use a shared_ptr here because the Table needs to set
134 // this in its own constructor, but the Table does guarantee that this pointer is either valid or
135 // null.
137};
138} // namespace table
139} // namespace afw
140} // namespace lsst
141
142namespace std {
143template <>
144struct hash<lsst::afw::table::AliasMap> {
147 size_t operator()(argument_type const& obj) const noexcept { return obj.hash_value(); }
148};
149} // namespace std
150
151#endif // !AFW_TABLE_AliasMap_h_INCLUDED
Mapping class that holds aliases for a Schema.
Definition AliasMap.h:36
bool contains(AliasMap const &other) const
Return true if all aliases in this are also in other (with the same targets).
Definition AliasMap.cc:111
bool operator!=(AliasMap const &other) const
Definition AliasMap.h:112
AliasMap(AliasMap &&other)
Definition AliasMap.h:50
std::string apply(std::string const &name) const
Apply any aliases that match the given field name and return a de-aliased name.
Definition AliasMap.cc:67
AliasMap(AliasMap const &other)
Deep-copy an AliasMap.
Definition AliasMap.h:48
std::size_t size() const
Return the number of aliases.
Definition AliasMap.h:66
void setTable(std::shared_ptr< BaseTable > table)
Definition AliasMap.h:122
std::shared_ptr< BaseTable > getTable() const
Definition AliasMap.h:121
Iterator begin() const
Return a iterator to the beginning of the map.
Definition AliasMap.h:60
std::map< std::string, std::string >::const_iterator Iterator
An iterator over alias->target pairs.
Definition AliasMap.h:57
bool erase(std::string const &alias)
Remove an alias from the schema if it is present.
Definition AliasMap.cc:90
AliasMap & operator=(AliasMap const &)=default
bool empty() const
Return the true if there are no aliases.
Definition AliasMap.h:69
std::string get(std::string const &alias) const
Return the target of the given alias.
Definition AliasMap.cc:73
std::size_t hash_value() const noexcept
Return a hash of this object.
Definition AliasMap.cc:101
AliasMap & operator=(AliasMap &&)=default
void set(std::string const &alias, std::string const &target)
Add an alias to the schema or replace an existing one.
Definition AliasMap.cc:82
bool operator==(AliasMap const &other) const
Equality comparison.
Definition AliasMap.cc:99
Iterator end() const
Return a iterator to one past the end of the map.
Definition AliasMap.h:63
Base class for all tables.
Definition BaseTable.h:61
STL namespace.
lsst::afw::table::AliasMap argument_type
Definition AliasMap.h:145
size_t operator()(argument_type const &obj) const noexcept
Definition AliasMap.h:147