lsst::afw::typehandling::StorableHelper< Base > Class Template Reference

"Trampoline" for Storable to let it be used as a base class in Python. More...

#include <python.h>

Inheritance diagram for lsst::afw::typehandling::StorableHelper< Base >:

Public Member Functions
std::shared_ptr< Storable >	cloneStorable () const override
std::string	toString () const override
std::size_t	hash_value () const override
bool	equals (Storable const &other) const noexcept override

Detailed Description

template<class Base = Storable>
class lsst::afw::typehandling::StorableHelper< Base >

"Trampoline" for Storable to let it be used as a base class in Python.

Subclasses of Storable that are wrapped in pybind11 should have a similar helper that subclasses StorableHelper<subclass>. This helper can be skipped if the subclass neither adds any virtual methods nor implements any abstract methods.

Template Parameters

Base	the exact (most specific) class being wrapped

See also

pybind11 documentation

Definition at line 50 of file python.h.

Member Function Documentation

cloneStorable()

template<class Base = Storable>

std::shared_ptr<Storable> lsst::afw::typehandling::StorableHelper< Base >::cloneStorable ( ) const

inlineoverride

Definition at line 54 of file python.h.

                                                           {
        /* __deepcopy__ takes an optional dict, but PYBIND11_OVERLOAD_* won't
         * compile unless you give it arguments that work for the C++ method
         */
        PYBIND11_OVERLOAD_NAME(std::shared_ptr<Storable>, Base, "__deepcopy__", cloneStorable, );
    }

equals()

template<class Base = Storable>

bool lsst::afw::typehandling::StorableHelper< Base >::equals ( Storable const &  other ) const

inlineoverridenoexcept

Definition at line 69 of file python.h.

                                                               {
        PYBIND11_OVERLOAD_NAME(bool, Base, "__eq__", equals, other);
    }

hash_value()

template<class Base = Storable>

std::size_t lsst::afw::typehandling::StorableHelper< Base >::hash_value ( ) const

inlineoverride

Definition at line 65 of file python.h.

                                          {
        PYBIND11_OVERLOAD_NAME(std::size_t, Base, "__hash__", hash_value, );
    }

toString()

template<class Base = Storable>

std::string lsst::afw::typehandling::StorableHelper< Base >::toString ( ) const

inlineoverride

Definition at line 61 of file python.h.

                                        {
        PYBIND11_OVERLOAD_NAME(std::string, Base, "__repr__", toString, );
    }

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/Linux64/afw/19.0.0-4-ga671dab3b+1/include/lsst/afw/typehandling/python.h