HART  0.2.0
High level Audio Regression and Testing
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
CLIConfig Struct Reference
Test Runner

Holds values set by the user via CLI interface. More...

#include <hart_cliconfig.hpp>

Public Member Functions

void initCommandLineArgs ()
 Inits the CLI arguments.
 
CLI::App & getCLIApp ()
 
std::string getDataRootPath () const
 Get data root path set by a "`--data-root-path`,`-d`" argument.
 
uint_fast32_t getRandomSeed () const
 Gets random seed set by a "`--seed`/`-s`" argument.
 
int getLinDecimals () const
 
int getDbDecimals () const
 
int getSecDecimals () const
 
int getHzDecimals () const
 
int getRadDecimals () const
 
int getCentsDecimals () const
 
bool shouldRunGenerators () const
 
bool shouldShuffleTasks () const
 
std::string getTags () const
 
size_t getGefaultBlockSizeFrames () const
 
size_t getDefaultNumInputChannels () const
 
size_t getDefaultNumOutputChannels () const
 
double getDefaultSampleRateHz () const
 
double getDefaultRenderDurationSeconds () const
 
size_t getDefaultRenderDurationFrames () const
 

Static Public Member Functions

static CLIConfig & getInstance ()
 Get the singleton instance.
 

Detailed Description

Holds values set by the user via CLI interface.

It's mostly intended for the internal use, but you may access it in your own test cases as well

Definition at line 12 of file hart_cliconfig.hpp.

Member Function Documentation

◆ getInstance()

static CLIConfig & getInstance ( )
inlinestatic

Get the singleton instance.

Definition at line 16 of file hart_cliconfig.hpp.

◆ initCommandLineArgs()

void initCommandLineArgs ( )
inline

Inits the CLI arguments.

Definition at line 23 of file hart_cliconfig.hpp.

◆ getCLIApp()

CLI::App & getCLIApp ( )
inline

Definition at line 99 of file hart_cliconfig.hpp.

◆ getDataRootPath()

std::string getDataRootPath ( ) const
inline

Get data root path set by a "`--data-root-path`,`-d`" argument.

Definition at line 102 of file hart_cliconfig.hpp.

◆ getRandomSeed()

uint_fast32_t getRandomSeed ( ) const
inline

Gets random seed set by a "`--seed`/`-s`" argument.

You can use it in your test cases to keep your own random-ness dependent on the global random seed

Definition at line 106 of file hart_cliconfig.hpp.

◆ getLinDecimals()

int getLinDecimals ( ) const
inline
See also
linPrecision

Definition at line 109 of file hart_cliconfig.hpp.

◆ getDbDecimals()

int getDbDecimals ( ) const
inline
See also
dbPrecision

Definition at line 112 of file hart_cliconfig.hpp.

◆ getSecDecimals()

int getSecDecimals ( ) const
inline
See also
secPrecision

Definition at line 115 of file hart_cliconfig.hpp.

◆ getHzDecimals()

int getHzDecimals ( ) const
inline
See also
hzPrecision

Definition at line 118 of file hart_cliconfig.hpp.

◆ getRadDecimals()

int getRadDecimals ( ) const
inline
See also
radPrecision

Definition at line 121 of file hart_cliconfig.hpp.

◆ getCentsDecimals()

int getCentsDecimals ( ) const
inline
See also
centsPrecision

Definition at line 124 of file hart_cliconfig.hpp.

◆ shouldRunGenerators()

bool shouldRunGenerators ( ) const
inline

Definition at line 126 of file hart_cliconfig.hpp.

◆ shouldShuffleTasks()

bool shouldShuffleTasks ( ) const
inline

Definition at line 127 of file hart_cliconfig.hpp.

◆ getTags()

std::string getTags ( ) const
inline

Definition at line 128 of file hart_cliconfig.hpp.

◆ getGefaultBlockSizeFrames()

size_t getGefaultBlockSizeFrames ( ) const
inline

Definition at line 130 of file hart_cliconfig.hpp.

◆ getDefaultNumInputChannels()

size_t getDefaultNumInputChannels ( ) const
inline

Definition at line 131 of file hart_cliconfig.hpp.

◆ getDefaultNumOutputChannels()

size_t getDefaultNumOutputChannels ( ) const
inline

Definition at line 132 of file hart_cliconfig.hpp.

◆ getDefaultSampleRateHz()

double getDefaultSampleRateHz ( ) const
inline

Definition at line 133 of file hart_cliconfig.hpp.

◆ getDefaultRenderDurationSeconds()

double getDefaultRenderDurationSeconds ( ) const
inline

Definition at line 134 of file hart_cliconfig.hpp.

◆ getDefaultRenderDurationFrames()

size_t getDefaultRenderDurationFrames ( ) const
inline

Definition at line 135 of file hart_cliconfig.hpp.

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