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

Specialization for Flag fields. More...

#include <Flag.h>

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

Public Types
typedef bool	Value
	the type returned by BaseRecord::get More...
typedef boost::int64_t	Element
	the actual storage type (shared by multiple flag fields) More...

Public Member Functions
int	getElementCount () const
	Return the number of subfield elements (always one for scalars). More...
	FieldBase ()
	FieldBase (int)

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

Detailed Description

template<>
struct lsst::afw::table::FieldBase< Flag >

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 27 of file Flag.h.

Member Typedef Documentation

typedef boost::int64_t lsst::afw::table::FieldBase< Flag >::Element

the actual storage type (shared by multiple flag fields)

Definition at line 30 of file Flag.h.

typedef bool lsst::afw::table::FieldBase< Flag >::Value

the type returned by BaseRecord::get

Definition at line 29 of file Flag.h.

Constructor & Destructor Documentation

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

inline

Definition at line 42 of file Flag.h.

{}

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

inline

Definition at line 43 of file Flag.h.

                   {
        throw LSST_EXCEPT(
            lsst::pex::exceptions::LogicError,
            "Constructor disabled (it only appears to exist as a workaround for a SWIG bug)."
        );
    }

Member Function Documentation

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

inline

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

Definition at line 33 of file Flag.h.

{ return 1; }

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

inlinestatic

Return a string description of the field type.

Definition at line 36 of file Flag.h.

{ return "Flag"; }

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

inlineprotected

Defines how fields are printed.

Definition at line 54 of file Flag.h.

{}

---

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

• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/table/Flag.h