openfluid::machine::ExecutionTimePoint Class Reference

#include <machine/ExecutionTimePoint.hpp>

Public Member Functions
	ExecutionTimePoint (openfluid::core::TimeIndex_t TimeIndex)
	~ExecutionTimePoint ()
void	appendItem (openfluid::machine::ModelItemInstance *Item)
bool	hasItemsToProcess () const
openfluid::base::SchedulingRequest	processNextItem ()
openfluid::machine::ModelItemInstance *	nextItem () const
openfluid::core::TimeIndex_t	getTimeIndex () const
void	sortByOriginalPosition ()

Constructor & Destructor Documentation

ExecutionTimePoint()

openfluid::machine::ExecutionTimePoint::ExecutionTimePoint

(

openfluid::core::TimeIndex_t

TimeIndex

)

Constructor

Parameters

[in]

TimeIndex

the time index of the execution time point

~ExecutionTimePoint()

openfluid::machine::ExecutionTimePoint::~ExecutionTimePoint

(

)

Member Function Documentation

appendItem()

void openfluid::machine::ExecutionTimePoint::appendItem

(

openfluid::machine::ModelItemInstance *

Item

)

Appends a model item instance to the stack of the execution time point

Parameters

[in]

Item

a pointer to the model item instance to append

getTimeIndex()

openfluid::core::TimeIndex_t openfluid::machine::ExecutionTimePoint::getTimeIndex ( ) const

inline

Returns the time index of the execution time point

Returns

the time index

hasItemsToProcess()

bool openfluid::machine::ExecutionTimePoint::hasItemsToProcess ( ) const

inline

Returns true if there is at least one model item to process in the execution time point

Returns

true if there is at least one model item

nextItem()

openfluid::machine::ModelItemInstance* openfluid::machine::ExecutionTimePoint::nextItem ( ) const

inline

Returns the next item to process

Returns

a pointer to the next item to process

processNextItem()

openfluid::base::SchedulingRequest openfluid::machine::ExecutionTimePoint::processNextItem

(

)

Executes the runStep() method of the next item and pops it out of the stack

Returns

the scheduling request returned by the runStep() once it is completed

sortByOriginalPosition()

void openfluid::machine::ExecutionTimePoint::sortByOriginalPosition ( )

inline

Sorts model items of the execution time point using their original position in the coupled model

---

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

• machine/ExecutionTimePoint.hpp