flowcell_layout Class Reference

#include <flowcell_layout.h>

Public Types
typedef constants::tile_naming_method	tile_naming_method_t
typedef std::vector< std::string >	str_vector_t
typedef ::uint32_t	uint_t

Public Member Functions
	flowcell_layout (const uint_t lane_count=1, const uint_t surface_count=1, const uint_t swath_count=1, const uint_t tile_count=1, const uint_t sections_per_lane=1, const uint_t lanes_per_section=1, const str_vector_t &tiles=str_vector_t(), const tile_naming_method_t naming_method=constants::UnknownTileNamingMethod, const std::string &barcode="")
uint_t	lane_count () const
uint_t	surface_count () const
bool	supports_multisurface () const
const std::vector< uint_t > &	surface_list () const
uint_t	swath_count () const
uint_t	tile_count () const
uint_t	sections_per_lane () const
uint_t	lanes_per_section () const
uint_t	total_number_of_sections () const
tile_naming_method_t	naming_method () const
const str_vector_t &	tiles () const
const std::string &	barcode () const
size_t	total_swaths (const bool all_surfaces) const
size_t	tiles_per_lane () const
size_t	total_tiles () const
void	set_naming_method (const constants::tile_naming_method naming_method)
void	lane_count (const uint_t lane_count)
void	surface_count (const uint_t surface_count)
void	swath_count (const uint_t swath_count)
void	tile_count (const uint_t tile_count)
void	sections_per_lane (const uint_t count)
void	lanes_per_section (const uint_t count)

Friends
class	info

Detailed Description

Layout of the flow cell

Member Typedef Documentation

typedef std::vector<std::string> str_vector_t

Define string vector type

typedef constants::tile_naming_method tile_naming_method_t

Define tile naming method type

typedef ::uint32_t uint_t

Define an unsigned int

Constructor & Destructor Documentation

flowcell_layout ( const uint_t  lane_count = 1, const uint_t  surface_count = 1, const uint_t  swath_count = 1, const uint_t  tile_count = 1, const uint_t  sections_per_lane = 1, const uint_t  lanes_per_section = 1, const str_vector_t &  tiles = str_vector_t(), const tile_naming_method_t  naming_method = constants::UnknownTileNamingMethod, const std::string &  barcode = ""  )

inline

Constructor

Parameters

lane_count	number of lanes
surface_count	number of surfaces
swath_count	number of swaths
tile_count	number of tiles
sections_per_lane	number of sections per lane (number of cameras per lane)
lanes_per_section	number of lanes per section (number of lanes a camera covers)
tiles	vector of tile names
naming_method	tile naming method
barcode	flowcell barcode

Member Function Documentation

void lane_count ( const uint_t  lane_count )

inline

Set number of lanes

Parameters

lane_count

number of lanes

void lanes_per_section ( const uint_t  count )

inline

Set number of lanes per section

Parameters

count

number of lanes per section

void sections_per_lane ( const uint_t  count )

inline

Set number of sections per lane

Parameters

count

number of sections per lane

void set_naming_method ( const constants::tile_naming_method  naming_method )

inline

Set the tile naming method

Parameters

naming_method

tile naming method

void surface_count ( const uint_t  surface_count )

inline

Set number of surfaces

Parameters

surface_count

number of surfaces

void swath_count ( const uint_t  swath_count )

inline

Set number of swathes

Parameters

swath_count

number of swathes

void tile_count ( const uint_t  tile_count )

inline

Set number of tiles

Parameters

tile_count

number of tiles

size_t tiles_per_lane ( ) const

inline

Get the total number of tiles

Returns

total number of tiles per lane

size_t total_swaths ( const bool  all_surfaces ) const

inline

Get the number of swaths

Parameters

all_surfaces

if true, multiply the number by 2

Returns

number of columns

size_t total_tiles ( ) const

inline

Get total number of tiles for the flowcell

Returns

total number of tiles on the flowcell

Friends And Related Function Documentation

friend class info

friend

---

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

• /io/interop/model/run/flowcell_layout.h