Class FlagDefinitionList¶
Defined in File FlagHandler.h
Class Documentation¶
-
class
FlagDefinitionList
¶ vector-type utility class to build a collection of FlagDefinitions
Public 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. Return a copy with the FlagDefinition.number set corresponding to its index in the list.
-
std::size_t
size
() const¶ return the current size (number of defined elements) of the collection
Public Static Functions
-
static FlagDefinitionList const &
getEmptyList
()¶
-