"Trampoline" for Storable to let it be used as a base class in Python. More...
#include <python.h>
Public Member Functions | |
| template<typename... Args> | |
| StorableHelper (Args... args) | |
| Delegating constructor for wrapped class. | |
| std::shared_ptr< Storable > | cloneStorable () const override |
| Create a new object that is a copy of this one (optional operation). | |
| std::string | toString () const override |
| Create a string representation of this object (optional operation). | |
| std::size_t | hash_value () const override |
| Return a hash of this object (optional operation). | |
| bool | equals (Storable const &other) const noexcept override |
| bool | isPersistable () const noexcept override |
| Return true if this particular object can be persisted using afw::table::io. | |
| std::string | getPersistenceName () const override |
| Return the unique name used to persist this object and look up its factory. | |
| std::string | getPythonModule () const override |
| Return the fully-qualified Python module that should be imported to guarantee that its factory is registered. | |
| void | write (table::io::OutputArchiveHandle &handle) const override |
| Write the object to one or more catalogs. | |
Detailed Description
class 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
Constructor & Destructor Documentation
◆ StorableHelper()
|
inlineexplicit |
Delegating constructor for wrapped class.
While we would like to simply inherit base class constructors, when doing so, we cannot change their access specifiers. One consequence is that it's not possible to use inheritance to expose a protected constructor to python. The alternative, used here, is to create a new public constructor that delegates to the base class public or protected constructor with the same signature.
- Template Parameters
-
Args Variadic type specification
- Parameters
-
...args Arguments to forward to the Base class constructor.
Member Function Documentation
◆ cloneStorable()
|
inlineoverridevirtual |
Create a new object that is a copy of this one (optional operation).
This operation is required for Storables that are stored in GenericMap by value, but not for those stored by shared pointer.
- Exceptions
-
UnsupportedOperationException Thrown if this object is not cloneable.
- Note
- If this class supports a
cloneoperation, the two should behave identically except for the formal return type. -
When called on Python classes, this method delegates to
__deepcopy__if it exists.
Reimplemented from lsst::afw::typehandling::Storable.
◆ equals()
|
inlineoverridenoexcept |
◆ getPersistenceName()
|
inlineoverridevirtual |
Return the unique name used to persist this object and look up its factory.
Must be less than ArchiveIndexSchema::MAX_NAME_LENGTH characters.
Reimplemented from lsst::afw::table::io::Persistable.
◆ getPythonModule()
|
inlineoverridevirtual |
Return the fully-qualified Python module that should be imported to guarantee that its factory is registered.
Must be less than ArchiveIndexSchema::MAX_MODULE_LENGTH characters.
Will be ignored if empty.
Reimplemented from lsst::afw::table::io::Persistable.
◆ hash_value()
|
inlineoverridevirtual |
Return a hash of this object (optional operation).
- Exceptions
-
UnsupportedOperationException Thrown if this object is not hashable.
- Note
- C++ subclass authors are responsible for any associated specializations of std::hash.
-
When called on Python classes, this method delegates to
__hash__if it exists.
Reimplemented from lsst::afw::typehandling::Storable.
◆ isPersistable()
|
inlineoverridevirtualnoexcept |
Return true if this particular object can be persisted using afw::table::io.
Reimplemented from lsst::afw::table::io::Persistable.
◆ toString()
|
inlineoverridevirtual |
Create a string representation of this object (optional operation).
- Exceptions
-
UnsupportedOperationException Thrown if this object does not have a string representation.
- Note
- When called on Python classes, this method delegates to
__repr__.
Reimplemented from lsst::afw::typehandling::Storable.
◆ write()
|
overridevirtual |
Write the object to one or more catalogs.
The handle object passed to this function provides an interface for adding new catalogs and adding nested objects to the same archive (while checking for duplicates). See OutputArchiveHandle for more information.
Reimplemented from lsst::afw::table::io::Persistable.
The documentation for this class was generated from the following file:
- include/lsst/afw/typehandling/python.h
Generated on Sat Apr 25 2026 01:19:58 for lsst.afw by
1.13.2