generic_layout< q_metric, 5 > Struct Template Reference

Inheritance diagram for generic_layout< q_metric, 5 >:

Public Types
typedef layout::base_cycle_metric< ::uint16_t >	metric_id_t
typedef ::uint32_t	count_t
typedef ::uint8_t	bool_t
typedef ::uint8_t	bin_count_t
typedef ::uint8_t	bin_t
Public Types inherited from default_layout< 5 >
enum
typedef ::uint8_t	record_size_t
typedef ::uint8_t	version_t

Static Public Member Functions
template<class Stream , class Metric , class Header >
static std::streamsize	map_stream (Stream &stream, Metric &metric, Header &header, const bool)
template<class Metric , class Header >
static std::streamsize	map_stream (std::ostream &stream, Metric &metric, Header &header, const bool)
template<class Metric , class Header >
static std::streamsize	map_stream (const char *, const Metric &, const Header &, const bool)
static record_size_t	compute_size (const q_metric::header_type &)
template<class Stream , class Header >
static std::streamsize	map_stream_for_header (Stream &stream, Header &header)
static record_size_t	compute_header_size (const q_metric::header_type &header)
Static Public Member Functions inherited from default_layout< 5 >
static std::streamsize	map_stream_for_header (Stream &, Header &)
static RecordSize	map_stream_record_size (Stream &stream, RecordSize record_size)
static bool	skip_metric (const Metric &metric)
static bool	is_valid (const LayoutId &id)

Detailed Description

template<>
struct illumina::interop::io::generic_layout< q_metric, 5 >

Q-score Metric Record Layout Version 5

This class provides an interface to reading the q-metric file:

• InterOp/QMetrics.bin
• InterOp/QMetricsOut.bin

The class takes two template arguments:

 1. Metric Type: q_metric
 2. Version: 5

Member Typedef Documentation

typedef ::uint8_t bin_count_t

Bin count type

typedef ::uint8_t bin_t

Bin type

typedef ::uint8_t bool_t

Bool type

typedef ::uint32_t count_t

Histogram count type

typedef layout::base_cycle_metric< ::uint16_t > metric_id_t

Metric ID type

Member Function Documentation

static record_size_t compute_header_size ( const q_metric::header_type &  header )

inlinestatic

Compute header size

Parameters

header

q-metric header

Returns

header size

static record_size_t compute_size ( const q_metric::header_type &  )

inlinestatic

Compute the layout size

Returns

size of the record

static std::streamsize map_stream ( Stream &  stream, Metric &  metric, Header &  header, const bool    )

inlinestatic

Read metric from the input stream

Parameters

stream	input stream
metric	destination metric
header	metric header

Returns

number of bytes read or total number of bytes written

static std::streamsize map_stream ( std::ostream &  stream, Metric &  metric, Header &  header, const bool    )

inlinestatic

Write metric to the output stream

Parameters

stream	output stream
metric	source metric
header	metric header

Returns

number of bytes read or total number of bytes written

static std::streamsize map_stream ( const char *  , const Metric &  , const Header &  , const bool    )

inlinestatic

Throws an unimplemented error

static std::streamsize map_stream_for_header ( Stream &  stream, Header &  header  )

inlinestatic

Map reading/writing a header to a stream

Reading and writing are symmetric operations, map it once

Parameters

stream	input/output stream
header	source/destination header

Returns

number of bytes read or total number of bytes written

---

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

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