enum_description< Enum > Class Template Reference

#include <enum_description.h>

Public Types
typedef Enum	enum_t

Public Member Functions
	enum_description ()
	enum_description (const enum_t val, const std::string &description)
	enum_description (const std::pair< metric_type, std::string > &pair)
enum_t	value () const
const std::string &	description () const
	operator enum_t () const

Detailed Description

template<typename Enum>
class illumina::interop::constants::enum_description< Enum >

Encapsulates an enum and a string description

Member Typedef Documentation

typedef Enum enum_t

Type of the enum

Constructor & Destructor Documentation

enum_description ( )

inline

Constructor

enum_description ( const enum_t  val, const std::string &  description  )

inline

Constructor

Parameters

val	enum value
description	enum description

enum_description ( const std::pair< metric_type, std::string > &  pair )

inline

Constructor

Parameters

pair	enum value/description pair

Member Function Documentation

const std::string& description ( ) const

inline

Get the description of the enum

Returns

enum description

operator enum_t ( ) const

inline

Implicit conversion operator

Returns

enum value

enum_t value ( ) const

inline

Get the value of the enum

Returns

enum value

---

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

• /io/interop/constants/enum_description.h