Public Member Functions | Static Public Member Functions | Protected Attributes

openfluid::base::SimulationInfo Class Reference

Inheritance diagram for openfluid::base::SimulationInfo:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 SimulationInfo (openfluid::core::DateTime StartTime, openfluid::core::DateTime EndTime, int TimeStep)
 ~SimulationInfo ()
int getTimeStep () const
unsigned int getStepsCount () const
openfluid::core::DateTime getStartTime () const
openfluid::core::DateTime getEndTime () const

Static Public Member Functions

static int computeTimeStepsCount (const openfluid::core::DateTime &StartTime, const openfluid::core::DateTime &EndTime, const int &TimeStep)

Protected Attributes

openfluid::core::DateTime m_StartTime
openfluid::core::DateTime m_EndTime
int m_TimeStep
unsigned int m_StepsCount

Detailed Description

Class giving static information on simulation


Constructor & Destructor Documentation

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

Constructor

openfluid::base::SimulationInfo::~SimulationInfo ( )

Destructor


Member Function Documentation

static int openfluid::base::SimulationInfo::computeTimeStepsCount ( const openfluid::core::DateTime StartTime,
const openfluid::core::DateTime EndTime,
const int &  TimeStep 
) [static]
openfluid::core::DateTime openfluid::base::SimulationInfo::getEndTime ( ) const [inline]

Returns the date and time of the ending of the simulation

Returns:
the DateTime of the ending of the simulation
openfluid::core::DateTime openfluid::base::SimulationInfo::getStartTime ( ) const [inline]

Returns the date and time of the beginning of the simulation

Returns:
the DateTime of the beginning of the simulation
unsigned int openfluid::base::SimulationInfo::getStepsCount ( ) const [inline]

Returns the number of time step for the simulation

Returns:
the number of time steps
int openfluid::base::SimulationInfo::getTimeStep ( ) const [inline]

Returns the value of a time step (in seconds)

Returns:
the number of second in a time step

Member Data Documentation


Generated using Doxygen 1.7.3
Creative Commons License Creative Commons By-NC-ND license