ome::xml::model::enums::Immersion Class Reference

Immersion enumeration. More...

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

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

Public Types
enum	enum_value {   OIL, WATER, WATERDIPPING, AIR,   MULTI, GLYCEROL, OTHER }
	Enumeration values. More...
typedef std::map< std::string, Immersion::enum_value >	string_map_type
	String map type.
typedef std::map< Immersion::enum_value, std::string >	value_map_type
	Value map type.

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

Detailed Description

Immersion enumeration.

Member Enumeration Documentation

enum_value

enum ome::xml::model::enums::Immersion::enum_value

Enumeration values.

Enumerator
OIL	Oil.
WATER	Water.
WATERDIPPING	WaterDipping.
AIR	Air.
MULTI	Multi.
GLYCEROL	Glycerol.
OTHER	Other.

Constructor & Destructor Documentation

Immersion() [1/3]

ome::xml::model::enums::Immersion::Immersion

(

enum_value

value

)

Construct a Immersion enumeration by an enumeration value.

Parameters

value

the value of the enumeration.

References name, and values().

Referenced by Immersion(), and ome::xml::model::enums::operator>>().

Here is the caller graph for this function:

Immersion() [2/3]

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

Construct a Immersion 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 ome::common::createLogger(), Immersion(), lowercase_strings(), name, strings(), trim(), value, and values().

Immersion() [3/3]

ome::xml::model::enums::Immersion::Immersion

(

const Immersion &

original

)

Copy constructor.

Parameters

original

the instance to copy.

Member Function Documentation

lowercase_strings()

const Immersion::string_map_type & ome::xml::model::enums::Immersion::lowercase_strings ( )

staticprivate

Get a map of valid lowercased string names and enum values.

Returns

a map of lowercased string names to enum values.

References AIR, GLYCEROL, MULTI, OIL, OTHER, WATER, and WATERDIPPING.

Referenced by Immersion().

Here is the caller graph for this function:

operator const std::string &()

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

inline

Cast the enumeration to its name.

Returns

the enumeration value.

References name.

operator enum_value()

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

inline

Cast the enumeration to its value.

Returns

the enumeration value.

References value.

operator=()

Immersion& ome::xml::model::enums::Immersion::operator= ( const Immersion &  rhs )

inline

Assignment operator.

Parameters

rhs	the value to assign.

Returns

the assigned value.

References name, and value.

strings()

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

static

Get a map of valid string names and enum values.

Returns

a map of string names to enum values.

References AIR, GLYCEROL, MULTI, OIL, OTHER, WATER, and WATERDIPPING.

Referenced by Immersion().

Here is the caller graph for this function:

values()

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

static

Get a map of valid enum values and string names.

Returns

a map of enum values to string names.

References AIR, GLYCEROL, MULTI, OIL, OTHER, WATER, and WATERDIPPING.

Referenced by Immersion().

Here is the caller graph for this function:

---

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

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