openm::IModel Struct Reference

model sub-value run public interface More...

#include <omModel.h>

Inheritance diagram for openm::IModel:

Public Member Functions
virtual	~IModel (void) noexcept=0
	model sub-value run public interface
virtual int	subValueCount (void) const noexcept=0
	number of sub-values More...
virtual int	subValueId (void) const noexcept=0
	sub-value index of current modeling thread More...
virtual int	tableIdByName (const char *i_name) const =0
	return id of output table by name More...
virtual bool	isSuppressed (const char *i_name) const =0
	check by name if output table suppressed. More...
virtual const RunOptions *	runOptions (void) const =0
	return basic model run options More...
virtual int	parameterSubValueIndex (const char *i_name) const =0
	return index of parameter sub-value in the storage array for current modeling thread More...
virtual void	writeOutputTable (const char *i_name, size_t i_size, std::forward_list< std::unique_ptr< double[]> > &io_accValues)=0
	write output result table: sub values
virtual void	updateProgress (int i_count, double i_value=0.0)=0
	set modeling progress count and value More...
virtual void	writeDbMicrodata (int i_entityKind, uint64_t i_microdataKey, const void *i_entityThis)=0
	write microdata into the database. More...
virtual void	writeCsvMicrodata (int i_entityKind, uint64_t i_microdataKey, int i_eventId, bool i_isSameEntity, const void *i_entityThis)=0
	write microdata into CSV file or into trace. More...

Detailed Description

model sub-value run public interface

Member Function Documentation

isSuppressed()

virtual bool openm::IModel::isSuppressed ( const char *  i_name ) const

pure virtual

check by name if output table suppressed.

Implemented in openm::ModelBase.

parameterSubValueIndex()

virtual int openm::IModel::parameterSubValueIndex ( const char *  i_name ) const

pure virtual

return index of parameter sub-value in the storage array for current modeling thread

Implemented in openm::ModelBase.

runOptions()

virtual const RunOptions * openm::IModel::runOptions ( void  ) const

pure virtual

return basic model run options

Implemented in openm::ModelBase.

subValueCount()

virtual int openm::IModel::subValueCount ( void  ) const

pure virtualnoexcept

number of sub-values

Implemented in openm::ModelBase.

subValueId()

virtual int openm::IModel::subValueId ( void  ) const

pure virtualnoexcept

sub-value index of current modeling thread

Implemented in openm::ModelBase.

tableIdByName()

virtual int openm::IModel::tableIdByName ( const char *  i_name ) const

pure virtual

return id of output table by name

Implemented in openm::ModelBase.

updateProgress()

virtual void openm::IModel::updateProgress ( int  i_count, double  i_value = 0.0  )

pure virtual

set modeling progress count and value

Implemented in openm::ModelBase.

writeCsvMicrodata()

virtual void openm::IModel::writeCsvMicrodata ( int  i_entityKind, uint64_t  i_microdataKey, int  i_eventId, bool  i_isSameEntity, const void *  i_entityThis  )

pure virtual

write microdata into CSV file or into trace.

Parameters

i_entityKind	entity kind id: model metadata entity id in database.
i_microdataKey	unique entity instance id.
i_eventId	event id, if microdata events enabled.
i_isSameEntity	if true then event entity the same as microdata entity.
i_entityThis	entity class instance this pointer.

Implemented in openm::ModelBase.

writeDbMicrodata()

virtual void openm::IModel::writeDbMicrodata ( int  i_entityKind, uint64_t  i_microdataKey, const void *  i_entityThis  )

pure virtual

write microdata into the database.

Parameters

i_entityKind	entity kind id: model metadata entity id in database.
i_microdataKey	unique entity instance id.
i_entityThis	entity class instance this pointer.

Implemented in openm::ModelBase.

---

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

• /home/build_doc/ompp-make-doc/ompp-main/include/libopenm/omModel.h
• model/modelBase.cpp