LSSTApplications  18.0.0+67,19.0.0+5,19.0.0+54,19.0.0+57,19.0.0+63,19.0.0+9,19.0.0-1-g20d9b18+23,19.0.0-1-g49a97f9+3,19.0.0-1-g5549ca4+4,19.0.0-1-g8c57eb9+23,19.0.0-1-g8e6e14c+13,19.0.0-1-ga72da6b+3,19.0.0-1-gbfe0924+50,19.0.0-1-ge272bc4+23,19.0.0-1-gefe1d0d+36,19.0.0-11-g57ef05f+1,19.0.0-13-g8db0348+4,19.0.0-14-g706b86db4+1,19.0.0-14-ge428dae,19.0.0-15-g557baf8+8,19.0.0-16-gdc8ce7c+1,19.0.0-2-g0d9f9cd+59,19.0.0-2-g260436e+40,19.0.0-2-g9675b69+3,19.0.0-2-g9b11441+48,19.0.0-2-gde8e5e3+3,19.0.0-2-gf01c5b1+1,19.0.0-2-gff6972b+7,19.0.0-3-g27e4659+25,19.0.0-3-g6513920+52,19.0.0-4-gac56cce+1,19.0.0-41-g13db8fbc+1,19.0.0-43-gbcf6a3c,19.0.0-6-gdd6eb13,19.0.0-7-g686a884+4,19.0.0-9-gce87a591+7,w.2020.14
LSSTDataManagementBasePackage
Persistable.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 #ifndef AFW_TABLE_IO_Persistable_h_INCLUDED
3 #define AFW_TABLE_IO_Persistable_h_INCLUDED
4 
5 #include <climits>
6 #include "lsst/base.h"
7 #include "lsst/pex/exceptions.h"
9 
10 namespace lsst {
11 namespace afw {
12 
13 namespace fits {
14 
15 class Fits;
16 class MemFileManager;
17 
18 } // namespace fits
19 
20 namespace table {
21 namespace io {
22 
23 class InputArchive;
24 class OutputArchive;
25 class OutputArchiveHandle;
26 class CatalogVector;
27 
32 
33 
40 
41 
48 #define LSST_ARCHIVE_ASSERT(EXPR) \
49  if (!(EXPR)) \
50  throw LSST_EXCEPT(lsst::afw::table::io::MalformedArchiveError, "Archive assertion failed: " #EXPR)
51 
74 class Persistable {
75 public:
83  void writeFits(std::string const& fileName, std::string const& mode = "w") const;
84 
92  void writeFits(fits::MemFileManager& manager, std::string const& mode = "w") const;
93 
99  void writeFits(fits::Fits& fitsfile) const;
100 
102  virtual bool isPersistable() const noexcept { return false; }
103 
104  virtual ~Persistable() noexcept = default;
105 
106 protected:
107  // convenient for derived classes not in afw::table::io
109 
115  virtual std::string getPersistenceName() const;
116 
125  virtual std::string getPythonModule() const;
126 
134  virtual void write(OutputArchiveHandle& handle) const;
135 
136  Persistable() noexcept = default;
137 
138  Persistable(Persistable const& other) noexcept = default;
139  Persistable(Persistable&& other) noexcept = default;
140 
141  Persistable& operator=(Persistable const& other) noexcept = default;
142  Persistable& operator=(Persistable&& other) noexcept = default;
143 
144 private:
145  friend class io::OutputArchive;
146  friend class io::InputArchive;
147 
148  template <typename T>
149  friend class PersistableFacade;
150 
151  static std::shared_ptr<Persistable> _readFits(std::string const& fileName, int hdu = fits::DEFAULT_HDU);
152 
153  static std::shared_ptr<Persistable> _readFits(fits::MemFileManager& manager, int hdu = fits::DEFAULT_HDU);
154 
155  static std::shared_ptr<Persistable> _readFits(fits::Fits& fitsfile);
156 };
157 
175 template <typename T>
176 class PersistableFacade {
177 public:
184  return dynamicCast(Persistable::_readFits(fitsfile));
185  }
186 
194  static std::shared_ptr<T> readFits(std::string const& fileName, int hdu = fits::DEFAULT_HDU) {
195  return dynamicCast(Persistable::_readFits(fileName, hdu));
196  }
197 
206  return dynamicCast(Persistable::_readFits(manager, hdu));
207  }
208 
218  static std::shared_ptr<T> dynamicCast(std::shared_ptr<Persistable> const &ptr);
219 };
220 
229 protected:
230  typedef io::InputArchive InputArchive; // convenient for derived classes not in afw::table::io
232 
233 public:
245  explicit PersistableFactory(std::string const& name);
246 
248  virtual std::shared_ptr<Persistable> read(InputArchive const& archive,
249  CatalogVector const& catalogs) const = 0;
250 
258  static PersistableFactory const& lookup(std::string const& name, std::string const& module = "");
259 
260  virtual ~PersistableFactory() noexcept = default;
261 
262  // No copying
263  PersistableFactory(const PersistableFactory&) = delete;
264  PersistableFactory& operator=(const PersistableFactory&) = delete;
265 
266  // No moving
268  PersistableFactory& operator=(PersistableFactory&&) = delete;
269 };
270 } // namespace io
271 } // namespace table
272 } // namespace afw
273 } // namespace lsst
274 
275 #endif // !AFW_TABLE_IO_Persistable_h_INCLUDED
def write(self, patchRef, catalog)
Write the output.
Basic LSST definitions.
uint64_t * ptr
Definition: RangeSet.cc:88
An object passed to Persistable::write to allow it to persist itself.
A base class for factory classes used to reconstruct objects from records.
Definition: Persistable.h:228
STL namespace.
ItemVariant const * other
Definition: Schema.cc:56
A simple struct that combines the two arguments that must be passed to most cfitsio routines and cont...
Definition: fits.h:297
Fits * fits
Definition: FitsWriter.cc:90
Reports errors in external input/output operations.
Definition: Runtime.h:160
static std::shared_ptr< T > readFits(std::string const &fileName, int hdu=fits::DEFAULT_HDU)
Read an object from a regular FITS file.
Definition: Persistable.h:194
STL class.
A base class for objects that can be persisted via afw::table::io Archive classes.
Definition: Persistable.h:74
A multi-catalog archive object used to save table::io::Persistable objects.
Definition: OutputArchive.h:34
A base class for image defects.
Lifetime-management for memory that goes into FITS memory files.
Definition: fits.h:121
A vector of catalogs used by Persistable.
Definition: CatalogVector.h:29
io::OutputArchiveHandle OutputArchiveHandle
Definition: Persistable.h:108
virtual bool isPersistable() const noexcept
Return true if this particular object can be persisted using afw::table::io.
Definition: Persistable.h:102
A multi-catalog archive object used to load table::io::Persistable objects.
Definition: InputArchive.h:31
static std::shared_ptr< T > readFits(fits::Fits &fitsfile)
Read an object from an already open FITS object.
Definition: Persistable.h:183
#define LSST_EXCEPTION_TYPE(t, b, c)
Macro used to define new types of exceptions without additional data.
Definition: Exception.h:69
A CRTP facade class for subclasses of Persistable.
Definition: Persistable.h:176
An exception thrown when problems occur during persistence.
Definition: Persistable.h:31
An exception thrown when an InputArchive&#39;s contents do not make sense.
Definition: Persistable.h:39
static std::shared_ptr< T > readFits(fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
Read an object from a FITS file in memory.
Definition: Persistable.h:205
const int DEFAULT_HDU
Specify that the default HDU should be read.
Definition: fitsDefaults.h:18