lsst.meas.base  21.0.0-13-g64487bb+c861f1fb05
Public Member Functions | Static Public Member Functions | List of all members
lsst::meas::base::FlagDefinitionList Class Reference

vector-type utility class to build a collection of FlagDefinitions More...

#include <FlagHandler.h>

Public Member Functions

 FlagDefinitionList ()
 initialize a FlagDefinition list with no entries. More...
 
 FlagDefinitionList (std::initializer_list< FlagDefinition > const &list)
 initialize a FlagDefinition list from initializer_list. More...
 
FlagDefinition getDefinition (std::size_t index) const
 get a reference to the FlagDefinition with specified index. More...
 
FlagDefinition getDefinition (std::string const &name) const
 get a reference to the FlagDefinition with specified name. More...
 
FlagDefinition operator[] (std::size_t index) const
 get a reference to the FlagDefinition with specified array index More...
 
bool hasDefinition (std::string const &name) const
 See if there is a FlagDefinition with specified name. More...
 
FlagDefinition addFailureFlag (std::string const &doc="General Failure Flag")
 Add a Flag Defintion to act as a "General" failure flag This flag will be set if a Measurement error is thrown. More...
 
FlagDefinition add (std::string const &name, std::string const &doc)
 Add a new FlagDefinition to this list. More...
 
std::size_t size () const
 return the current size (number of defined elements) of the collection More...
 

Static Public Member Functions

static FlagDefinitionList const & getEmptyList ()
 

Detailed Description

vector-type utility class to build a collection of FlagDefinitions

Definition at line 60 of file FlagHandler.h.

Constructor & Destructor Documentation

◆ FlagDefinitionList() [1/2]

lsst::meas::base::FlagDefinitionList::FlagDefinitionList ( )
inline

initialize a FlagDefinition list with no entries.

Definition at line 65 of file FlagHandler.h.

◆ FlagDefinitionList() [2/2]

lsst::meas::base::FlagDefinitionList::FlagDefinitionList ( std::initializer_list< FlagDefinition > const &  list)
inline

initialize a FlagDefinition list from initializer_list.

Definition at line 70 of file FlagHandler.h.

Member Function Documentation

◆ add()

FlagDefinition lsst::meas::base::FlagDefinitionList::add ( std::string const &  name,
std::string const &  doc 
)
inline

Add a new FlagDefinition to this list.

Return a copy with the FlagDefinition.number set corresponding to its index in the list.

Definition at line 116 of file FlagHandler.h.

◆ addFailureFlag()

FlagDefinition lsst::meas::base::FlagDefinitionList::addFailureFlag ( std::string const &  doc = "General Failure Flag")

Add a Flag Defintion to act as a "General" failure flag This flag will be set if a Measurement error is thrown.

Definition at line 33 of file FlagHandler.cc.

◆ getDefinition() [1/2]

FlagDefinition lsst::meas::base::FlagDefinitionList::getDefinition ( std::size_t  index) const
inline

get a reference to the FlagDefinition with specified index.

Definition at line 83 of file FlagHandler.h.

◆ getDefinition() [2/2]

FlagDefinition lsst::meas::base::FlagDefinitionList::getDefinition ( std::string const &  name) const
inline

get a reference to the FlagDefinition with specified name.

Definition at line 87 of file FlagHandler.h.

◆ getEmptyList()

static FlagDefinitionList const& lsst::meas::base::FlagDefinitionList::getEmptyList ( )
inlinestatic

Definition at line 76 of file FlagHandler.h.

◆ hasDefinition()

bool lsst::meas::base::FlagDefinitionList::hasDefinition ( std::string const &  name) const
inline

See if there is a FlagDefinition with specified name.

Definition at line 100 of file FlagHandler.h.

◆ operator[]()

FlagDefinition lsst::meas::base::FlagDefinitionList::operator[] ( std::size_t  index) const
inline

get a reference to the FlagDefinition with specified array index

Definition at line 96 of file FlagHandler.h.

◆ size()

std::size_t lsst::meas::base::FlagDefinitionList::size ( ) const
inline

return the current size (number of defined elements) of the collection

Definition at line 125 of file FlagHandler.h.


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