openfluid::base::SimulationStatus Class Reference

Inheritance diagram for openfluid::base::SimulationStatus:

List of all members.

Public Member Functions
	SimulationStatus (openfluid::core::DateTime StartTime, openfluid::core::DateTime EndTime, int TimeStep)
	~SimulationStatus ()
bool	switchToNextStep ()
unsigned int	getCurrentStep () const
openfluid::core::DateTime	getCurrentTime () const
unsigned int	getSeconds () const
bool	isFirstStep () const
bool	isLastStep () const

---

Detailed Description

Class giving dynamic information on simulation

---

Constructor & Destructor Documentation

openfluid::base::SimulationStatus::SimulationStatus	(	openfluid::core::DateTime	StartTime,
		openfluid::core::DateTime	EndTime,
		int	TimeStep
	)

Constructor

openfluid::base::SimulationStatus::~SimulationStatus

(

)

Destructor

---

Member Function Documentation

unsigned int openfluid::base::SimulationStatus::getCurrentStep

(

)

const [inline]

Returns the current time step of the simulation

Returns:

the current time step number

openfluid::core::DateTime openfluid::base::SimulationStatus::getCurrentTime

(

)

const [inline]

Returns the current time of the simulation

Returns:

the current time

unsigned int openfluid::base::SimulationStatus::getSeconds

(

)

const [inline]

Returns the number of seconds since the simulation beginning

Returns:

the number of seconds

bool openfluid::base::SimulationStatus::isFirstStep

(

)

const [inline]

Returns true if the current step is the first step of the simulation

bool openfluid::base::SimulationStatus::isLastStep

(

)

const [inline]

Returns true if the current step is the last step of the simulation

bool openfluid::base::SimulationStatus::switchToNextStep

(

)