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
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