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 boost::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 ()

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
typedef io::InputArchive	InputArchive
typedef io::CatalogVector	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 231 of file Persistable.h.

Member Typedef Documentation

typedef io::CatalogVector lsst::afw::table::io::PersistableFactory::CatalogVector

protected

Definition at line 234 of file Persistable.h.

typedef io::InputArchive lsst::afw::table::io::PersistableFactory::InputArchive

protected

Definition at line 233 of file Persistable.h.

Constructor & Destructor Documentation

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.

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

inlinevirtual

Definition at line 262 of file Persistable.h.

{}

Member Function Documentation

static 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.

virtual boost::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::WcsFactory, lsst::afw::math::LinearCombinationKernel::Factory, lsst::afw::math::AnalyticKernel::Factory, lsst::afw::math::FixedKernel::Factory, lsst::afw::math::DeltaFunctionKernel::Factory, and lsst::meas::algorithms::KernelPsfFactory< T, K >.

---

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

• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/table/io/Persistable.h