openm::IModelRunState Struct Reference

model run state public interface: thread safe More...

#include <omModelRunState.h>

Inheritance diagram for openm::IModelRunState:

Collaboration diagram for openm::IModelRunState:

Public Member Functions
virtual ModelStatus	status (void)=0
	get model status More...
virtual bool	isShutdownOrFinal (void)=0
	return true if model in shutdown state: modeling completed or one of exiting More...
virtual RunState	get (void)=0
	return model run state data More...
virtual ModelStatus	updateStatus (ModelStatus i_status)=0
	set model status if not already set as one of final status values More...
virtual void	updateProgress (int i_count, double i_value=0.0)=0
	set modeling progress count and value More...
Public Member Functions inherited from openm::IFinalState
virtual bool	isFinal (void)=0
	return true if status is one of exiting: done, exit, error More...
virtual bool	isError (void)=0
	return true if status is an error More...

Detailed Description

model run state public interface: thread safe

Member Function Documentation

get()

virtual RunState openm::IModelRunState::get ( void  )

pure virtual

return model run state data

Implemented in openm::ModelRunState.

isShutdownOrFinal()

virtual bool openm::IModelRunState::isShutdownOrFinal ( void  )

pure virtual

return true if model in shutdown state: modeling completed or one of exiting

Implemented in openm::ModelRunState.

status()

virtual ModelStatus openm::IModelRunState::status ( void  )

pure virtual

get model status

Implemented in openm::ModelRunState.

updateProgress()

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

pure virtual

set modeling progress count and value

Implemented in openm::ModelRunState.

updateStatus()

virtual ModelStatus openm::IModelRunState::updateStatus ( ModelStatus  i_status )

pure virtual

set model status if not already set as one of final status values

Implemented in openm::ModelRunState.

---

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

• /home/build_doc/ompp-make-doc/ompp-main/include/libopenm/omModelRunState.h
• model/modelRunState.cpp