HEBench
Classes | Public Types | Public Member Functions | List of all members
hebench::TestHarness::IBenchmarkDescriptor::DescriptionToken Class Reference

Token returned by a successful call to IBenchmarkDescriptor::matchBenchmarkDescriptor(). More...

#include <hebench_ibenchmark.h>

Classes

class  FriendKeyCreation
 

Public Types

typedef std::shared_ptr< DescriptionToken > Ptr
 

Public Member Functions

 DescriptionToken (IBenchmarkDescriptor &caller, const BenchmarkDescription::Backend &backend_desc, const BenchmarkDescription::Configuration &config, const BenchmarkDescription::Description &text_desc, const FriendKeyCreation &)
 
IBenchmarkDescriptor * getDescriptor ()
 
const BenchmarkDescription::Backend & getBackendDescription () const
 
const BenchmarkDescription::Configuration & getBenchmarkConfiguration () const
 
const BenchmarkDescription::Description & getDescription () const
 

Detailed Description

Token returned by a successful call to IBenchmarkDescriptor::matchBenchmarkDescriptor().

Use the token returned by IBenchmarkDescriptor::matchBenchmarkDescriptor() to instantiate the actual benchmark.

When returned by IBenchmarkDescriptor::matchBenchmarkDescriptor(), this token fields are fully and correctly set, including the backend BenchmarkDescriptor with concrete values instead of configurable placeholder values. This token can be used to describe the benchmark.

Definition at line 59 of file hebench_ibenchmark.h.

Member Typedef Documentation

◆ Ptr

typedef std::shared_ptr<DescriptionToken> hebench::TestHarness::IBenchmarkDescriptor::DescriptionToken::Ptr

Definition at line 70 of file hebench_ibenchmark.h.

Constructor & Destructor Documentation

◆ DescriptionToken()

hebench::TestHarness::IBenchmarkDescriptor::DescriptionToken::DescriptionToken ( IBenchmarkDescriptor &  caller,
const BenchmarkDescription::Backend &  backend_desc,
const BenchmarkDescription::Configuration &  config,
const BenchmarkDescription::Description &  text_desc,
const FriendKeyCreation &   
)
inline

Definition at line 73 of file hebench_ibenchmark.h.

Member Function Documentation

◆ getBackendDescription()

const BenchmarkDescription::Backend& hebench::TestHarness::IBenchmarkDescriptor::DescriptionToken::getBackendDescription ( ) const
inline

Definition at line 84 of file hebench_ibenchmark.h.

◆ getBenchmarkConfiguration()

const BenchmarkDescription::Configuration& hebench::TestHarness::IBenchmarkDescriptor::DescriptionToken::getBenchmarkConfiguration ( ) const
inline

Definition at line 85 of file hebench_ibenchmark.h.

◆ getDescription()

const BenchmarkDescription::Description& hebench::TestHarness::IBenchmarkDescriptor::DescriptionToken::getDescription ( ) const
inline

Definition at line 86 of file hebench_ibenchmark.h.

◆ getDescriptor()

IBenchmarkDescriptor* hebench::TestHarness::IBenchmarkDescriptor::DescriptionToken::getDescriptor ( )
inline

Definition at line 83 of file hebench_ibenchmark.h.

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