openfluid::base::SimulationStatus Class Reference

#include <base/SimulationStatus.hpp>

Public Types
enum	SimulationStage {   PRE , INITPARAMS , PREPAREDATA , CHECKCONSISTENCY ,   INITIALIZERUN , RUNSTEP , FINALIZERUN , POST ,   UNKNOWN }
enum	SchedulingConstraint { SCHED_NONE , SCHED_DTCHECKED , SCHED_DTFORCED }

Public Member Functions
	SimulationStatus ()=delete
	SimulationStatus (const openfluid::core::DateTime &Begin, const openfluid::core::DateTime &End, const openfluid::core::Duration_t DeltaT, const SchedulingConstraint &SConst=SCHED_NONE)
	~SimulationStatus ()
openfluid::core::DateTime	getBeginDate () const
openfluid::core::DateTime	getEndDate () const
openfluid::core::DateTime	getCurrentDate () const
openfluid::core::Duration_t	getDefaultDeltaT () const
openfluid::core::Duration_t	getSimulationDuration () const
openfluid::core::TimeIndex_t	getCurrentTimeIndex () const
SchedulingConstraint	getSchedulingConstraint () const
bool	isFirstTimeIndex () const
void	setCurrentTimeIndex (const openfluid::core::TimeIndex_t &Index)
SimulationStage	getCurrentStage () const
std::string	getCurrentStageAsString () const
void	setCurrentStage (const SimulationStage &Stage)

Static Public Member Functions
static std::string	getStageAsString (const SimulationStage &Stage)

Member Enumeration Documentation

SchedulingConstraint

enum openfluid::base::SimulationStatus::SchedulingConstraint

Enumerator
SCHED_NONE
SCHED_DTCHECKED
SCHED_DTFORCED

SimulationStage

enum openfluid::base::SimulationStatus::SimulationStage

Enumerator
PRE
INITPARAMS
PREPAREDATA
CHECKCONSISTENCY
INITIALIZERUN
RUNSTEP
FINALIZERUN
POST
UNKNOWN

Constructor & Destructor Documentation

SimulationStatus() [1/2]

openfluid::base::SimulationStatus::SimulationStatus ( )

delete

SimulationStatus() [2/2]

openfluid::base::SimulationStatus::SimulationStatus	(	const openfluid::core::DateTime &	Begin,
		const openfluid::core::DateTime &	End,
		const openfluid::core::Duration_t	DeltaT,
		const SchedulingConstraint &	SConst = SCHED_NONE
	)

~SimulationStatus()

openfluid::base::SimulationStatus::~SimulationStatus ( )

inline

Member Function Documentation

getBeginDate()

openfluid::core::DateTime openfluid::base::SimulationStatus::getBeginDate ( ) const

inline

getCurrentDate()

openfluid::core::DateTime openfluid::base::SimulationStatus::getCurrentDate ( ) const

inline

getCurrentStage()

SimulationStage openfluid::base::SimulationStatus::getCurrentStage ( ) const

inline

getCurrentStageAsString()

std::string openfluid::base::SimulationStatus::getCurrentStageAsString

(

)

const

getCurrentTimeIndex()

openfluid::core::TimeIndex_t openfluid::base::SimulationStatus::getCurrentTimeIndex ( ) const

inline

getDefaultDeltaT()

openfluid::core::Duration_t openfluid::base::SimulationStatus::getDefaultDeltaT ( ) const

inline

getEndDate()

openfluid::core::DateTime openfluid::base::SimulationStatus::getEndDate ( ) const

inline

getSchedulingConstraint()

SchedulingConstraint openfluid::base::SimulationStatus::getSchedulingConstraint ( ) const

inline

getSimulationDuration()

openfluid::core::Duration_t openfluid::base::SimulationStatus::getSimulationDuration ( ) const

inline

getStageAsString()

static std::string openfluid::base::SimulationStatus::getStageAsString ( const SimulationStage &  Stage )

static

isFirstTimeIndex()

bool openfluid::base::SimulationStatus::isFirstTimeIndex ( ) const

inline

setCurrentStage()

void openfluid::base::SimulationStatus::setCurrentStage

(

const SimulationStage &

Stage

)

setCurrentTimeIndex()

void openfluid::base::SimulationStatus::setCurrentTimeIndex

(

const openfluid::core::TimeIndex_t &

Index

)

---

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

• base/SimulationStatus.hpp