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
|
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 |
|
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 |
|
staticinherited |
Return a string description of the field type.
Definition at line 56 of file FieldBase.cc.
|
inlinenoexcept |
|
inlineprotectedinherited |
|
inlinestaticprotectednoexceptinherited |
|
defaultnoexcept |
|
default |
|
inlineprotectedinherited |
|
inlineprotectedinherited |
|
friend |
Stringification.
Definition at line 80 of file Field.h.