lsst::afw::table::Key< Flag > Class Reference

Key specialization for Flag. More...

#include <Flag.h>

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

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

Public Member Functions
template<typename OtherT >
bool	operator== (Key< OtherT > const &other) const
	Equality comparison. More...
template<typename OtherT >
bool	operator!= (Key< OtherT > const &other) const
bool	operator== (Key const &other) const
bool	operator!= (Key const &other) const
std::size_t	hash_value () const noexcept
	Return a hash of this object. More...
std::size_t	getOffset () const
	Return the offset in bytes of the integer element that holds this field's bit. More...
std::size_t	getBit () const
	The index of this field's bit within the integer it shares with other Flag fields. More...
bool	isValid () const
	Return true if the key was initialized to valid offset. More...
	Key ()
	Default construct a field. More...
	Key (Key const &)=default
	Key (Key &&)=default
Key &	operator= (Key const &)=default
Key &	operator= (Key &&)=default
	~Key ()=default
Key< FieldBase< Flag >::Element >	getStorage () const
	Return a key corresponding to the integer element where this field's bit is packed. More...
std::size_t	getElementCount () const
	Return the number of subfield elements (always one for scalars). More...

Static Public Member Functions
static std::string	getTypeString ()
	Return a string description of the field type. More...

Static Public Attributes
static bool const	HAS_NAMED_SUBFIELDS = false

Protected Member Functions
void	stream (std::ostream &os) const
	Defines how fields are printed. More...

Friends
class	detail::Access
class	BaseRecord
std::ostream &	operator<< (std::ostream &os, Key< Flag > const &key)
	Stringification. More...

Detailed Description

Key specialization for Flag.

Flag fields are special; their keys need to contain not only the offset to the integer element they share with other Flag fields, but also their position in that shared field.

Flag fields operate mostly like a bool field, but they do not support reference access, and internally they are packed into an integer shared by multiple fields so the marginal cost of each Flag field is only one bit.

Definition at line 94 of file Flag.h.

Member Typedef Documentation

Element

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

inherited

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

inherited

the type returned by BaseRecord::get

Definition at line 34 of file Flag.h.

Constructor & Destructor Documentation

Key() [1/3]

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

inline

Default construct a field.

The new field will be invalid until a valid Key is assigned to it.

Definition at line 146 of file Flag.h.

: FieldBase<Flag>(), _offset(0), _bit(0), _valid(false) {}

Key() [2/3]

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

default

Key() [3/3]

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

default

~Key()

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

default

Member Function Documentation

getBit()

std::size_t lsst::afw::table::Key< Flag >::getBit ( ) const

inline

The index of this field's bit within the integer it shares with other Flag fields.

Definition at line 129 of file Flag.h.

{ return _bit; }

getElementCount()

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

inlineinherited

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

Definition at line 38 of file Flag.h.

{ return 1; }

getOffset()

std::size_t lsst::afw::table::Key< Flag >::getOffset ( ) const

inline

Return the offset in bytes of the integer element that holds this field's bit.

Definition at line 126 of file Flag.h.

{ return _offset; }

getStorage()

Key< FieldBase< Flag >::Element > lsst::afw::table::KeyBase< Flag >::getStorage ( ) const

inherited

Return a key corresponding to the integer element where this field's bit is packed.

Definition at line 15 of file KeyBase.cc.

                                                            {
    return detail::Access::extractElement(*this, 0);
}

getTypeString()

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

inlinestaticinherited

Return a string description of the field type.

Definition at line 41 of file Flag.h.

{ return "Flag"; }

hash_value()

std::size_t lsst::afw::table::Key< Flag >::hash_value ( ) const

inlinenoexcept

Return a hash of this object.

Definition at line 120 of file Flag.h.

                                          {
        // Completely arbitrary seed
        return utils::hashCombine(17, _offset, _bit);
    }

isValid()

bool lsst::afw::table::Key< Flag >::isValid ( ) const

inline

Return true if the key was initialized to valid offset.

This does not guarantee that a key is valid with any particular schema, or even that any schemas still exist in which this key is valid.

A key that is default constructed will always be invalid.

Definition at line 139 of file Flag.h.

{ return _valid; }

operator!=() [1/2]

bool lsst::afw::table::Key< Flag >::operator!= ( Key< Flag > const &  other ) const

inline

Definition at line 116 of file Flag.h.

{ return !this->operator==(other); }

operator!=() [2/2]

template<typename OtherT >

bool lsst::afw::table::Key< Flag >::operator!= ( Key< OtherT > const &  other ) const

inline

Definition at line 111 of file Flag.h.

                                                    {
        return true;
    }

operator=() [1/2]

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

default

operator=() [2/2]

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

default

operator==() [1/2]

bool lsst::afw::table::Key< Flag >::operator== ( Key< Flag > const &  other ) const

inline

Definition at line 115 of file Flag.h.

{ return _offset == other._offset && _bit == other._bit; }

operator==() [2/2]

template<typename OtherT >

bool lsst::afw::table::Key< Flag >::operator== ( Key< OtherT > const &  other ) const

inline

Equality comparison.

Two keys with different types are never equal. Keys with the same type are equal if they point to the same location in a table, regardless of what Schema they were constructed from (for instance, if a field has a different name in one Schema than another, but is otherwise the same, the two keys will be equal).

Definition at line 107 of file Flag.h.

                                                    {
        return false;
    }

stream()

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

inlineprotectedinherited

Defines how fields are printed.

Definition at line 60 of file Flag.h.

{}

Friends And Related Function Documentation

BaseRecord

friend class BaseRecord

friend

Definition at line 162 of file Flag.h.

detail::Access

friend class detail::Access

friend

Definition at line 161 of file Flag.h.

operator<<

std::ostream& operator<< ( std::ostream &  os, Key< Flag > const &  key  )

friend

Stringification.

Definition at line 155 of file Flag.h.

                                                                               {
        return os << "Key['" << Key<Flag>::getTypeString() << "'](offset=" << key.getOffset()
                  << ", bit=" << key.getBit() << ")";
    }

Member Data Documentation

HAS_NAMED_SUBFIELDS

bool const lsst::afw::table::KeyBase< Flag >::HAS_NAMED_SUBFIELDS = false

staticinherited

Definition at line 69 of file Flag.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/include/lsst/afw/table/Flag.h