Unity Scopes API
|
The Benchmark class defines an interface to provide scope authors with runtime benchmarking capabilities to be used in their own testing. More...
#include <unity/scopes/testing/Benchmark.h>
Classes | |
struct | ActionConfiguration |
The ActionConfiguration struct constains all options controlling the benchmark of scope action activation operations. More... | |
struct | ActivationConfiguration |
The ActivationConfiguration struct constains all options controlling the benchmark of scope activation operations. More... | |
struct | PreviewConfiguration |
The PreviewConfiguration struct constains all options controlling the benchmark of scope preview operations. More... | |
struct | QueryConfiguration |
The QueryConfiguration struct constains all options controlling the benchmark of scope query operations. More... | |
struct | Result |
The Result struct encapsulates all of the result gathered from one individual benchmark run consisting of multiple independent trials. More... | |
struct | StatisticsConfiguration |
The StatisticsConfiguration struct contains options controlling the calculation of benchmark result statistics. More... | |
struct | TrialConfiguration |
The TrialConfiguration struct contains options controlling the execution of individual trials. More... | |
Public Member Functions | |
virtual Result | for_query (const std::shared_ptr< unity::scopes::ScopeBase > &scope, QueryConfiguration configuration)=0 |
for_query executes a benchmark to measure the scope's query performance. More... | |
virtual Result | for_preview (const std::shared_ptr< unity::scopes::ScopeBase > &scope, PreviewConfiguration configuration)=0 |
for_preview executes a benchmark to measure the scope's preview performance. More... | |
virtual Result | for_activation (const std::shared_ptr< unity::scopes::ScopeBase > &scope, ActivationConfiguration configuration)=0 |
for_preview executes a benchmark to measure the scope's activation performance. More... | |
virtual Result | for_action (const std::shared_ptr< unity::scopes::ScopeBase > &scope, ActionConfiguration configuration)=0 |
for_preview executes a benchmark to measure the scope's action activation performance. More... | |
The Benchmark class defines an interface to provide scope authors with runtime benchmarking capabilities to be used in their own testing.
|
pure virtual |
for_preview executes a benchmark to measure the scope's action activation performance.
std::runtime_error | in case of timeouts. |
std::logic_error | in case of misconfiguration. |
scope | The scope instance to benchmark. |
configuration | Options controlling the experiment. |
Implemented in unity::scopes::testing::OutOfProcessBenchmark, and unity::scopes::testing::InProcessBenchmark.
|
pure virtual |
for_preview executes a benchmark to measure the scope's activation performance.
std::runtime_error | in case of timeouts. |
std::logic_error | in case of misconfiguration. |
scope | The scope instance to benchmark. |
configuration | Options controlling the experiment. |
Implemented in unity::scopes::testing::OutOfProcessBenchmark, and unity::scopes::testing::InProcessBenchmark.
|
pure virtual |
for_preview executes a benchmark to measure the scope's preview performance.
std::runtime_error | in case of timeouts. |
std::logic_error | in case of misconfiguration. |
scope | The scope instance to benchmark. |
configuration | Options controlling the experiment. |
Implemented in unity::scopes::testing::OutOfProcessBenchmark, and unity::scopes::testing::InProcessBenchmark.
|
pure virtual |
for_query executes a benchmark to measure the scope's query performance.
std::runtime_error | in case of timeouts. |
std::logic_error | in case of misconfiguration. |
scope | The scope instance to benchmark. |
configuration | Options controlling the experiment. |
Implemented in unity::scopes::testing::OutOfProcessBenchmark, and unity::scopes::testing::InProcessBenchmark.