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

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
FieldBase &	operator= (FieldBase const &) noexcept=default
FieldBase &	operator= (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.

                         {
        throw LSST_EXCEPT(lsst::pex::exceptions::LogicError,
                          "Constructor disabled (this Field type is not sized).");
    }

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.

{ 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.

{ 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.

{ 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.

                                      {
    return TypeTraits<T>::getName();
}

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.

{ 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.

{ 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.

{ *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.

{}

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/afw/g7ae74a0b1c+a25e60b391/include/lsst/afw/table/FieldBase.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/afw/g7ae74a0b1c+a25e60b391/src/table/FieldBase.cc