LSST Applications g180d380827+0f66a164bb,g2079a07aa2+86d27d4dc4,g2305ad1205+7d304bc7a0,g29320951ab+500695df56,g2bbee38e9b+0e5473021a,g337abbeb29+0e5473021a,g33d1c0ed96+0e5473021a,g3a166c0a6a+0e5473021a,g3ddfee87b4+e42ea45bea,g48712c4677+36a86eeaa5,g487adcacf7+2dd8f347ac,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+c70619cc9d,g5a732f18d5+53520f316c,g5ea96fc03c+341ea1ce94,g64a986408d+f7cd9c7162,g858d7b2824+f7cd9c7162,g8a8a8dda67+585e252eca,g99cad8db69+469ab8c039,g9ddcbc5298+9a081db1e4,ga1e77700b3+15fc3df1f7,gb0e22166c9+60f28cb32d,gba4ed39666+c2a2e4ac27,gbb8dafda3b+c92fc63c7e,gbd866b1f37+f7cd9c7162,gc120e1dc64+02c66aa596,gc28159a63d+0e5473021a,gc3e9b769f7+b0068a2d9f,gcf0d15dbbd+e42ea45bea,gdaeeff99f8+f9a426f77a,ge6526c86ff+84383d05b3,ge79ae78c31+0e5473021a,gee10cc3b42+585e252eca,gff1a9f87cc+f7cd9c7162,w.2024.17
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
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
236 SchemaMapper* mapper;
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
Schema minimal
Tag types used to declare specialized field types.
Definition misc.h:31
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.