openm::ParameterRunWriter Class Reference

Inheritance diagram for openm::ParameterRunWriter:

Collaboration diagram for openm::ParameterRunWriter:

Public Member Functions
	ParameterRunWriter (int i_runId, const char *i_name, IDbExec *i_dbExec, const MetaHolder *i_metaStore, const char *i_doubleFormat="")
virtual size_t	sizeOf (void) const noexcept override
	return input parameter size for single sub value
void	writeParameter (IDbExec *i_dbExec, const type_info &i_type, int i_subCount, size_t i_size, void *i_valueArr) override
	write parameter: write all sub values of the parameter into db run table
virtual void	loadCsvParameter (IDbExec *i_dbExec, const vector< int > &i_subIdArr, const char *i_filePath, bool i_isIdCsv=false) override
	load parameter values from csv file into run table, it can be any of: .csv .tsv .id.csv .id.tsv file.
void	digestParameter (IDbExec *i_dbExec, int i_subCount, const type_info &i_type) override
	calculate run parameter values digest and store only single copy of parameter values.
Public Member Functions inherited from openm::ParameterWriter
	ParameterWriter (const char *i_name, IDbExec *i_dbExec, const MetaHolder *i_metaStore)

Additional Inherited Members
Static Public Member Functions inherited from openm::IParameterRunWriter
static IParameterRunWriter *	create (int i_runId, const char *i_name, IDbExec *i_dbExec, const MetaHolder *i_metaStore, const char *i_doubleFormat="")
	input parameter writer factory
Protected Member Functions inherited from openm::ParameterWriter
void	writeParameter (IDbExec *i_dbExec, bool i_isToRun, int i_dstId, const type_info &i_type, int i_subCount, size_t i_valueLen, void *i_valueArr)
Protected Attributes inherited from openm::ParameterWriter
int	modelId
int	paramId
int	dimCount
size_t	totalSize
vector< int >	dimSizeVec
const ParamDicRow *	paramRow
const TypeDicRow *	paramTypeRow
vector< TypeEnumLstRow >	paramEnums
vector< ParamDimsRow >	paramDims
vector< vector< TypeEnumLstRow > >	dimEnums

Member Function Documentation

digestParameter()

void ParameterRunWriter::digestParameter ( IDbExec *  i_dbExec, int  i_subCount, const type_info &  i_type  )

overridevirtual

calculate run parameter values digest and store only single copy of parameter values.

Parameters

[in]	i_dbExec	database connection
[in]	i_subCount	number of parameter sub-values
[in]	i_type	parameter type, use char * for string parameters

Implements openm::IParameterRunWriter.

loadCsvParameter()

void ParameterRunWriter::loadCsvParameter ( IDbExec *  i_dbExec, const vector< int > &  i_subIdArr, const char *  i_filePath, bool  i_isIdCsv = false  )

overridevirtual

load parameter values from csv file into run table, it can be any of: .csv .tsv .id.csv .id.tsv file.

Parameters

[in]	i_dbExec	database connection
[in]	i_subIdArr	sub-value id's to select from csv
[in]	i_filePath	path to parameter.csv file, it can be any of: .csv .tsv .id.csv .id.tsv file.
[in]	i_isIdCsv	if true then create csv file contains enum id's, default: enum code

if file extension .tsv then it is a tab separated file, by default comma separated file expected. if i_isIdCsv is true or file extension is .id.csv or .id.tsv then file contains enum id's, by default enum codes expected

Implements openm::IParameterRunWriter.

sizeOf()

virtual size_t openm::ParameterRunWriter::sizeOf ( void  ) const

inlineoverridevirtualnoexcept

return input parameter size for single sub value

Implements openm::IParameterRunWriter.

writeParameter()

void ParameterRunWriter::writeParameter ( IDbExec *  i_dbExec, const type_info &  i_type, int  i_subCount, size_t  i_size, void *  i_valueArr  )

overridevirtual

write parameter: write all sub values of the parameter into db run table

Parameters

[in]	i_dbExec	database connection
[in]	i_type	parameter value type, use std::string for string parameters
[in]	i_subCount	number of parameter sub-values
[in]	i_size	parameter size for single sub value
[in,out]	i_valueArr	array of parameter values, size must be == i_size * i_subCount

Implements openm::IParameterRunWriter.

---

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

• db/parameterWriter.cpp