Public Types | Static Public Member Functions | List of all members
generic_layout< error_metric, 4 > Struct Template Reference
Inheritance diagram for generic_layout< error_metric, 4 >:
default_layout< 4 >

Public Types

typedef layout::base_cycle_metric< ::uint32_t > metric_id_t
 
typedef float error_t
 
- Public Types inherited from default_layout< 4 >
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)
 
static record_size_t compute_size (const error_metric::header_type &)
 
static record_size_t compute_header_size (const error_metric::header_type &)
 
- Static Public Member Functions inherited from default_layout< 4 >
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, 4 >

Error Metric Record Layout Version 4

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: 4

Member Typedef Documentation

typedef float error_t

Error type

typedef layout::base_cycle_metric< ::uint32_t > metric_id_t

Metric ID type

Member Function Documentation

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

Compute header size

Returns
header size
static record_size_t compute_size ( const error_metric::header_type &  )
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
streaminput/output stream
metricsource/destination metric
Returns
number of bytes read or total number of bytes written
The documentation for this struct was generated from the following file: