text_layout< extraction_metric, 1 > Struct Template Reference

Public Types
typedef extraction_metric::header_type	header_type

Static Public Member Functions
static size_t	write_header (std::ostream &out, const header_type &header, const std::vector< std::string > &channel_names, const char sep, const char eol)
static size_t	write_metric (std::ostream &out, const extraction_metric &metric, const header_type &header, const char sep, const char eol, const char)

Detailed Description

template<>
struct illumina::interop::io::text_layout< extraction_metric, 1 >

Extraction Metric CSV text format

This class provide an interface for writing the extraction metrics to a CSV file:

• ExtractionMetrics.csv

Member Typedef Documentation

typedef extraction_metric::header_type header_type

Define a header type

Member Function Documentation

static size_t write_header ( std::ostream &  out, const header_type &  header, const std::vector< std::string > &  channel_names, const char  sep, const char  eol  )

inlinestatic

Write header to the output stream

Parameters

out	output stream
header	extraction metric header
channel_names	list of channel names
sep	column separator
eol	row separator

Returns

number of column headers

static size_t write_metric ( std::ostream &  out, const extraction_metric &  metric, const header_type &  header, const char  sep, const char  eol, const char    )

inlinestatic

Write a extraction metric to the output stream

Parameters

out	output stream
metric	extraction metric
header	extraction metric header
sep	column separator
eol	row separator

Returns

number of columns written

---

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

• /io/src/interop/model/metrics/extraction_metric.cpp