LSSTApplications  19.0.0-10-g920eed2,19.0.0-11-g48a0200+2,19.0.0-18-gfc4e62b+17,19.0.0-2-g3b2f90d+2,19.0.0-2-gd671419+5,19.0.0-20-g5a5a17ab+15,19.0.0-21-g2644856+18,19.0.0-23-g84eeccb+6,19.0.0-24-g878c510+5,19.0.0-25-g6c8df7140,19.0.0-25-gb330496+5,19.0.0-3-g2b32d65+5,19.0.0-3-g8227491+16,19.0.0-3-g9c54d0d+16,19.0.0-3-gca68e65+12,19.0.0-3-gcfc5f51+5,19.0.0-3-ge110943+15,19.0.0-3-ge74d124,19.0.0-3-gfe04aa6+16,19.0.0-30-g9c3fd16+6,19.0.0-4-g06f5963+5,19.0.0-4-g3d16501+18,19.0.0-4-g4a9c019+5,19.0.0-4-g5a8b323,19.0.0-4-g66397f0+1,19.0.0-4-g8278b9b+1,19.0.0-4-g8557e14,19.0.0-4-g8964aba+17,19.0.0-4-ge404a01+16,19.0.0-5-g40f3a5a,19.0.0-5-g4db63b3,19.0.0-5-gfb03ce7+17,19.0.0-6-gbaebbfb+16,19.0.0-61-gec4c6e08+6,19.0.0-7-g039c0b5+16,19.0.0-7-gbea9075+4,19.0.0-7-gc567de5+17,19.0.0-70-g334bf3e+1,19.0.0-9-g463f923+16,b.20.0.x-g5487ab2134,v20.0.0.rc1
LSSTDataManagementBasePackage
python.h
Go to the documentation of this file.
1 /*
2  * This file is part of afw.
3  *
4  * Developed for the LSST Data Management System.
5  * This product includes software developed by the LSST Project
6  * (https://www.lsst.org).
7  * See the COPYRIGHT file at the top-level directory of this distribution
8  * for details of code ownership.
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program. If not, see <https://www.gnu.org/licenses/>.
22  */
23 
24 #ifndef LSST_AFW_TYPEHANDLING_PYTHON_H
25 #define LSST_AFW_TYPEHANDLING_PYTHON_H
26 
27 #include "pybind11/pybind11.h"
28 
29 #include <string>
30 
32 
33 namespace lsst {
34 namespace afw {
35 namespace typehandling {
36 
49 template <class Base = Storable>
50 class StorableHelper : public Base {
51 public:
52  using Base::Base;
53 
55  /* __deepcopy__ takes an optional dict, but PYBIND11_OVERLOAD_* won't
56  * compile unless you give it arguments that work for the C++ method
57  */
58  PYBIND11_OVERLOAD_NAME(std::shared_ptr<Storable>, Base, "__deepcopy__", cloneStorable, );
59  }
60 
61  std::string toString() const override {
62  PYBIND11_OVERLOAD_NAME(std::string, Base, "__repr__", toString, );
63  }
64 
65  std::size_t hash_value() const override {
66  PYBIND11_OVERLOAD_NAME(std::size_t, Base, "__hash__", hash_value, );
67  }
68 
69  bool equals(Storable const& other) const noexcept override {
70  PYBIND11_OVERLOAD_NAME(bool, Base, "__eq__", equals, other);
71  }
72 };
73 
74 std::string declareGenericMapRestrictions(std::string const& className, std::string const& keyName);
75 
76 } // namespace typehandling
77 } // namespace afw
78 } // namespace lsst
79 
80 #endif
lsst::afw::typehandling::declareGenericMapRestrictions
std::string declareGenericMapRestrictions(std::string const &className, std::string const &keyName)
Definition: python.cc:32
std::string
STL class.
std::shared_ptr
STL class.
lsst::afw::typehandling::StorableHelper::equals
bool equals(Storable const &other) const noexcept override
Compare this object to another Storable.
Definition: python.h:69
lsst::afw::typehandling::StorableHelper::hash_value
std::size_t hash_value() const override
Return a hash of this object (optional operation).
Definition: python.h:65
lsst::afw
Definition: imageAlgorithm.dox:1
lsst::afw::typehandling::Storable
Interface supporting iteration over heterogenous containers.
Definition: Storable.h:58
lsst::afw::typehandling::StorableHelper::toString
std::string toString() const override
Create a string representation of this object (optional operation).
Definition: python.h:61
lsst::afw::typehandling::StorableHelper::cloneStorable
std::shared_ptr< Storable > cloneStorable() const override
Create a new object that is a copy of this one (optional operation).
Definition: python.h:54
other
ItemVariant const * other
Definition: Schema.cc:56
Storable.h
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
std::size_t
lsst::afw::typehandling::StorableHelper
"Trampoline" for Storable to let it be used as a base class in Python.
Definition: python.h:50