This class stores the configuration data loaded from file. All data are placed in the config global variable that can be accessed anywhere in the code. More...

#include <config_data.h>

Public Member Functions
	ConfigData ()

	ConfigData (std::string &algorithm_name, const std::string &mask_name, bool use_frequencies=false)

std::filesystem::path	GetDotCodePath (const std::string &out_base_name)

std::filesystem::path	GetDotOutPath (const std::string &out_base_name)

std::filesystem::path	GetForestCodePath (const std::string &out_base_name)

std::filesystem::path	GetFrequenciesPath (const std::string &datasets_name) const

std::filesystem::path	GetCustomOdtPath (const std::string &custom_suffix) const

std::string	GetDatasetsString (const std::string &separator=", ")

void	UpdateAlgoNameWithDatasets ()

void	SetDescription (std::string description)

Public Attributes
std::string	description_ = ""

std::string	config_file_ = "config.yaml"

std::filesystem::path	global_output_path_

std::filesystem::path	algorithm_output_path_

std::filesystem::path	global_input_path_

std::string	algorithm_name_

std::string	mask_name_

std::string	dot_background_color_ = "\"transparent\""

std::string	dot_output_format_ = ".pdf"

std::string	dot_ranksep_ = "0.5"

std::string	dotcode_suffix_ = "_dotcode.txt"

std::filesystem::path	dotcode_path_

std::string	odt_suffix_ = "_odt.txt"

std::filesystem::path	odt_path_

std::string	code_suffix_ = "_code.cpp"

std::filesystem::path	code_path_

std::string	treecode_suffix_ = "_tree_code.inc.h"

std::filesystem::path	treecode_path_

std::string	forestcode_suffix_ = "_forest_code.inc.h"

std::filesystem::path	forestcode_path_

std::string	treedagcode_suffix_ = "_tree_dag_code.inc.h"

std::filesystem::path	treedagcode_path_

std::string	forestdagcode_suffix_ = "_forest_dag_code.inc.h"

std::filesystem::path	forestdagcode_path_

std::string	rstable_suffix_ = "_rstable.yaml"

std::filesystem::path	rstable_path_

std::vector< std::string >	datasets_

std::vector< std::filesystem::path >	datasets_path_

std::string	frequencies_local_path_ = "frequencies"

std::filesystem::path	frequencies_path_

std::string	frequencies_suffix_ = ".bin"

std::filesystem::path	ctbe_rstable_path_

std::string	chaincode_rstable_filename_ = "ChainCode_rstable.yaml"

std::filesystem::path	chaincode_rstable_path_

std::string	ctbe_rstable_filename_ = "ctbe_rstable.yaml"

bool	force_odt_generation_ = false

Detailed Description

This class stores the configuration data loaded from file. All data are placed in the config global variable that can be accessed anywhere in the code.

Definition at line 20 of file config_data.h.

Constructor & Destructor Documentation

◆ ConfigData() [1/2]

ConfigData::ConfigData ( )

inline

Definition at line 85 of file config_data.h.

◆ ConfigData() [2/2]

ConfigData::ConfigData	(	std::string &	algorithm_name,
		const std::string &	mask_name,
		bool	use_frequencies = `false`
	)

Member Function Documentation

◆ GetCustomOdtPath()

std::filesystem::path ConfigData::GetCustomOdtPath ( const std::string & custom_suffix ) const

inline

Definition at line 110 of file config_data.h.

◆ GetDatasetsString()

std::string ConfigData::GetDatasetsString ( const std::string & separator = ", " )

inline

Definition at line 114 of file config_data.h.

◆ GetDotCodePath()

std::filesystem::path ConfigData::GetDotCodePath ( const std::string & out_base_name )

inline

Definition at line 90 of file config_data.h.

◆ GetDotOutPath()

std::filesystem::path ConfigData::GetDotOutPath ( const std::string & out_base_name )

inline

Definition at line 95 of file config_data.h.

◆ GetForestCodePath()

std::filesystem::path ConfigData::GetForestCodePath ( const std::string & out_base_name )

inline

Definition at line 100 of file config_data.h.

◆ GetFrequenciesPath()

std::filesystem::path ConfigData::GetFrequenciesPath ( const std::string & datasets_name ) const

inline

Definition at line 105 of file config_data.h.

◆ SetDescription()

void ConfigData::SetDescription ( std::string description )

inline

Definition at line 134 of file config_data.h.

◆ UpdateAlgoNameWithDatasets()

void ConfigData::UpdateAlgoNameWithDatasets ( )

inline

Definition at line 130 of file config_data.h.

Member Data Documentation

◆ algorithm_name_

std::string ConfigData::algorithm_name_

Definition at line 30 of file config_data.h.

◆ algorithm_output_path_

std::filesystem::path ConfigData::algorithm_output_path_

Definition at line 28 of file config_data.h.

◆ chaincode_rstable_filename_

std::string ConfigData::chaincode_rstable_filename_ = "ChainCode_rstable.yaml"

Definition at line 77 of file config_data.h.

◆ chaincode_rstable_path_

std::filesystem::path ConfigData::chaincode_rstable_path_

Definition at line 80 of file config_data.h.

◆ code_path_

std::filesystem::path ConfigData::code_path_

Definition at line 49 of file config_data.h.

◆ code_suffix_

std::string ConfigData::code_suffix_ = "_code.cpp"

Definition at line 48 of file config_data.h.

◆ config_file_

std::string ConfigData::config_file_ = "config.yaml"

