LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
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< ErrElement > lsst::afw::table::Key< Scalar > lsst::afw::table::Key< MagErrElement > lsst::afw::table::Key< double > lsst::afw::table::Key< std::uint16_t > lsst::afw::table::Key< CentroidElement > lsst::afw::table::Key< float > lsst::afw::table::Key< int > lsst::afw::table::Key< afw::table::Flag > lsst::afw::table::Key< afw::table::Array< Scalar > > lsst::afw::table::Key< Mag > lsst::afw::table::Key< lsst::geom::Angle > lsst::afw::table::Key< FluxErrElement > lsst::afw::table::Key< lsst::afw::table::Array< Scalar > > lsst::afw::table::Key< lsst::afw::table::Array< int > > lsst::afw::table::Key< std::int64_t > lsst::afw::table::Key< meas::base::Flux > lsst::afw::table::Field< T > lsst::afw::table::Key< T >

Public Types

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

Public Member Functions

std::size_t getElementCount () const noexcept
 Return the number of subfield elements (always one for scalars). More...
 
 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. 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...
 

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
Reports errors in the logical structure of the program.
Definition: Runtime.h:46

◆ 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  {
57  return TypeTraits<T>::getName();
58 }
std::string const & getName() const noexcept
Return a filter's name.
Definition: Filter.h:78

◆ 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: