generic_layout< summary_run_metric, 1 > Struct Template Reference
Inheritance diagram for generic_layout< summary_run_metric, 1 >:
default_layout< 1 >

Public Types

typedef layout::base_run_metric metric_id_t
typedef ::uint32_t record_size_t
typedef summary_run_metric::count_t count_t
- Public Types inherited from default_layout< 1 >
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)
static record_size_t compute_size (const summary_run_metric::header_type &)
static record_size_t compute_header_size (const summary_run_metric::header_type &)
- Static Public Member Functions inherited from default_layout< 1 >
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

struct illumina::interop::io::generic_layout< summary_run_metric, 1 >

Summary Run Metric Record Layout Version 1

This class provides an interface to reading the summary run metric file:

  • InterOp/SummaryRun.bin
  • InterOp/SummaryRunOut.bin

The class takes two template arguments:

 1. Metric Type: summary_run_metric
 2. Version: 1

Member Typedef Documentation

Metric ID type

typedef ::uint32_t record_size_t

Define a record size type

Member Function Documentation

static record_size_t compute_header_size ( const summary_run_metric::header_type )

Compute header size

header size
static record_size_t compute_size ( const summary_run_metric::header_type )

Compute the layout size

size of the record
static std::streamsize map_stream ( Stream &  stream,
Metric &  metric,
Header &  ,
const bool   

Map reading/writing to stream

Reading and writing are symmetric operations, map it once

streaminput/output stream
metricsource/destination metric
headermetric header layout
number of bytes read or total number of bytes written

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