---

5.4.3 C++ Exec Report Reference

C++ Type: exec_report ¶

Valid objects of this type represent the report generated by a single execution of a test_case object.

C++ Constructor: exec_report::exec_report () ¶

Preconditions:

1. None.

Effects:

1. None.

Postconditions:

1. The only operations defined on *this are the assignment and the destruction.

C++ Constructor: exec_report::exec_report (exec_report&& other) noexcept ¶

C++ Assignment Operator: exec_report& exec_report::operator= (exec_report&& other) noexcept ¶

Preconditions:

1. None.

Effects:

1. The validity from other is transferred to *this.
2. The state of other is transferred to *this if other is valid.

Postconditions:

1. other is not a valid object. Only destruction and assignment are defined on it.

Other helper types are:

C++ Type: total_time_type ¶

This structure contains two public members—seconds and nanoseconds—and a function template to<T>() to convert the result using std::chrono::duration_cast.. Valid objects of this type represent the report generated by a single execution of a test_case object.

C++ Type: <time-unit> ¶

Internal template. Has two members: to_unit which returns its value in std::chrono::nanoseconds and value which returns the underlying double value.

C++ Type: <iteration-unit> ¶

Internal template. Has two members: to_unit which returns its value in std::size_t and value which returns the underlying double value.

C++ Type: <iteration-stat> ¶

C++ Type: <time-stat> ¶

Internal template. Has three <iteration-unit> or <time-unit> fields: mean, std_deviation and variance.

C++ Type: <time-samples> ¶

Internal alias of a collection of time samples.

C++ Method: char const* exec_report::name () const ¶

Preconditions:

1. *this is a valid object.

Effects:

1. None.

Postconditions:

1. If state::set_name was called during the execution associated to *this, the returned value is equivalent to the last value provided during that execution.

C++ Method: std::vector<std::size_t> exec_report::sizes () const ¶

Preconditions:

1. *this is a valid object.

Effects:

1. None.

Postconditions:

1. The return value is equivalent to the value returned by state::sizes during the execution associated to *this.

C++ Method: std::size_t exec_report::iterations () const ¶

Preconditions:

1. *this is a valid object.

Effects:

1. None.

Postconditions:

1. The return value represents the sampled iterations performed by the execution associated to *this.

C++ Method: std::size_t exec_report::total_iterations () const ¶

Preconditions:

1. *this is a valid object.

Effects:

1. None.

Postconditions:

1. The return value represents the total iterations performed by the execution associated to *this.

C++ Method: <total-time-type> exec_report::total_time () const ¶

Preconditions:

1. *this is a valid object.

Effects:

1. None.

Postconditions:

1. The return value represents the total time elapsed during the execution associated to *this.

C++ Method: <time-samples> exec_report::time_samples () const ¶

Preconditions:

1. *this is a valid object.

Effects:

1. None.

Postconditions:

1. The return value represents the time samples collected during the execution associated to *this.

C++ Method: std::size_t exec_report::total_samples () const ¶

Preconditions:

1. *this is a valid object.

Effects:

1. None.

Postconditions:

1. The return value represents the number of samples collected during the execution associated to *this.

C++ Method: std::size_t exec_report::used_samples () const ¶

Preconditions:

1. *this is a valid object.

Effects:

1. None.

Postconditions:

1. The return value represents the number of samples used for the statistical data generation of the test execution associated to *this.

C++ Method: <time-stat> exec_report::iteration_time () const ¶

Preconditions:

1. *this is a valid object.

Effects:

1. None.

Postconditions:

1. The return value represents the aggregated time per iteration data of the execution associated to *this.

C++ Method: <time-stat> exec_report::sample_time () const ¶

Preconditions:

1. *this is a valid object.

Effects:

1. None.

Postconditions:

1. The return value represents the aggregated time per sample data of the execution associated to *this.

C++ Method: <iteration-stat> exec_report::sample_iterations () const ¶

Preconditions:

1. *this is a valid object.

Effects:

1. None.

Postconditions:

1. The return value represents the aggregated sample time data of the execution associated to *this.