"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
template<typename... Args>
	StorableHelper (Args... args)
	Delegating constructor for wrapped class. More...

std::shared_ptr< Storable >	cloneStorable () const override
	Create a new object that is a copy of this one (optional operation). More...

std::string	toString () const override
	Create a string representation of this object (optional operation). More...

std::size_t	hash_value () const override
	Return a hash of this object (optional operation). More...

bool	equals (Storable const &other) const noexcept override
	Compare this object to another Storable. More...

bool	isPersistable () const noexcept override
	Return true if this particular object can be persisted using afw::table::io. More...

std::string	getPersistenceName () const override
	Return the unique name used to persist this object and look up its factory. More...

std::string	getPythonModule () const override
	Return the fully-qualified Python module that should be imported to guarantee that its factory is registered. More...

void	write (table::io::OutputArchiveHandle &handle) const override
	Write the object to one or more catalogs. More...

void	writeFits (std::string const &fileName, std::string const &mode="w") const
	Write the object to a regular FITS file. More...

void	writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
	Write the object to a FITS image in memory. More...

void	writeFits (fits::Fits &fitsfile) const
	Write the object to an already-open FITS object. More...

Protected Types
using	OutputArchiveHandle = io::OutputArchiveHandle

Static Protected Member Functions
template<class T >
static bool	singleClassEquals (T const &lhs, Storable const &rhs)
	Test if a Storable is of a particular class and equal to another object. More...

Related Functions
(Note that these are not member functions.)
std::ostream &	operator<< (std::ostream &os, Storable const &storable)
	Output operator for Storable. More...

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 54 of file python.h.

Member Typedef Documentation

◆ OutputArchiveHandle

using lsst::afw::table::io::Persistable::OutputArchiveHandle = io::OutputArchiveHandle

protectedinherited

Definition at line 108 of file Persistable.h.

Constructor & Destructor Documentation

◆ StorableHelper()

template<class Base = Storable>

template<typename... Args>

lsst::afw::typehandling::StorableHelper< Base >::StorableHelper ( Args... args )

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.

Definition at line 193 of file python.h.

71 : Base(args...) {}

lsst::meas::algorithms.psfSelectionFromMatchList.args

list args

Definition: psfSelectionFromMatchList.py:29

Member Function Documentation

◆ cloneStorable()

template<class Base = Storable>

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

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 clone operation, 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.

Definition at line 73 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

inlineoverridevirtualnoexcept

Compare this object to another Storable.

Subclasses that implement equality comparison must override this method to give results consistent with operator== for all inputs that are accepted by both.

Returns: This implementation returns whether the two objects are the same.

Warning: This method compares an object to any type of Storable, although cross-class comparisons should usually return false. If cross-class comparisons are valid, implementers should take care that they are symmetric and will give the same result no matter what the compile-time types of the left- and right-hand sides are.

See also: singleClassEquals

Note: When called on Python classes, this method delegates to __eq__ if it exists.

Reimplemented from lsst::afw::typehandling::Storable.

Definition at line 88 of file python.h.

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

◆ getPersistenceName()

template<class Base = Storable>

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

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.

Definition at line 98 of file python.h.

                                                   {
         PYBIND11_OVERLOAD_NAME(
             std::string, Base, "_getPersistenceName", getPersistenceName
         );
     }

◆ getPythonModule()

template<class Base = Storable>

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

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.

Definition at line 104 of file python.h.

                                                {
         PYBIND11_OVERLOAD_NAME(
             std::string, Base, "_getPythonModule", getPythonModule
         );
     }

◆ hash_value()

template<class Base = Storable>

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

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.

Definition at line 84 of file python.h.

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

◆ isPersistable()

template<class Base = Storable>

bool lsst::afw::typehandling::StorableHelper< Base >::isPersistable ( ) const

inlineoverridevirtualnoexcept

Return true if this particular object can be persisted using afw::table::io.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 92 of file python.h.

                                                  {
         PYBIND11_OVERLOAD(
             bool, Base, isPersistable
         );
     }

◆ singleClassEquals()

template<class T >

static bool lsst::afw::typehandling::Storable::singleClassEquals	(	T const &	lhs,
		Storable const &	rhs
	)

inlinestaticprotectedinherited

