hayai::Outputter Class Reference

Outputter. More...

#include <hayai_outputter.hpp>

Inheritance diagram for hayai::Outputter:

List of all members.

Public Member Functions
virtual void	Begin (const std::size_t &enabledCount, const std::size_t &disabledCount)=0
	Begin benchmarking.
virtual void	BeginTest (const std::string &fixtureName, const std::string &testName, const TestParametersDescriptor &parameters, const std::size_t &runsCount, const std::size_t &iterationsCount)=0
	Begin benchmark test run.
virtual void	End (const std::size_t &executedCount, const std::size_t &disabledCount)=0
	End benchmarking.
virtual void	EndTest (const std::string &fixtureName, const std::string &testName, const TestParametersDescriptor &parameters, const TestResult &result)=0
	End benchmark test run.
virtual void	SkipDisabledTest (const std::string &fixtureName, const std::string &testName, const TestParametersDescriptor &parameters, const std::size_t &runsCount, const std::size_t &iterationsCount)=0
	Skip disabled benchmark test run.
virtual	~Outputter ()
Static Protected Member Functions
static void	WriteTestNameToStream (std::ostream &stream, const std::string &fixtureName, const std::string &testName, const TestParametersDescriptor &parameters)
	Write a nicely formatted test name to a stream.

---

Detailed Description

Outputter.

Abstract base class for outputters.

Definition at line 14 of file hayai_outputter.hpp.

---

Constructor & Destructor Documentation

virtual hayai::Outputter::~Outputter

(

)

[inline, virtual]

Definition at line 78 of file hayai_outputter.hpp.

---

Member Function Documentation

virtual void hayai::Outputter::Begin	(	const std::size_t &	enabledCount,
		const std::size_t &	disabledCount
	)		[pure virtual]

Begin benchmarking.

The total number of benchmarks registred is the sum of the two counts passed to the outputter.

Parameters:

enabledCount	Number of benchmarks to be executed.
disabledCount	Number of disabled benchmarks to be skipped.

Implemented in hayai::JUnitXmlOutputter, hayai::JsonOutputter, and hayai::ConsoleOutputter.

virtual void hayai::Outputter::BeginTest	(	const std::string &	fixtureName,
		const std::string &	testName,
		const TestParametersDescriptor &	parameters,
		const std::size_t &	runsCount,
		const std::size_t &	iterationsCount
	)		[pure virtual]

Begin benchmark test run.

Parameters:

fixtureName	Fixture name.
testName	Test name.
parameters	Test parameter description.
runsCount	Number of runs to be executed.
iterationsCount	Number of iterations per run.

Implemented in hayai::JUnitXmlOutputter, hayai::ConsoleOutputter, and hayai::JsonOutputter.

virtual void hayai::Outputter::End	(	const std::size_t &	executedCount,
		const std::size_t &	disabledCount
	)		[pure virtual]

End benchmarking.

Parameters:

executedCount	Number of benchmarks that have been executed.
disabledCount	Number of benchmarks that have been skipped because they are disabled.

Implemented in hayai::JsonOutputter, hayai::JUnitXmlOutputter, and hayai::ConsoleOutputter.

virtual void hayai::Outputter::EndTest	(	const std::string &	fixtureName,
		const std::string &	testName,
		const TestParametersDescriptor &	parameters,
		const TestResult &	result
	)		[pure virtual]

End benchmark test run.

Parameters:

fixtureName	Fixture name.
testName	Test name.
parameters	Test parameter description.
result	Test result.

Implemented in hayai::JUnitXmlOutputter, hayai::ConsoleOutputter, and hayai::JsonOutputter.

virtual void hayai::Outputter::SkipDisabledTest	(	const std::string &	fixtureName,
		const std::string &	testName,
		const TestParametersDescriptor &	parameters,
		const std::size_t &	runsCount,
		const std::size_t &	iterationsCount
	)		[pure virtual]

Skip disabled benchmark test run.

Parameters:

fixtureName	Fixture name.
testName	Test name.
parameters	Test parameter description.
runsCount	Number of runs to be executed.
iterationsCount	Number of iterations per run.

Implemented in hayai::JUnitXmlOutputter, hayai::ConsoleOutputter, and hayai::JsonOutputter.

static void hayai::Outputter::WriteTestNameToStream	(	std::ostream &	stream,
		const std::string &	fixtureName,
		const std::string &	testName,
		const TestParametersDescriptor &	parameters
	)		[inline, static, protected]

Write a nicely formatted test name to a stream.

Definition at line 84 of file hayai_outputter.hpp.

---

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

• hayai_outputter.hpp