default_layout< V, MultiRecord, Deprecated > Struct Template Reference

#include <default_layout.h>

Public Types
enum	{ VERSION = V, MULTI_RECORD =MultiRecord, IS_DEPRECATED =Deprecated }
typedef ::uint8_t	record_size_t
typedef ::uint8_t	version_t

Static Public Member Functions
template<class Stream , class Header >
static std::streamsize	map_stream_for_header (Stream &, Header &)
template<class Stream , class RecordSize >
static RecordSize	map_stream_record_size (Stream &stream, RecordSize record_size)
template<class Metric >
static bool	skip_metric (const Metric &metric)
template<class LayoutId >
static bool	is_valid (const LayoutId &id)

Detailed Description

template<int V, int MultiRecord = 0, int Deprecated = 0>
struct illumina::interop::io::default_layout< V, MultiRecord, Deprecated >

Define default methods and typedefs for a record layout

Member Typedef Documentation

typedef ::uint8_t record_size_t

Define a record size type

typedef ::uint8_t version_t

Define a version type

Member Enumeration Documentation

anonymous enum

Enumerator
VERSION	Version of the format
MULTI_RECORD	Flag indicating whether metric is split into multiple records in the InterOp file
IS_DEPRECATED	Flag to indicate the format is no longer supported

Member Function Documentation

static bool is_valid ( const LayoutId &  id )

inlinestatic

Skip inserting this metric into the metric set

This function was originally added to skip control records in tile metrics.

Parameters

id	metric to check

Returns

true, if the metric id is 0

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

inlinestatic

Map reading/writing a header to a stream

Does nothing

Returns

0

static RecordSize map_stream_record_size ( Stream &  stream, RecordSize  record_size  )

inlinestatic

Map reading/writing the record size to the stream

Parameters

stream	input/output stream
record_size	size of the record

Returns

size of the record

static bool skip_metric ( const Metric &  metric )

inlinestatic

Skip inserting this metric into the metric set

This function was originally added to skip control records in tile metrics.

Parameters

metric

metric to check

Returns

true, if the metric id is 0

---

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

• /io/interop/io/format/default_layout.h