index_flowcell_summary Class Reference

#include <index_flowcell_summary.h>

Public Types

typedef std::vector< index_lane_summarylane_summary_vector_t
 
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

 index_flowcell_summary (const size_t n=0)
 
index_lane_summaryoperator[] (const size_t n) INTEROP_THROW_SPEC((model
 
const index_lane_summaryoperator[] (const size_t n) const INTEROP_THROW_SPEC((model
 
index_lane_summaryat (const size_t n) INTEROP_THROW_SPEC((model
 
const_reference at (const size_type n) const INTEROP_THROW_SPEC((model
 
size_t size () const
 
void resize (const size_type n)
 
iterator begin ()
 
iterator end ()
 
const_iterator begin () const
 
const_iterator end () const
 
void sort ()
 
void clear ()
 

Friends

template<class MetricType , int Version>
struct io::generic_layout
 
std::ostream & operator<< (std::ostream &out, const index_flowcell_summary &summary)
 
std::istream & operator>> (std::istream &in, index_flowcell_summary &summary)
 

Detailed Description

Summary of metrics for index reads for the entire flowcell

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

Lane summary vector type

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

index_flowcell_summary ( const size_t  n = 0)
inline

Constructor

Parameters
nnumber of lanes

Member Function Documentation

iterator begin ( )
inline

Get random access iterator to start of summaries by read

Returns
random access iterator
const_iterator begin ( ) const
inline

Get constant random access iterator to start of summaries by read

Returns
constant random access iterator
void clear ( )
inline

Clear the lane info

iterator end ( )
inline

Get random access iterator to end of summaries by read

Returns
random access iterator
const_iterator end ( ) const
inline

Get constant random access iterator to end of summaries by read

Returns
constant random access iterator
void resize ( const size_type  n)
inline

Allocate space for the number of lanes

Parameters
nnumber of lanes
void sort ( )
inline

Sort the index summaries in each lane

Friends And Related Function Documentation

friend struct io::generic_layout
friend
std::ostream& operator<< ( std::ostream &  out,
const index_flowcell_summary summary 
)
friend
std::istream& operator>> ( std::istream &  in,
index_flowcell_summary summary 
)
friend

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