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.

{};

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.

                                                                        {
        for (FlagDefinition const* iter = list.begin(); iter < list.end(); iter++) {
            add(iter->name, iter->doc);
        }
    }

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.

                                                                    {
        FlagDefinition flagDef = FlagDefinition(name, doc, _vector.size());
        _vector.push_back(flagDef);
        return _vector.back();
    }

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.

                                                                      {
    return add(FlagHandler::getFailureFlagName(), doc);
}

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.

                                                                      {
    if (index >= _vector.size()) {
        throw std::out_of_range((boost::format("Cannot access index %d of length=%d flag definition list.") %
                                 index % _vector.size())
                                        .str());
    } else {
        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 88 of file FlagHandler.h.

                                                              {
        for (std::size_t i = 0; i < size(); i++) {
            if (_vector[i].name == name) return _vector[i];
        }
        throw FatalAlgorithmError("No Flag Definition for " + name);
    }

getEmptyList()

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

inlinestatic

Definition at line 76 of file FlagHandler.h.

                                                    {
        static FlagDefinitionList list;
        return list;
    }

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.

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

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.

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

{ return _vector.size(); }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/meas_base/g3e17d7035e+5b3adc59f5/include/lsst/meas/base/FlagHandler.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/meas_base/g3e17d7035e+5b3adc59f5/src/FlagHandler.cc