lsst::meas::base::FlagDefinition Struct Reference

Simple class used to define and document flags The name and doc constitute the identity of the FlagDefinition The number is used for indexing, but is assigned arbitrarily. More...

#include <FlagHandler.h>

Public Member Functions
	FlagDefinition ()
	FlagDefinition (std::string const &name, std::string const &doc, std::size_t number=number_undefined)
bool	operator== (FlagDefinition const &other) const
bool	operator!= (FlagDefinition const &other) const

Public Attributes
std::string	name
std::string	doc
std::size_t	number

Static Public Attributes
static constexpr std::size_t	number_undefined = SIZE_MAX

Detailed Description

Simple class used to define and document flags The name and doc constitute the identity of the FlagDefinition The number is used for indexing, but is assigned arbitrarily.

Definition at line 40 of file FlagHandler.h.

Constructor & Destructor Documentation

FlagDefinition() [1/2]

lsst::meas::base::FlagDefinition::FlagDefinition ( )

inline

Definition at line 43 of file FlagHandler.h.

: name(), doc(), number() {}

FlagDefinition() [2/2]

lsst::meas::base::FlagDefinition::FlagDefinition ( std::string const &  name, std::string const &  doc, std::size_t  number = number_undefined  )

inline

Definition at line 45 of file FlagHandler.h.

            : name(name), doc(doc), number(number) {}

Member Function Documentation

operator!=()

bool lsst::meas::base::FlagDefinition::operator!= ( FlagDefinition const &  other ) const

inline

Definition at line 50 of file FlagHandler.h.

{ return (other.name != name); }

operator==()

bool lsst::meas::base::FlagDefinition::operator== ( FlagDefinition const &  other ) const

inline

Definition at line 49 of file FlagHandler.h.

{ return (other.name == name); }

Member Data Documentation

doc

std::string lsst::meas::base::FlagDefinition::doc

Definition at line 53 of file FlagHandler.h.

name

std::string lsst::meas::base::FlagDefinition::name

Definition at line 52 of file FlagHandler.h.

number

std::size_t lsst::meas::base::FlagDefinition::number

Definition at line 54 of file FlagHandler.h.

number_undefined

constexpr std::size_t lsst::meas::base::FlagDefinition::number_undefined = SIZE_MAX

staticconstexpr

Definition at line 41 of file FlagHandler.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_base/22.0.1-25-gb120d7b+8b5510f75f/include/lsst/meas/base/FlagHandler.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_base/22.0.1-25-gb120d7b+8b5510f75f/src/FlagHandler.cc