lsst::afw::table::io::OutputArchive Class Reference

A multi-catalog archive object used to save table::io::Persistable objects. More...

#include <OutputArchive.h>

Classes
class	Impl

Public Member Functions
	OutputArchive ()
	Construct an empty OutputArchive containing no objects.
	OutputArchive (OutputArchive const &other)
	Copy-construct an OutputArchive. Saved objects are not deep-copied.
	OutputArchive (OutputArchive &&other)
OutputArchive &	operator= (OutputArchive const &other)
	Assign from another OutputArchive. Saved objects are not deep-copied.
OutputArchive &	operator= (OutputArchive &&other)
	~OutputArchive ()
BaseCatalog const &	getIndexCatalog () const
	Return the index catalog that specifies where objects are stored in the data catalogs.
BaseCatalog const &	getCatalog (int n) const
	Return the nth catalog. Catalog 0 is always the index catalog.
std::size_t	countCatalogs () const
	Return the total number of catalogs, including the index.
void	writeFits (fits::Fits &fitsfile) const
	Write the archive to an already-open FITS object.
int	put (std::shared_ptr< Persistable const > obj, bool permissive=false)
	Save an object to the archive and return a unique ID that can be used to retrieve it from an InputArchive.
int	put (Persistable const *obj, bool permissive=false)
	Save an object to the archive and return a unique ID that can be used to retrieve it from an InputArchive.
int	put (Persistable const &obj, bool permissive=false)
	Save an object to the archive and return a unique ID that can be used to retrieve it from an InputArchive.

Friends
class	OutputArchiveHandle

Detailed Description

A multi-catalog archive object used to save table::io::Persistable objects.

OutputArchive should generally be used directly only by objects that do not themselves inherit from Persistable, but contain many objects that do (such as Exposure). It provides an interface for adding objects to the archive (put()), transforming them into catalogs that can be retrieved directly or written to a FITS file. The first catalog is an index that indicates which rows of the subsequent catalogs correspond to each object.

See getIndexCatalog() for a more detailed description of the index.

Definition at line 34 of file OutputArchive.h.

Constructor & Destructor Documentation

OutputArchive() [1/3]

lsst::afw::table::io::OutputArchive::OutputArchive

(

)

Construct an empty OutputArchive containing no objects.

Definition at line 160 of file OutputArchive.cc.

: _impl(new Impl()) {}

OutputArchive() [2/3]

lsst::afw::table::io::OutputArchive::OutputArchive ( OutputArchive const & other )

default

Copy-construct an OutputArchive. Saved objects are not deep-copied.

OutputArchive() [3/3]

lsst::afw::table::io::OutputArchive::OutputArchive

(

OutputArchive &&

other

)

Definition at line 164 of file OutputArchive.cc.

: OutputArchive(other) {}

~OutputArchive()

lsst::afw::table::io::OutputArchive::~OutputArchive ( )

default

Member Function Documentation

countCatalogs()

std::size_t lsst::afw::table::io::OutputArchive::countCatalogs

(

)

const

Return the total number of catalogs, including the index.

Definition at line 201 of file OutputArchive.cc.

{ return _impl->_catalogs.size() + 1; }

getCatalog()

BaseCatalog const & lsst::afw::table::io::OutputArchive::getCatalog

(

int

n

)

const

Return the nth catalog. Catalog 0 is always the index catalog.

Definition at line 190 of file OutputArchive.cc.

                                                        {
    if (n == 0) return _impl->_index;
    if (std::size_t(n) > _impl->_catalogs.size() || n < 0) {
        throw LSST_EXCEPT(
                pex::exceptions::LengthError,
                (boost::format("Catalog number %d is out of range [0,%d]") % n % _impl->_catalogs.size())
                        .str());
    }
    return _impl->_catalogs[n - 1];
}

getIndexCatalog()

BaseCatalog const & lsst::afw::table::io::OutputArchive::getIndexCatalog

(

)

const

Return the index catalog that specifies where objects are stored in the data catalogs.

Definition at line 188 of file OutputArchive.cc.

{ return _impl->_index; }

operator=() [1/2]

OutputArchive & lsst::afw::table::io::OutputArchive::operator=

(

OutputArchive &&

other

)

Definition at line 168 of file OutputArchive.cc.

{ return *this = other; }

operator=() [2/2]

