LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
|
A description of a field in a table. More...
#include <Field.h>
Public Types | |
using | Element = typename FieldBase<T>::Element |
Type used to store field data in the table (a field may have multiple elements). | |
using | Value = T |
the type returned by BaseRecord::get | |
using | Reference = T & |
the type returned by BaseRecord::operator[] (non-const) | |
using | ConstReference = const T & |
the type returned by BaseRecord::operator[] (const) | |
Public Member Functions | |
Field (std::string const &name, std::string const &doc, std::string const &units="", FieldBase< T > const &size=FieldBase< T >()) | |
Construct a new field. | |
Field (std::string const &name, std::string const &doc, FieldBase< T > const &size) | |
Construct a new field. | |
Field (Field const &)=default | |
Field (Field &&) noexcept=default | |
Field & | operator= (Field const &)=default |
Field & | operator= (Field &&) noexcept=default |
~Field () noexcept=default | |
std::string const & | getName () const noexcept |
Return the name of the field. | |
std::string const & | getDoc () const noexcept |
Return the documentation for the field. | |
std::string const & | getUnits () const noexcept |
Return the units for the field. | |
Field< T > | copyRenamed (std::string const &newName) const |
Return a new Field with a new name and other properties the same as this. | |
std::size_t | getElementCount () const noexcept |
Return the number of subfield elements (always one for scalars). | |
Static Public Member Functions | |
static std::string | getTypeString () |
Return a string description of the field type. | |
Protected Member Functions | |
void | stream (std::ostream &os) const |
Defines how Fields are printed. | |
Reference | getReference (Element *p, ndarray::Manager::Ptr const &) const |
Used to implement BaseRecord::operator[] (non-const). | |
ConstReference | getConstReference (Element const *p, ndarray::Manager::Ptr const &) const |
Used to implement BaseRecord::operator[] (const). | |
Value | getValue (Element const *p, ndarray::Manager::Ptr const &) const |
Used to implement BaseRecord::get. | |
void | setValue (Element *p, ndarray::Manager::Ptr const &, Value v) const |
Used to implement BaseRecord::set. | |
Static Protected Member Functions | |
static FieldBase | makeDefault () noexcept |
Needed to allow Keys to be default-constructed. | |
Friends | |
std::ostream & | operator<< (std::ostream &os, Field< T > const &field) |
Stringification. | |
A description of a field in a table.
Field combines a type with the field name, documentation, units, and in some cases, the size of the field.
Specializations for different field types are inherited through FieldBase; see the documentation for those specializations for additional information about particular field types.
|
inherited |
the type returned by BaseRecord::operator[] (const)
Definition at line 44 of file FieldBase.h.
using lsst::afw::table::Field< T >::Element = typename FieldBase<T>::Element |
|
inherited |
the type returned by BaseRecord::operator[] (non-const)
Definition at line 43 of file FieldBase.h.
|
inherited |
the type returned by BaseRecord::get
Definition at line 42 of file FieldBase.h.
|
inline |
Construct a new field.
[in] | name | Name of the field. Schemas provide extra functionality for names whose components are separated by underscores. Field names should be limited to letters, numbers, and underscores. |
[in] | doc | Documentation for the field. Should not contain single-quotes to avoid FITS round-trip problems. |
[in] | units | Units for the field. Should not contain single-quotes to avoid FITS round-trip problems. |
[in] | size | Size of the field as an integer, if appropriate. Field types that accept a size have a FieldBase that is implicitly constructable from an integer, so the argument type should be considered to effectively be int; using FieldBase here allows use to throw when the signature does not match the field type. |
Definition at line 44 of file Field.h.
|
inline |
Construct a new field.
[in] | name | Name of the field. Schemas provide extra functionality for names whose components are separated by underscores. Field names should be limited to letters, numbers, and underscores. |
[in] | doc | Documentation for the field. |
[in] | size | Size of the field as an integer, if appropriate. Field types that accept a size have a FieldBase that is implicitly constructable from an integer, so the argument type should be considered to effectively be int; using FieldBase here allows use to throw when the signature does not match the field type. |
Definition at line 61 of file Field.h.
|
default |
|
defaultnoexcept |
|
defaultnoexcept |
Definition at line 50 of file fieldImpl.cc.
|
inline |
Return a new Field with a new name and other properties the same as this.
Definition at line 89 of file Field.h.
|
inlineprotectedinherited |
Used to implement BaseRecord::operator[] (const).
Definition at line 78 of file FieldBase.h.
|
inlinenoexcept |
|
inlinenoexceptinherited |
Return the number of subfield elements (always one for scalars).
Definition at line 48 of file FieldBase.h.
|
inlinenoexcept |
|
inlineprotectedinherited |
Used to implement BaseRecord::operator[] (non-const).
Definition at line 75 of file FieldBase.h.
|
staticinherited |
Return a string description of the field type.
Definition at line 56 of file FieldBase.cc.
|
inlinenoexcept |
|
inlineprotectedinherited |
|
inlinestaticprotectednoexceptinherited |
Needed to allow Keys to be default-constructed.
Definition at line 69 of file FieldBase.h.
|
defaultnoexcept |
|
default |
|
inlineprotectedinherited |
|
inlineprotectedinherited |
|
friend |
Stringification.
Definition at line 80 of file Field.h.