#include <ware/SimulationDrivenWare.hpp>
◆ SimulationDrivenWare()
openfluid::ware::SimulationDrivenWare::SimulationDrivenWare |
( |
WareType |
WType | ) |
|
|
inlineprotected |
◆ ~SimulationDrivenWare()
virtual openfluid::ware::SimulationDrivenWare::~SimulationDrivenWare |
( |
| ) |
|
|
inlinevirtual |
◆ appendToLog()
◆ computeFrameworkContext()
◆ computeWareContext()
◆ displayToConsole()
◆ finalizeWare()
void openfluid::ware::SimulationDrivenWare::finalizeWare |
( |
| ) |
|
|
virtual |
◆ initializeWare()
void openfluid::ware::SimulationDrivenWare::initializeWare |
( |
const WareID_t & |
ID | ) |
|
|
virtual |
◆ isLinked()
virtual bool openfluid::ware::SimulationDrivenWare::isLinked |
( |
| ) |
const |
|
inlineprotectedvirtual |
◆ linkToSimulation()
◆ linkToSimulationLogger()
◆ OPENFLUID_GetBeginDate()
Returns the real beginning date of the simulated period
- Returns
- the date
◆ OPENFLUID_GetCurrentDate()
Returns the current real date corresponding to the current time index
- Returns
- the date
◆ OPENFLUID_GetCurrentStage()
Returns the current stage of the simulation
- Returns
- the stage
◆ OPENFLUID_GetCurrentStageAsString()
std::string openfluid::ware::SimulationDrivenWare::OPENFLUID_GetCurrentStageAsString |
( |
| ) |
const |
|
protected |
◆ OPENFLUID_GetCurrentTimeIndex()
Returns the current time index of the simulation, in seconds since the simulation started. When the simulation starts, the time index is equal to zero.
- Returns
- the current time index in seconds
◆ OPENFLUID_GetDefaultDeltaT()
Returns the default DeltaT used by the scheduler
- Returns
- the deltaT in seconds
◆ OPENFLUID_GetEndDate()
Returns the real ending date of the simulated period
- Returns
- the date
◆ OPENFLUID_GetPreviousRunTimeIndex()
Returns the time index of the simulation when the plugged ware was previously run
- Returns
- the time index in seconds
◆ OPENFLUID_GetSchedulingConstraint()
Returns the scheduling constraint applied to the simulation (may be NONE)
- Returns
- the constraint type
◆ OPENFLUID_GetSimulationDuration()
Returns the simulation duration in seconds
- Returns
- the duration in seconds
◆ OPENFLUID_RaiseError() [1/2]
virtual void openfluid::ware::SimulationDrivenWare::OPENFLUID_RaiseError |
( |
const std::string & |
Msg | ) |
|
|
protectedvirtual |
Raises an error message to the kernel. This stops the simulation the next time the kernel has the control
- Parameters
-
[in] | Msg | the content of the message |
Reimplemented from openfluid::ware::PluggableWare.
◆ OPENFLUID_RaiseError() [2/2]
virtual void openfluid::ware::SimulationDrivenWare::OPENFLUID_RaiseError |
( |
const std::string & |
Source, |
|
|
const std::string & |
Msg |
|
) |
| |
|
protectedvirtual |
◆ OPENFLUID_RaiseWarning() [1/2]
virtual void openfluid::ware::SimulationDrivenWare::OPENFLUID_RaiseWarning |
( |
const std::string & |
Msg | ) |
|
|
protectedvirtual |
Raises a time-marked warning message to the kernel. This does not stops the simulation
- Parameters
-
[in] | Msg | the content of the message |
◆ OPENFLUID_RaiseWarning() [2/2]
virtual void openfluid::ware::SimulationDrivenWare::OPENFLUID_RaiseWarning |
( |
const std::string & |
Source, |
|
|
const std::string & |
Msg |
|
) |
| |
|
protectedvirtual |
◆ setPreviousTimeIndex()
The documentation for this class was generated from the following file: