Public Member Functions | Protected Member Functions | List of all members
openfluid::machine::ModelInstance Class Reference

#include <machine/ModelInstance.hpp>

Public Member Functions

 ModelInstance (openfluid::machine::SimulationBlob &SimulationBlob, openfluid::machine::MachineListener *Listener)
 
 ~ModelInstance ()
 
void appendItem (ModelItemInstance *ItemInstance)
 
void insertItem (ModelItemInstance *ItemInstance, unsigned int Position)
 
void deleteItem (unsigned int Position)
 
void clear ()
 
unsigned int getItemsCount () const
 
openfluid::ware::WareParams_tglobalParameters ()
 
void setGlobalParameter (const openfluid::ware::WareParamKey_t &Key, const openfluid::ware::WareParamValue_t &Value)
 
void setGlobalParameters (const openfluid::ware::WareParams_t &Params)
 
const std::list< ModelItemInstance * > & items () const
 
void initialize (openfluid::base::SimulationLogger *SimLogger)
 
void finalize ()
 
void call_initParams () const
 
void call_prepareData () const
 
void call_checkConsistency () const
 
void call_initializeRun ()
 
bool hasTimePointToProcess () const
 
void processNextTimePoint ()
 
openfluid::core::Duration_t getNextTimePointIndex () const
 
void call_finalizeRun () const
 
void resetInitialized ()
 

Protected Member Functions

openfluid::ware::WareParams_t mergeParamsWithGlobalParams (const openfluid::ware::WareParams_t &Params) const
 

Constructor & Destructor Documentation

◆ ModelInstance()

openfluid::machine::ModelInstance::ModelInstance ( openfluid::machine::SimulationBlob SimulationBlob,
openfluid::machine::MachineListener Listener 
)

◆ ~ModelInstance()

openfluid::machine::ModelInstance::~ModelInstance ( )

Member Function Documentation

◆ appendItem()

void openfluid::machine::ModelInstance::appendItem ( ModelItemInstance ItemInstance)

◆ call_checkConsistency()

void openfluid::machine::ModelInstance::call_checkConsistency ( ) const

◆ call_finalizeRun()

void openfluid::machine::ModelInstance::call_finalizeRun ( ) const

◆ call_initializeRun()

void openfluid::machine::ModelInstance::call_initializeRun ( )

◆ call_initParams()

void openfluid::machine::ModelInstance::call_initParams ( ) const

◆ call_prepareData()

void openfluid::machine::ModelInstance::call_prepareData ( ) const

◆ clear()

void openfluid::machine::ModelInstance::clear ( )

◆ deleteItem()

void openfluid::machine::ModelInstance::deleteItem ( unsigned int  Position)

Delete the ModelItemInstance located at the given postion (positions starts at index 0), and remove it from the ModelInstance

Parameters
[in]Positionthe position

◆ finalize()

void openfluid::machine::ModelInstance::finalize ( )

◆ getItemsCount()

unsigned int openfluid::machine::ModelInstance::getItemsCount ( ) const
inline

◆ getNextTimePointIndex()

openfluid::core::Duration_t openfluid::machine::ModelInstance::getNextTimePointIndex ( ) const
inline

◆ globalParameters()

openfluid::ware::WareParams_t& openfluid::machine::ModelInstance::globalParameters ( )
inline

◆ hasTimePointToProcess()

bool openfluid::machine::ModelInstance::hasTimePointToProcess ( ) const
inline

◆ initialize()

void openfluid::machine::ModelInstance::initialize ( openfluid::base::SimulationLogger SimLogger)

◆ insertItem()

void openfluid::machine::ModelInstance::insertItem ( ModelItemInstance ItemInstance,
unsigned int  Position 
)

Insert a ModelItemInstance before the given postion (positions starts at index 0)

Parameters
[in]ItemInstancethe ModelItemInstance to insert
[in]Positionthe position

◆ items()

const std::list<ModelItemInstance*>& openfluid::machine::ModelInstance::items ( ) const
inline

◆ mergeParamsWithGlobalParams()

openfluid::ware::WareParams_t openfluid::machine::ModelInstance::mergeParamsWithGlobalParams ( const openfluid::ware::WareParams_t Params) const
protected

◆ processNextTimePoint()

void openfluid::machine::ModelInstance::processNextTimePoint ( )

◆ resetInitialized()

void openfluid::machine::ModelInstance::resetInitialized ( )
inline

◆ setGlobalParameter()

void openfluid::machine::ModelInstance::setGlobalParameter ( const openfluid::ware::WareParamKey_t Key,
const openfluid::ware::WareParamValue_t Value 
)

◆ setGlobalParameters()

void openfluid::machine::ModelInstance::setGlobalParameters ( const openfluid::ware::WareParams_t Params)
inline

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