LSSTApplications  17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
LSSTDataManagementBasePackage
Flag.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 #ifndef LSST_AFW_TABLE_Flag_h_INCLUDED
3 #define LSST_AFW_TABLE_Flag_h_INCLUDED
4 
5 #include <cstdint>
6 
8 
9 #include "lsst/afw/table/misc.h"
11 #include "lsst/afw/table/KeyBase.h"
12 
13 namespace lsst {
14 namespace afw {
15 namespace table {
16 
17 namespace detail {
18 
19 class Access;
20 
21 } // namespace detail
22 
32 template <>
33 struct FieldBase<Flag> {
34  typedef bool Value;
36 
38  int getElementCount() const { return 1; }
39 
41  static std::string getTypeString() { return "Flag"; }
42 
43  // Only the first of these constructors is valid for this specializations, but
44  // it's convenient to be able to instantiate both, since the other is used
45  // by other specializations.
46  FieldBase() = default;
47  FieldBase(int) {
49  "Constructor disabled (this Field type is not sized).");
50  }
51 
52  FieldBase(FieldBase const &) = default;
53  FieldBase(FieldBase &&) = default;
54  FieldBase &operator=(FieldBase const &) = default;
55  FieldBase &operator=(FieldBase &&) = default;
56  ~FieldBase() = default;
57 
58 protected:
60  void stream(std::ostream &os) const {}
61 };
62 
66 template <>
67 class KeyBase<Flag> {
68 public:
69  static bool const HAS_NAMED_SUBFIELDS = false;
70 
72  Key<FieldBase<Flag>::Element> getStorage() const;
73 
74  KeyBase() = default;
75  KeyBase(KeyBase const &) = default;
76  KeyBase(KeyBase &&) = default;
77  KeyBase &operator=(KeyBase const &) = default;
78  KeyBase &operator=(KeyBase &&) = default;
79  ~KeyBase() = default;
80 };
81 
93 template <>
94 class Key<Flag> : public KeyBase<Flag>, public FieldBase<Flag> {
95 public:
97 
106  template <typename OtherT>
107  bool operator==(Key<OtherT> const &other) const {
108  return false;
109  }
110  template <typename OtherT>
111  bool operator!=(Key<OtherT> const &other) const {
112  return true;
113  }
114 
115  bool operator==(Key const &other) const { return _offset == other._offset && _bit == other._bit; }
116  bool operator!=(Key const &other) const { return !this->operator==(other); }
118 
120  std::size_t hash_value() const noexcept {
121  // Completely arbitrary seed
122  return utils::hashCombine(17, _offset, _bit);
123  }
124 
126  int getOffset() const { return _offset; }
127 
129  int getBit() const { return _bit; }
130 
139  bool isValid() const { return _offset >= 0; }
140 
146  Key() : FieldBase<Flag>(), _offset(-1), _bit(0) {}
147 
148  Key(Key const &) = default;
149  Key(Key &&) = default;
150  Key &operator=(Key const &) = default;
151  Key &operator=(Key &&) = default;
152  ~Key() = default;
153 
155  inline friend std::ostream &operator<<(std::ostream &os, Key<Flag> const &key) {
156  return os << "Key['" << Key<Flag>::getTypeString() << "'](offset=" << key.getOffset()
157  << ", bit=" << key.getBit() << ")";
158  }
159 
160 private:
161  friend class detail::Access;
162  friend class BaseRecord;
163 
165  Value getValue(Element const *p, ndarray::Manager::Ptr const &) const {
166  return (*p) & (Element(1) << _bit);
167  }
168 
170  void setValue(Element *p, ndarray::Manager::Ptr const &, Value v) const {
171  if (v) {
172  *p |= (Element(1) << _bit);
173  } else {
174  *p &= ~(Element(1) << _bit);
175  }
176  }
177 
178  explicit Key(int offset, int bit) : _offset(offset), _bit(bit) {}
179 
180  int _offset;
181  int _bit;
182 };
183 } // namespace table
184 } // namespace afw
185 } // namespace lsst
186 
187 namespace std {
188 template <>
189 struct hash<lsst::afw::table::Key<lsst::afw::table::Flag>> {
192  size_t operator()(argument_type const &obj) const noexcept { return obj.hash_value(); }
193 };
194 } // namespace std
195 
196 #endif // !LSST_AFW_TABLE_Flag_h_INCLUDED
Field base class default implementation (used for numeric scalars and lsst::geom::Angle).
Definition: FieldBase.h:43
Key()
Default construct a field.
Definition: Flag.h:146
bool Value
the type returned by BaseRecord::get
Definition: Flag.h:34
STL namespace.
std::size_t hash_value() const noexcept
Return a hash of this object.
Definition: Flag.h:120
bool isValid() const
Return true if the key was initialized to valid offset.
Definition: Flag.h:139
STL class.
A base class for image defects.
bool operator!=(Key< OtherT > const &other) const
Equality comparison.
Definition: Flag.h:111
static std::string getTypeString()
Return a string description of the field type.
Definition: Flag.h:41
Reports errors in the logical structure of the program.
Definition: Runtime.h:46
int getBit() const
The index of this field&#39;s bit within the integer it shares with other Flag fields.
Definition: Flag.h:129
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
A base class for Key that allows subfield keys to be extracted for some field types.
Definition: KeyBase.h:20
bool operator==(Key const &other) const
Equality comparison.
Definition: Flag.h:115
Base class for all records.
Definition: BaseRecord.h:31
A class used as a handle to a particular field in a table.
Definition: fwd.h:45
Key< U > key
Definition: Schema.cc:281
size_t operator()(argument_type const &obj) const noexcept
Definition: Flag.h:192
int getElementCount() const
Return the number of subfield elements (always one for scalars).
Definition: Flag.h:38
void stream(std::ostream &os) const
Defines how fields are printed.
Definition: Flag.h:60
ItemVariant const * other
Definition: Schema.cc:56
bool operator==(Key< OtherT > const &other) const
Equality comparison.
Definition: Flag.h:107
std::size_t hashCombine(std::size_t seed) noexcept
Combine hashes.
Definition: hashCombine.h:35
int getOffset() const
Return the offset in bytes of the integer element that holds this field&#39;s bit.
Definition: Flag.h:126
static std::string getTypeString()
Return a string description of the field type.
Definition: FieldBase.cc:56
STL class.
std::ostream * os
Definition: Schema.cc:746
std::int64_t Element
the actual storage type (shared by multiple flag fields)
Definition: Flag.h:35
bool operator!=(Key const &other) const
Equality comparison.
Definition: Flag.h:116