LSST Applications  21.0.0+3c14b91618,21.0.0+9f51b1e3f7,21.0.0-1-ga51b5d4+6691386486,21.0.0-10-g2408eff+1a328412bf,21.0.0-10-g560fb7b+52fd22d7b4,21.0.0-10-g8d1d15d+2f9043cae0,21.0.0-10-gcf60f90+d15de71c48,21.0.0-11-g25eff31+d43066e4ef,21.0.0-15-g490e301a+a676f0d5cf,21.0.0-2-g103fe59+4758c8ef83,21.0.0-2-g1367e85+a9f57e981a,21.0.0-2-g45278ab+9f51b1e3f7,21.0.0-2-g5242d73+a9f57e981a,21.0.0-2-g7f82c8f+1bcc828e4f,21.0.0-2-g8f08a60+e6fd6d9ff9,21.0.0-2-ga326454+1bcc828e4f,21.0.0-2-gde069b7+66c51b65da,21.0.0-2-gecfae73+251b9830c3,21.0.0-2-gfc62afb+a9f57e981a,21.0.0-20-g09baf175d+e1e7d1c708,21.0.0-3-g357aad2+854c3902c3,21.0.0-3-g4be5c26+a9f57e981a,21.0.0-3-g65f322c+feaa1990e9,21.0.0-3-g7d9da8d+3c14b91618,21.0.0-3-ge02ed75+bda8df9b93,21.0.0-4-g591bb35+bda8df9b93,21.0.0-4-g65b4814+52fd22d7b4,21.0.0-4-g88306b8+656365ce3f,21.0.0-4-gccdca77+86bf7a300d,21.0.0-4-ge8a399c+b99e86088e,21.0.0-5-gd00fb1e+6a0dc09319,21.0.0-51-gd3b42663+bf9f0d1c8b,21.0.0-6-g2d4f3f3+9f51b1e3f7,21.0.0-7-g04766d7+ee2ae02087,21.0.0-7-g98eecf7+3609eddee2,21.0.0-7-gde99fe0+bda8df9b93,21.0.0-8-gd70ce6f+79e45e76e4,master-gac4afde19b+bda8df9b93,w.2021.10
LSST Data Management Base Package
Public Member Functions | Friends | List of all members
lsst::afw::table::io::OutputArchiveHandle Class Referencefinal

An object passed to Persistable::write to allow it to persist itself. More...

#include <OutputArchive.h>

Public Member Functions

BaseCatalog makeCatalog (Schema const &schema)
 Return a new, empty catalog with the given schema. More...
 
void saveEmpty ()
 Indicate that the object being persisted has no state, and hence will never call makeCatalog() or saveCatalog(). More...
 
void saveCatalog (BaseCatalog const &catalog)
 Save a catalog in the archive. More...
 
 ~OutputArchiveHandle ()
 
 OutputArchiveHandle (const OutputArchiveHandle &)=delete
 
OutputArchiveHandleoperator= (const OutputArchiveHandle &)=delete
 
 OutputArchiveHandle (OutputArchiveHandle &&)=delete
 
OutputArchiveHandleoperator= (OutputArchiveHandle &&)=delete
 
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. More...
 
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. More...
 
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. More...
 

Friends

class OutputArchive::Impl
 

Detailed Description

An object passed to Persistable::write to allow it to persist itself.

OutputArchiveHandle provides an interface to add additional catalogs and save nested Persistables to the same archive.

Definition at line 118 of file OutputArchive.h.

Constructor & Destructor Documentation

◆ ~OutputArchiveHandle()

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

Definition at line 232 of file OutputArchive.cc.

232 {}

◆ OutputArchiveHandle() [1/2]

lsst::afw::table::io::OutputArchiveHandle::OutputArchiveHandle ( const OutputArchiveHandle )
delete

◆ OutputArchiveHandle() [2/2]

lsst::afw::table::io::OutputArchiveHandle::OutputArchiveHandle ( OutputArchiveHandle &&  )
delete

Member Function Documentation

◆ makeCatalog()

BaseCatalog lsst::afw::table::io::OutputArchiveHandle::makeCatalog ( Schema const &  schema)

Return a new, empty catalog with the given schema.

All catalogs passed to saveCatalog should be originally created by makeCatalog, or at least share the same table.

Definition at line 207 of file OutputArchive.cc.

207 { return _impl->makeCatalog(schema); }
table::Schema schema
Definition: python.h:134

◆ operator=() [1/2]

OutputArchiveHandle& lsst::afw::table::io::OutputArchiveHandle::operator= ( const OutputArchiveHandle )
delete

◆ operator=() [2/2]

OutputArchiveHandle& lsst::afw::table::io::OutputArchiveHandle::operator= ( OutputArchiveHandle &&  )
delete

◆ put() [1/3]

int lsst::afw::table::io::OutputArchiveHandle::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 146 of file OutputArchive.h.

146 { return put(&obj, permissive); }
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 InputArc...

◆ put() [2/3]

int lsst::afw::table::io::OutputArchiveHandle::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 216 of file OutputArchive.cc.

216  {
217  // Handle doesn't worry about copy-on-write, because Handles should only exist
218  // while an OutputArchive::put() call is active.
219  return _impl->put(obj, _impl, permissive);
220 }

◆ put() [3/3]

int lsst::afw::table::io::OutputArchiveHandle::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 222 of file OutputArchive.cc.

222  {
223  // Handle doesn't worry about copy-on-write, because Handles should only exist
224  // while an OutputArchive::put() call is active.
225  return _impl->put(std::move(obj), _impl, permissive);
226 }
T move(T... args)

◆ saveCatalog()

void lsst::afw::table::io::OutputArchiveHandle::saveCatalog ( BaseCatalog const &  catalog)

Save a catalog in the archive.

The catalog must have been created using makeCatalog, or be a shallow copy or subset of such a catalog.

Definition at line 211 of file OutputArchive.cc.

211  {
212  _impl->saveCatalog(catalog, _id, _name, _module, _catPersistable);
213  ++_catPersistable;
214 }

◆ saveEmpty()

void lsst::afw::table::io::OutputArchiveHandle::saveEmpty ( )

Indicate that the object being persisted has no state, and hence will never call makeCatalog() or saveCatalog().

Definition at line 209 of file OutputArchive.cc.

209 { _impl->saveEmpty(_id, _name, _module); }

Friends And Related Function Documentation

◆ OutputArchive::Impl

friend class OutputArchive::Impl
friend

Definition at line 160 of file OutputArchive.h.


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