illumina::interop::constants Namespace Reference

Namespaces
	detail

Classes
class	enum_description
class	enumeration_string_mapping
class	enumeration_string_mapping< bar_plot_options >
class	enumeration_string_mapping< dna_bases >
class	enumeration_string_mapping< instrument_type >
class	enumeration_string_mapping< metric_base_type >
class	enumeration_string_mapping< metric_data >
class	enumeration_string_mapping< metric_feature_type >
class	enumeration_string_mapping< metric_group >
class	enumeration_string_mapping< metric_type >
class	enumeration_string_mapping< model::table::column_id >
class	enumeration_string_mapping< plot_colors >
class	enumeration_string_mapping< plot_types >
class	enumeration_string_mapping< surface_type >
class	enumeration_string_mapping< tile_naming_method >

Typedefs
typedef constant_type< metric_base_type, BaseTileType >	base_tile_t
typedef constant_type< metric_base_type, BaseCycleType >	base_cycle_t
typedef constant_type< metric_base_type, BaseReadType >	base_read_t
typedef constant_type< metric_base_type, BaseLaneType >	base_lane_t
typedef constant_type< metric_base_type, BaseRunType >	base_run_t

Enumerations
enum	common { Unknown = 0x800 }
enum	metric_type {   Intensity, FWHM, BasePercent, PercentNoCall,   Q20Percent, Q30Percent, AccumPercentQ20, AccumPercentQ30,   QScore, Clusters, ClustersPF, ClusterCount,   ClusterCountPF, ErrorRate, PercentPhasing, PercentPrephasing,   PercentAligned, Phasing, PrePhasing, CorrectedIntensity,   CalledIntensity, SignalToNoise, OccupiedCountK, PercentOccupied,   PercentPF, MetricTypeCount, UnknownMetricType = 0x800 }
enum	metric_group {   CorrectedInt, Error, Extraction, Image,   Index, Q, Tile, QByLane,   QCollapsed, EmpiricalPhasing, DynamicPhasing, ExtendedTile,   SummaryRun, MetricCount, UnknownMetricGroup = 0x800 }
enum	tile_naming_method {   FourDigit, FiveDigit, Absolute, TileNamingMethodCount,   UnknownTileNamingMethod = 0x800 }
enum	dna_bases {   NC = -1, A, C, G,   T, NUM_OF_BASES, NUM_OF_BASES_AND_NC, UnknownBase = 0x800 }
enum	surface_type { SentinelSurface, Top, Bottom, UnknownSurface = 0x800 }
enum	instrument_type {   HiSeq, HiScan, MiSeq, NextSeq,   MiniSeq, NovaSeq, iSeq, NextSeq1k2k,   InstrumentCount, UnknownInstrument = 0x800 }
enum	metric_base_type {   BaseTileType, BaseCycleType, BaseReadType, BaseLaneType,   BaseRunType, BaseMetricCount, UnknownBaseType = 0x800 }
enum	plot_colors {   Red, Green, Blue, Black,   PlotColorCount, UnknownColor = 0x800 }
enum	bar_plot_options { Centered, Shifted, UnknownBarPlotOption = 0x800 }
enum	metric_data {   IdType, ValueType, StructType, ChannelArray,   BaseArray, MetricDataCount, UnknownMetricData = 0x800 }
enum	metric_feature_type {   TileFeature = 0x01, CycleFeature = 0x02, ReadFeature = 0x04, BaseFeature = 0x08,   ChannelFeature = 0x10, LaneFeature = 0x20, DiskFeature = 0x400, UnknownMetricFeature = 0x800 }
enum	plot_types {   FlowcellPlot, ByCyclePlot, ByLanePlot, QHistogramPlot,   QHeatmapPlot, SampleQCPlot, UnknownPlotType = 0x800 }

Functions
template<typename Enum >
std::string	to_string (Enum value)
template<typename Enum >
Enum	parse (const std::string &name)
template<typename Enum >
void	list_enums (std::vector< Enum > &vec, const size_t skip=0)
template<typename Enum >
void	list_enum_names (std::vector< std::string > &vec, const size_t skip=0)

Typedef Documentation

typedef constant_type<metric_base_type, BaseCycleType> base_cycle_t

Define base type for cycle metrics

typedef constant_type<metric_base_type, BaseLaneType> base_lane_t

Define base type for lane metrics

typedef constant_type<metric_base_type, BaseReadType> base_read_t

Define base type for read metrics

typedef constant_type<metric_base_type, BaseRunType> base_run_t

Define base type for lane metrics

typedef constant_type<metric_base_type, BaseTileType> base_tile_t

Define base type for tile metrics

Function Documentation

void illumina::interop::constants::list_enum_names	(	std::vector< std::string > &	vec,
		const size_t	skip = 0
	)

Fill given enum vector with all available enums

Parameters

vec	enum vector
skip	number of start elements to skip

void illumina::interop::constants::list_enums	(	std::vector< Enum > &	vec,
		const size_t	skip = 0
	)

Fill given enum vector with all available enums

Parameters

vec	enum vector
skip	number of start elements to skip

Enum illumina::interop::constants::parse

(

const std::string &

name

)

Convert a string representation of a enum value to an enum value

Parameters

name	string representation of a enum value

Returns

enum value

std::string illumina::interop::constants::to_string

(

Enum

value

)

Convert an enum value to its string representation

Parameters

value

enum value

Returns

string representation of the enum value