LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
LSST Data Management Base Package
Loading...
Searching...
No Matches
OutputArchive.h
Go to the documentation of this file.
1// -*- lsst-c++ -*-
2#ifndef AFW_TABLE_IO_OutputArchive_h_INCLUDED
3#define AFW_TABLE_IO_OutputArchive_h_INCLUDED
4
5#include "lsst/base.h"
7
8namespace lsst {
9namespace afw {
10namespace table {
11
12class Schema;
13class BaseRecord;
14template <typename RecordT>
15class CatalogT;
17
18namespace io {
19
20class Persistable;
22
34class OutputArchive final {
35public:
36 friend class OutputArchiveHandle;
37
40
44
48
49 // (trivial) destructor must be defined in the source for pimpl idiom.
51
53
80 int put(std::shared_ptr<Persistable const> obj, bool permissive = false);
81 int put(Persistable const * obj, bool permissive = false);
82 int put(Persistable const & obj, bool permissive = false) { return put(&obj, permissive); }
84
89 BaseCatalog const& getIndexCatalog() const;
90
92 BaseCatalog const& getCatalog(int n) const;
93
96
104 void writeFits(fits::Fits& fitsfile) const;
105
106private:
107 class Impl;
108
110};
111
119public:
126 BaseCatalog makeCatalog(Schema const& schema);
127
132 void saveEmpty();
133
140 void saveCatalog(BaseCatalog const& catalog);
141
144 int put(Persistable const* obj, bool permissive = false);
145 int put(std::shared_ptr<Persistable const> obj, bool permissive = false);
146 int put(Persistable const & obj, bool permissive = false) { return put(&obj, permissive); }
148
150
151 // No copying
154
155 // No moving
158
159private:
161
162 OutputArchiveHandle(int id, std::string const& name, std::string const& module,
164
165 int _id;
166 int _catPersistable;
167 std::string _name;
168 std::string _module;
170};
171} // namespace io
172} // namespace table
173} // namespace afw
174} // namespace lsst
175
176#endif // !AFW_TABLE_IO_OutputArchive_h_INCLUDED
Basic LSST definitions.
A simple struct that combines the two arguments that must be passed to most cfitsio routines and cont...
Definition fits.h:308
Base class for all records.
Definition BaseRecord.h:31
A custom container class for records, based on std::vector.
Definition Catalog.h:98
Defines the fields and offsets for a table.
Definition Schema.h:51
An object passed to Persistable::write to allow it to persist itself.
OutputArchiveHandle & operator=(OutputArchiveHandle &&)=delete
OutputArchiveHandle & operator=(const OutputArchiveHandle &)=delete
OutputArchiveHandle(OutputArchiveHandle &&)=delete
void saveCatalog(BaseCatalog const &catalog)
Save a catalog in the archive.
OutputArchiveHandle(const OutputArchiveHandle &)=delete
void saveEmpty()
Indicate that the object being persisted has no state, and hence will never call makeCatalog() or sav...
BaseCatalog makeCatalog(Schema const &schema)
Return a new, empty catalog with the given schema.
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...
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...
OutputArchive(OutputArchive const &other)
Copy-construct an OutputArchive. Saved objects are not deep-copied.
std::size_t countCatalogs() const
Return the total number of catalogs, including the index.
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...
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 InputArc...
void writeFits(fits::Fits &fitsfile) const
Write the archive to an already-open FITS object.
BaseCatalog const & getCatalog(int n) const
Return the nth catalog. Catalog 0 is always the index catalog.
OutputArchive & operator=(OutputArchive const &other)
Assign from another OutputArchive. Saved objects are not deep-copied.
BaseCatalog const & getIndexCatalog() const
Return the index catalog that specifies where objects are stored in the data catalogs.
OutputArchive()
Construct an empty OutputArchive containing no objects.
A base class for objects that can be persisted via afw::table::io Archive classes.
Definition Persistable.h:74
CatalogT< BaseRecord > BaseCatalog
Definition fwd.h:72