ome::xml::model::enums::Binning Class Reference

Binning enumeration. More...

#include <ome/xml/model/enums/Binning.h>

Collaboration diagram for ome::xml::model::enums::Binning:

Public Types
enum	enum_value {   ONEXONE, TWOXTWO, FOURXFOUR, EIGHTXEIGHT,   OTHER }
	Enumeration values. More...
typedef std::map< std::string, Binning::enum_value >	string_map_type
	String map type.
typedef std::map< Binning::enum_value, std::string >	value_map_type
	Value map type.

Public Member Functions
	Binning (enum_value value)
	Construct a Binning enumeration by an enumeration value. More...
	Binning (const std::string &name, bool strict=true)
	Construct a Binning enumeration by an enumeration name. More...
	Binning (const Binning &original)
	Copy constructor. More...
Binning &	operator= (const Binning &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...

Private Attributes
enum_value	value
	Enumeration value.
const std::string *	name
	Enumeration name.

Static Private Attributes
static const string_map_type	string_map
	Mapping of enumeration name to value.
static const string_map_type	lowercase_string_map
	Mapping of lowercase enumeration name to value.
static const value_map_type	value_map
	Mapping of enumeration value to name.

Detailed Description

Binning enumeration.

Member Enumeration Documentation

enum ome::xml::model::enums::Binning::enum_value

Enumeration values.

Enumerator
ONEXONE	1x1
TWOXTWO	2x2
FOURXFOUR	4x4
EIGHTXEIGHT	8x8
OTHER	Other.

Constructor & Destructor Documentation

ome::xml::model::enums::Binning::Binning

(

enum_value

value

)

Construct a Binning enumeration by an enumeration value.

Parameters

value

the value of the enumeration.

References name, and value_map.

Referenced by Binning().

Here is the caller graph for this function:

ome::xml::model::enums::Binning::Binning	(	const std::string &	name,
		bool	strict = true
	)

Construct a Binning 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 Binning(), ome::common::createLogger(), lowercase_string_map, name, string_map, ome::common::trim(), value, and value_map.

ome::xml::model::enums::Binning::Binning

(

const Binning &

original

)

Copy constructor.

Parameters

original

the instance to copy.

Member Function Documentation

ome::xml::model::enums::Binning::operator const std::string & ( ) const

inline

Cast the enumeration to its name.

Returns

the enumeration value.

References name.

ome::xml::model::enums::Binning::operator enum_value ( ) const

inline

Cast the enumeration to its value.

Returns

the enumeration value.

References value.

const Binning::string_map_type & ome::xml::model::enums::Binning::strings ( )

static

Get a map of valid string names and enum values.

Returns

a map of string names to enum values.

References string_map.

const Binning::value_map_type & ome::xml::model::enums::Binning::values ( )

static

Get a map of valid enum values and string names.

Returns

a map of enum values to string names.

References value_map.

---

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

• ome/xml/model/enums/Binning.h
• ome/xml/model/enums/Binning.cpp