lsst::afw::table::io::PersistableFactory Class Reference

A base class for factory classes used to reconstruct objects from records. More...

#include <Persistable.h>

Inheritance diagram for lsst::afw::table::io::PersistableFactory:

Public Member Functions
	PersistableFactory (std::string const &name)
	Constructor for the factory. More...
virtual std::shared_ptr< Persistable >	read (InputArchive const &archive, CatalogVector const &catalogs) const =0
	Construct a new object from the given InputArchive and vector of catalogs. More...
virtual	~PersistableFactory () noexcept=default
	PersistableFactory (const PersistableFactory &)=delete
PersistableFactory &	operator= (const PersistableFactory &)=delete
	PersistableFactory (PersistableFactory &&)=delete
PersistableFactory &	operator= (PersistableFactory &&)=delete

Static Public Member Functions
static PersistableFactory const &	lookup (std::string const &name, std::string const &module="")
	Return the factory that has been registered with the given name. More...

Protected Types
using	InputArchive = io::InputArchive
using	CatalogVector = io::CatalogVector

Detailed Description

A base class for factory classes used to reconstruct objects from records.

Classes that inherit from Persistable should also subclass PersistableFactory, and instantiate exactly one instance of the derived factory with static duration (usually the class and instance are both defined in an anonymous namespace in a source file).

Definition at line 228 of file Persistable.h.

Member Typedef Documentation

CatalogVector

using lsst::afw::table::io::PersistableFactory::CatalogVector = io::CatalogVector

protected

Definition at line 231 of file Persistable.h.

InputArchive

using lsst::afw::table::io::PersistableFactory::InputArchive = io::InputArchive

protected

Definition at line 230 of file Persistable.h.

Constructor & Destructor Documentation

PersistableFactory() [1/3]

lsst::afw::table::io::PersistableFactory::PersistableFactory ( std::string const &  name )

explicit

Constructor for the factory.

This should be called only once, and only on an object with static duration, as a pointer to the object will be put in a singleton registry.

The name must be globally unique with respect to all Persistables and be the same as Persistable::getPersistenceName(); the Python module that a Persistable may also declare is not used to resolve names, but rather just to import the module that may install the necessary factory in the registry.

Definition at line 74 of file Persistable.cc.

{ getRegistry()[name] = this; }

~PersistableFactory()

virtual lsst::afw::table::io::PersistableFactory::~PersistableFactory ( )

virtualdefaultnoexcept

PersistableFactory() [2/3]

lsst::afw::table::io::PersistableFactory::PersistableFactory ( const PersistableFactory &  )

delete

PersistableFactory() [3/3]

lsst::afw::table::io::PersistableFactory::PersistableFactory ( PersistableFactory &&  )

delete

Member Function Documentation

lookup()

PersistableFactory const & lsst::afw::table::io::PersistableFactory::lookup ( std::string const &  name, std::string const &  module = ""  )

static

Return the factory that has been registered with the given name.

If the lookup fails and module is not an empty string, we will attempt to import a Python module with that name (this will only work when the C++ is being called from Python) and try again.

Definition at line 76 of file Persistable.cc.

                                                                                                   {
    RegistryMap::const_iterator i = getRegistry().find(name);
    if (i == getRegistry().end()) {
        if (!module.empty()) {
            bool success = base::ModuleImporter::import(module);
            if (!success) {
                throw LSST_EXCEPT(
                        pex::exceptions::NotFoundError,
                        (boost::format(
                                 "PersistableFactory with name '%s' not found, and import of module "
                                 "'%s' failed (possibly because Python calls were not available from C++).") %
                         name % module)
                                .str());
            }
            i = getRegistry().find(name);
            if (i == getRegistry().end()) {
                throw LSST_EXCEPT(
                        pex::exceptions::LogicError,
                        (boost::format(
                                 "PersistableFactory with name '%s' not found even after successful import "
                                 "of module '%s'.  Please report this as a bug in the persistence "
                                 "implementation for this object.") %
                         name % module)
                                .str());
            }
        } else {
            throw LSST_EXCEPT(
                    pex::exceptions::LogicError,
                    (boost::format(
                             "PersistableFactory with name '%s' not found, and no Python module to import "
                             "was provided.  Please report this as a bug in the persistence implementation "
                             "for this object.") %
                     name)
                            .str());
        }
    }
    return *i->second;
}

operator=() [1/2]

PersistableFactory& lsst::afw::table::io::PersistableFactory::operator= ( const PersistableFactory &  )

delete

operator=() [2/2]

PersistableFactory& lsst::afw::table::io::PersistableFactory::operator= ( PersistableFactory &&  )

delete

read()

virtual std::shared_ptr<Persistable> lsst::afw::table::io::PersistableFactory::read ( InputArchive const &  archive, CatalogVector const &  catalogs  ) const

pure virtual

Construct a new object from the given InputArchive and vector of catalogs.

Implemented in lsst::afw::image::FilterLabel::Factory, lsst::afw::math::LinearCombinationKernel::Factory, lsst::afw::math::FixedKernel::Factory, lsst::afw::math::DeltaFunctionKernel::Factory, lsst::afw::math::AnalyticKernel::Factory, lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::Factory, lsst::afw::cameraGeom::TransformMap::Factory, lsst::afw::cameraGeom::DetectorCollection::Factory, lsst::afw::cameraGeom::Detector::Factory, lsst::afw::cameraGeom::Camera::Factory, lsst::meas::algorithms::CoaddPsf::Factory, lsst::meas::algorithms::CoaddBoundedField::Factory, lsst::afw::detection::FootprintFactory, and lsst::meas::algorithms::KernelPsfFactory< T, K >.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/include/lsst/afw/table/io/Persistable.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/src/table/io/Persistable.cc