openfluid::ware::PluggableWare Class Reference

#include <ware/PluggableWare.hpp>

Inheritance diagram for openfluid::ware::PluggableWare:

Public Types
enum	WareType { UNDEFINED, OBSERVER, SIMULATOR, OTHER }

Public Member Functions
virtual	~PluggableWare ()
void	linkToRunEnvironment (const openfluid::base::EnvironmentProperties *Env)
virtual void	initializeWare (const WareID_t &ID)
virtual void	finalizeWare ()

Static Public Member Functions
static bool	isWellFormated (const openfluid::ware::WareParamKey_t &ParameterKey)
static boost::property_tree::ptree	getParamsAsPropertyTree (const WareParams_t &Params)

Protected Member Functions
virtual bool	isLinked () const
virtual void	OPENFLUID_RaiseError (const std::string &Msg)
bool	OPENFLUID_GetRunEnvironment (std::string Key, std::string &Val)
bool	OPENFLUID_GetRunEnvironment (std::string Key, bool &Val)
WareID_t	OPENFLUID_GetWareID () const
	PluggableWare (WareType WType)

Protected Attributes
bool	m_Initialized
WareType	m_WareType

Member Enumeration Documentation

enum openfluid::ware::PluggableWare::WareType

Enumerator
UNDEFINED
OBSERVER
SIMULATOR
OTHER

Constructor & Destructor Documentation

openfluid::ware::PluggableWare::PluggableWare ( WareType  WType )

protected

virtual openfluid::ware::PluggableWare::~PluggableWare ( )

virtual

Member Function Documentation

virtual void openfluid::ware::PluggableWare::finalizeWare ( )

virtual

Reimplemented in openfluid::ware::SimulationDrivenWare.

static boost::property_tree::ptree openfluid::ware::PluggableWare::getParamsAsPropertyTree ( const WareParams_t &  Params )

static

virtual void openfluid::ware::PluggableWare::initializeWare ( const WareID_t &  ID )

virtual

Reimplemented in openfluid::ware::SimulationDrivenWare, openfluid::builderext::PluggableBuilderExtension, and openfluid::ware::PluggableObserver.

virtual bool openfluid::ware::PluggableWare::isLinked ( ) const

inlineprotectedvirtual

Reimplemented in openfluid::ware::SimulationDrivenWare, and openfluid::ware::SimulationInspectorWare.

static bool openfluid::ware::PluggableWare::isWellFormated ( const openfluid::ware::WareParamKey_t &  ParameterKey )

static

Return false if ParameterKey starts nor ends with a dot, true otherwise

void openfluid::ware::PluggableWare::linkToRunEnvironment ( const openfluid::base::EnvironmentProperties *  Env )

inline

bool openfluid::ware::PluggableWare::OPENFLUID_GetRunEnvironment ( std::string  Key, std::string &  Val  )

protected

Gets an environment string value associated to a Key

Parameters

[in]	Key	the sender of the message
[out]	Val	the value associated with the environment key

bool openfluid::ware::PluggableWare::OPENFLUID_GetRunEnvironment ( std::string  Key, bool &  Val  )

protected

Gets an environment boolean value associated to a Key

Parameters

[in]	Key	the sender of the message
[out]	Val	the value associated with the environment key

WareID_t openfluid::ware::PluggableWare::OPENFLUID_GetWareID ( ) const

inlineprotected

Returns the ID of the ware (itself)

Returns

the ID

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.

Member Data Documentation

bool openfluid::ware::PluggableWare::m_Initialized

protected

WareType openfluid::ware::PluggableWare::m_WareType

protected

---

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

• ware/PluggableWare.hpp