Name of the configuration file

Definition at line 24 of file config_data.h.

◆ ctbe_rstable_filename_

std::string ConfigData::ctbe_rstable_filename_ = "ctbe_rstable.yaml"

Definition at line 81 of file config_data.h.

◆ ctbe_rstable_path_

std::filesystem::path ConfigData::ctbe_rstable_path_

Definition at line 76 of file config_data.h.

◆ datasets_

std::vector<std::string> ConfigData::datasets_

Definition at line 67 of file config_data.h.

◆ datasets_path_

std::vector<std::filesystem::path> ConfigData::datasets_path_

Definition at line 68 of file config_data.h.

◆ description_

std::string ConfigData::description_ = ""

Algorithm's description

Definition at line 22 of file config_data.h.

◆ dot_background_color_

std::string ConfigData::dot_background_color_ = "\"transparent\""

Definition at line 34 of file config_data.h.

◆ dot_output_format_

std::string ConfigData::dot_output_format_ = ".pdf"

Definition at line 35 of file config_data.h.

◆ dot_ranksep_

std::string ConfigData::dot_ranksep_ = "0.5"

Definition at line 36 of file config_data.h.

◆ dotcode_path_

std::filesystem::path ConfigData::dotcode_path_

Definition at line 41 of file config_data.h.

◆ dotcode_suffix_

std::string ConfigData::dotcode_suffix_ = "_dotcode.txt"

Definition at line 40 of file config_data.h.

◆ force_odt_generation_

bool ConfigData::force_odt_generation_ = false

Definition at line 83 of file config_data.h.

◆ forestcode_path_

std::filesystem::path ConfigData::forestcode_path_

Definition at line 55 of file config_data.h.

◆ forestcode_suffix_

std::string ConfigData::forestcode_suffix_ = "_forest_code.inc.h"

Definition at line 54 of file config_data.h.

◆ forestdagcode_path_

std::filesystem::path ConfigData::forestdagcode_path_

Definition at line 60 of file config_data.h.

◆ forestdagcode_suffix_

std::string ConfigData::forestdagcode_suffix_ = "_forest_dag_code.inc.h"

Definition at line 59 of file config_data.h.

◆ frequencies_local_path_

std::string ConfigData::frequencies_local_path_ = "frequencies"

Definition at line 71 of file config_data.h.

◆ frequencies_path_

std::filesystem::path ConfigData::frequencies_path_

Definition at line 72 of file config_data.h.

◆ frequencies_suffix_

std::string ConfigData::frequencies_suffix_ = ".bin"

Definition at line 73 of file config_data.h.

◆ global_input_path_

std::filesystem::path ConfigData::global_input_path_

Definition at line 29 of file config_data.h.

◆ global_output_path_

std::filesystem::path ConfigData::global_output_path_

Definition at line 27 of file config_data.h.

◆ mask_name_

std::string ConfigData::mask_name_

Definition at line 31 of file config_data.h.

◆ odt_path_

std::filesystem::path ConfigData::odt_path_

Definition at line 45 of file config_data.h.

◆ odt_suffix_

std::string ConfigData::odt_suffix_ = "_odt.txt"

Definition at line 44 of file config_data.h.

◆ rstable_path_

std::filesystem::path ConfigData::rstable_path_

Definition at line 64 of file config_data.h.

◆ rstable_suffix_

std::string ConfigData::rstable_suffix_ = "_rstable.yaml"

Definition at line 63 of file config_data.h.

◆ treecode_path_

std::filesystem::path ConfigData::treecode_path_

Definition at line 53 of file config_data.h.

◆ treecode_suffix_

std::string ConfigData::treecode_suffix_ = "_tree_code.inc.h"

Definition at line 52 of file config_data.h.

◆ treedagcode_path_

std::filesystem::path ConfigData::treedagcode_path_

Definition at line 58 of file config_data.h.

◆ treedagcode_suffix_

std::string ConfigData::treedagcode_suffix_ = "_tree_dag_code.inc.h"

Definition at line 57 of file config_data.h.

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

config_data.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ConfigData() [1/2]

◆ ConfigData() [2/2]

Member Function Documentation

◆ GetCustomOdtPath()

◆ GetDatasetsString()

◆ GetDotCodePath()

◆ GetDotOutPath()

◆ GetForestCodePath()

◆ GetFrequenciesPath()

◆ SetDescription()

◆ UpdateAlgoNameWithDatasets()

Member Data Documentation

◆ algorithm_name_

◆ algorithm_output_path_

◆ chaincode_rstable_filename_

◆ chaincode_rstable_path_

◆ code_path_

◆ code_suffix_

◆ config_file_

◆ ctbe_rstable_filename_

◆ ctbe_rstable_path_

◆ datasets_

◆ datasets_path_

◆ description_

◆ dot_background_color_

◆ dot_output_format_

◆ dot_ranksep_

◆ dotcode_path_

◆ dotcode_suffix_

◆ force_odt_generation_

◆ forestcode_path_

◆ forestcode_suffix_

◆ forestdagcode_path_

◆ forestdagcode_suffix_

◆ frequencies_local_path_

◆ frequencies_path_

◆ frequencies_suffix_

◆ global_input_path_

◆ global_output_path_

◆ mask_name_

◆ odt_path_

◆ odt_suffix_

◆ rstable_path_

◆ rstable_suffix_

◆ treecode_path_

◆ treecode_suffix_

◆ treedagcode_path_

◆ treedagcode_suffix_