PixelType enumeration.
More...
#include <ome/xml/model/enums/PixelType.h>
|
enum | enum_value {
INT8,
INT16,
INT32,
UINT8,
UINT16,
UINT32,
FLOAT,
BIT,
DOUBLE,
COMPLEX,
DOUBLECOMPLEX
} |
| Enumeration values. More...
|
|
typedef std::map< std::string, PixelType::enum_value > | string_map_type |
| String map type.
|
|
typedef std::map< PixelType::enum_value, std::string > | value_map_type |
| Value map type.
|
|
Enumeration values.
Enumerator |
---|
INT8 |
int8
|
INT16 |
int16
|
INT32 |
int32
|
UINT8 |
uint8
|
UINT16 |
uint16
|
UINT32 |
uint32
|
FLOAT |
float
|
BIT |
bit
|
DOUBLE |
double
|
COMPLEX |
complex
|
DOUBLECOMPLEX |
double-complex
|
ome::xml::model::enums::PixelType::PixelType |
( |
enum_value |
value | ) |
|
Construct a PixelType enumeration by an enumeration value.
- Parameters
-
value | the value of the enumeration. |
References name, and values().
ome::xml::model::enums::PixelType::PixelType |
( |
const std::string & |
name, |
|
|
bool |
strict = true |
|
) |
| |
Construct a PixelType 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.
- Parameters
-
name | the name of the enumeration. |
strict | true to require an exact name, false to allow an inexact match. |
References lowercase_strings(), strings(), ome::common::trim(), value, and values().
ome::xml::model::enums::PixelType::PixelType |
( |
const PixelType & |
original | ) |
|
Copy constructor.
- Parameters
-
original | the instance to copy. |
Get a map of valid lowercased string names and enum values.
- Returns
- a map of lowercased string names to enum values.
References BIT, COMPLEX, DOUBLE, DOUBLECOMPLEX, FLOAT, INT16, INT32, INT8, UINT16, UINT32, and UINT8.
Referenced by PixelType().
ome::xml::model::enums::PixelType::operator const std::string & |
( |
| ) |
const |
|
inline |
Cast the enumeration to its name.
- Returns
- the enumeration value.
References name.
ome::xml::model::enums::PixelType::operator enum_value |
( |
| ) |
const |
|
inline |
Cast the enumeration to its value.
- Returns
- the enumeration value.
References value.
Get a map of valid string names and enum values.
- Returns
- a map of string names to enum values.
References BIT, COMPLEX, DOUBLE, DOUBLECOMPLEX, FLOAT, INT16, INT32, INT8, UINT16, UINT32, and UINT8.
Referenced by PixelType().
Get a map of valid enum values and string names.
- Returns
- a map of enum values to string names.
References BIT, COMPLEX, DOUBLE, DOUBLECOMPLEX, FLOAT, INT16, INT32, INT8, UINT16, UINT32, and UINT8.
Referenced by PixelType().
The documentation for this class was generated from the following files:
- ome/xml/model/enums/PixelType.h
- ome/xml/model/enums/PixelType.cpp