LSSTApplications  20.0.0
LSSTDataManagementBasePackage
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 
8 namespace lsst {
9 namespace afw {
10 namespace table {
11 
12 class BaseTable;
13 
36 class AliasMap final {
38 
39 public:
40  // Create an empty AliasMap
41  AliasMap() : _internal(), _table(0) {}
42 
48  AliasMap(AliasMap const& other) : _internal(other._internal), _table(0) {}
49  // Delegate to copy-constructor for backwards compatibility
51 
52  AliasMap& operator=(AliasMap const&) = default;
53  AliasMap& operator=(AliasMap&&) = default;
54  ~AliasMap() = default;
55 
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 private:
122  friend class Schema;
123  friend class SubSchema;
124  friend class BaseTable;
125 
126  // Internal in-place implementation of apply()
127  void _apply(std::string& name) const;
128 
129  Internal _internal;
130 
131  // Table to notify of any changes. We can't use a shared_ptr here because the Table needs to set
132  // this in its own constructor, but the Table does guarantee that this pointer is either valid or
133  // null.
134  BaseTable* _table;
135 };
136 } // namespace table
137 } // namespace afw
138 } // namespace lsst
139 
140 namespace std {
141 template <>
142 struct hash<lsst::afw::table::AliasMap> {
145  size_t operator()(argument_type const& obj) const noexcept { return obj.hash_value(); }
146 };
147 } // namespace std
148 
149 #endif // !AFW_TABLE_AliasMap_h_INCLUDED
lsst::afw::table::AliasMap::size
std::size_t size() const
Return the number of aliases.
Definition: AliasMap.h:66
lsst::afw::table::AliasMap::~AliasMap
~AliasMap()=default
lsst::afw::table::AliasMap::end
Iterator end() const
Return a iterator to one past the end of the map.
Definition: AliasMap.h:63
lsst::afw::table::AliasMap::hash_value
std::size_t hash_value() const noexcept
Return a hash of this object.
Definition: AliasMap.cc:99
std::string
STL class.
lsst::afw::table::AliasMap::AliasMap
AliasMap(AliasMap &&other)
Definition: AliasMap.h:50
lsst::afw::table::AliasMap::operator=
AliasMap & operator=(AliasMap const &)=default
lsst::afw::table::AliasMap::get
std::string get(std::string const &alias) const
Return the target of the given alias.
Definition: AliasMap.cc:73
std::hash< lsst::afw::table::AliasMap >::operator()
size_t operator()(argument_type const &obj) const noexcept
Definition: AliasMap.h:145
std::map::size
T size(T... args)
lsst::afw::table::AliasMap::AliasMap
AliasMap(AliasMap const &other)
Deep-copy an AliasMap.
Definition: AliasMap.h:48
lsst::afw
Definition: imageAlgorithm.dox:1
lsst::afw::table::Schema
Defines the fields and offsets for a table.
Definition: Schema.h:50
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
lsst::afw::table::BaseTable
Base class for all tables.
Definition: BaseTable.h:61
lsst::afw::table::AliasMap
Mapping class that holds aliases for a Schema.
Definition: AliasMap.h:36
other
ItemVariant const * other
Definition: Schema.cc:56
lsst::afw::table::AliasMap::operator!=
bool operator!=(AliasMap const &other) const
Definition: AliasMap.h:112
std::map< std::string, std::string >
lsst::afw::table::AliasMap::operator==
bool operator==(AliasMap const &other) const
Equality comparison.
Definition: AliasMap.cc:97
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
target
Key< Flag > const & target
Definition: BaseColumnView.cc:20
lsst::afw::table::AliasMap::apply
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
lsst::afw::table::AliasMap::begin
Iterator begin() const
Return a iterator to the beginning of the map.
Definition: AliasMap.h:60
std::map::begin
T begin(T... args)
lsst::afw::table::SubSchema
A proxy type for name lookups in a Schema.
Definition: Schema.h:357
std
STL namespace.
lsst::afw::table::AliasMap::erase
bool erase(std::string const &alias)
Remove an alias from the schema if it is present.
Definition: AliasMap.cc:89
lsst::afw::table::AliasMap::empty
bool empty() const
Return the true if there are no aliases.
Definition: AliasMap.h:69
lsst::afw::table::AliasMap::operator=
AliasMap & operator=(AliasMap &&)=default
lsst::afw::table::AliasMap::AliasMap
AliasMap()
Definition: AliasMap.h:41
std::map::empty
T empty(T... args)
std::size_t
lsst::afw::table::AliasMap::contains
bool contains(AliasMap const &other) const
Return true if all aliases in this are also in other (with the same targets).
Definition: AliasMap.cc:109
std::map::end
T end(T... args)
lsst::afw::table::AliasMap::set
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
std::hash
lsst::afw::table::AliasMap::Iterator
std::map< std::string, std::string >::const_iterator Iterator
An iterator over alias->target pairs.
Definition: AliasMap.h:57