lsst::afw::table::FieldBase< Flag > Struct Reference

Specialization for Flag fields. More...

#include <Flag.h>

Inheritance diagram for lsst::afw::table::FieldBase< Flag >:

Public Types
using	Value = bool
	the type returned by BaseRecord::get
using	Element = std::int64_t
	the actual storage type (shared by multiple flag fields)
using	Value
	the type returned by BaseRecord::get
using	Reference
	the type returned by BaseRecord::operator[] (non-const)
using	ConstReference
	the type returned by BaseRecord::operator[] (const)
using	Element
	the type of subfields (the same as the type itself for scalars)

Public Member Functions
std::size_t	getElementCount () const
	Return the number of subfield elements (always one for scalars).
	FieldBase ()=default
	FieldBase (std::size_t)
	FieldBase (FieldBase const &)=default
	FieldBase (FieldBase &&)=default
FieldBase &	operator= (FieldBase const &)=default
FieldBase &	operator= (FieldBase &&)=default
	~FieldBase ()=default
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.
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.
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

Specialization for Flag fields.

Flag fields are handled specially in many places, because their keys have both an offset into an integer element and the bit in that element; while other fields have one or more elements per field, Flags have multiple fields per element. This means we can't put all the custom code for Flag in FieldBase, and because Flags have an explicit Key specialization, we put the record access implementation in Key.

Definition at line 33 of file Flag.h.

Member Typedef Documentation

ConstReference

using lsst::afw::table::FieldBase< Flag >::ConstReference

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

Definition at line 44 of file FieldBase.h.

Element [1/2]

using lsst::afw::table::FieldBase< Flag >::Element

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

Definition at line 45 of file FieldBase.h.

Element [2/2]

using lsst::afw::table::FieldBase< Flag >::Element = std::int64_t

the actual storage type (shared by multiple flag fields)

Definition at line 35 of file Flag.h.

Reference

using lsst::afw::table::FieldBase< Flag >::Reference

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

Definition at line 43 of file FieldBase.h.

Value [1/2]

using lsst::afw::table::FieldBase< Flag >::Value

the type returned by BaseRecord::get

Definition at line 42 of file FieldBase.h.

Value [2/2]

using lsst::afw::table::FieldBase< Flag >::Value = bool

the type returned by BaseRecord::get

Definition at line 34 of file Flag.h.

Constructor & Destructor Documentation

FieldBase() [1/8]

lsst::afw::table::FieldBase< Flag >::FieldBase ( )

default

FieldBase() [2/8]

lsst::afw::table::FieldBase< Flag >::FieldBase ( std::size_t )

inline

Definition at line 47 of file Flag.h.

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

FieldBase() [3/8]

lsst::afw::table::FieldBase< Flag >::FieldBase ( FieldBase< Flag > const & )

default

FieldBase() [4/8]

lsst::afw::table::FieldBase< Flag >::FieldBase ( FieldBase< Flag > && )

default

~FieldBase() [1/2]

lsst::afw::table::FieldBase< Flag >::~FieldBase ( )

default

FieldBase() [5/8]

lsst::afw::table::FieldBase< Flag >::FieldBase ( )

default

FieldBase() [6/8]

lsst::afw::table::FieldBase< Flag >::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() [7/8]

lsst::afw::table::FieldBase< Flag >::FieldBase ( FieldBase< Flag > const & )

defaultnoexcept

FieldBase() [8/8]

lsst::afw::table::FieldBase< Flag >::FieldBase ( FieldBase< Flag > && )

defaultnoexcept

~FieldBase() [2/2]

lsst::afw::table::FieldBase< Flag >::~FieldBase ( )

defaultnoexcept

Member Function Documentation

getConstReference()

ConstReference lsst::afw::table::FieldBase< Flag >::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() [1/2]

std::size_t lsst::afw::table::FieldBase< Flag >::getElementCount ( ) const

inline

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

Definition at line 38 of file Flag.h.

{ return 1; }

getElementCount() [2/2]

std::size_t lsst::afw::table::FieldBase< Flag >::getElementCount ( ) const

inlinenoexcept

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

Definition at line 48 of file FieldBase.h.

{ return 1; }

getReference()

Reference lsst::afw::table::FieldBase< Flag >::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() [1/2]

std::string lsst::afw::table::FieldBase< Flag >::getTypeString ( )

static

Return a string description of the field type.

Definition at line 51 of file FieldBase.cc.

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

getTypeString() [2/2]

static std::string lsst::afw::table::FieldBase< Flag >::getTypeString ( )

inlinestatic

Return a string description of the field type.

Definition at line 41 of file Flag.h.

{ return "Flag"; }

getValue()

Value lsst::afw::table::FieldBase< Flag >::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()

static FieldBase lsst::afw::table::FieldBase< Flag >::makeDefault ( )

inlinestaticprotectednoexcept

Needed to allow Keys to be default-constructed.

Definition at line 69 of file FieldBase.h.

{ return FieldBase(); }

operator=() [1/4]

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

defaultnoexcept

operator=() [2/4]

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

default

operator=() [3/4]

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

defaultnoexcept

operator=() [4/4]

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

default

setValue()

void lsst::afw::table::FieldBase< Flag >::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() [1/2]

void lsst::afw::table::FieldBase< Flag >::stream ( std::ostream & os ) const

inlineprotected

Defines how Fields are printed.

Definition at line 72 of file FieldBase.h.

{}

stream() [2/2]

void lsst::afw::table::FieldBase< Flag >::stream ( std::ostream & os ) const

inlineprotected

Defines how fields are printed.

Definition at line 60 of file Flag.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/Flag.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/afw/g7ae74a0b1c+a25e60b391/src/table/FieldBase.cc