#include <ware/PluggableWare.hpp>
◆ PluggableWare()
openfluid::ware::PluggableWare::PluggableWare |
( |
WareType |
WType | ) |
|
|
protected |
◆ ~PluggableWare()
virtual openfluid::ware::PluggableWare::~PluggableWare |
( |
| ) |
|
|
virtual |
◆ finalizeWare()
virtual void openfluid::ware::PluggableWare::finalizeWare |
( |
| ) |
|
|
virtual |
◆ initializeWare()
virtual void openfluid::ware::PluggableWare::initializeWare |
( |
const WareID_t & |
ID | ) |
|
|
virtual |
◆ isLinked()
virtual bool openfluid::ware::PluggableWare::isLinked |
( |
| ) |
const |
|
inlineprotectedvirtual |
◆ isWellFormatted()
Return false if ParameterKey starts nor ends with a dot, true otherwise
◆ linkToRunEnvironment()
◆ OPENFLUID_GetRunEnvironment() [1/2]
bool openfluid::ware::PluggableWare::OPENFLUID_GetRunEnvironment |
( |
const std::string & |
Key, |
|
|
std::string & |
Val |
|
) |
| |
|
protected |
Gets an environment string value associated to a Key
- Parameters
-
[in] | Key | the requested environment key |
[out] | Val | the value associated with the environment key |
◆ OPENFLUID_GetRunEnvironment() [2/2]
bool openfluid::ware::PluggableWare::OPENFLUID_GetRunEnvironment |
( |
const std::string & |
Key, |
|
|
bool & |
Val |
|
) |
| |
|
protected |
Gets an environment boolean value associated to a Key
- Parameters
-
[in] | Key | the requested environment key |
[out] | Val | the value associated with the environment key |
◆ OPENFLUID_GetWareID()
WareID_t openfluid::ware::PluggableWare::OPENFLUID_GetWareID |
( |
| ) |
const |
|
inlineprotected |
Returns the ID of the ware (itself)
- Returns
- the ID
◆ OPENFLUID_GetWareType()
WareType openfluid::ware::PluggableWare::OPENFLUID_GetWareType |
( |
| ) |
const |
|
inlineprotected |
Returns the type of the ware (itself)
- Returns
- the type
◆ OPENFLUID_RaiseError()
virtual void openfluid::ware::PluggableWare::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 in openfluid::ware::SimulationDrivenWare.
◆ m_Initialized
bool openfluid::ware::PluggableWare::m_Initialized |
|
protected |
The documentation for this class was generated from the following file: