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::enums::LaserMedium Class Reference

LaserMedium enumeration. More...

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

+ Collaboration diagram for ome::xml::model::enums::LaserMedium:

Public Types

enum  enum_value {
  CU, AG, ARFL, ARCL,
  KRFL, KRCL, XEFL, XECL,
  XEBR, N, AR, KR,
  XE, HENE, HECD, CO,
  CO2, H2O, HFL, NDGLASS,
  NDYAG, ERGLASS, ERYAG, HOYLF,
  HOYAG, RUBY, TISAPPHIRE, ALEXANDRITE,
  RHODAMINE6G, COUMARINC30, GAAS, GAALAS,
  EMINUS, OTHER
}
 Enumeration values. More...
 
typedef std::map< std::string, LaserMedium::enum_valuestring_map_type
 String map type.
 
typedef std::map< LaserMedium::enum_value, std::string > value_map_type
 Value map type.
 

Public Member Functions

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

LaserMedium enumeration.

Member Enumeration Documentation

◆ enum_value

Enumeration values.

Enumerator
CU 

Cu.

AG 

Ag.

ARFL 

ArFl.

ARCL 

ArCl.

KRFL 

KrFl.

KRCL 

KrCl.

XEFL 

XeFl.

XECL 

XeCl.

XEBR 

XeBr.

N.

AR 

Ar.

KR 

Kr.

XE 

Xe.

HENE 

HeNe.

HECD 

HeCd.

CO 

CO.

CO2 

CO2.

H2O 

H2O.

HFL 

HFl.

NDGLASS 

NdGlass.

NDYAG 

NdYAG.

ERGLASS 

ErGlass.

ERYAG 

ErYAG.

HOYLF 

HoYLF.

HOYAG 

HoYAG.

RUBY 

Ruby.

TISAPPHIRE 

TiSapphire.

ALEXANDRITE 

Alexandrite.

RHODAMINE6G 

Rhodamine6G.

COUMARINC30 

CoumarinC30.

GAAS 

GaAs.

GAALAS 

GaAlAs.

EMINUS 

EMinus.

OTHER 

Other.

Constructor & Destructor Documentation

◆ LaserMedium() [1/3]

ome::xml::model::enums::LaserMedium::LaserMedium ( enum_value  value)

Construct a LaserMedium enumeration by an enumeration value.

Parameters
valuethe value of the enumeration.

References name, and values().

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

+ Here is the caller graph for this function:

◆ LaserMedium() [2/3]

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

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

References ome::common::createLogger(), LaserMedium(), lowercase_strings(), name, strings(), trim(), value, and values().

◆ LaserMedium() [3/3]

ome::xml::model::enums::LaserMedium::LaserMedium ( const LaserMedium original)

Copy constructor.

Parameters
originalthe instance to copy.

Member Function Documentation

◆ lowercase_strings()

const LaserMedium::string_map_type & ome::xml::model::enums::LaserMedium::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 AG, ALEXANDRITE, AR, ARCL, ARFL, CO, CO2, COUMARINC30, CU, EMINUS, ERGLASS, ERYAG, GAALAS, GAAS, H2O, HECD, HENE, HFL, HOYAG, HOYLF, KR, KRCL, KRFL, N, NDGLASS, NDYAG, OTHER, RHODAMINE6G, RUBY, TISAPPHIRE, XE, XEBR, XECL, and XEFL.

Referenced by LaserMedium().

+ Here is the caller graph for this function:

◆ operator const std::string &()

ome::xml::model::enums::LaserMedium::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::LaserMedium::operator enum_value ( ) const
inline

Cast the enumeration to its value.

Returns
the enumeration value.

References value.

◆ operator=()

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

Assignment operator.

Parameters
rhsthe value to assign.
Returns
the assigned value.

References name, and value.

◆ strings()

const LaserMedium::string_map_type & ome::xml::model::enums::LaserMedium::strings ( )
static

Get a map of valid string names and enum values.

Returns
a map of string names to enum values.

References AG, ALEXANDRITE, AR, ARCL, ARFL, CO, CO2, COUMARINC30, CU, EMINUS, ERGLASS, ERYAG, GAALAS, GAAS, H2O, HECD, HENE, HFL, HOYAG, HOYLF, KR, KRCL, KRFL, N, NDGLASS, NDYAG, OTHER, RHODAMINE6G, RUBY, TISAPPHIRE, XE, XEBR, XECL, and XEFL.

Referenced by LaserMedium().

+ Here is the caller graph for this function:

◆ values()

const LaserMedium::value_map_type & ome::xml::model::enums::LaserMedium::values ( )
static

Get a map of valid enum values and string names.

Returns
a map of enum values to string names.

References AG, ALEXANDRITE, AR, ARCL, ARFL, CO, CO2, COUMARINC30, CU, EMINUS, ERGLASS, ERYAG, GAALAS, GAAS, H2O, HECD, HENE, HFL, HOYAG, HOYLF, KR, KRCL, KRFL, N, NDGLASS, NDYAG, OTHER, RHODAMINE6G, RUBY, TISAPPHIRE, XE, XEBR, XECL, and XEFL.

Referenced by LaserMedium().

+ Here is the caller graph for this function:

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