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)

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

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.

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

Element

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.

Value

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/4]

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

default

FieldBase() [2/4]

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/4]

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

default

FieldBase() [4/4]

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

default

~FieldBase()

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

default

Member Function Documentation

getElementCount()

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; }

getTypeString()

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"; }

operator=() [1/2]

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

default

operator=() [2/2]

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

default

stream()

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/include/lsst/afw/table/Flag.h