Loading [MathJax]/extensions/tex2jax.js
LSST Applications 28.0.0,g1653933729+a8ce1bb630,g1a997c3884+a8ce1bb630,g28da252d5a+5bd70b7e6d,g2bbee38e9b+638fca75ac,g2bc492864f+638fca75ac,g3156d2b45e+07302053f8,g347aa1857d+638fca75ac,g35bb328faa+a8ce1bb630,g3a166c0a6a+638fca75ac,g3e281a1b8c+7bbb0b2507,g4005a62e65+17cd334064,g414038480c+5b5cd4fff3,g41af890bb2+4ffae9de63,g4e1a3235cc+0f1912dca3,g6249c6f860+3c3976f90c,g80478fca09+46aba80bd6,g82479be7b0+77990446f6,g858d7b2824+78ba4d1ce1,g89c8672015+f667a5183b,g9125e01d80+a8ce1bb630,ga5288a1d22+2a6264e9ca,gae0086650b+a8ce1bb630,gb58c049af0+d64f4d3760,gc22bb204ba+78ba4d1ce1,gc28159a63d+638fca75ac,gcf0d15dbbd+32ddb6096f,gd6b7c0dfd1+3e339405e9,gda3e153d99+78ba4d1ce1,gda6a2b7d83+32ddb6096f,gdaeeff99f8+1711a396fd,gdd5a9049c5+b18c39e5e3,ge2409df99d+a5e4577cdc,ge33fd446bb+78ba4d1ce1,ge79ae78c31+638fca75ac,gf0baf85859+64e8883e75,gf5289d68f6+e1b046a8d7,gfa443fc69c+91d9ed1ecf,gfda6b12a05+8419469a56
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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>
17
18namespace io {
19
20class Persistable;
21class OutputArchiveHandle;
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
A custom container class for records, based on std::vector.
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...
A multi-catalog archive object used to save table::io::Persistable objects.
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