LSST Applications 26.0.0,g0265f82a02+6660c170cc,g07994bdeae+30b05a742e,g0a0026dc87+17526d298f,g0a60f58ba1+17526d298f,g0e4bf8285c+96dd2c2ea9,g0ecae5effc+c266a536c8,g1e7d6db67d+6f7cb1f4bb,g26482f50c6+6346c0633c,g2bbee38e9b+6660c170cc,g2cc88a2952+0a4e78cd49,g3273194fdb+f6908454ef,g337abbeb29+6660c170cc,g337c41fc51+9a8f8f0815,g37c6e7c3d5+7bbafe9d37,g44018dc512+6660c170cc,g4a941329ef+4f7594a38e,g4c90b7bd52+5145c320d2,g58be5f913a+bea990ba40,g635b316a6c+8d6b3a3e56,g67924a670a+bfead8c487,g6ae5381d9b+81bc2a20b4,g93c4d6e787+26b17396bd,g98cecbdb62+ed2cb6d659,g98ffbb4407+81bc2a20b4,g9ddcbc5298+7f7571301f,ga1e77700b3+99e9273977,gae46bcf261+6660c170cc,gb2715bf1a1+17526d298f,gc86a011abf+17526d298f,gcf0d15dbbd+96dd2c2ea9,gdaeeff99f8+0d8dbea60f,gdb4ec4c597+6660c170cc,ge23793e450+96dd2c2ea9,gf041782ebf+171108ac67
LSST Data Management Base Package
Loading...
Searching...
No Matches
SchemaMapper.h
Go to the documentation of this file.
1// -*- lsst-c++ -*-
2#ifndef AFW_TABLE_SchemaMapper_h_INCLUDED
3#define AFW_TABLE_SchemaMapper_h_INCLUDED
4
5#include <memory>
6
8
9namespace lsst {
10namespace afw {
11namespace table {
12
13class BaseRecord;
14
21class SchemaMapper final {
22public:
24 Schema const getInputSchema() const { return _impl->_input; }
25
27 Schema const getOutputSchema() const { return _impl->_output; }
28
30 Schema& editOutputSchema() { return _impl->_output; }
31
33 template <typename T>
34 Key<T> addOutputField(Field<T> const& newField, bool doReplace = false) {
35 return _impl->_output.addField(newField, doReplace);
36 }
37
48 template <typename T>
49 Key<T> addMapping(Key<T> const& inputKey, bool doReplace = false);
50
61 template <typename T>
62 Key<T> addMapping(Key<T> const& inputKey, Field<T> const& outputField, bool doReplace = false);
63
74 template <typename T>
75 Key<T> addMapping(Key<T> const& inputKey, std::string const& outputName, bool doReplace = true);
76
82 template <typename T>
83 Key<T> addMapping(Key<T> const& inputKey, char const* outputName, bool doReplace = true) = delete;
84
97 template <typename Predicate>
98 void addMappingsWhere(Predicate predicate, bool doReplace = true);
99
110 void addMinimalSchema(Schema const& minimal, bool doMap = true);
111
122 static SchemaMapper removeMinimalSchema(Schema const& input, Schema const& minimal);
123
125 void invert();
126
128 template <typename T>
129 bool isMapped(Key<T> const& inputKey) const;
130
132 template <typename T>
133 Key<T> getMapping(Key<T> const& inputKey) const;
134
136
149 template <typename F>
150 void forEach(F& func) const {
151 for (auto const & item : _impl->_map) {
152 std::visit([&func](auto const & pair) { func(pair.first, pair.second); }, item);
153 }
154 }
155 template <typename F>
156 void forEach(F const& func) const {
157 for (auto const & item : _impl->_map) {
158 std::visit([&func](auto const & pair) { func(pair.first, pair.second); }, item);
159 }
160 }
162
164 explicit SchemaMapper();
165
181 explicit SchemaMapper(Schema const& input, Schema const& output);
182
200 explicit SchemaMapper(Schema const& input, bool shareAliasMap = false);
201
203 SchemaMapper(SchemaMapper const& other);
204 SchemaMapper(SchemaMapper&& other);
205
207 SchemaMapper& operator=(SchemaMapper const& other);
209
211
222 std::vector<Schema> const& inputs,
224
225private:
226 template <typename Predicate>
227 struct AddMappingsWhere {
228 template <typename T>
229 void operator()(SchemaItem<T> const& item) const {
230 if (predicate(item)) mapper->addMapping(item.key, doReplace);
231 }
232
233 AddMappingsWhere(SchemaMapper* mapper_, Predicate predicate_, bool doReplace_)
234 : mapper(mapper_), predicate(predicate_), doReplace(doReplace_) {}
235
237 Predicate predicate;
238 bool doReplace;
239 };
240
241 using Impl = detail::SchemaMapperImpl;
242
244};
245
246template <typename Predicate>
247void SchemaMapper::addMappingsWhere(Predicate predicate, bool doReplace) {
248 _impl->_input.forEach(AddMappingsWhere<Predicate>(this, predicate, doReplace));
249}
250} // namespace table
251} // namespace afw
252} // namespace lsst
253
254#endif // !AFW_TABLE_SchemaMapper_h_INCLUDED
SchemaMapper * mapper
Schema minimal
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
void forEach(F &func) const
Apply a functor to each SchemaItem in the Schema.
Definition Schema.h:214
Key< T > addField(Field< T > const &field, bool doReplace=false)
Add a new field to the Schema, and return the associated Key.
Definition Schema.cc:479
A mapping between the keys of two Schemas, used to copy data between them.
Schema const getOutputSchema() const
Return the output schema (copy-on-write).
SchemaMapper()
Construct an empty mapper; useless unless you assign a fully-constructed one to it.
SchemaMapper & operator=(SchemaMapper const &other)
Assignment (copy-on-write).
Key< T > addMapping(Key< T > const &inputKey, char const *outputName, bool doReplace=true)=delete
This deliberately deleted overload ensures we don't accidentally cast string literals to bool.
void forEach(F &func) const
Call the given functor for each key pair in the mapper.
Key< T > addOutputField(Field< T > const &newField, bool doReplace=false)
Add a new field to the output Schema that is not connected to the input Schema.
Key< T > addMapping(Key< T > const &inputKey, bool doReplace=false)
Add a new field to the output Schema that is a copy of a field in the input Schema.
static SchemaMapper removeMinimalSchema(Schema const &input, Schema const &minimal)
Create a mapper by removing fields from the front of a schema.
static std::vector< SchemaMapper > join(std::vector< Schema > const &inputs, std::vector< std::string > const &prefixes=std::vector< std::string >())
Combine a sequence of schemas into one, creating a SchemaMapper for each.
void forEach(F const &func) const
Schema & editOutputSchema()
Return a reference to the output schema that allows it to be modified in place.
Key< T > getMapping(Key< T > const &inputKey) const
Return the output Key corresponding to the given input Key, or raise NotFoundError.
bool isMapped(Key< T > const &inputKey) const
Return true if the given input Key is mapped to an output Key.
void addMinimalSchema(Schema const &minimal, bool doMap=true)
Add the given minimal schema to the output schema.
void invert()
Swap the input and output schemas in-place.
Schema const getInputSchema() const
Return the input schema (copy-on-write).
void addMappingsWhere(Predicate predicate, bool doReplace=true)
Add mappings for all fields that match criteria defined by a predicate.
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