CLIConfig Struct Reference

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 ()
	Get data root path set by a "`--data-root-path`,`-d`" argument.
uint_fast32_t	getRandomSeed ()
	Gets random seed set by a "`--seed`/`-s`" argument.
int	getLinDecimals ()
int	getDbDecimals ()
int	getSecDecimals ()
int	getHzDecimals ()
int	getRadDecimals ()
int	getCentsDecimals ()
bool	shouldRunGenerators ()
bool	shouldShuffleTasks ()
std::string &	getTags ()
size_t	getGefaultBlockSizeFrames () const
size_t	getDefaultNumInputChannels () const
size_t	getDefaultNumOutputChannels () const
double	getDefaultSampleRateHz () const
double	getDefaultRenderDurationSeconds () 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 ( )

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 ( )

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 ( )

inline

See also

linPrecision

Definition at line 109 of file hart_cliconfig.hpp.

getDbDecimals()

int getDbDecimals ( )

inline

See also

dbPrecision

Definition at line 112 of file hart_cliconfig.hpp.

getSecDecimals()

int getSecDecimals ( )

inline

See also

secPrecision

Definition at line 115 of file hart_cliconfig.hpp.

getHzDecimals()

int getHzDecimals ( )

inline

See also

hzPrecision

Definition at line 118 of file hart_cliconfig.hpp.

getRadDecimals()

int getRadDecimals ( )

inline

See also

radPrecision

Definition at line 121 of file hart_cliconfig.hpp.

getCentsDecimals()

int getCentsDecimals ( )

inline

See also

centsPrecision

Definition at line 124 of file hart_cliconfig.hpp.

shouldRunGenerators()

bool shouldRunGenerators ( )

inline

Definition at line 126 of file hart_cliconfig.hpp.

shouldShuffleTasks()

bool shouldShuffleTasks ( )

inline

Definition at line 127 of file hart_cliconfig.hpp.

getTags()

std::string & getTags ( )

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.

---

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

• include/hart_cliconfig.hpp