lsst.afw g4f4f280218+33796f850d
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Friends | List of all members
lsst::afw::table::Field< T > Struct Template Reference

A description of a field in a table. More...

#include <Field.h>

Inheritance diagram for lsst::afw::table::Field< T >:
lsst::afw::table::FieldBase< T >

Public Types

using Element = typename FieldBase< T >::Element
 Type used to store field data in the table (a field may have multiple elements). More...
 
using Value = T
 the type returned by BaseRecord::get More...
 
using Reference = T &
 the type returned by BaseRecord::operator[] (non-const) More...
 
using ConstReference = const T &
 the type returned by BaseRecord::operator[] (const) More...
 

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. More...
 
 Field (std::string const &name, std::string const &doc, FieldBase< T > const &size)
 Construct a new field. More...
 
 Field (Field const &)=default
 
 Field (Field &&) noexcept=default
 
Fieldoperator= (Field const &)=default
 
Fieldoperator= (Field &&) noexcept=default
 
 ~Field () noexcept=default
 
std::string const & getName () const noexcept
 Return the name of the field. More...
 
std::string const & getDoc () const noexcept
 Return the documentation for the field. More...
 
std::string const & getUnits () const noexcept
 Return the units for the field. More...
 
Field< T > copyRenamed (std::string const &newName) const
 Return a new Field with a new name and other properties the same as this. More...
 
std::size_t getElementCount () const noexcept
 Return the number of subfield elements (always one for scalars). More...
 

Static Public Member Functions

static std::string getTypeString ()
 Return a string description of the field type. More...
 

Protected Member Functions

void stream (std::ostream &os) const
 Defines how Fields are printed. More...
 
Reference getReference (Element *p, ndarray::Manager::Ptr const &) const
 Used to implement BaseRecord::operator[] (non-const). More...
 
ConstReference getConstReference (Element const *p, ndarray::Manager::Ptr const &) const
 Used to implement BaseRecord::operator[] (const). More...
 
Value getValue (Element const *p, ndarray::Manager::Ptr const &) const
 Used to implement BaseRecord::get. More...
 
void setValue (Element *p, ndarray::Manager::Ptr const &, Value v) const
 Used to implement BaseRecord::set. More...
 

Static Protected Member Functions

static FieldBase makeDefault () noexcept
 Needed to allow Keys to be default-constructed. More...
 

Friends

std::ostreamoperator<< (std::ostream &os, Field< T > const &field)
 Stringification. More...
 

Detailed Description

template<typename T>
struct lsst::afw::table::Field< T >

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.

Definition at line 24 of file Field.h.

Member Typedef Documentation

◆ ConstReference

template<typename T >
using lsst::afw::table::FieldBase< T >::ConstReference = const T &
inherited

the type returned by BaseRecord::operator[] (const)

Definition at line 44 of file FieldBase.h.

◆ Element

template<typename T >
using lsst::afw::table::Field< T >::Element = typename FieldBase<T>::Element

Type used to store field data in the table (a field may have multiple elements).

Definition at line 26 of file Field.h.

◆ Reference

template<typename T >
using lsst::afw::table::FieldBase< T >::Reference = T &
inherited

the type returned by BaseRecord::operator[] (non-const)

Definition at line 43 of file FieldBase.h.

◆ Value

template<typename T >
using lsst::afw::table::FieldBase< T >::Value = T
inherited

the type returned by BaseRecord::get

Definition at line 42 of file FieldBase.h.

Constructor & Destructor Documentation

◆ Field() [1/4]

template<typename T >
lsst::afw::table::Field< T >::Field ( std::string const &  name,
std::string const &  doc,
std::string const &  units = "",
FieldBase< T > const &  size = FieldBase<T>() 
)
inline

Construct a new field.

Parameters
[in]nameName 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]docDocumentation for the field. Should not contain single-quotes to avoid FITS round-trip problems.
[in]unitsUnits for the field. Should not contain single-quotes to avoid FITS round-trip problems.
[in]sizeSize 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.

◆ Field() [2/4]

template<typename T >
lsst::afw::table::Field< T >::Field ( std::string const &  name,
std::string const &  doc,
FieldBase< T > const &  size 
)
inline

