LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
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.