parameters Class Reference

#include <parameters.h>

Public Types
typedef ::uint32_t	uint_t
typedef constants::instrument_type	instrument_type_t

Public Member Functions
	parameters (const uint_t version=0, const instrument_type_t instrument_type=constants::UnknownInstrument)
instrument_type_t	instrument_type () const
uint_t	version () const

Detailed Description

Metadata describing sequencing run

This class parses the RunParameters.xml XML file. It only provides the instrument type and version of the XML file format. We do not plan to support parsing any other values in this file.

This class is only used on legacy platforms where:

1. The channel names were not given in the RunInfo.xml
2. The bins were not provided in the header of the QMetrics.bin (v4)

We do not support parsing this file on later platforms.

120705_11618Unbin1R2I

Test:

Confirm MiSeq version of the XML format is properly

131212_221Bin1R0I

Test:

Confirm HiSeq version of the XML format is properly

6471489_213Bin1R0I

Test:

Confirm NexSeq version of the XML format is properly

https://basespace.illumina.com/run/195891710/iSeq-100-Illumina-RNA-Prep-with-Enrichment-and-RVOPv2-SARS-CoV-2-Synthetic-RNA-Control-/details

Test:

Confirm NexSeq version of the XML format is properly

6471489_213Bin1R0I

Test:

Confirm NexSeq version of the XML format is properly

Member Typedef Documentation

typedef constants::instrument_type instrument_type_t

Instrument type enum

typedef ::uint32_t uint_t

Unsigned integer type

Constructor & Destructor Documentation

parameters ( const uint_t  version = 0, const instrument_type_t  instrument_type = constants::UnknownInstrument  )

inline

Constructor

Parameters

version	XML format version
instrument_type	type code of the instrument

---

The documentation for this class was generated from the following files:

• /io/interop/model/run/parameters.h
• /io/src/interop/model/run/parameters.cpp