Public Member Functions |
Protected Types |
Static Protected Member Functions |
Related Symbols |
List of all members
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 | |
| 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 |
| Compare this object to another Storable. | |
| 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. | |
| void | writeFits (std::string const &fileName, std::string const &mode="w") const |
| Write the object to a regular FITS file. | |
| void | writeFits (fits::MemFileManager &manager, std::string const &mode="w") const |
| Write the object to a FITS image in memory. | |
| void | writeFits (fits::Fits &fitsfile) const |
| Write the object to an already-open FITS object. | |
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. | |
Related Symbols | |
(Note that these are not member symbols.) | |
| std::ostream & | operator<< (std::ostream &os, Storable const &storable) |
| Output operator for Storable. | |
Detailed Description
template<class Base = Storable>
class lsst::afw::typehandling::StorableHelper< Base >
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
Member Typedef Documentation
◆ OutputArchiveHandle
|
protectedinherited |
Definition at line 108 of file Persistable.h.
Constructor & Destructor Documentation
◆ StorableHelper()
template<class Base = Storable>
template<typename... 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.
Member Function Documentation
◆ cloneStorable()
template<class Base = Storable>
|
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.
◆ equals()
template<class Base = Storable>
|
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.
◆ getPersistenceName()
template<class Base = Storable>
|
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()
template<class Base = Storable>
|
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()
template<class Base = Storable>
|
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()
template<class Base = Storable>
|
inlineoverridevirtualnoexcept |
Return true if this particular object can be persisted using afw::table::io.
Reimplemented from lsst::afw::table::io::Persistable.
◆ singleClassEquals()
template<class T>
|
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.
◆ toString()
template<class Base = Storable>
|
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()
template<typename Base>
|
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.
◆ writeFits() [1/3]
|
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.
◆ writeFits() [2/3]
|
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.
◆ writeFits() [3/3]
|
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.
Friends And Related Symbol Documentation
◆ operator<<()
|
Output operator for 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.
The documentation for this class was generated from the following file:
- include/lsst/afw/typehandling/python.h
Generated on for lsst.afw by
1.17.0