LSST Applications 24.1.6,g063fba187b+56b85ce14a,g0f08755f38+df8a265115,g12f32b3c4e+891a09f10d,g1524ad2192+7a5d7b3fbd,g1653933729+a8ce1bb630,g168dd56ebc+a8ce1bb630,g28da252d5a+07cb1400be,g2bbee38e9b+ae03bbfc84,g2bc492864f+ae03bbfc84,g3156d2b45e+6e55a43351,g347aa1857d+ae03bbfc84,g35bb328faa+a8ce1bb630,g3a166c0a6a+ae03bbfc84,g3e281a1b8c+c5dd892a6c,g414038480c+6b9177ef31,g41af890bb2+8f257c4c0b,g781aacb6e4+a8ce1bb630,g7af13505b9+7137b3b17d,g80478fca09+6df6903293,g82479be7b0+091ce1d07f,g858d7b2824+df8a265115,g89c8672015+f4add4ffd5,g9125e01d80+a8ce1bb630,g9726552aa6+414189b318,ga5288a1d22+4a2bca08d7,gacef1a1666+c9a8ff65f4,gb58c049af0+d64f4d3760,gbcfae0f0a0+de1d42d831,gc28159a63d+ae03bbfc84,gcf0d15dbbd+72117bf34e,gda6a2b7d83+72117bf34e,gdaeeff99f8+1711a396fd,ge500cccec5+c8c9c9af63,ge79ae78c31+ae03bbfc84,gf0baf85859+c1f95f4921,gfa517265be+df8a265115,gfa999e8aa5+17cd334064,gfb92a5be7c+df8a265115
LSST Data Management Base Package
Loading...
Searching...
No Matches
Storable.h
Go to the documentation of this file.
1// -*- LSST-C++ -*-
2/*
3 * This file is part of afw.
4 *
5 * Developed for the LSST Data Management System.
6 * This product includes software developed by the LSST Project
7 * (https://www.lsst.org).
8 * See the COPYRIGHT file at the top-level directory of this distribution
9 * for details of code ownership.
10 *
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <https://www.gnu.org/licenses/>.
23 */
24
25#ifndef LSST_AFW_TYPEHANDLING_STORABLE_H
26#define LSST_AFW_TYPEHANDLING_STORABLE_H
27
28#include <functional>
29#include <memory>
30#include <ostream>
31#include <string>
32
33#include "lsst/pex/exceptions.h"
35
36namespace lsst {
37namespace afw {
38namespace typehandling {
39
45LSST_EXCEPTION_TYPE(UnsupportedOperationException, pex::exceptions::RuntimeError,
47
48
58class Storable : public table::io::Persistable {
59public:
60 ~Storable() noexcept override = 0;
61
76 // Return shared_ptr to work around https://github.com/pybind/pybind11/issues/1138
77 virtual std::shared_ptr<Storable> cloneStorable() const;
78
87 virtual std::string toString() const;
88
100 virtual std::size_t hash_value() const;
101
122 virtual bool equals(Storable const& other) const noexcept;
123
124protected:
150 template <class T>
151 static bool singleClassEquals(T const& lhs, Storable const& rhs) {
152 auto typedRhs = dynamic_cast<T const*>(&rhs);
153 if (typedRhs != nullptr) {
154 return lhs == *typedRhs;
155 } else {
156 return false;
157 }
158 }
159};
160
174inline std::ostream& operator<<(std::ostream& os, Storable const& storable) {
175 return os << storable.toString();
176}
177
178} // namespace typehandling
179} // namespace afw
180} // namespace lsst
181
182namespace std {
188template <>
189struct hash<lsst::afw::typehandling::Storable> {
192 size_t operator()(argument_type const& obj) const { return obj.hash_value(); }
193};
194} // namespace std
195
196#endif
#define LSST_EXCEPTION_TYPE(t, b, c)
Macro used to define new types of exceptions without additional data.
Definition Exception.h:69
Interface supporting iteration over heterogenous containers.
Definition Storable.h:58
~Storable() noexcept override=0
virtual std::string toString() const
Create a string representation of this object (optional operation).
Definition Storable.cc:40
std::ostream & operator<<(std::ostream &os, Storable const &storable)
Output operator for Storable.
Definition Storable.h:174
Exception thrown by Storable operations for unimplemented operations.
Definition Storable.h:46
STL namespace.
decltype(sizeof(void *)) size_t
Definition doctest.h:524
size_t operator()(argument_type const &obj) const
Definition Storable.h:192