Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04a91732dc+a777afbe81,g07dc498a13+7e3c5f68a2,g12483e3c20+0145ec33cd,g1409bbee79+7e3c5f68a2,g1a7e361dbc+7e3c5f68a2,g1fd858c14a+9f35e23ec3,g31cf31e263+9c59251d59,g35bb328faa+fcb1d3bbc8,g3ad4f90e5c+0145ec33cd,g3bd4b5ce2c+9e43d17133,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g5477a8d5ce+d2270fb7b7,g60b5630c4e+0145ec33cd,g623d845a50+0145ec33cd,g6f0c2978f1+a406a63c6f,g75b6c65c88+d54b601591,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+4639f750a5,g89139ef638+7e3c5f68a2,g9125e01d80+fcb1d3bbc8,g95236ca021+f7a31438ed,g989de1cb63+7e3c5f68a2,g9f33ca652e+2d6fa11d35,gaaedd4e678+7e3c5f68a2,gabe3b4be73+1e0a283bba,gb1101e3267+4a428ef779,gb4a253aaf5+0122250889,gb58c049af0+f03b321e39,gc99c83e5f0+76d20ab76d,gcf25f946ba+4639f750a5,gd0fa69b896+890c3b4faa,gd6cbbdb0b4+c8606af20c,gde0f65d7ad+c2b4c879fb,ge278dab8ac+932305ba37,gfba249425e+fcb1d3bbc8,w.2025.07
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
lsst::afw::table::FieldBase< T > Struct Template Reference

Field base class default implementation (used for numeric scalars and lsst::geom::Angle). More...

#include <FieldBase.h>

Inheritance diagram for lsst::afw::table::FieldBase< T >:
lsst::afw::table::Key< afw::table::Flag > lsst::afw::table::Key< lsst::afw::table::Flag > lsst::afw::table::Key< double > lsst::afw::table::Key< Scalar > lsst::afw::table::Key< afw::table::Array< Scalar > > lsst::afw::table::Field< T > lsst::afw::table::Key< T >

Public Types

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)
 
using Element = T
 the type of subfields (the same as the type itself for scalars)
 

Public Member Functions

std::size_t getElementCount () const noexcept
 Return the number of subfield elements (always one for scalars).
 
 FieldBase ()=default
 
 FieldBase (std::size_t)
 
 FieldBase (FieldBase const &) noexcept=default
 
 FieldBase (FieldBase &&) noexcept=default
 
FieldBaseoperator= (FieldBase const &) noexcept=default
 
FieldBaseoperator= (FieldBase &&) noexcept=default
 
 ~FieldBase () noexcept=default
 

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.
 

Detailed Description

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

Field base class default implementation (used for numeric scalars and lsst::geom::Angle).

Definition at line 41 of file FieldBase.h.

Member Typedef Documentation

◆ ConstReference

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

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

Definition at line 44 of file FieldBase.h.

◆ Element

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

the type of subfields (the same as the type itself for scalars)

Definition at line 45 of file FieldBase.h.

◆ Reference

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

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

the type returned by BaseRecord::get

Definition at line 42 of file FieldBase.h.

Constructor & Destructor Documentation

◆ FieldBase() [1/4]

template<typename T>
lsst::afw::table::FieldBase< T >::FieldBase ( )
default

◆ FieldBase() [2/4]

template<typename T>
lsst::afw::table::FieldBase< T >::FieldBase ( std::size_t )
inline

Definition at line 57 of file FieldBase.h.

57 {
59 "Constructor disabled (this Field type is not sized).");
60 }
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition Exception.h:48
Field base class default implementation (used for numeric scalars and lsst::geom::Angle).
Definition FieldBase.h:41

◆ FieldBase() [3/4]

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

◆ FieldBase() [4/4]

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

◆ ~FieldBase()

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

Member Function Documentation

◆ getConstReference()

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

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

Definition at line 78 of file FieldBase.h.

78{ return *p; }

◆ getElementCount()

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

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

Definition at line 48 of file FieldBase.h.

48{ return 1; }

◆ getReference()

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

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

Definition at line 75 of file FieldBase.h.

75{ return *p; }

◆ getTypeString()

template<typename T>
std::string lsst::afw::table::FieldBase< T >::getTypeString ( )
static

Return a string description of the field type.

Definition at line 56 of file FieldBase.cc.

56 {
58}

◆ getValue()

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

Used to implement BaseRecord::get.

Definition at line 81 of file FieldBase.h.

81{ return *p; }

◆ makeDefault()

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

Needed to allow Keys to be default-constructed.

Definition at line 69 of file FieldBase.h.

69{ return FieldBase(); }

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ setValue()

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

Used to implement BaseRecord::set.

Definition at line 84 of file FieldBase.h.

84{ *p = v; }

◆ stream()

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

Defines how Fields are printed.

Definition at line 72 of file FieldBase.h.

72{}

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