LSSTApplications  18.0.0+106,18.0.0+50,19.0.0,19.0.0+1,19.0.0+10,19.0.0+11,19.0.0+13,19.0.0+17,19.0.0+2,19.0.0-1-g20d9b18+6,19.0.0-1-g425ff20,19.0.0-1-g5549ca4,19.0.0-1-g580fafe+6,19.0.0-1-g6fe20d0+1,19.0.0-1-g7011481+9,19.0.0-1-g8c57eb9+6,19.0.0-1-gb5175dc+11,19.0.0-1-gdc0e4a7+9,19.0.0-1-ge272bc4+6,19.0.0-1-ge3aa853,19.0.0-10-g448f008b,19.0.0-12-g6990b2c,19.0.0-2-g0d9f9cd+11,19.0.0-2-g3d9e4fb2+11,19.0.0-2-g5037de4,19.0.0-2-gb96a1c4+3,19.0.0-2-gd955cfd+15,19.0.0-3-g2d13df8,19.0.0-3-g6f3c7dc,19.0.0-4-g725f80e+11,19.0.0-4-ga671dab3b+1,19.0.0-4-gad373c5+3,19.0.0-5-ga2acb9c+2,19.0.0-5-gfe96e6c+2,w.2020.01
LSSTDataManagementBasePackage
IdFactory.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 #ifndef AFW_TABLE_IdFactory_h_INCLUDED
3 #define AFW_TABLE_IdFactory_h_INCLUDED
4 
5 #include <memory>
6 
7 #include "lsst/base.h"
8 #include "lsst/afw/table/misc.h"
9 
10 namespace lsst {
11 namespace afw {
12 namespace table {
13 
21 class IdFactory {
22 public:
24  virtual RecordId operator()() = 0;
25 
27  virtual void notify(RecordId id) = 0;
28 
30  virtual std::shared_ptr<IdFactory> clone() const = 0;
31 
38 
49  static std::shared_ptr<IdFactory> makeSource(RecordId expId, int reserved);
50 
57  static int computeReservedFromMaxBits(int maxBits) {
58  // Subtract one for signed integers to avoid the sign bit.
59  return sizeof(RecordId)*8 - std::is_signed<RecordId>::value - maxBits;
60  }
61 
62  IdFactory() = default;
63  IdFactory(IdFactory const &) = default;
64  IdFactory(IdFactory &&) = default;
65 
66  // Protected to prevent slicing.
67  IdFactory &operator=(IdFactory const &other) = delete;
68  IdFactory &operator=(IdFactory &&other) = delete;
69  virtual ~IdFactory() = default;
70 
71 private:
72 };
73 } // namespace table
74 } // namespace afw
75 } // namespace lsst
76 
77 #endif // !AFW_TABLE_IdFactory_h_INCLUDED
std::int64_t RecordId
Type used for unique IDs for records.
Definition: misc.h:22
Basic LSST definitions.
ItemVariant const * other
Definition: Schema.cc:56
static int computeReservedFromMaxBits(int maxBits)
Return the number to pass as the &#39;reserved&#39; argument to makeSource for an exposure ID with the given ...
Definition: IdFactory.h:57
IdFactory & operator=(IdFactory const &other)=delete
static std::shared_ptr< IdFactory > makeSource(RecordId expId, int reserved)
Return an IdFactory that includes another, fixed ID in the higher-order bits.
Definition: IdFactory.cc:72
virtual RecordId operator()()=0
Return a new unique RecordId.
A base class for image defects.
A polymorphic functor base class for generating record IDs for a table.
Definition: IdFactory.h:21
virtual ~IdFactory()=default
virtual void notify(RecordId id)=0
Notify the IdFactory that the given ID has been used and must not be returned by operator().
virtual std::shared_ptr< IdFactory > clone() const =0
Deep-copy the IdFactory.
static std::shared_ptr< IdFactory > makeSimple()
Return a simple IdFactory that simply counts from 1.
Definition: IdFactory.cc:70