Construct a new field.

Parameters
[in]nameName 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]docDocumentation for the field.
[in]sizeSize 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.

◆ Field() [3/4]

template<typename T >
lsst::afw::table::Field< T >::Field ( Field< T > const &  )
default

◆ Field() [4/4]

template<typename T >
lsst::afw::table::Field< T >::Field ( Field< T > &&  )
defaultnoexcept

◆ ~Field()

template<typename T >
lsst::afw::table::Field< T >::~Field ( )
defaultnoexcept

Member Function Documentation

◆ copyRenamed()

template<typename T >
Field< T > lsst::afw::table::Field< T >::copyRenamed ( std::string const &  newName) const
inline

Return a new Field with a new name and other properties the same as this.

Definition at line 89 of file Field.h.

◆ getConstReference()

template<typename T >
ConstReference lsst::afw::table::FieldBase< T >::getConstReference ( Element const *  p,
ndarray::Manager::Ptr const &   
) const
inlineprotectedinherited

Used to implement BaseRecord::operator[] (const).

Definition at line 78 of file FieldBase.h.

◆ getDoc()

template<typename T >
std::string const & lsst::afw::table::Field< T >::getDoc ( ) const
inlinenoexcept

Return the documentation for the field.

Definition at line 74 of file Field.h.

◆ getElementCount()

template<typename T >
std::size_t lsst::afw::table::FieldBase< T >::getElementCount ( ) const
inlinenoexceptinherited

Return the number of subfield elements (always one for scalars).

Definition at line 48 of file FieldBase.h.

◆ getName()

template<typename T >
std::string const & lsst::afw::table::Field< T >::getName ( ) const
inlinenoexcept

Return the name of the field.

Definition at line 71 of file Field.h.

◆ getReference()

template<typename T >
Reference lsst::afw::table::FieldBase< T >::getReference ( Element p,
ndarray::Manager::Ptr const &   
) const
inlineprotectedinherited

Used to implement BaseRecord::operator[] (non-const).

Definition at line 75 of file FieldBase.h.

◆ getTypeString()

template<typename T >
std::string lsst::afw::table::FieldBase< T >::getTypeString
staticinherited

Return a string description of the field type.

Definition at line 56 of file FieldBase.cc.

◆ getUnits()

template<typename T >
std::string const & lsst::afw::table::Field< T >::getUnits ( ) const
inlinenoexcept

Return the units for the field.

Definition at line 77 of file Field.h.

◆ getValue()

template<typename T >
Value lsst::afw::table::FieldBase< T >::getValue ( Element const *  p,
ndarray::Manager::Ptr const &   
) const
inlineprotectedinherited

Used to implement BaseRecord::get.

Definition at line 81 of file FieldBase.h.

◆ makeDefault()

template<typename T >
static FieldBase lsst::afw::table::FieldBase< T >::makeDefault ( )
inlinestaticprotectednoexceptinherited

Needed to allow Keys to be default-constructed.

Definition at line 69 of file FieldBase.h.

◆ operator=() [1/2]

template<typename T >
Field & lsst::afw::table::Field< T >::operator= ( Field< T > &&  )
defaultnoexcept

◆ operator=() [2/2]

template<typename T >
Field & lsst::afw::table::Field< T >::operator= ( Field< T > const &  )
default

◆ setValue()

template<typename T >
void lsst::afw::table::FieldBase< T >::setValue ( Element p,
ndarray::Manager::Ptr const &  ,
Value  v 
) const
inlineprotectedinherited

Used to implement BaseRecord::set.

Definition at line 84 of file FieldBase.h.

◆ stream()

template<typename T >
void lsst::afw::table::FieldBase< T >::stream ( std::ostream os) const
inlineprotectedinherited

Defines how Fields are printed.

Definition at line 72 of file FieldBase.h.

Friends And Related Function Documentation

◆ operator<<

template<typename T >
std::ostream & operator<< ( std::ostream os,
Field< T > const &  field 
)
friend

Stringification.

Definition at line 80 of file Field.h.


The documentation for this struct was generated from the following file: