generic_layout< extended_tile_metric, 1 > Struct Template Reference

Inheritance diagram for generic_layout< extended_tile_metric, 1 >:

Public Types
enum	ExtendedTileMetricCode { ClusterCountOccupied }
typedef layout::base_metric< ::uint16_t >	metric_id_t
typedef generic_layout< extended_tile_metric, 1 >	record_t
Public Types inherited from default_layout< 1 >
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 , class Header >
static std::streamsize	map_stream (std::ostream &stream, Metric &metric, Header &, const bool)
static record_size_t	compute_size (const extended_tile_metric::header_type &)
static record_size_t	compute_header_size (const extended_tile_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)

Public Attributes
::uint16_t	code
float	value

Detailed Description

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

Extended Tile Metric Record Layout Version 1

This class provides an interface to reading the extended tile metric file:

• InterOp/ExtendedTileMetrics.bin
• InterOp/ExtendedTileMetricsOut.bin

The class takes two template arguments:

 1. Metric Type: extended_tile_metric
 2. Version: 1

Member Typedef Documentation

typedef layout::base_metric< ::uint16_t > metric_id_t

Metric ID type

typedef generic_layout<extended_tile_metric, 1> record_t

Record type

Member Enumeration Documentation

enum ExtendedTileMetricCode

Code for each extended tile metric

Enumerator
ClusterCountOccupied

Member Function Documentation

static record_size_t compute_header_size ( const extended_tile_metric::header_type &  )

inlinestatic

Compute header size

Returns

header size

static record_size_t compute_size ( const extended_tile_metric::header_type &  )

inlinestatic

Compute the size of a single metric record

Returns

record size

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

inlinestatic

Read metric from the input stream

Parameters

stream	input stream
metric	destination metric

Returns

number of bytes read or total number of bytes written

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

inlinestatic

Write metric to the output stream

Parameters

stream	output stream
metric	source metric

Returns

number of bytes read or total number of bytes written

Member Data Documentation

::uint16_t code

Tile metric code

float value

Tile metric value

---

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

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