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
typedef T	Value
	the type returned by BaseRecord::get More...
typedef T &	Reference
	the type returned by BaseRecord::operator[] (non-const) More...
typedef T const &	ConstReference
	the type returned by BaseRecord::operator[] (const) More...
typedef T	Element
	the type of subfields (the same as the type itself for scalars) More...

Public Member Functions
int	getElementCount () const noexcept
	Return the number of subfield elements (always one for scalars). More...
	FieldBase ()=default
	FieldBase (int)
	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. 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 43 of file FieldBase.h.

Member Typedef Documentation

ConstReference

template<typename T>

typedef T const& lsst::afw::table::FieldBase< T >::ConstReference

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

Definition at line 46 of file FieldBase.h.

Element

template<typename T>

typedef T lsst::afw::table::FieldBase< T >::Element

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

Definition at line 47 of file FieldBase.h.

Reference

template<typename T>

typedef T& lsst::afw::table::FieldBase< T >::Reference

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

Definition at line 45 of file FieldBase.h.

Value

template<typename T>

typedef T lsst::afw::table::FieldBase< T >::Value

the type returned by BaseRecord::get

Definition at line 44 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 ( int  )

inline

Definition at line 59 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 80 of file FieldBase.h.

{ return *p; }

getElementCount()

template<typename T>

int lsst::afw::table::FieldBase< T >::getElementCount ( ) const

inlinenoexcept

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

Definition at line 50 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 77 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 83 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 71 of file FieldBase.h.

{ return FieldBase(); }

operator=() [1/2]

template<typename T>

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

defaultnoexcept

operator=() [2/2]

template<typename T>

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

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 86 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 74 of file FieldBase.h.

{}

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/afw/19.0.0-4-ga671dab3b+1/include/lsst/afw/table/FieldBase.h
• /j/snowflake/release/lsstsw/stack/Linux64/afw/19.0.0-4-ga671dab3b+1/src/table/FieldBase.cc