lsst::afw::table::io::PersistableFacade< T > Class Template Reference

A CRTP facade class for subclasses of Persistable. More...

#include <Persistable.h>

Static Public Member Functions
static boost::shared_ptr< T >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object. More...
static boost::shared_ptr< T >	readFits (std::string const &fileName, int hdu=0)
	Read an object from a regular FITS file. More...
static boost::shared_ptr< T >	readFits (fits::MemFileManager &manager, int hdu=0)
	Read an object from a FITS file in memory. More...

Detailed Description

template<typename T>
class lsst::afw::table::io::PersistableFacade< T >

A CRTP facade class for subclasses of Persistable.

Derived classes should generally inherit from PersistableFacade at all levels, but only inherit from Persistable via the base class of each hierarchy. For example, with Psfs:

*  class Psf: public PersistableFacade<Psf>, public Persistable { ... };
*  class DoubleGaussianPsf: public PersistableFacade<DoubleGaussianPsf>, public Psf { ... };
*  

Inheriting from PersistableFacade is not required for any classes but the base of each hierarchy, but doing so can save users from having to do some dynamic_casts.

Note

PersistableFacade should usually be the first class in a list of base classes; if it appears after a base class that inherits from different specialization of PersistableFacade, those base class member functions will hide the desired ones.

Definition at line 182 of file Persistable.h.

Member Function Documentation

template<typename T>

static boost::shared_ptr< T > lsst::afw::table::io::PersistableFacade< T >::readFits ( fits::Fits &  fitsfile )

inlinestatic

Read an object from an already open FITS object.

Parameters

[in]

fitsfile

FITS object to read from, already positioned at the desired HDU.

Definition at line 192 of file Persistable.h.

                                                {
        return boost::dynamic_pointer_cast<T>(Persistable::_readFits(fitsfile));
    }

template<typename T>

static boost::shared_ptr< T > lsst::afw::table::io::PersistableFacade< T >::readFits ( std::string const &  fileName, int  hdu = 0  )

inlinestatic

Read an object from a regular FITS file.

Parameters

[in]	fileName	Name of the file to read.
[in]	hdu	HDU to read, where 1 is the primary. The special value of 0 skips the primary HDU if it is empty.

Definition at line 205 of file Persistable.h.

                                                                  {
        return boost::dynamic_pointer_cast<T>(Persistable::_readFits(fileName, hdu));
    }

template<typename T>

static boost::shared_ptr< T > lsst::afw::table::io::PersistableFacade< T >::readFits ( fits::MemFileManager &  manager, int  hdu = 0  )

inlinestatic

Read an object from a FITS file in memory.

Parameters

[in]	manager	Manager for the memory to read from.
[in]	hdu	HDU to read, where 1 is the primary. The special value of 0 skips the primary HDU if it is empty.

Definition at line 216 of file Persistable.h.

                                                                    {
        return boost::dynamic_pointer_cast<T>(Persistable::_readFits(manager, hdu));
    }

---

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