LSST Applications g04c3c9f7ca+2075667efa,g1e125bf412+5f448d5fcf,g2079a07aa2+3e9fd84d81,g2305ad1205+b635cf1488,g2bbee38e9b+6c6beb4891,g337abbeb29+6c6beb4891,g33d1c0ed96+6c6beb4891,g3a166c0a6a+6c6beb4891,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+42f171e1e6,g5c3423f6d4+d536b04327,g607f77f49a+d536b04327,g6f43f06aed+ca1339dc19,g858d7b2824+d536b04327,g8ee334c5b4+d7f9608c2f,g9963eaa53e+b3dc1655d3,g998f4353bf+d536b04327,g99cad8db69+8ef2408349,g9ddcbc5298+9a081db1e4,ga1e77700b3+2cbb763275,gadfd92a7e4+aec2f3b930,gae0086650b+585e252eca,gb0e22166c9+0e73c8378f,gb3b7280ab2+cb5fdb229e,gbb8dafda3b+a327199e22,gc120e1dc64+88074880ea,gc28159a63d+6c6beb4891,gcdd4ae20e8+bd241b2308,gcde1bda545+903e937d91,gcf0d15dbbd+bd241b2308,gdaeeff99f8+f9a426f77a,gddc38dedce+585e252eca,ge79ae78c31+6c6beb4891,gfbcc870c63+b310236976,w.2024.23
LSST Data Management Base Package
Loading...
Searching...
No Matches
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::Field< Flag > lsst::afw::table::Key< float > lsst::afw::table::Key< afw::table::Flag > lsst::afw::table::Key< std::int64_t > lsst::afw::table::Key< int > lsst::afw::table::Key< lsst::afw::table::Array< int > > lsst::afw::table::Key< Element > lsst::afw::table::Key< lsst::geom::Angle > lsst::afw::table::Key< double > lsst::afw::table::Key< std::string > lsst::afw::table::Key< std::uint16_t > lsst::afw::table::Key< CentroidElement > lsst::afw::table::Key< ErrElement > lsst::afw::table::Key< meas::base::Flux > lsst::afw::table::Key< FluxErrElement > lsst::afw::table::Key< Mag > lsst::afw::table::Key< MagErrElement > lsst::afw::table::Key< Scalar > lsst::afw::table::Key< lsst::afw::table::Array< 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
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}

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