LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
LSST Data Management Base Package
Loading...
Searching...
No Matches
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: