LSSTApplications  19.0.0-14-gb0260a2+b89439f59d,20.0.0+126303c00d,20.0.0+2f3d0e5c40,20.0.0+36ef800059,20.0.0+6ab788e194,20.0.0+a788ff1d83,20.0.0+b545961afb,20.0.0+bebc1f60e8,20.0.0+e2e26847c2,20.0.0+ec00f03e9c,20.0.0-1-g10df615+b92a01c08d,20.0.0-1-g253301a+36ef800059,20.0.0-1-g2b7511a+bebc1f60e8,20.0.0-1-g4d801e7+7c74587066,20.0.0-1-g5b95a8c+3e2d406de1,20.0.0-1-g660595b+f45b7d88f4,20.0.0-1-gc96f8cb+665e8551f1,20.0.0-1-gd1c87d7+85c46248f3,20.0.0-1-gedffbd8+ca2c461684,20.0.0-14-g1ce627f+450400e286,20.0.0-16-g111fe95+665e8551f1,20.0.0-16-g233ea98+b7ef15a6f8,20.0.0-17-ga9337b4+235318a901,20.0.0-2-g4dae9ad+665e8551f1,20.0.0-2-g7818986+85c46248f3,20.0.0-2-gec03fae+ff10c6d78d,20.0.0-25-g38d2b7ae+6870ac0cf6,20.0.0-3-g4cc78c6+63636aeed8,20.0.0-3-g6a8623c+450400e286,20.0.0-3-g750bffe+50c7740d2d,20.0.0-4-gfea843c+f45b7d88f4,20.0.0-48-gd64a390+cf2ddfd0ca,20.0.0-5-g357b56b+f45b7d88f4,20.0.0-5-gfcebe35+806271b712,20.0.0-7-gc818c6e6+7d435f9f99,20.0.0-7-gcda7bf1+1884c7ddc6,20.0.0-9-g61a2a9a3d+14f89e4eca,w.2020.39
LSSTDataManagementBasePackage
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
std::string
STL class.
std::shared_ptr
STL class.
lsst::afw::typehandling::Storable::toString
virtual std::string toString() const
Create a string representation of this object (optional operation).
Definition: Storable.cc:40
lsst::afw
Definition: imageAlgorithm.dox:1
lsst::geom::hash_value
std::size_t hash_value(Extent< T, N > const &extent) noexcept
Definition: Extent.cc:127
lsst::afw::typehandling::Storable::hash_value
virtual std::size_t hash_value() const
Return a hash of this object (optional operation).
Definition: Storable.cc:44
lsst::afw::typehandling::Storable
Interface supporting iteration over heterogenous containers.
Definition: Storable.h:58
std::ostream
STL class.
other
ItemVariant const * other
Definition: Schema.cc:56
lsst::afw::typehandling::UnsupportedOperationException
Exception thrown by Storable operations for unimplemented operations.
Definition: Storable.h:46
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
os
std::ostream * os
Definition: Schema.cc:746
exceptions.h
lsst::afw::typehandling::operator<<
std::ostream & operator<<(std::ostream &os, Key< K, V > const &key)
Output operator for Key.
Definition: Key.h:196
std
STL namespace.
std::size_t
LSST_EXCEPTION_TYPE
#define LSST_EXCEPTION_TYPE(t, b, c)
Macro used to define new types of exceptions without additional data.
Definition: Exception.h:69
std::hash< lsst::afw::typehandling::Storable >::operator()
size_t operator()(argument_type const &obj) const
Definition: Storable.h:192
lsst::afw::typehandling::Storable::singleClassEquals
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
std::hash
Persistable.h