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

Static Public Member Functions

template<class Stream , class Summary >
static std::streamsize map_records (Stream &stream, Summary &summary)
 
template<class Stream , class Summary >
static std::streamsize map_header (Stream &stream, Summary &header)
 
- 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)
 

Additional Inherited Members

- Public Types inherited from default_layout< 1 >
enum  
 
typedef ::uint8_t record_size_t
 
typedef ::uint8_t version_t
 

Detailed Description

template<>
struct illumina::interop::io::generic_layout< index_flowcell_summary, 1 >

Index summary Record Layout Version 1

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

  • InterOp/IndexSummary.bin

The class takes two template arguments: 

 1. Metric Type: index_flowcell_summary
 2. Version: 1

Member Function Documentation

static std::streamsize map_header ( Stream &  stream,
Summary &  header 
)
inlinestatic

Map reading/writing a summary to a stream

Reading and writing are symmetric operations, map it once

Parameters
streaminput/output stream
headersource/destination header
Returns
number of bytes read or total number of bytes written
static std::streamsize map_records ( Stream &  stream,
Summary &  summary 
)
inlinestatic

Map reading/writing a summary to a stream

Reading and writing are symmetric operations, map it once

Parameters
streaminput/output stream
summarysource/destination summary
Returns
number of bytes read or total number of bytes written
The documentation for this struct was generated from the following file: