#include <plot_regression_test_generator.h>

Inheritance diagram for plot_regression_test_generator< PlotData >:

Public Member Functions
plot_regression_test_generator (const std::string &test_dir, const constants::plot_types plot_type)

plot_regression_test_generator (const std::string &run_folder, const std::string &test_dir, const constants::plot_types plot_type)

std::string baseline () const

Public Member Functions inherited from abstract_regression_test_generator< PlotData >
abstract_regression_test_generator (const std::string &test_dir, const int test_modifier=0)

abstract_regression_test_generator (const std::string &run_folder, const std::string &test_dir, const int test_modifier=0)

base_t operator() (const std::string &name) const

::testing::AssertionResult generate (PlotData &expected, PlotData &actual, bool *skip_test) const

Public Member Functions inherited from abstract_generator< PlotData >
abstract_generator (const int test_modifier=0)

virtual ~abstract_generator ()

int test_modifier () const

std::string info () const

Protected Member Functions
bool generate_actual (const std::string &run_folder, PlotData &actual) const

void write (std::ostream &out) const

bool advance ()

base_type clone () const

base_type clone (const std::string &run_folder) const

bool read_expected (const std::string &baseline_file, PlotData &expected) const

bool write_actual (const std::string &baseline_file, const PlotData &actual) const

Additional Inherited Members
Public Types inherited from abstract_regression_test_generator< PlotData >
typedef abstract_generator< PlotData >::parent_type base_t

Public Types inherited from abstract_generator< PlotData >
typedef generator_ptr< PlotData > parent_type

Protected Attributes inherited from abstract_regression_test_generator< PlotData >
std::string m_run_folder

std::string m_test_dir

Detailed Description

template<class PlotData>
class illumina::interop::unittest::plot_regression_test_generator< PlotData >

Plot regression test fixture

Constructor & Destructor Documentation

plot_regression_test_generator	(	const std::string &	test_dir,
		const constants::plot_types	plot_type
	)

inline

Constructor

Parameters

test_dir	sub directory containing the tests
plot_type	type of the plot

plot_regression_test_generator	(	const std::string &	run_folder,
		const std::string &	test_dir,
		const constants::plot_types	plot_type
	)

inline

Constructor

Parameters

run_folder	run folder
test_dir	sub directory containing the tests
plot_type	type of the plot

Member Function Documentation

bool advance ( )

inlineprotectedvirtual

Advance to the next type

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

Reimplemented from abstract_generator< PlotData >.

std::string baseline ( ) const

inlinevirtual

Get the full path of the baseline output file

Returns: full path

Reimplemented from abstract_regression_test_generator< PlotData >.

base_type clone ( ) const

inlineprotectedvirtual

Create a copy of this object

Returns: pointer to an abstract_generator

Implements abstract_regression_test_generator< PlotData >.

base_type clone ( const std::string & run_folder ) const

inlineprotectedvirtual

Create a copy of this object

Returns: pointer to an abstract_generator

Implements abstract_regression_test_generator< PlotData >.

bool generate_actual	(	const std::string &	run_folder,
		PlotData &	actual
	)		const

inlineprotectedvirtual

Read the actual data from the run folder

Parameters

run_folder	run folder
actual	actual model data

Returns: true if data was generated

Implements abstract_regression_test_generator< PlotData >.

bool read_expected	(	const std::string &	baseline_file,
		PlotData &	expected
	)		const

inlineprotectedvirtual

Read the expected data from the baseline file into the model

Parameters

baseline_file	baseline file
expected	expected model data

Returns: true if the file was found, and the read completed without failure

Implements abstract_regression_test_generator< PlotData >.

void write ( std::ostream & out ) const

inlineprotectedvirtual

Write generator info to output stream

Parameters

out	output stream

Implements abstract_generator< PlotData >.

bool write_actual	(	const std::string &	baseline_file,
		const PlotData &	actual
	)		const

inlineprotectedvirtual

Write the actual data to the run folder

Parameters

baseline_file	baseline file
actual	actual model data

Implements abstract_regression_test_generator< PlotData >.

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

/io/src/tests/interop/logic/inc/plot_regression_test_generator.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

template<class PlotData> class illumina::interop::unittest::plot_regression_test_generator< PlotData >

Constructor & Destructor Documentation

Member Function Documentation

template<class PlotData>
class illumina::interop::unittest::plot_regression_test_generator< PlotData >