ome::xml::model::enums::DimensionOrder Class Reference

DimensionOrder enumeration. More...

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

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

Public Types
enum	enum_value {   XYZCT, XYZTC, XYCTZ, XYCZT,   XYTCZ, XYTZC }
	Enumeration values. More...
typedef std::map< std::string, DimensionOrder::enum_value >	string_map_type
	String map type.
typedef std::map< DimensionOrder::enum_value, std::string >	value_map_type
	Value map type.

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

Detailed Description

DimensionOrder enumeration.

Member Enumeration Documentation

enum ome::xml::model::enums::DimensionOrder::enum_value

Enumeration values.

Enumerator
XYZCT	XYZCT.
XYZTC	XYZTC.
XYCTZ	XYCTZ.
XYCZT	XYCZT.
XYTCZ	XYTCZ.
XYTZC	XYTZC.

Constructor & Destructor Documentation

ome::xml::model::enums::DimensionOrder::DimensionOrder

(

enum_value

value

)

Construct a DimensionOrder enumeration by an enumeration value.

Parameters

value

the value of the enumeration.

References name, and values().

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

Construct a DimensionOrder 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::DimensionOrder::DimensionOrder

(

const DimensionOrder &

original

)

Copy constructor.

Parameters

original

the instance to copy.

Member Function Documentation

const DimensionOrder::string_map_type & ome::xml::model::enums::DimensionOrder::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 XYCTZ, XYCZT, XYTCZ, XYTZC, XYZCT, and XYZTC.

Referenced by DimensionOrder().

Here is the caller graph for this function:

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

inline

Cast the enumeration to its name.

Returns

the enumeration value.

References name.

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

inline

Cast the enumeration to its value.

Returns

the enumeration value.

References value.

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

static

Get a map of valid string names and enum values.

Returns

a map of string names to enum values.

References XYCTZ, XYCZT, XYTCZ, XYTZC, XYZCT, and XYZTC.

Referenced by DimensionOrder().

Here is the caller graph for this function:

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

static

Get a map of valid enum values and string names.

Returns

a map of enum values to string names.

References XYCTZ, XYCZT, XYTCZ, XYTZC, XYZCT, and XYZTC.

Referenced by DimensionOrder().

Here is the caller graph for this function:

---

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

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