OpenM++ runtime library (libopenm)
openm::ModelRunState Class Reference

model run state: thread safe More...

#include <modelRunState.h>

Inheritance diagram for openm::ModelRunState:
Collaboration diagram for openm::ModelRunState:

Public Member Functions

 ModelRunState (void)
 initialize model run state
 
ModelStatus status (void) override
 get model status More...
 
bool isFinal (void) override
 return true if status is one of exiting: ie done, exit, error More...
 
bool isError (void) override
 return true if status is an error More...
 
bool isShutdownOrFinal (void) override
 return true if model in shutdown state: modeling completed or one of exiting More...
 
RunState get (void) override
 return model run state data More...
 
ModelStatus updateStatus (ModelStatus i_status) override
 set model status if not already set as one of final status values More...
 
void updateProgress (int i_count, double i_value=0.0) override
 set modeling progress count and value More...
 
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...
 
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: thread safe

Member Function Documentation

◆ get()

RunState ModelRunState::get ( void  )
overridevirtual

return model run state data

Implements openm::IModelRunState.

◆ isError()

bool ModelRunState::isError ( void  )
overridevirtual

return true if status is an error

Implements openm::IFinalState.

◆ isFinal()

bool ModelRunState::isFinal ( void  )
overridevirtual

return true if status is one of exiting: ie done, exit, error

Implements openm::IFinalState.

◆ isShutdownOrFinal()

bool ModelRunState::isShutdownOrFinal ( void  )
overridevirtual

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

Implements openm::IModelRunState.

◆ status()

ModelStatus ModelRunState::status ( void  )
overridevirtual

get model status

Implements openm::IModelRunState.

◆ updateProgress()

void ModelRunState::updateProgress ( int  i_count,
double  i_value = 0.0 
)
overridevirtual

set modeling progress count and value

Implements openm::IModelRunState.

◆ updateStatus()

ModelStatus ModelRunState::updateStatus ( ModelStatus  i_status)
overridevirtual

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

Implements openm::IModelRunState.


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