#include <run_summary.h>

Public Types
typedef std::vector< read_summary >	read_summary_vector_t

typedef read_summary_vector_t::reference	reference

typedef read_summary_vector_t::const_reference	const_reference

typedef read_summary_vector_t::iterator	iterator

typedef read_summary_vector_t::const_iterator	const_iterator

typedef read_summary_vector_t::size_type	size_type

Public Member Functions
	run_summary ()

template<typename I >
	run_summary (I beg, I end, const size_t lane_count, const size_t surface_count, const size_t channel_count)

	run_summary (const std::vector< run::read_info > &reads, const size_t lane_count, const size_t surface_count, const size_t channel_count)

void	initialize (const run::info &run_info)

void	initialize (const std::vector< run::read_info > &reads, const size_t lane_count, const size_t surface_count, const size_t channel_count)

void	copy_reads (std::vector< run::read_info > &dst)

read_summary &	operator[] (const size_t n) INTEROP_THROW_SPEC((model

const read_summary &	operator[] (const size_t n) const INTEROP_THROW_SPEC((model

read_summary &	at (const size_t n) INTEROP_THROW_SPEC((model

const_reference	at (const size_type n) const INTEROP_THROW_SPEC((model

size_t	size () const

iterator	begin ()

iterator	end ()

const_iterator	begin () const

const_iterator	end () const

size_t	lane_count () const

void	lane_count (const size_t lane_count)

size_t	surface_count () const

size_t	channel_count () const

void	surface_count (const size_t surface_count)

const metric_summary &	total_summary () const

metric_summary &	total_summary ()

void	total_summary (const metric_summary &summary)

const metric_summary &	nonindex_summary () const

metric_summary &	nonindex_summary ()

void	nonindex_summary (const metric_summary &summary)

const cycle_state_summary &	cycle_state () const

cycle_state_summary &	cycle_state ()

void	clear ()

Friends
template<class MetricType , int Version>
struct	io::generic_layout

std::ostream &	operator<< (std::ostream &out, const run_summary &summary)

std::istream &	operator>> (std::istream &in, run_summary &summary)

Detailed Description

Summary statistics over entire run

Member Typedef Documentation

typedef read_summary_vector_t::const_iterator const_iterator

Constant random access iterator to vector of read_summary

typedef read_summary_vector_t::const_reference const_reference

Constant reference to read_summary

typedef read_summary_vector_t::iterator iterator

Random access iterator to vector of read_summary

typedef std::vector<read_summary> read_summary_vector_t

Read summary vector type

typedef read_summary_vector_t::reference reference

Reference to read_summary

typedef read_summary_vector_t::size_type size_type

Unsigned integral type (usually size_t)

Constructor & Destructor Documentation

run_summary ( )

inline

Constructor

run_summary	(	I	beg,
		I	end,
		const size_t	lane_count,
		const size_t	surface_count,
		const size_t	channel_count
	)

inline

Constructor

Parameters

beg	iterator to start of read collection
end	iterator to end of read collection
lane_count	number of lanes on flowcell
surface_count	number of surfaces on flowcell
channel_count	number of channels

run_summary	(	const std::vector< run::read_info > &	reads,
		const size_t	lane_count,
		const size_t	surface_count,
		const size_t	channel_count
	)

inline

Constructor

Parameters

reads	read info vector
lane_count	number of lanes on flowcell
surface_count	number of surfaces on flowcell
channel_count	number of channels

Member Function Documentation

void clear ( )

inline

Clear the contents of the summary

void copy_reads ( std::vector< run::read_info > & dst )

inline

Copy reads to destination vector

Parameters

dst	destination vector

void initialize ( const run::info & run_info )

inline

Initialize the run summary with the run info

Parameters

run_info run info

void initialize	(	const std::vector< run::read_info > &	reads,
		const size_t	lane_count,
		const size_t	surface_count,
		const size_t	channel_count
	)

inline

Initialize the run summary with the number of reads and lanes

Parameters

reads	vector of reads
lane_count	number of lanes
surface_count	number of surfaces on flowcell
channel_count	number of channels

Friends And Related Function Documentation

friend struct io::generic_layout

friend

std::ostream& operator<<	(	std::ostream &	out,
		const run_summary &	summary
	)

friend

std::istream& operator>>	(	std::istream &	in,
		run_summary &	summary
	)

friend

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

/io/interop/model/summary/run_summary.h

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation