Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04dff08e69+fafbcb10e2,g0d33ba9806+3d21495239,g0fba68d861+4a282a2c93,g1ec0fe41b4+f536777771,g1fd858c14a+ae46bc2a71,g35bb328faa+fcb1d3bbc8,g4af146b050+9c38a215af,g4d2262a081+36f1e108ba,g53246c7159+fcb1d3bbc8,g5a012ec0e7+b20b785ecb,g60b5630c4e+3d21495239,g6273192d42+d9e7b43dd0,g67b6fd64d1+4086c0989b,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g87b7deb4dc+2198278b84,g8852436030+54b48a5987,g89139ef638+4086c0989b,g9125e01d80+fcb1d3bbc8,g94187f82dc+3d21495239,g989de1cb63+4086c0989b,g9d31334357+3d21495239,g9f33ca652e+83205baa3c,gabe3b4be73+1e0a283bba,gabf8522325+fa80ff7197,gb1101e3267+85d1f90f4c,gb58c049af0+f03b321e39,gb89ab40317+4086c0989b,gc0bb628dac+d11454dffd,gcf25f946ba+54b48a5987,gd6cbbdb0b4+af3c3595f5,gd9a9a58781+fcb1d3bbc8,gde0f65d7ad+a74c3eaa38,ge278dab8ac+d65b3c2b70,ge410e46f29+4086c0989b,gf23fb2af72+b3e27b8ebc,gf67bdafdda+4086c0989b,v29.0.0.rc6
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>
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