LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+b2075782a9,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g3ddfee87b4+a60788ef87,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+a60788ef87,g591dd9f2cf+ba8caea58f,g5ec818987f+864ee9cddb,g858d7b2824+9ee1ab4172,g876c692160+a40945ebb7,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+5e309b7bc6,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+aa12a14d27,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+d0da15e3be,gba4ed39666+1ac82b564f,gbb8dafda3b+5dfd9c994b,gbeb006f7da+97157f9740,gc28159a63d+c6dfa2ddaf,gc86a011abf+9ee1ab4172,gcf0d15dbbd+a60788ef87,gdaeeff99f8+1cafcb7cd4,gdc0c513512+9ee1ab4172,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,geb961e4c1e+f9439d1e6f,gee10cc3b42+90ebb246c7,gf1cff7945b+9ee1ab4172,w.2024.12
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.