Loading [MathJax]/extensions/tex2jax.js
LSST Applications g0fba68d861+aa97b6e50c,g1ec0fe41b4+f536777771,g1fd858c14a+a9301854fb,g35bb328faa+fcb1d3bbc8,g4af146b050+a5c07d5b1d,g4d2262a081+78f4f01b60,g53246c7159+fcb1d3bbc8,g56a49b3a55+9c12191793,g5a012ec0e7+3632fc3ff3,g60b5630c4e+ded28b650d,g67b6fd64d1+ed4b5058f4,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g8352419a5c+fcb1d3bbc8,g87b7deb4dc+7b42cf88bf,g8852436030+e5453db6e6,g89139ef638+ed4b5058f4,g8e3bb8577d+d38d73bdbd,g9125e01d80+fcb1d3bbc8,g94187f82dc+ded28b650d,g989de1cb63+ed4b5058f4,g9d31334357+ded28b650d,g9f33ca652e+50a8019d8c,gabe3b4be73+1e0a283bba,gabf8522325+fa80ff7197,gb1101e3267+d9fb1f8026,gb58c049af0+f03b321e39,gb89ab40317+ed4b5058f4,gcf25f946ba+e5453db6e6,gcf6002c91b+2a0c9e9e84,gd6cbbdb0b4+bb83cc51f8,gdd1046aedd+ded28b650d,gde0f65d7ad+66b3a48cb7,ge278dab8ac+d65b3c2b70,ge410e46f29+ed4b5058f4,gf23fb2af72+b7cae620c0,gf5e32f922b+fcb1d3bbc8,gf67bdafdda+ed4b5058f4,w.2025.16
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Field.h
Go to the documentation of this file.
1// -*- lsst-c++ -*-
2#ifndef AFW_TABLE_Field_h_INCLUDED
3#define AFW_TABLE_Field_h_INCLUDED
4
5#include <iostream>
6
8
9namespace lsst {
10namespace afw {
11namespace table {
12
23template <typename T>
24struct Field : public FieldBase<T> {
27
44 Field(std::string const& name, std::string const& doc, std::string const& units = "",
45 FieldBase<T> const& size = FieldBase<T>())
46 : FieldBase<T>(size), _name(name), _doc(doc), _units(units) {}
47
61 Field(std::string const& name, std::string const& doc, FieldBase<T> const& size)
62 : FieldBase<T>(size), _name(name), _doc(doc), _units() {}
63
64 Field(Field const&) = default;
65 Field(Field&&) noexcept = default;
66 Field& operator=(Field const&) = default;
67 Field& operator=(Field&&) noexcept = default;
68 ~Field() noexcept = default;
69
71 std::string const& getName() const noexcept { return _name; }
72
74 std::string const& getDoc() const noexcept { return _doc; }
75
77 std::string const& getUnits() const noexcept { return _units; }
78
80 inline friend std::ostream& operator<<(std::ostream& os, Field<T> const& field) {
81 os << "Field['" << Field<T>::getTypeString() << "'](name=\"" << field.getName() << "\"";
82 if (!field.getDoc().empty()) os << ", doc=\"" << field.getDoc() << "\"";
83 if (!field.getUnits().empty()) os << ", units=\"" << field.getUnits() << "\"";
84 field.stream(os);
85 return os << ")";
86 }
87
89 Field<T> copyRenamed(std::string const& newName) const {
90 return Field<T>(newName, getDoc(), getUnits(), *this);
91 }
92
93private:
94 std::string _name;
95 std::string _doc;
96 std::string _units;
97};
98} // namespace table
99} // namespace afw
100} // namespace lsst
101
102#endif // !AFW_TABLE_Field_h_INCLUDED
T empty(T... args)
STL namespace.
static std::string getTypeString()
Return a string description of the field type.
Definition FieldBase.cc:56
void stream(std::ostream &os) const
Defines how Fields are printed.
Definition FieldBase.h:72
T Element
the type of subfields (the same as the type itself for scalars)
Definition FieldBase.h:45
typename FieldBase< Flag >::Element Element
Definition Field.h:26
std::string const & getName() const noexcept
Definition Field.h:71
friend std::ostream & operator<<(std::ostream &os, Field< T > const &field)
Stringification.
Definition Field.h:80
std::string const & getUnits() const noexcept
Return the units for the field.
Definition Field.h:77
Field(std::string const &name, std::string const &doc, FieldBase< T > const &size)
Construct a new field.
Definition Field.h:61
Field< T > copyRenamed(std::string const &newName) const
Return a new Field with a new name and other properties the same as this.
Definition Field.h:89
Field(std::string const &name, std::string const &doc, std::string const &units="", FieldBase< T > const &size=FieldBase< T >())
Construct a new field.
Definition Field.h:44
Field(Field const &)=default
Field(Field &&) noexcept=default
std::string const & getDoc() const noexcept
Return the documentation for the field.
Definition Field.h:74