OpenM++ runtime library (libopenm)
openm::IParameterReader Struct Referenceabstract

input parameter reader public interface More...

#include <dbParameter.h>

Inheritance diagram for openm::IParameterReader:

Public Member Functions

virtual int parameterId (void) const noexcept=0
 return input parameter id More...
 
virtual size_t sizeOf (void) const noexcept=0
 return input parameter size for single sub value More...
 
virtual void readParameter (IDbExec *i_dbExec, int i_subId, const type_info &i_type, size_t i_size, void *io_valueArr)=0
 read input parameter single sub value. More...
 
virtual void readParameter (IDbExec *i_dbExec, const type_info &i_type, int i_subCount, size_t i_size, void *io_valueArr)=0
 read all sub values of input parameter. More...
 
virtual void readParameter (IDbExec *i_dbExec, const vector< int > &i_subIdArr, const type_info &i_type, size_t i_size, void *io_valueArr)=0
 read input parameter single selected sub values. More...
 

Static Public Member Functions

static IParameterReadercreate (int i_runId, const char *i_name, IDbExec *i_dbExec, const MetaHolder *i_metaStore)
 input parameter reader factory
 

Detailed Description

input parameter reader public interface

Member Function Documentation

◆ parameterId()

virtual int openm::IParameterReader::parameterId ( void  ) const
pure virtualnoexcept

return input parameter id

Implemented in openm::ParameterReader.

◆ readParameter() [1/3]

virtual void openm::IParameterReader::readParameter ( IDbExec i_dbExec,
const type_info &  i_type,
int  i_subCount,
size_t  i_size,
void *  io_valueArr 
)
pure virtual

read all sub values of input parameter.

Parameters
[in]i_dbExecdatabase connection
[in]i_typeparameter value type, use std::string for string parameters
[in]i_subCountnumber of parameter sub-values
[in]i_sizeparameter size (number of parameter values in single sub value)
[in,out]io_valueArrarray to return parameter values, size must be =i_size * i_subCount, use io_valueArr[] of std::string for string parameters

Implemented in openm::ParameterReader.

◆ readParameter() [2/3]

virtual void openm::IParameterReader::readParameter ( IDbExec i_dbExec,
const vector< int > &  i_subIdArr,
const type_info &  i_type,
size_t  i_size,
void *  io_valueArr 
)
pure virtual

read input parameter single selected sub values.

Parameters
[in]i_dbExecdatabase connection
[in]i_subIdArrvector of sub value ids to select
[in]i_typeparameter value type, use std::string for string parameters
[in]i_sizeparameter size (number of parameter values in single sub value)
[in,out]io_valueArrarray to return parameter values, size must be =i_size * i_subIdArr.size(), use io_valueArr[] of std::string for string parameters

Implemented in openm::ParameterReader.

◆ readParameter() [3/3]

virtual void openm::IParameterReader::readParameter ( IDbExec i_dbExec,
int  i_subId,
const type_info &  i_type,
size_t  i_size,
void *  io_valueArr 
)
pure virtual

read input parameter single sub value.

Parameters
[in]i_dbExecdatabase connection
[in]i_subIdparameter sub value id
[in]i_typeparameter value type, use std::string for string parameters
[in]i_sizeparameter size (number of parameter values in single sub value)
[in,out]io_valueArrarray to return parameter values, size must be =i_size, use io_valueArr[] of std::string for string parameters

Implemented in openm::ParameterReader.

◆ sizeOf()

virtual size_t openm::IParameterReader::sizeOf ( void  ) const
pure virtualnoexcept

return input parameter size for single sub value

Implemented in openm::ParameterReader.


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