LSSTApplications  19.0.0-10-g920eed2,19.0.0-11-g48a0200+2,19.0.0-18-gfc4e62b+11,19.0.0-2-g3b2f90d+2,19.0.0-2-gd671419+5,19.0.0-20-g5a5a17ab+9,19.0.0-21-g2644856+11,19.0.0-22-gc5dc5b1+6,19.0.0-23-gdc29a50+3,19.0.0-24-g923e380+11,19.0.0-25-g6c8df7140,19.0.0-28-g9b887e2,19.0.0-3-g2b32d65+5,19.0.0-3-g8227491+10,19.0.0-3-g9c54d0d+10,19.0.0-3-gca68e65+6,19.0.0-3-gcfc5f51+5,19.0.0-3-ge110943+9,19.0.0-3-ge74d124,19.0.0-3-gfe04aa6+11,19.0.0-4-g06f5963+5,19.0.0-4-g3d16501+11,19.0.0-4-g4a9c019+5,19.0.0-4-g5a8b323,19.0.0-4-g66397f0+1,19.0.0-4-g8278b9b+1,19.0.0-4-g8557e14,19.0.0-4-g8964aba+11,19.0.0-4-ge404a01+10,19.0.0-5-g40f3a5a,19.0.0-5-g4db63b3,19.0.0-5-gfb03ce7+11,19.0.0-6-gbaebbfb+10,19.0.0-60-gafafd468+11,19.0.0-67-g3ab1e6e,19.0.0-7-g039c0b5+9,19.0.0-7-gbea9075+4,19.0.0-7-gc567de5+11,19.0.0-8-g3a3ce09+6,19.0.0-9-g463f923+10,w.2020.21
LSSTDataManagementBasePackage
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  }

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  }

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

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

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

◆ 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); }

◆ 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:
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
lsst::meas::base::FlagDefinitionList::add
FlagDefinition add(std::string const &name, std::string const &doc)
Add a new FlagDefinition to this list.
Definition: FlagHandler.h:116
lsst::meas::base::FlagHandler::getFailureFlagName
static std::string const & getFailureFlagName()
Define the universal name of the general failure flag.
Definition: FlagHandler.h:181
lsst::meas::base::FlagDefinitionList::size
std::size_t size() const
return the current size (number of defined elements) of the collection
Definition: FlagHandler.h:125
list
daf::base::PropertyList * list
Definition: fits.cc:913
lsst::meas::base::FlagDefinitionList::FlagDefinitionList
FlagDefinitionList()
initialize a FlagDefinition list with no entries.
Definition: FlagHandler.h:65
std::size_t
lsst::meas::base::FlagDefinitionList::getDefinition
FlagDefinition getDefinition(std::size_t index) const
get a reference to the FlagDefinition with specified index.
Definition: FlagHandler.h:83
astshim.fitsChanContinued.iter
def iter(self)
Definition: fitsChanContinued.py:88