ome-xml  5.6.0
Public Types | Public Member Functions | Static Public Member Functions | Static Private Member Functions | Private Attributes | List of all members
ome::xml::model::primitives::UnitsElectricPotential Class Reference

UnitsElectricPotential enumeration. More...

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

+ Collaboration diagram for ome::xml::model::primitives::UnitsElectricPotential:

Public Types

enum  enum_value {
  YOTTAVOLT, ZETTAVOLT, EXAVOLT, PETAVOLT,
  TERAVOLT, GIGAVOLT, MEGAVOLT, KILOVOLT,
  HECTOVOLT, DECAVOLT, VOLT, DECIVOLT,
  CENTIVOLT, MILLIVOLT, MICROVOLT, NANOVOLT,
  PICOVOLT, FEMTOVOLT, ATTOVOLT, ZEPTOVOLT,
  YOCTOVOLT
}
 Enumeration values. More...
 
typedef std::map< std::string, UnitsElectricPotential::enum_valuestring_map_type
 String map type.
 
typedef std::map< UnitsElectricPotential::enum_value, std::string > value_map_type
 Value map type.
 

Public Member Functions

 UnitsElectricPotential (enum_value value)
 Construct a UnitsElectricPotential quantity by an enumeration value. More...
 
 UnitsElectricPotential (const std::string &name, bool strict=true)
 Construct a UnitsElectricPotential enumeration by an enumeration name. More...
 
 UnitsElectricPotential (const UnitsElectricPotential &original)
 Copy constructor. More...
 
UnitsElectricPotentialoperator= (const UnitsElectricPotential &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_typestrings ()
 Get a map of valid string names and enum values. More...
 
static const value_map_typevalues ()
 Get a map of valid enum values and string names. More...
 

Static Private Member Functions

static const string_map_typelowercase_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

UnitsElectricPotential enumeration.

Member Enumeration Documentation

◆ enum_value

Enumeration values.

Enumerator
YOTTAVOLT 

yottavolt unit.

ZETTAVOLT 

zettavolt unit.

EXAVOLT 

exavolt unit.

PETAVOLT 

petavolt unit.

TERAVOLT 

teravolt unit.

GIGAVOLT 

gigavolt unit.

MEGAVOLT 

megavolt unit.

KILOVOLT 

kilovolt unit.

HECTOVOLT 

hectovolt unit.

DECAVOLT 

decavolt unit.

VOLT 

volt unit.

DECIVOLT 

decivolt unit.

CENTIVOLT 

centivolt unit.

MILLIVOLT 

millivolt unit.

MICROVOLT 

microvolt unit.

NANOVOLT 

nanovolt unit.

PICOVOLT 

picovolt unit.

FEMTOVOLT 

femtovolt unit.

ATTOVOLT 

attovolt unit.

ZEPTOVOLT 

zeptovolt unit.

YOCTOVOLT 

yoctovolt unit.

Constructor & Destructor Documentation

◆ UnitsElectricPotential() [1/3]

ome::xml::model::primitives::UnitsElectricPotential::UnitsElectricPotential ( enum_value  value)

Construct a UnitsElectricPotential quantity by an enumeration value.

Parameters
valuethe value of the enumeration.

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

+ Here is the caller graph for this function:

◆ UnitsElectricPotential() [2/3]

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

Construct a UnitsElectricPotential 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
namethe name of the enumeration.
stricttrue to require an exact name, false to allow an inexact match.

◆ UnitsElectricPotential() [3/3]

ome::xml::model::primitives::UnitsElectricPotential::UnitsElectricPotential ( const UnitsElectricPotential original)

Copy constructor.

Parameters
originalthe instance to copy.

Member Function Documentation

◆ lowercase_strings()

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

Cast the enumeration to its value.

Returns
the enumeration value.

References value.

◆ operator=()

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

Assignment operator.

Parameters
rhsthe quantity to assign.
Returns
the assigned quantity.

References name, and value.

◆ strings()

static const string_map_type& ome::xml::model::primitives::UnitsElectricPotential::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::UnitsElectricPotential::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: