LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
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.

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.
Definition: FlagHandler.h:116
daf::base::PropertyList * list
Definition: fits.cc:913

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.

116  {
117  FlagDefinition flagDef = FlagDefinition(name, doc, _vector.size());
118  _vector.push_back(flagDef);
119  return _vector.back();
120  }
table::Key< std::string > name
Definition: Amplifier.cc:116

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

33  {
34  return add(FlagHandler::getFailureFlagName(), doc);
35 }
static std::string const & getFailureFlagName()
Define the universal name of the general failure flag.
Definition: FlagHandler.h:181

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

83 { return _vector[index]; }

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

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

◆ getEmptyList()

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

Definition at line 76 of file FlagHandler.h.

76  {
77  static FlagDefinitionList list;
78  return list;
79  }
FlagDefinitionList()
initialize a FlagDefinition list with no entries.
Definition: FlagHandler.h:65

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

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

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

96 { return getDefinition(index); }
FlagDefinition getDefinition(std::size_t index) const
get a reference to the FlagDefinition with specified index.
Definition: FlagHandler.h:83

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

125 { return _vector.size(); }

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