LSST Applications g0265f82a02+093ff98f47,g02d81e74bb+10352d6f39,g1f3e9fa97e+40b0fc677d,g2079a07aa2+14824f138e,g2bbee38e9b+093ff98f47,g337abbeb29+093ff98f47,g3ddfee87b4+064c02c7ee,g487adcacf7+7e842ebf4b,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g568d43a26c+1d7ac31cb0,g591dd9f2cf+fb1f69e2ea,g858d7b2824+10352d6f39,g8a8a8dda67+a6fc98d2e7,g8cdfe0ae6a+66d966b544,g99cad8db69+7ce8a7c20a,g9ddcbc5298+d4bad12328,ga1e77700b3+246acaaf9c,ga2e4dd1c03+064c02c7ee,ga8c6da7877+04f6ba86dc,gae46bcf261+093ff98f47,gb0e22166c9+3863383f4c,gba4ed39666+9664299f35,gbb8dafda3b+db40f59a7d,gbeb006f7da+e6a448e96d,gbf5cecdb8a+10352d6f39,gc0f3af6251+10a3fd39cd,gc120e1dc64+5839e50a77,gc28159a63d+093ff98f47,gcf0d15dbbd+064c02c7ee,gd2a12a3803+0c2c227a2b,gdaeeff99f8+a38ce5ea23,ge79ae78c31+093ff98f47,gee10cc3b42+a6fc98d2e7,gf1cff7945b+10352d6f39,w.2024.15
LSST Data Management Base Package
Loading...
Searching...
No Matches
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.
 
 FlagDefinitionList (std::initializer_list< FlagDefinition > const &list)
 initialize a FlagDefinition list from initializer_list.
 
FlagDefinition getDefinition (std::size_t index) const
 get a reference to the FlagDefinition with specified index.
 
FlagDefinition getDefinition (std::string const &name) const
 get a reference to the FlagDefinition with specified name.
 
FlagDefinition operator[] (std::size_t index) const
 get a reference to the FlagDefinition with specified array index
 
bool hasDefinition (std::string const &name) const
 See if there is a FlagDefinition with specified name.
 
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.
 
FlagDefinition add (std::string const &name, std::string const &doc)
 Add a new FlagDefinition to this list.
 
std::size_t size () const
 return the current size (number of defined elements) of the collection
 

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.

65{};

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

70 {
71 for (FlagDefinition const* iter = list.begin(); iter < list.end(); iter++) {
72 add(iter->name, iter->doc);
73 }
74 }
FlagDefinition add(std::string const &name, std::string const &doc)
Add a new FlagDefinition to this list.

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

117 {
118 FlagDefinition flagDef = FlagDefinition(name, doc, _vector.size());
119 _vector.push_back(flagDef);
120 return _vector.back();
121 }

◆ 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 43 of file FlagHandler.cc.

43 {
45}
static std::string const & getFailureFlagName()
Define the universal name of the general failure flag.

◆ getDefinition() [1/2]

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

get a reference to the FlagDefinition with specified index.

Definition at line 33 of file FlagHandler.cc.

33 {
34 if (index >= _vector.size()) {
35 throw std::out_of_range((boost::format("Cannot access index %d of length=%d flag definition list.") %
36 index % _vector.size())
37 .str());
38 } else {
39 return _vector[index];
40 }
41}

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

88 {
89 for (std::size_t i = 0; i < size(); i++) {
90 if (_vector[i].name == name) return _vector[i];
91 }
92 throw FatalAlgorithmError("No Flag Definition for " + name);
93 }
std::size_t size() const
return the current size (number of defined elements) of the collection

◆ getEmptyList()

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

Definition at line 76 of file FlagHandler.h.

76 {
78 return list;
79 }
FlagDefinitionList()
initialize a FlagDefinition list with no entries.
Definition FlagHandler.h:65
daf::base::PropertyList * list
Definition fits.cc:932

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

101 {
102 for (std::size_t i = 0; i < size(); i++) {
103 if (_vector[i].name == name) return true;
104 }
105 return false;
106 }

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

97{ return getDefinition(index); }
FlagDefinition getDefinition(std::size_t index) const
get a reference to the FlagDefinition with specified index.

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

126{ return _vector.size(); }

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