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
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
virtual std::size_t hash_value() const
Return a hash of this object (optional operation).
Definition Storable.cc:44
virtual bool equals(Storable const &other) const noexcept
Compare this object to another Storable.
Definition Storable.cc:48
std::ostream & operator<<(std::ostream &os, Storable const &storable)
Output operator for Storable.
Definition Storable.h:174
static bool singleClassEquals(T const &lhs, Storable const &rhs)
Test if a Storable is of a particular class and equal to another object.
Definition Storable.h:151
virtual std::shared_ptr< Storable > cloneStorable() const
Create a new object that is a copy of this one (optional operation).
Definition Storable.cc:36
Exception thrown by Storable operations for unimplemented operations.
Definition Storable.h:46
STL namespace.
lsst::afw::typehandling::Storable argument_type
Definition Storable.h:190
size_t operator()(argument_type const &obj) const
Definition Storable.h:192