lsst.meas.base  14.0-17-g4f4ea82
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
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 38 of file FlagHandler.h.

Constructor & Destructor Documentation

◆ FlagDefinition() [1/2]

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

Definition at line 42 of file FlagHandler.h.

◆ 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 44 of file FlagHandler.h.

Member Function Documentation

◆ operator!=()

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

Definition at line 51 of file FlagHandler.h.

◆ operator==()

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

Definition at line 48 of file FlagHandler.h.

Member Data Documentation

◆ doc

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

Definition at line 56 of file FlagHandler.h.

◆ name

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

Definition at line 55 of file FlagHandler.h.

◆ number

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

Definition at line 57 of file FlagHandler.h.

◆ number_undefined

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

Definition at line 40 of file FlagHandler.h.


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