ome::xml::model::primitives::UnitsTime Class Reference

UnitsTime enumeration. More...

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

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

Public Types
enum	enum_value {   YOTTASECOND, ZETTASECOND, EXASECOND, PETASECOND,   TERASECOND, GIGASECOND, MEGASECOND, KILOSECOND,   HECTOSECOND, DECASECOND, SECOND, DECISECOND,   CENTISECOND, MILLISECOND, MICROSECOND, NANOSECOND,   PICOSECOND, FEMTOSECOND, ATTOSECOND, ZEPTOSECOND,   YOCTOSECOND, MINUTE, HOUR, DAY }
	Enumeration values. More...
typedef std::map< std::string, UnitsTime::enum_value >	string_map_type
	String map type.
typedef std::map< UnitsTime::enum_value, std::string >	value_map_type
	Value map type.

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

UnitsTime enumeration.

Member Enumeration Documentation

enum_value

enum ome::xml::model::primitives::UnitsTime::enum_value

Enumeration values.

Enumerator
YOTTASECOND	yottasecond SI unit.
ZETTASECOND	zettasecond SI unit.
EXASECOND	exasecond SI unit.
PETASECOND	petasecond SI unit.
TERASECOND	terasecond SI unit.
GIGASECOND	gigasecond SI unit.
MEGASECOND	megasecond SI unit.
KILOSECOND	kilosecond SI unit.
HECTOSECOND	hectosecond SI unit.
DECASECOND	decasecond SI unit.
SECOND	second SI unit.
DECISECOND	decisecond SI unit.
CENTISECOND	centisecond SI unit.
MILLISECOND	millisecond SI unit.
MICROSECOND	microsecond SI unit.
NANOSECOND	nanosecond SI unit.
PICOSECOND	picosecond SI unit.
FEMTOSECOND	femtosecond SI unit.
ATTOSECOND	attosecond SI unit.
ZEPTOSECOND	zeptosecond SI unit.
YOCTOSECOND	yoctosecond SI unit.
MINUTE	minute SI-derived unit.
HOUR	hour SI-derived unit.
DAY	day SI-derived unit.

Constructor & Destructor Documentation

UnitsTime() [1/3]

ome::xml::model::primitives::UnitsTime::UnitsTime

(

enum_value

value

)

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

UnitsTime() [2/3]

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

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

UnitsTime() [3/3]

ome::xml::model::primitives::UnitsTime::UnitsTime

(

const UnitsTime &

original

)

Copy constructor.

Parameters

original

the instance to copy.

Member Function Documentation

lowercase_strings()

static const string_map_type& ome::xml::model::primitives::UnitsTime::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::UnitsTime::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::UnitsTime::operator enum_value ( ) const

inline

Cast the enumeration to its value.

Returns

the enumeration value.

References value.

operator=()

UnitsTime& ome::xml::model::primitives::UnitsTime::operator= ( const UnitsTime &  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::UnitsTime::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::UnitsTime::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/TimeQuantity.h