lsst.afw  22.0.1-29-g184b6e44e+8b185d4e2d
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 
36 namespace lsst {
37 namespace afw {
38 namespace typehandling {
39 
45 LSST_EXCEPTION_TYPE(UnsupportedOperationException, pex::exceptions::RuntimeError,
47 
48 
58 class Storable : public table::io::Persistable {
59 public:
60  virtual ~Storable() noexcept = 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 
124 protected:
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 
174 inline 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 
182 namespace std {
188 template <>
189 struct 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)
std::ostream * os
Definition: Schema.cc:558
Interface supporting iteration over heterogenous containers.
Definition: Storable.h:58
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 ~Storable() noexcept=0
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
std::size_t hash_value() const noexcept
Return a hash of this object.
A base class for image defects.
STL namespace.
size_t operator()(argument_type const &obj) const
Definition: Storable.h:192