metric_filter_iterator Class Reference

#include <metric_filter_iterator.h>

Public Member Functions
	metric_filter_iterator ()
	metric_filter_iterator (const metric_filter_iterator &source)
void	reset (const std::string &run_info_filename, const constants::plot_types plot_type)
void	plot (model::metrics::run_metrics &run, model::plot::plot_data< model::plot::candle_stick_point > &data) const
void	plot (model::metrics::run_metrics &run, model::plot::plot_data< model::plot::bar_point > &data) const
void	plot (model::metrics::run_metrics &run, model::plot::heatmap_data &data) const
void	plot (model::metrics::run_metrics &run, model::plot::flowcell_data &data) const
void	reset (const model::run::info &run_info, const constants::plot_types plot_type)
constants::metric_type	metric () const
const model::plot::filter_options &	options () const
bool	advance ()
bool	is_done ()
metric_type_vector_t &	metric_types ()

Protected Member Functions
void	reset ()

Protected Attributes
metric_type_vector_t	m_metric_types
model::plot::filter_options	m_options

Detailed Description

Iterator over metric types and filter options

Constructor & Destructor Documentation

metric_filter_iterator ( )

inline

Constructor

metric_filter_iterator ( const metric_filter_iterator &  source )

inline

Copy constructor

Parameters

source

source iterator to copy

Member Function Documentation

bool advance ( )

inline

Advance to the next type

Returns

true when the generator has finished, and the next parameter can be obtained

bool is_done ( )

inline

Test if the iterator is exhausted

Returns

true when the generator has finished

constants::metric_type metric ( ) const

inline

Get current metric

Returns

current metric

metric_type_vector_t& metric_types ( )

inline

Get a vector of metric types

Returns

vector of metric types

const model::plot::filter_options& options ( ) const

inline

Get filter options

Returns

filter options

void plot ( model::metrics::run_metrics &  run, model::plot::plot_data< model::plot::candle_stick_point > &  data  ) const

inline

Plot a run by lane or cycle

Parameters

run	run metrics
data	candle stick plot data

void plot ( model::metrics::run_metrics &  run, model::plot::plot_data< model::plot::bar_point > &  data  ) const

inline

Plot a histogram of the q-scores

Parameters

run	run metrics
data	bar plot data

void plot ( model::metrics::run_metrics &  run, model::plot::heatmap_data &  data  ) const

inline

Plot a q-score heat map of the run

Parameters

run	run metrics
data	heatmap plot data

void plot ( model::metrics::run_metrics &  run, model::plot::flowcell_data &  data  ) const

inline

Plot a flow cell of the run

Parameters

run	run metrics
data	flowcell plot data

void reset ( const std::string &  run_info_filename, const constants::plot_types  plot_type  )

inline

Reset iterator ranges and set to start

Parameters

run_info_filename	path to run info xml
plot_type	type of the plot

void reset ( const model::run::info &  run_info, const constants::plot_types  plot_type  )

inline

Reset iterator ranges and set to start

Parameters

run_info	run info
plot_type	type of the plot

void reset ( )

inlineprotected

Reset the metric iterator

Member Data Documentation

metric_type_vector_t m_metric_types

protected

Vector of metrics

model::plot::filter_options m_options

protected

Filter options

---

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

• /io/src/tests/interop/logic/inc/metric_filter_iterator.h