Public Member Functions | Public Attributes
hayai::ConsoleOutputter Class Reference

Console outputter. More...

#include <hayai_console_outputter.hpp>

Inheritance diagram for hayai::ConsoleOutputter:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual void Begin (const std::size_t &enabledCount, const std::size_t &disabledCount)
 Begin benchmarking.
void BeginOrSkipTest (const std::string &fixtureName, const std::string &testName, const TestParametersDescriptor &parameters, const std::size_t &runsCount, const std::size_t &iterationsCount, const bool skip)
virtual void BeginTest (const std::string &fixtureName, const std::string &testName, const TestParametersDescriptor &parameters, const std::size_t &runsCount, const std::size_t &iterationsCount)
 Begin benchmark test run.
 ConsoleOutputter (std::ostream &stream=std::cout)
 Initialize console outputter.
virtual void End (const std::size_t &executedCount, const std::size_t &disabledCount)
 End benchmarking.
virtual void EndTest (const std::string &fixtureName, const std::string &testName, const TestParametersDescriptor &parameters, const TestResult &result)
 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)
 Skip disabled benchmark test run.

Public Attributes

std::ostream & _stream

Detailed Description

Console outputter.

Prints the result to standard output.

Definition at line 12 of file hayai_console_outputter.hpp.


Constructor & Destructor Documentation

hayai::ConsoleOutputter::ConsoleOutputter ( std::ostream &  stream = std::cout) [inline]

Initialize console outputter.

Parameters:
streamOutput stream. Must exist for the entire duration of the outputter's use.

Definition at line 20 of file hayai_console_outputter.hpp.


Member Function Documentation

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

Begin benchmarking.

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

Parameters:
enabledCountNumber of benchmarks to be executed.
disabledCountNumber of disabled benchmarks to be skipped.

Implements hayai::Outputter.

Definition at line 27 of file hayai_console_outputter.hpp.

void hayai::ConsoleOutputter::BeginOrSkipTest ( const std::string &  fixtureName,
const std::string &  testName,
const TestParametersDescriptor parameters,
const std::size_t &  runsCount,
const std::size_t &  iterationsCount,
const bool  skip 
) [inline]

Definition at line 75 of file hayai_console_outputter.hpp.

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

Begin benchmark test run.

Parameters:
fixtureNameFixture name.
testNameTest name.
parametersTest parameter description.
runsCountNumber of runs to be executed.
iterationsCountNumber of iterations per run.

Implements hayai::Outputter.

Definition at line 104 of file hayai_console_outputter.hpp.

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

End benchmarking.

Parameters:
executedCountNumber of benchmarks that have been executed.
disabledCountNumber of benchmarks that have been skipped because they are disabled.

Implements hayai::Outputter.

Definition at line 51 of file hayai_console_outputter.hpp.

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

End benchmark test run.

Parameters:
fixtureNameFixture name.
testNameTest name.
parametersTest parameter description.
resultTest result.

Implements hayai::Outputter.

Definition at line 136 of file hayai_console_outputter.hpp.

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

Skip disabled benchmark test run.

Parameters:
fixtureNameFixture name.
testNameTest name.
parametersTest parameter description.
runsCountNumber of runs to be executed.
iterationsCountNumber of iterations per run.

Implements hayai::Outputter.

Definition at line 119 of file hayai_console_outputter.hpp.


Member Data Documentation

Definition at line 256 of file hayai_console_outputter.hpp.


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


hayai
Author(s): Nick Bruun
autogenerated on Thu Jun 6 2019 18:13:43