HEBench
Classes | Public Member Functions | Static Public Member Functions | List of all members
hebench::Utilities::BenchmarkConfigLoader Class Reference

#include <hebench_config.h>

Classes

class  FriendKey
 

Public Member Functions

 BenchmarkConfigLoader (const BenchmarkConfigLoader &)=delete
 
 BenchmarkConfigLoader (const BenchmarkConfigLoader &&)=delete
 
std::uint64_t getDefaultMinTestTimeMs () const
 
std::uint64_t getDefaultSampleSize () const
 
const std::string & getFilename () const
 Retrieves the file name used to load the yaml data. More...
 
const std::vector< std::int8_t > & getInitData () const
 
std::uint64_t getRandomSeed () const
 Retrieves the configuration random seed. More...
 
const void * getYAMLContent (const FriendKey &) const
 

Static Public Member Functions

static std::shared_ptr< BenchmarkConfigLoader > create (const std::string &yaml_filename, std::uint64_t fallback_random_seed)
 Loads a benchmark configuration from yaml data contained in a file. More...
 

Detailed Description

Definition at line 42 of file hebench_config.h.

Constructor & Destructor Documentation

◆ BenchmarkConfigLoader() [1/2]

hebench::Utilities::BenchmarkConfigLoader::BenchmarkConfigLoader ( const BenchmarkConfigLoader &  )
delete

◆ BenchmarkConfigLoader() [2/2]

hebench::Utilities::BenchmarkConfigLoader::BenchmarkConfigLoader ( const BenchmarkConfigLoader &&  )
delete

Member Function Documentation

◆ create()

std::shared_ptr< BenchmarkConfigLoader > hebench::Utilities::BenchmarkConfigLoader::create ( const std::string &  yaml_filename,
std::uint64_t  fallback_random_seed 
)
static

Loads a benchmark configuration from yaml data contained in a file.

Parameters
[in]yaml_filenameFile name containing the configuration data in yaml format.
Exceptions
Instanceof std::exception on error.
Returns
Pointer to created BenchmarkConfigLoader with valid loaded configuration data to be used by a BenchmarkConfigBroker to parse and generate a configuration for benchmark session.

Definition at line 480 of file hebench_config.cpp.

◆ getDefaultMinTestTimeMs()

std::uint64_t hebench::Utilities::BenchmarkConfigLoader::getDefaultMinTestTimeMs ( ) const
inline

Definition at line 71 of file hebench_config.h.

◆ getDefaultSampleSize()

std::uint64_t hebench::Utilities::BenchmarkConfigLoader::getDefaultSampleSize ( ) const
inline

Definition at line 72 of file hebench_config.h.

◆ getFilename()

const std::string& hebench::Utilities::BenchmarkConfigLoader::getFilename ( ) const
inline

Retrieves the file name used to load the yaml data.

Definition at line 76 of file hebench_config.h.

◆ getInitData()

const std::vector<std::int8_t>& hebench::Utilities::BenchmarkConfigLoader::getInitData ( ) const
inline

Definition at line 77 of file hebench_config.h.

◆ getRandomSeed()

std::uint64_t hebench::Utilities::BenchmarkConfigLoader::getRandomSeed ( ) const
inline

Retrieves the configuration random seed.

Returns
The random seed to be used for this configuration as loaded from the configuration file, or a system clock pre-generated seed if none was specified in the configuration file.

Definition at line 84 of file hebench_config.h.

◆ getYAMLContent()

const void* hebench::Utilities::BenchmarkConfigLoader::getYAMLContent ( const FriendKey &  ) const
inline

Definition at line 86 of file hebench_config.h.

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