LSSTApplications  10.0+286,10.0+36,10.0+46,10.0-2-g4f67435,10.1+152,10.1+37,11.0,11.0+1,11.0-1-g47edd16,11.0-1-g60db491,11.0-1-g7418c06,11.0-2-g04d2804,11.0-2-g68503cd,11.0-2-g818369d,11.0-2-gb8b8ce7
LSSTDataManagementBasePackage
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
lsst::afw::table::io::OutputArchiveHandle Class Reference

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

#include <OutputArchive.h>

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

Public Member Functions

BaseCatalog makeCatalog (Schema const &schema)
 Return a new, empty catalog with the given schema. More...
 
void saveCatalog (BaseCatalog const &catalog)
 Save a catalog in the archive. More...
 
 ~OutputArchiveHandle ()
 
int put (Persistable const *obj, bool permissive=false)
 Save a nested Persistable to the same archive. More...
 
int put (boost::shared_ptr< Persistable const > obj, bool permissive=false)
 Save a nested Persistable to the same archive. More...
 

Private Member Functions

 OutputArchiveHandle (int id, std::string const &name, std::string const &module, boost::shared_ptr< OutputArchive::Impl > impl)
 

Private Attributes

int _id
 
int _catPersistable
 
std::string _name
 
std::string _module
 
boost::shared_ptr
< OutputArchive::Impl > 
_impl
 

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 111 of file OutputArchive.h.

Constructor & Destructor Documentation

lsst::afw::table::io::OutputArchiveHandle::~OutputArchiveHandle ( )
lsst::afw::table::io::OutputArchiveHandle::OutputArchiveHandle ( int  id,
std::string const &  name,
std::string const &  module,
boost::shared_ptr< OutputArchive::Impl >  impl 
)
private

Member Function Documentation

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.

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

Save a nested Persistable to the same archive.

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

Save a nested Persistable to the same archive.

Definition at line 137 of file OutputArchive.h.

137 { return put(obj.get(), permissive); }
int put(Persistable const *obj, bool permissive=false)
Save a nested Persistable to the same archive.
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.

Friends And Related Function Documentation

friend class OutputArchive::Impl
friend

Definition at line 144 of file OutputArchive.h.

Member Data Documentation

int lsst::afw::table::io::OutputArchiveHandle::_catPersistable
private

Definition at line 152 of file OutputArchive.h.

int lsst::afw::table::io::OutputArchiveHandle::_id
private

Definition at line 151 of file OutputArchive.h.

boost::shared_ptr< OutputArchive::Impl > lsst::afw::table::io::OutputArchiveHandle::_impl
private

Definition at line 155 of file OutputArchive.h.

std::string lsst::afw::table::io::OutputArchiveHandle::_module
private

Definition at line 154 of file OutputArchive.h.

std::string lsst::afw::table::io::OutputArchiveHandle::_name
private

Definition at line 153 of file OutputArchive.h.


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