LSST Applications g04c3c9f7ca+2075667efa,g1e125bf412+5f448d5fcf,g2079a07aa2+3e9fd84d81,g2305ad1205+b635cf1488,g2bbee38e9b+6c6beb4891,g337abbeb29+6c6beb4891,g33d1c0ed96+6c6beb4891,g3a166c0a6a+6c6beb4891,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+42f171e1e6,g5c3423f6d4+d536b04327,g607f77f49a+d536b04327,g6f43f06aed+ca1339dc19,g858d7b2824+d536b04327,g8ee334c5b4+d7f9608c2f,g9963eaa53e+b3dc1655d3,g998f4353bf+d536b04327,g99cad8db69+8ef2408349,g9ddcbc5298+9a081db1e4,ga1e77700b3+2cbb763275,gadfd92a7e4+aec2f3b930,gae0086650b+585e252eca,gb0e22166c9+0e73c8378f,gb3b7280ab2+cb5fdb229e,gbb8dafda3b+a327199e22,gc120e1dc64+88074880ea,gc28159a63d+6c6beb4891,gcdd4ae20e8+bd241b2308,gcde1bda545+903e937d91,gcf0d15dbbd+bd241b2308,gdaeeff99f8+f9a426f77a,gddc38dedce+585e252eca,ge79ae78c31+6c6beb4891,gfbcc870c63+b310236976,w.2024.23
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;
16using BaseCatalog = CatalogT<BaseRecord>;
17
18namespace io {
19
20class Persistable;
21class OutputArchiveHandle;
22
35public:
36 friend class OutputArchiveHandle;
37
40
44
48
49 // (trivial) destructor must be defined in the source for pimpl idiom.
51
53
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);
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
Tag types used to declare specialized field types.
Definition misc.h:31
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