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
SchemaImpl.h
Go to the documentation of this file.
1// -*- lsst-c++ -*-
2#ifndef AFW_TABLE_DETAIL_SchemaImpl_h_INCLUDED
3#define AFW_TABLE_DETAIL_SchemaImpl_h_INCLUDED
4
5#include <vector>
6#include <algorithm>
7#include <map>
8#include <variant>
9
10namespace lsst {
11namespace afw {
12namespace table {
13
14class Schema;
15class SubSchema;
16
21template <typename T>
22struct SchemaItem final {
25
26 SchemaItem(Key<T> const& key_, Field<T> const& field_) : key(key_), field(field_) {}
27};
28
29namespace detail {
30
31class Access;
32
46private:
49 template <typename ...E>
50 static std::variant<SchemaItem<E>...> makeItemVariantType(TypeList<E...>);
51public:
52 static int const VERSION = 3;
53
55 using ItemVariant = decltype(makeItemVariantType(FieldTypes{}));
64
66 std::size_t getRecordSize() const { return _recordSize; }
67
69 std::size_t getFieldCount() const { return _names.size(); }
70
72 std::size_t getFlagFieldCount() const { return _flags.size(); }
73
75 std::size_t getNonFlagFieldCount() const { return _offsets.size(); }
76
78 template <typename T>
79 SchemaItem<T> find(std::string const& name) const;
80
82 template <typename T>
83 SchemaItem<T> find(Key<T> const& key) const;
84
86 SchemaItem<Flag> find(Key<Flag> const& key) const;
87
89 template <typename F>
90 decltype(auto) findAndApply(std::string const& name, F&& func) const {
91 auto iter = _names.find(name);
92 if (iter == _names.end()) {
94 (boost::format("Field with name '%s' not found") % name).str());
95 }
96 return std::visit(std::forward<F>(func), _items[iter->second]);
97 }
98
100 std::set<std::string> getNames(bool topOnly) const;
101
103 std::set<std::string> getNames(bool topOnly, std::string const& prefix) const;
104
105 template <typename T>
106 int contains(SchemaItem<T> const& item, int flags) const;
107
109 template <typename T>
110 Key<T> addField(Field<T> const& field, bool doReplace = false);
111
113 Key<Flag> addField(Field<Flag> const& field, bool doReplace = false);
114
116 template <typename T>
117 Key<Array<T> > addField(Field<Array<T> > const& field, bool doReplace = false);
118
120 Key<std::string> addField(Field<std::string> const& field, bool doReplace = false);
121
123 template <typename T>
124 void replaceField(Key<T> const& key, Field<T> const& field);
125
133 ItemContainer const& getItems() const { return _items; }
134
136 SchemaImpl() : _recordSize(0), _lastFlagField(0), _lastFlagBit(0), _items(), _initFlag(false) {}
137
138private:
139 friend class detail::Access;
140
141 template <typename T>
142 Key<T> addFieldImpl(std::size_t elementSize, std::size_t elementCount, Field<T> const& field, bool doReplace);
143
144 std::size_t _recordSize; // Size of a record in bytes.
145 std::size_t _lastFlagField; // Offset of the last flag field in bytes.
146 std::size_t _lastFlagBit; // Bit of the last flag field.
147 ItemContainer _items; // Vector of variants of SchemaItem<T>.
148 NameMap _names; // Field name to vector-index map.
149 OffsetMap _offsets; // Offset to vector-index map for regular fields.
150 FlagMap _flags; // Offset to vector-index map for flags.
151 bool _initFlag; // Indicates if record is valid
152};
153} // namespace detail
154} // namespace table
155} // namespace afw
156} // namespace lsst
157
158#endif // !AFW_TABLE_DETAIL_SchemaImpl_h_INCLUDED
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition Exception.h:48
Tag types used to declare specialized field types.
Definition misc.h:31
A class used as a handle to a particular field in a table.
Definition Key.h:53
Defines the fields and offsets for a table.
Definition Schema.h:51
A proxy type for name lookups in a Schema.
Definition Schema.h:367
std::set< std::string > getNames(bool topOnly) const
Return a set of field names (used to implement Schema::getNames).
Definition Schema.cc:251
SchemaImpl()
Default constructor.
Definition SchemaImpl.h:136
Key< T > addField(Field< T > const &field, bool doReplace=false)
Add a field to the schema (used to implement Schema::addField).
Definition Schema.cc:314
int contains(SchemaItem< T > const &item, int flags) const
Definition Schema.cc:225
decltype(auto) findAndApply(std::string const &name, F &&func) const
Find an item by name and run the given functor on it.
Definition SchemaImpl.h:90
std::size_t getRecordSize() const
The size of a record in bytes.
Definition SchemaImpl.h:66
void replaceField(Key< T > const &key, Field< T > const &field)
Replace the Field in an existing SchemaItem without changing the Key.
Definition Schema.cc:193
std::map< std::string, std::size_t > NameMap
A map from field names to position in the vector, so we can do name lookups.
Definition SchemaImpl.h:59
std::size_t getFlagFieldCount() const
The number of Flag fields.
Definition SchemaImpl.h:72
std::size_t getNonFlagFieldCount() const
The number of non-Flag fields.
Definition SchemaImpl.h:75
SchemaItem< T > find(std::string const &name) const
Find an item by name (used to implement Schema::find).
Definition Schema.cc:92
std::map< std::pair< std::size_t, std::size_t >, std::size_t > FlagMap
A map from Flag field offset/bit pairs to position in the vector, so we can do Flag field lookups.
Definition SchemaImpl.h:63
ItemContainer const & getItems() const
Return the vector of SchemaItem variants.
Definition SchemaImpl.h:133
std::size_t getFieldCount() const
The total number of fields.
Definition SchemaImpl.h:69
decltype(makeItemVariantType(FieldTypes{})) ItemVariant
A Boost.Variant type that can hold any one of the allowed SchemaItem types.
Definition SchemaImpl.h:55
std::vector< ItemVariant > ItemContainer
A std::vector whose elements can be any of the allowed SchemaItem types.
Definition SchemaImpl.h:57
std::map< std::size_t, std::size_t > OffsetMap
A map from standard field offsets to position in the vector, so we can do field lookups.
Definition SchemaImpl.h:61
Reports attempts to access elements using an invalid key.
Definition Runtime.h:151
T forward(T... args)
TypeList< RecordId, std::uint16_t, std::int32_t, float, double, lsst::geom::Angle, std::uint8_t, Flag, std::string, Array< std::uint16_t >, Array< int >, Array< float >, Array< double >, Array< std::uint8_t > > FieldTypes
A compile-time list of all field types.
Definition types.h:53
A description of a field in a table.
Definition Field.h:24
A simple pair-like struct for mapping a Field (name and description) with a Key (used for actual data...
Definition SchemaImpl.h:22
SchemaItem(Key< T > const &key_, Field< T > const &field_)
Definition SchemaImpl.h:26