ome::xml::model::primitives::UnitsFrequency Class Reference

UnitsFrequency enumeration. More...

#include <ome/xml/model/primitives/FrequencyQuantity.h>

Collaboration diagram for ome::xml::model::primitives::UnitsFrequency:

Public Types
enum	enum_value {   YOTTAHERTZ, ZETTAHERTZ, EXAHERTZ, PETAHERTZ,   TERAHERTZ, GIGAHERTZ, MEGAHERTZ, KILOHERTZ,   HECTOHERTZ, DECAHERTZ, HERTZ, DECIHERTZ,   CENTIHERTZ, MILLIHERTZ, MICROHERTZ, NANOHERTZ,   PICOHERTZ, FEMTOHERTZ, ATTOHERTZ, ZEPTOHERTZ,   YOCTOHERTZ }
	Enumeration values. More...
typedef std::map< std::string, UnitsFrequency::enum_value >	string_map_type
	String map type.
typedef std::map< UnitsFrequency::enum_value, std::string >	value_map_type
	Value map type.

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

UnitsFrequency enumeration.

Member Enumeration Documentation

enum_value

enum ome::xml::model::primitives::UnitsFrequency::enum_value

Enumeration values.

Enumerator
YOTTAHERTZ	yottahertz unit.
ZETTAHERTZ	zettahertz unit.
EXAHERTZ	exahertz unit.
PETAHERTZ	petahertz unit.
TERAHERTZ	terahertz unit.
GIGAHERTZ	gigahertz unit.
MEGAHERTZ	megahertz unit.
KILOHERTZ	kilohertz unit.
HECTOHERTZ	hectohertz unit.
DECAHERTZ	decahertz unit.
HERTZ	hertz unit.
DECIHERTZ	decihertz unit.
CENTIHERTZ	centihertz unit.
MILLIHERTZ	millihertz unit.
MICROHERTZ	microhertz unit.
NANOHERTZ	nanohertz unit.
PICOHERTZ	picohertz unit.
FEMTOHERTZ	femtohertz unit.
ATTOHERTZ	attohertz unit.
ZEPTOHERTZ	zeptohertz unit.
YOCTOHERTZ	yoctohertz unit.

Constructor & Destructor Documentation

UnitsFrequency() [1/3]

ome::xml::model::primitives::UnitsFrequency::UnitsFrequency

(

enum_value

value

)

Construct a UnitsFrequency quantity by an enumeration value.

Parameters

value

the value of the enumeration.

Referenced by ome::xml::model::primitives::operator>>().

Here is the caller graph for this function:

UnitsFrequency() [2/3]

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

Construct a UnitsFrequency 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.

UnitsFrequency() [3/3]

ome::xml::model::primitives::UnitsFrequency::UnitsFrequency

(

const UnitsFrequency &

original

)

Copy constructor.

Parameters

original

the instance to copy.

Member Function Documentation

lowercase_strings()

static const string_map_type& ome::xml::model::primitives::UnitsFrequency::lowercase_strings ( )

staticprivate

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

Returns

a map of lowercased string names to enum values.

operator const std::string &()

ome::xml::model::primitives::UnitsFrequency::operator const std::string & ( ) const

inline

Cast the enumeration to its name.

Returns

the enumeration value.

References name.

operator enum_value()

ome::xml::model::primitives::UnitsFrequency::operator enum_value ( ) const

inline

Cast the enumeration to its value.

Returns

the enumeration value.

References value.

operator=()

UnitsFrequency& ome::xml::model::primitives::UnitsFrequency::operator= ( const UnitsFrequency &  rhs )

inline

Assignment operator.

Parameters

rhs	the quantity to assign.

Returns

the assigned quantity.

References name, and value.

strings()

static const string_map_type& ome::xml::model::primitives::UnitsFrequency::strings ( )

static

Get a map of valid string names and enum values.

Returns

a map of string names to enum values.

values()

static const value_map_type& ome::xml::model::primitives::UnitsFrequency::values ( )

static

Get a map of valid enum values and string names.

Returns

a map of enum values to string names.

---

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

• ome/xml/model/primitives/FrequencyQuantity.h