LSST Applications  21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
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
Basic LSST definitions.
A polymorphic functor base class for generating record IDs for a table.
Definition: IdFactory.h:21
virtual RecordId operator()()=0
Return a new unique RecordId.
IdFactory(IdFactory &&)=default
virtual ~IdFactory()=default
IdFactory & operator=(IdFactory const &other)=delete
static int computeReservedFromMaxBits(int maxBits)
Return the number to pass as the 'reserved' argument to makeSource for an exposure ID with the given ...
Definition: IdFactory.h:57
static std::shared_ptr< IdFactory > makeSimple()
Return a simple IdFactory that simply counts from 1.
Definition: IdFactory.cc:70
IdFactory & operator=(IdFactory &&other)=delete
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.
IdFactory(IdFactory const &)=default
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
std::int64_t RecordId
Type used for unique IDs for records.
Definition: misc.h:21
A base class for image defects.