OutputArchive & lsst::afw::table::io::OutputArchive::operator= ( OutputArchive const & other )

default

Assign from another OutputArchive. Saved objects are not deep-copied.

put() [1/3]

int lsst::afw::table::io::OutputArchive::put ( Persistable const & obj, bool permissive = false )

inline

Save an object to the archive and return a unique ID that can be used to retrieve it from an InputArchive.

If permissive is true and obj->isPersistable() is false, the object will not be saved but 0 will be returned instead of throwing an exception.

If the given pointer is null, the returned ID is always 0, which may be used to retrieve null pointers from an InputArchive.

It is expected that the shared_ptr form will usually be used, as Persistables are typically held by shared_ptr. We also provide a const reference overload for temporaries as well as a const raw pointer overload for temporaries that may be null.

If the shared_ptr form is used and the given pointer has already been saved, it will not be written again and the same ID will be returned as the first time it was saved.

Exception Safety

Provides no exception safety for the archive itself - if the object being saved (or any nested object) throws an exception, the archive may be in an inconsistent state and should not be saved. The objects being saved are never modified during persistence, even when exceptions are thrown.

Definition at line 82 of file OutputArchive.h.

{ return put(&obj, permissive); }

put() [2/3]

int lsst::afw::table::io::OutputArchive::put	(	Persistable const *	obj,
		bool	permissive = false )

Save an object to the archive and return a unique ID that can be used to retrieve it from an InputArchive.

If permissive is true and obj->isPersistable() is false, the object will not be saved but 0 will be returned instead of throwing an exception.

If the given pointer is null, the returned ID is always 0, which may be used to retrieve null pointers from an InputArchive.

It is expected that the shared_ptr form will usually be used, as Persistables are typically held by shared_ptr. We also provide a const reference overload for temporaries as well as a const raw pointer overload for temporaries that may be null.

If the shared_ptr form is used and the given pointer has already been saved, it will not be written again and the same ID will be returned as the first time it was saved.

Exception Safety

Provides no exception safety for the archive itself - if the object being saved (or any nested object) throws an exception, the archive may be in an inconsistent state and should not be saved. The objects being saved are never modified during persistence, even when exceptions are thrown.

Definition at line 172 of file OutputArchive.cc.

                                                              {
    if (!_impl.unique()) {  // copy on write
        std::shared_ptr<Impl> tmp(new Impl(*_impl));
        _impl.swap(tmp);
    }
    return _impl->put(obj, _impl, permissive);
}

put() [3/3]

int lsst::afw::table::io::OutputArchive::put	(	std::shared_ptr< Persistable const >	obj,
		bool	permissive = false )

Save an object to the archive and return a unique ID that can be used to retrieve it from an InputArchive.

If permissive is true and obj->isPersistable() is false, the object will not be saved but 0 will be returned instead of throwing an exception.

If the given pointer is null, the returned ID is always 0, which may be used to retrieve null pointers from an InputArchive.

It is expected that the shared_ptr form will usually be used, as Persistables are typically held by shared_ptr. We also provide a const reference overload for temporaries as well as a const raw pointer overload for temporaries that may be null.

If the shared_ptr form is used and the given pointer has already been saved, it will not be written again and the same ID will be returned as the first time it was saved.

Exception Safety

Provides no exception safety for the archive itself - if the object being saved (or any nested object) throws an exception, the archive may be in an inconsistent state and should not be saved. The objects being saved are never modified during persistence, even when exceptions are thrown.

Definition at line 180 of file OutputArchive.cc.

                                                                            {
    if (!_impl.unique()) {  // copy on write
        std::shared_ptr<Impl> tmp(new Impl(*_impl));
        _impl.swap(tmp);
    }
    return _impl->put(std::move(obj), _impl, permissive);
}

writeFits()

void lsst::afw::table::io::OutputArchive::writeFits

(

fits::Fits &

fitsfile

)

const

Write the archive to an already-open FITS object.

Always appends new HDUs.

Parameters

[in]

fitsfile

Open FITS object to write to.

Definition at line 203 of file OutputArchive.cc.

{ _impl->writeFits(fitsfile); }

Friends And Related Symbol Documentation

OutputArchiveHandle

friend class OutputArchiveHandle

friend

Definition at line 36 of file OutputArchive.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/include/lsst/afw/table/io/OutputArchive.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/src/table/io/OutputArchive.cc