openm::IRunOptionTable Struct Reference

run_option table public interface. More...

#include <dbMetaTable.h>

Inheritance diagram for openm::IRunOptionTable:

Collaboration diagram for openm::IRunOptionTable:

Public Member Functions
virtual const RunOptionRow *	byKey (int i_runId, const string &i_key) const =0
	binary search row by primary key: run id and option key, return NULL if not found.
virtual bool	isExist (int i_runId, const char *i_key) const noexcept=0
	return true if primary key (run id, option key) found.
virtual string	strValue (int i_runId, const char *i_key, const string &i_default="") const noexcept=0
	return string value by primary key (run id, option key) or default value if not found.
virtual bool	boolValue (int i_runId, const char *i_key) const noexcept=0
	return boolean value by primary key (run id, option key) or false if not found or value not "yes", "1", "true" or empty "" string.
virtual int	boolValueToInt (int i_runId, const char *i_key) const noexcept=0
	search for boolean value by primary key (run id, option key) and return one of: return 1 if key found and value is one of: "yes", "1", "true" or empty value, return 0 if key found and value is one of: "no", "0", "false", return -1 if key not found, return -2 otherwise.
virtual int	intValue (int i_runId, const char *i_key, int i_default) const noexcept=0
	return int value by primary key (run id, option key) or default if not found or can not be converted to int.
virtual long long	longValue (int i_runId, const char *i_key, long long i_default) const noexcept=0
	return long value by primary key (run id, option key) or default if not found or can not be converted to long.
virtual double	doubleValue (int i_runId, const char *i_key, double i_default) const noexcept=0
	return double value by primary key (run id, option key) or default if not found or can not be converted to double.
virtual IRowBaseVec &	rowsRef (void)=0
	get reference to list of all table rows.
Public Member Functions inherited from openm::IMetaLoadedTable< RunOptionRow >
virtual const IRowBaseVec &	rowsCRef (void) const=0
	get const reference to list of all table rows.
IRowBaseVec::difference_type	rowCount (void) const
	return number of rows.
vector< RunOptionRow >	rows (void) const
	get list of loaded table rows.
const RunOptionRow *	firstRow (void) const
	return first table row or NULL if table is empty.
vector< RunOptionRow >	findAll (RowEqual i_cmp) const
	get list of rows by predicate: all rows where comparator to i_row return true.
const RunOptionRow *	findFirst (RowEqual i_cmp) const
	get first row by predicate or NULL if not found: first row where comparator to i_row return true.
const RunOptionRow *	byIndex (IRowBaseVec::difference_type i_index) const
	return row value by index or NULL if out of range.
IRowBaseVec::difference_type	indexOf (RowEqual i_cmp, IRowBaseVec::difference_type i_startPos=0) const
	get first row by predicate or -1 if not found: first row where comparator to i_row return true.
IRowBaseVec::size_type	countOf (RowEqual i_cmp) const
	count rows by predicate: where comparator to i_row return true.

Static Public Member Functions
static IRunOptionTable *	create (IDbExec *i_dbExec, int i_runId=0)
	create new table object and load table rows sorted by primary key: run id and option key.
static IRunOptionTable *	create (IRowBaseVec &io_rowVec)
	create new table rows by swap with supplied vector of rows.

Additional Inherited Members
Public Types inherited from openm::IMetaLoadedTable< RunOptionRow >
typedef function< bool(const RunOptionRow &i_dbRow)>	RowEqual
	db table row comparator.
Protected Member Functions inherited from openm::IMetaLoadedTable< RunOptionRow >
const RunOptionRow *	findKey (const IRowBaseUptr &i_row) const
	binary search row by primary key, return NULL if not found.
Static Protected Member Functions inherited from openm::IMetaLoadedTable< RunOptionRow >
static IRowBaseVec	load (const string &i_sqlSelect, IDbExec *i_dbExec, const IRowAdapter &i_adapter)
	load table: return vector of selected rows sorted by primary key.
Static Protected Member Functions inherited from openm::IMetaTable< TRow >
static vector< TRow >	rows (const IRowBaseVec &i_rowVec)
	get list of table rows.

Detailed Description

run_option table public interface.

Member Function Documentation

boolValue()

virtual bool openm::IRunOptionTable::boolValue ( int  i_runId, const char *  i_key  ) const

pure virtualnoexcept

return boolean value by primary key (run id, option key) or false if not found or value not "yes", "1", "true" or empty "" string.

Implemented in openm::RunOptionTable.

boolValueToInt()

virtual int openm::IRunOptionTable::boolValueToInt ( int  i_runId, const char *  i_key  ) const

pure virtualnoexcept

search for boolean value by primary key (run id, option key) and return one of:
return 1 if key found and value is one of: "yes", "1", "true" or empty value,
return 0 if key found and value is one of: "no", "0", "false",
return -1 if key not found,
return -2 otherwise.

Implemented in openm::RunOptionTable.

byKey()

virtual const RunOptionRow * openm::IRunOptionTable::byKey ( int  i_runId, const string &  i_key  ) const

pure virtual

binary search row by primary key: run id and option key, return NULL if not found.

Implemented in openm::RunOptionTable.

create()

IRunOptionTable * IRunOptionTable::create ( IDbExec *  i_dbExec, int  i_runId = 0  )

static

create new table object and load table rows sorted by primary key: run id and option key.

if i_runId > 0 then select only rows where run_id = i_runId

doubleValue()

virtual double openm::IRunOptionTable::doubleValue ( int  i_runId, const char *  i_key, double  i_default  ) const

pure virtualnoexcept

return double value by primary key (run id, option key) or default if not found or can not be converted to double.

Implemented in openm::RunOptionTable.

intValue()

virtual int openm::IRunOptionTable::intValue ( int  i_runId, const char *  i_key, int  i_default  ) const

pure virtualnoexcept

return int value by primary key (run id, option key) or default if not found or can not be converted to int.

Implemented in openm::RunOptionTable.

isExist()

virtual bool openm::IRunOptionTable::isExist ( int  i_runId, const char *  i_key  ) const

pure virtualnoexcept

return true if primary key (run id, option key) found.

Implemented in openm::RunOptionTable.

longValue()

virtual long long openm::IRunOptionTable::longValue ( int  i_runId, const char *  i_key, long long  i_default  ) const

pure virtualnoexcept

return long value by primary key (run id, option key) or default if not found or can not be converted to long.

Implemented in openm::RunOptionTable.

rowsRef()

virtual IRowBaseVec & openm::IRunOptionTable::rowsRef ( void  )

pure virtual

get reference to list of all table rows.

Implements openm::IMetaLoadedTable< RunOptionRow >.

Implemented in openm::RunOptionTable.

strValue()

virtual string openm::IRunOptionTable::strValue ( int  i_runId, const char *  i_key, const string &  i_default = ""  ) const

pure virtualnoexcept

return string value by primary key (run id, option key) or default value if not found.

Implemented in openm::RunOptionTable.

---

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

• include/dbMetaTable.h
• db/runOptionTable.cpp