generic_layout< error_metric, 6 > Struct Template Reference

Inheritance diagram for generic_layout< error_metric, 6 >:

Public Types
typedef layout::base_cycle_metric< ::uint32_t >	metric_id_t
typedef float	error_t
typedef uint16_t	num_adapters_t
typedef uint16_t	adapter_length_t
Public Types inherited from default_layout< 6 >
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 &, const bool)
template<class Metric >
static void	update (const Metric &)
template<class Metric >
static void	update (Metric &metric)
template<class Header >
static std::streamsize	map_stream_for_header (std::istream &in, Header &header)
template<class Header >
static std::streamsize	map_stream_for_header (std::ostream &out, Header &header)
static record_size_t	compute_size (const error_metric::header_type &header)
static record_size_t	compute_header_size (const error_metric::header_type &header)
Static Public Member Functions inherited from default_layout< 6 >
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< error_metric, 6 >

Error Metric Record Layout Version 6

This class provides an interface to reading the error metric file:

• InterOp/ErrorMetrics.bin
• InterOp/ErrorMetricsOut.bin

The class takes two template arguments:

 1. Metric Type: error_metric
 2. Version: 6

Member Typedef Documentation

typedef uint16_t adapter_length_t

Adapter length type

typedef float error_t

Error type

typedef layout::base_cycle_metric< ::uint32_t > metric_id_t

Metric ID type

typedef uint16_t num_adapters_t

Number of adapters type

Member Function Documentation

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

inlinestatic

Compute header size

Returns

header size

static record_size_t compute_size ( const error_metric::header_type &  header )

inlinestatic

Compute the layout size

Returns

size of the record

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

inlinestatic

Map reading/writing to stream

Reading and writing are symmetric operations, map it once

Parameters

stream	input/output stream
metric	source/destination metric

Returns

number of bytes read or total number of bytes written

static std::streamsize map_stream_for_header ( std::istream &  in, Header &  header  )

inlinestatic

Read metric from the input stream

Parameters

in	input stream
header	destination header

Returns

sentinel

static std::streamsize map_stream_for_header ( std::ostream &  out, Header &  header  )

inlinestatic

Write metric to the output stream

Parameters

out	output stream
header	source header

Returns

sentinel

static void update ( const Metric &  )

inlinestatic

static void update ( Metric &  metric )

inlinestatic

---

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

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