LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
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 }
161
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
Base class for all records.
Definition BaseRecord.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 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