Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04dff08e69+42feea4ef2,g0fba68d861+a0b9de4ea6,g1ec0fe41b4+f536777771,g1fd858c14a+42269675ea,g35bb328faa+fcb1d3bbc8,g4af146b050+bbef1ba6f0,g4d2262a081+8f21adb3a6,g53246c7159+fcb1d3bbc8,g5a012ec0e7+b20b785ecb,g60b5630c4e+43e3f0d37c,g6273192d42+e9a7147bac,g67b6fd64d1+4086c0989b,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g7bbe65ff3e+43e3f0d37c,g8352419a5c+fcb1d3bbc8,g87b7deb4dc+43704db330,g8852436030+eb2388797a,g89139ef638+4086c0989b,g9125e01d80+fcb1d3bbc8,g94187f82dc+43e3f0d37c,g989de1cb63+4086c0989b,g9d31334357+43e3f0d37c,g9f33ca652e+9b312035f9,gabe3b4be73+1e0a283bba,gabf8522325+fa80ff7197,gb1101e3267+61f2793e68,gb58c049af0+f03b321e39,gb89ab40317+4086c0989b,gc0bb628dac+834c1753f9,gcf25f946ba+eb2388797a,gd6cbbdb0b4+af3c3595f5,gde0f65d7ad+9e0145b227,ge278dab8ac+d65b3c2b70,ge410e46f29+4086c0989b,gf23fb2af72+37a5db1cfd,gf67bdafdda+4086c0989b,v29.0.0.rc7
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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