read_summary Class Reference

#include <read_summary.h>

Public Types
typedef lane_summary_vector_t::reference	reference
typedef lane_summary_vector_t::const_reference	const_reference
typedef lane_summary_vector_t::iterator	iterator
typedef lane_summary_vector_t::const_iterator	const_iterator
typedef lane_summary_vector_t::size_type	size_type

Public Member Functions
	read_summary (const run::read_info &read=run::read_info(), const size_t channel_count=0)
lane_summary &	operator[] (const size_type n) INTEROP_THROW_SPEC((model
lane_summary &	at (const size_type n) INTEROP_THROW_SPEC((model
iterator	begin ()
iterator	end ()
void	resize (const size_type n)
run::read_info &	read ()
metric_summary &	summary ()
void	summary (const metric_summary &summary)
const lane_summary &	operator[] (const size_t n) const INTEROP_THROW_SPEC((model
const_reference	at (const size_type n) const INTEROP_THROW_SPEC((model
size_t	size () const
size_t	lane_count () const
const_iterator	begin () const
const_iterator	end () const
const run::read_info &	read () const
const metric_summary &	summary () const

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

Detailed Description

Summary statistics compiled by lane

Member Typedef Documentation

typedef lane_summary_vector_t::const_iterator const_iterator

Constant random access iterator to vector of lane_summary

typedef lane_summary_vector_t::const_reference const_reference

Constant reference to lane_summary

typedef lane_summary_vector_t::iterator iterator

Random access iterator to vector of lane_summary

typedef lane_summary_vector_t::reference reference

Reference to lane_summary

typedef lane_summary_vector_t::size_type size_type

Unsigned integral type (usually size_t)

Constructor & Destructor Documentation

read_summary ( const run::read_info &  read = run::read_info(), const size_t  channel_count = 0  )

inline

Constructor

Parameters

read	read information
channel_count	number of channels

Member Function Documentation

lane_summary& at ( const size_type  n )

inline

Get reference to lane_summary at given index

Deprecated:

Will be removed in next feature version (use operator[] instead for C++ Code)

Parameters

n

index

Returns

reference to lane_summary

iterator begin ( )

inline

Get random access iterator to start of summaries by lane

Returns

random access iterator

iterator end ( )

inline

Get random access iterator to end of summaries by lane

Returns

random access iterator

lane_summary& operator[] ( const size_type  n )

inline

Get reference to lane_summary at given index

Parameters

n

index

Returns

reference to lane_summary

run::read_info& read ( )

inline

Get read information

Returns

read information

void resize ( const size_type  n )

inline

Resize the summary by lane vector

Parameters

n	new size of summary by lane vector

metric_summary& summary ( )

inline

Get summary metrics

Returns

summary metrics

void summary ( const metric_summary &  summary )

inline

Set the summary

Parameters

summary

metric summary

Friends And Related Function Documentation

friend struct io::generic_layout

friend

---

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

• /io/interop/model/summary/read_summary.h