bioformats
5.1.6
|
FilterType enumeration. More...
#include <ome/xml/model/enums/FilterType.h>
Public Types | |
enum | enum_value { DICHROIC, LONGPASS, SHORTPASS, BANDPASS, MULTIPASS, NEUTRALDENSITY, TUNEABLE, OTHER } |
Enumeration values. More... | |
typedef std::map< std::string, FilterType::enum_value > | string_map_type |
String map type. | |
typedef std::map< FilterType::enum_value, std::string > | value_map_type |
Value map type. | |
Public Member Functions | |
FilterType (enum_value value) | |
Construct a FilterType enumeration by an enumeration value. More... | |
FilterType (const std::string &name, bool strict=true) | |
Construct a FilterType enumeration by an enumeration name. More... | |
FilterType (const FilterType &original) | |
Copy constructor. More... | |
FilterType & | operator= (const FilterType &rhs) |
Assignment operator. | |
operator enum_value () const | |
Cast the enumeration to its value. More... | |
operator const std::string & () const | |
Cast the enumeration to its name. More... | |
Static Public Member Functions | |
static const string_map_type & | strings () |
Get a map of valid string names and enum values. More... | |
static const value_map_type & | values () |
Get a map of valid enum values and string names. More... | |
Static Private Member Functions | |
static const string_map_type & | lowercase_strings () |
Get a map of valid lowercased string names and enum values. More... | |
Private Attributes | |
enum_value | value |
Enumeration value. | |
const std::string * | name |
Enumeration name. | |
FilterType enumeration.
ome::xml::model::enums::FilterType::FilterType | ( | enum_value | value | ) |
Construct a FilterType enumeration by an enumeration value.
value | the value of the enumeration. |
References name, and values().
Referenced by FilterType().
ome::xml::model::enums::FilterType::FilterType | ( | const std::string & | name, |
bool | strict = true |
||
) |
Construct a FilterType enumeration by an enumeration name.
Exact matching of the name will require the name to match one of the valid enumeration names. Inexact matching will strip leading and trailing whitespace and perform a case-insensitive match. Exact matching is recommended for use in program code which does not process user input; inexact matching is recommended when processing potentially malformed user input.
name | the name of the enumeration. |
strict | true to require an exact name, false to allow an inexact match. |
References ome::common::createLogger(), FilterType(), lowercase_strings(), name, strings(), ome::common::trim(), value, and values().
ome::xml::model::enums::FilterType::FilterType | ( | const FilterType & | original | ) |
Copy constructor.
original | the instance to copy. |
|
staticprivate |
Get a map of valid lowercased string names and enum values.
References BANDPASS, DICHROIC, LONGPASS, MULTIPASS, NEUTRALDENSITY, OTHER, SHORTPASS, and TUNEABLE.
Referenced by FilterType().
|
inline |
|
inline |
|
static |
Get a map of valid string names and enum values.
References BANDPASS, DICHROIC, LONGPASS, MULTIPASS, NEUTRALDENSITY, OTHER, SHORTPASS, and TUNEABLE.
Referenced by FilterType().
|
static |
Get a map of valid enum values and string names.
References BANDPASS, DICHROIC, LONGPASS, MULTIPASS, NEUTRALDENSITY, OTHER, SHORTPASS, and TUNEABLE.
Referenced by FilterType().