Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04a91732dc+a777afbe81,g07dc498a13+7e3c5f68a2,g12483e3c20+0145ec33cd,g1409bbee79+7e3c5f68a2,g1a7e361dbc+7e3c5f68a2,g1fd858c14a+9f35e23ec3,g35bb328faa+fcb1d3bbc8,g3ad4f90e5c+0145ec33cd,g3bd4b5ce2c+cbf1bea503,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g5477a8d5ce+db04660fe6,g60b5630c4e+0145ec33cd,g623d845a50+0145ec33cd,g6f0c2978f1+3526b51a37,g75b6c65c88+d54b601591,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+4639f750a5,g89139ef638+7e3c5f68a2,g9125e01d80+fcb1d3bbc8,g919ac25b3e+6220c5324a,g95236ca021+f7a31438ed,g989de1cb63+7e3c5f68a2,g9f33ca652e+2d6fa11d35,gaaedd4e678+7e3c5f68a2,gabe3b4be73+1e0a283bba,gb1101e3267+4a428ef779,gb4a253aaf5+0122250889,gb58c049af0+f03b321e39,gc99c83e5f0+76d20ab76d,gcf25f946ba+4639f750a5,gd6cbbdb0b4+c8606af20c,gde0f65d7ad+3d8a3b7e46,ge278dab8ac+932305ba37,gf795337580+03b96afe58,gfba249425e+fcb1d3bbc8,w.2025.08
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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
12
13namespace lsst {
14namespace afw {
15namespace table {
16
17namespace detail {
18
19class Access;
20
21} // namespace detail
22
32template <>
33struct FieldBase<Flag> {
34 using Value = bool;
36
38 std::size_t 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;
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;
56 ~FieldBase() = default;
57
58protected:
60 void stream(std::ostream &os) const {}
61};
62
66template <>
67class KeyBase<Flag> {
68public:
69 static bool const HAS_NAMED_SUBFIELDS = false;
70
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
93template <>
94class Key<Flag> : public KeyBase<Flag>, public FieldBase<Flag> {
95public:
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 cpputils::hashCombine(17, _offset, _bit);
123 }
124
126 std::size_t getOffset() const { return _offset; }
127
129 std::size_t getBit() const { return _bit; }
130
139 bool isValid() const { return _valid; }
140
146 Key() : FieldBase<Flag>(), _offset(0), _bit(0), _valid(false) {}
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
160private:
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(std::size_t offset, std::size_t bit) : _offset(offset), _bit(bit), _valid(true) {}
179
180 std::size_t _offset;
181 std::size_t _bit;
182 bool _valid;
183};
184} // namespace table
185} // namespace afw
186} // namespace lsst
187
188namespace std {
189template <>
190struct hash<lsst::afw::table::Key<lsst::afw::table::Flag>> {
193 size_t operator()(argument_type const &obj) const noexcept { return obj.hash_value(); }
194};
195} // namespace std
196
197#endif // !LSST_AFW_TABLE_Flag_h_INCLUDED
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition Exception.h:48
bool isValid() const
Return true if the key was initialized to valid offset.
Definition Flag.h:139
Key(Key const &)=default
bool operator==(Key< OtherT > const &other) const
Equality comparison.
Definition Flag.h:107
std::size_t getBit() const
The index of this field's bit within the integer it shares with other Flag fields.
Definition Flag.h:129
Key & operator=(Key &&)=default
Key()
Default construct a field.
Definition Flag.h:146
bool operator==(Key const &other) const
Definition Flag.h:115
bool operator!=(Key< OtherT > const &other) const
Definition Flag.h:111
bool operator!=(Key const &other) const
Definition Flag.h:116
std::size_t getOffset() const
Return the offset in bytes of the integer element that holds this field's bit.
Definition Flag.h:126
friend class BaseRecord
Definition Flag.h:162
friend std::ostream & operator<<(std::ostream &os, Key< Flag > const &key)
Stringification.
Definition Flag.h:155
std::size_t hash_value() const noexcept
Return a hash of this object.
Definition Flag.h:120
Key & operator=(Key const &)=default
KeyBase & operator=(KeyBase const &)=default
KeyBase(KeyBase const &)=default
static bool const HAS_NAMED_SUBFIELDS
Definition Flag.h:69
Key< FieldBase< Flag >::Element > getStorage() const
Return a key corresponding to the integer element where this field's bit is packed.
Definition KeyBase.cc:15
KeyBase & operator=(KeyBase &&)=default
A class used as a handle to a particular field in a table.
Definition Key.h:53
bool operator==(Key< OtherT > const &other) const noexcept
Equality comparison.
Definition Key.h:66
std::size_t getOffset() const noexcept
Return the offset (in bytes) of this field within a record.
Definition Key.h:87
Key() noexcept
Default construct a field.
Definition Key.h:104
Reports errors in the logical structure of the program.
Definition Runtime.h:46
std::size_t hashCombine(std::size_t seed) noexcept
Combine hashes.
Definition hashCombine.h:35
STL namespace.
decltype(sizeof(void *)) size_t
Definition doctest.h:524
FieldBase & operator=(FieldBase const &)=default
std::size_t 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
std::int64_t Element
the actual storage type (shared by multiple flag fields)
Definition Flag.h:35
static std::string getTypeString()
Return a string description of the field type.
Definition Flag.h:41
FieldBase(FieldBase &&)=default
FieldBase(FieldBase const &)=default
FieldBase & operator=(FieldBase &&)=default
bool Value
the type returned by BaseRecord::get
Definition Flag.h:34
static std::string getTypeString()
Return a string description of the field type.
Definition FieldBase.cc:56
Value getValue(Element const *p, ndarray::Manager::Ptr const &) const
Used to implement BaseRecord::get.
Definition FieldBase.h:81
void setValue(Element *p, ndarray::Manager::Ptr const &, Value v) const
Used to implement BaseRecord::set.
Definition FieldBase.h:84
lsst::afw::table::Key< lsst::afw::table::Flag > argument_type
Definition Flag.h:191
size_t operator()(argument_type const &obj) const noexcept
Definition Flag.h:193