Test if a Storable is of a particular class and equal to another object.

This method template simplifies implementations of equals that delegate to operator== without supporting cross-class comparisons.

Template Parameters

T	The class expected of the two objects to be compared.

Parameters

lhs,rhs The objects to compare. Note that rhs need not be a T, while lhs must be.

Returns: true if rhs is a T and lhs == rhs; false otherwise.

Exception Safety: Provides the same level of exception safety as operator==. Most implementations of operator== do not throw.

Note: This method template calls operator== with both arguments of compile-time type T const&. Its use is not recommended if there would be any ambiguity as to which operator== gets picked by overload resolution.

This method template is typically called from equals as:

bool MyType::equals(Storable const& other) const noexcept {
    return singleClassEquals(*this, other);
}

Definition at line 151 of file Storable.h.

                                                                      {
         auto typedRhs = dynamic_cast<T const*>(&rhs);
         if (typedRhs != nullptr) {
             return lhs == *typedRhs;
         } else {
             return false;
         }
     }

◆ toString()

template<class Base = Storable>

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

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.

Definition at line 80 of file python.h.

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

◆ write()

template<typename Base >

void StorableHelper::write ( table::io::OutputArchiveHandle & handle ) const

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.

Definition at line 193 of file python.h.

                                                                          {
     pybind11::gil_scoped_acquire gil;
     pybind11::function overload = pybind11::get_overload(static_cast<const Base *>(this), "_write");
     if (!overload)
         throw std::runtime_error("Cannot find StorableHelper _write overload");
     auto o = overload().cast<std::string>();
     auto const &keys = StorableHelperPersistenceHelper::get();
     table::BaseCatalog cat = handle.makeCatalog(keys.schema);
     std::shared_ptr<table::BaseRecord> record = cat.addNew();
     record->set(keys.bytes, formatters::stringToBytes(o));
     handle.saveCatalog(cat);
 }

◆ writeFits() [1/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::Fits & fitsfile ) const

inherited

Write the object to an already-open FITS object.

Parameters

[in] fitsfile Open FITS object to write to.

Definition at line 18 of file Persistable.cc.

                                                     {
     OutputArchive archive;
     archive.put(this);
     archive.writeFits(fitsfile);
 }

◆ writeFits() [2/3]

void lsst::afw::table::io::Persistable::writeFits	(	fits::MemFileManager &	manager,
		std::string const &	mode = `"w"`
	)		const

inherited

Write the object to a FITS image in memory.

Parameters

[in]	manager	Name of the file to write to.
[in]	mode	If "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 29 of file Persistable.cc.

                                                                                     {
     fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
     writeFits(fitsfile);
 }

◆ writeFits() [3/3]

void lsst::afw::table::io::Persistable::writeFits	(	std::string const &	fileName,
		std::string const &	mode = `"w"`
	)		const

inherited

Write the object to a regular FITS file.

Parameters

[in]	fileName	Name of the file to write to.
[in]	mode	If "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 24 of file Persistable.cc.

                                                                                   {
     fits::Fits fitsfile(fileName, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
     writeFits(fitsfile);
 }

Friends And Related Function Documentation

◆ operator<<()

std::ostream & operator<<	(	std::ostream &	os,
		Storable const &	storable
	)

Parameters

os	the desired output stream
storable	the object to print

Returns: a reference to os

Exceptions

UnsupportedOperationException Thrown if storable does not have an implementation of Storable::toString.

Definition at line 174 of file Storable.h.

                                                                         {
     return os << storable.toString();
 }

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-32-g5ddfab5d3+60ce4897b0/include/lsst/afw/typehandling/python.h

Public Member Functions

Protected Types

Static Protected Member Functions

Related Functions

Detailed Description

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

Member Typedef Documentation

◆ OutputArchiveHandle

Constructor & Destructor Documentation

◆ StorableHelper()

Member Function Documentation

◆ cloneStorable()

◆ equals()

◆ getPersistenceName()

◆ getPythonModule()

◆ hash_value()

◆ isPersistable()

◆ singleClassEquals()

◆ toString()

◆ write()

◆ writeFits() [1/3]

◆ writeFits() [2/3]

◆ writeFits() [3/3]

Friends And Related Function Documentation

◆ operator<<()

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