openfluid::ware::PluggableObserver Class Reference

#include <ware/PluggableObserver.hpp>

Inheritance diagram for openfluid::ware::PluggableObserver:

Collaboration diagram for openfluid::ware::PluggableObserver:

Public Member Functions
	PluggableObserver ()
virtual	~PluggableObserver ()
void	initializeWare (const WareID_t &SimID)
virtual void	initParams (const openfluid::ware::WareParams_t &Params)=0
virtual void	onPrepared ()=0
virtual void	onInitializedRun ()=0
virtual void	onStepCompleted ()=0
virtual void	onFinalizedRun ()=0
Public Member Functions inherited from openfluid::ware::SimulationInspectorWare
virtual	~SimulationInspectorWare ()
void	linkToSpatialGraph (openfluid::core::SpatialGraph *SGraph)
void	linkToDatastore (openfluid::core::Datastore *DStore)
Public Member Functions inherited from openfluid::ware::SimulationDrivenWare
virtual	~SimulationDrivenWare ()
void	linkToSimulation (const openfluid::base::SimulationStatus *SimStatus)
void	linkToSimulationLogger (openfluid::base::SimulationLogger *SimLogger)
void	initializeWare (const WareID_t &ID)
void	finalizeWare ()
void	setPreviousTimeIndex (const openfluid::core::TimeIndex_t &TimeIndex)
Public Member Functions inherited from openfluid::ware::PluggableWare
virtual	~PluggableWare ()
void	linkToRunEnvironment (const openfluid::core::MapValue *Env)

Additional Inherited Members
Static Public Member Functions inherited from openfluid::ware::PluggableWare
static bool	isWellFormated (const openfluid::ware::WareParamKey_t &ParameterKey)
Protected Member Functions inherited from openfluid::ware::SimulationInspectorWare
virtual bool	isLinked () const
bool	OPENFLUID_IsAttributeExist (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::AttributeName_t &AttrName) const
void	OPENFLUID_GetAttribute (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, openfluid::core::Value &Val) const
void	OPENFLUID_GetAttribute (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, double &Val) const
void	OPENFLUID_GetAttribute (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, long &Val) const
void	OPENFLUID_GetAttribute (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, std::string &Val) const
const openfluid::core::Value *	OPENFLUID_GetAttribute (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::AttributeName_t &AttrName) const
bool	OPENFLUID_IsVariableExist (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName) const
bool	OPENFLUID_IsVariableExist (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t Index) const
bool	OPENFLUID_IsVariableExist (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t Index, const openfluid::core::Value::Type ValueType) const
bool	OPENFLUID_IsTypedVariableExist (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::Value::Type VarType) const
bool	OPENFLUID_IsTypedVariableExist (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t Index, const openfluid::core::Value::Type VarType) const
void	OPENFLUID_GetVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t Index, openfluid::core::Value &Val) const
void	OPENFLUID_GetVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t Index, double &Val) const
void	OPENFLUID_GetVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t Index, long &Val) const
void	OPENFLUID_GetVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t Index, bool &Val) const
void	OPENFLUID_GetVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t Index, std::string &Val) const
const openfluid::core::Value *	OPENFLUID_GetVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t Index) const
void	OPENFLUID_GetVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, openfluid::core::Value &Val) const
void	OPENFLUID_GetVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, double &Val) const
void	OPENFLUID_GetVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, long &Val) const
void	OPENFLUID_GetVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, bool &Val) const
void	OPENFLUID_GetVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, std::string &Val) const
const openfluid::core::Value *	OPENFLUID_GetVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName) const
void	OPENFLUID_GetLatestVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, openfluid::core::IndexedValue &IndVal) const
openfluid::core::IndexedValue	OPENFLUID_GetLatestVariable (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName) const
void	OPENFLUID_GetLatestVariables (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t BeginIndex, openfluid::core::IndexedValueList &IndValList) const
openfluid::core::IndexedValueList	OPENFLUID_GetLatestVariables (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t BeginIndex) const
void	OPENFLUID_GetVariables (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t BeginIndex, const openfluid::core::TimeIndex_t EndIndex, openfluid::core::IndexedValueList &IndValList) const
openfluid::core::IndexedValueList	OPENFLUID_GetVariables (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t BeginIndex, const openfluid::core::TimeIndex_t EndIndex) const
void	OPENFLUID_GetEvents (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::DateTime BeginDate, const openfluid::core::DateTime EndDate, openfluid::core::EventsCollection &Events) const
openfluid::core::EventsCollection	OPENFLUID_GetEvents (const openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::DateTime BeginDate, const openfluid::core::DateTime EndDate) const
bool	OPENFLUID_IsUnitsClassExist (const openfluid::core::UnitsClass_t &ClassName) const
bool	OPENFLUID_IsUnitClassExist (const openfluid::core::UnitsClass_t &ClassName) const OPENFLUID_DEPRECATED
bool	OPENFLUID_IsUnitExist (const openfluid::core::UnitsClass_t &ClassName, openfluid::core::UnitID_t ID) const
void	OPENFLUID_GetUnitsCount (unsigned int &UnitsCount) const
unsigned int	OPENFLUID_GetUnitsCount () const
bool	OPENFLUID_GetUnitsCount (const openfluid::core::UnitsClass_t &ClassName, unsigned int &UnitsCount) const
unsigned int	OPENFLUID_GetUnitsCount (const openfluid::core::UnitsClass_t &ClassName) const
bool	OPENFLUID_GetUnit (const openfluid::core::UnitsClass_t &ClassName, const openfluid::core::UnitID_t &ID, openfluid::core::SpatialUnit *aUnit) const
openfluid::core::SpatialUnit *	OPENFLUID_GetUnit (const openfluid::core::UnitsClass_t &ClassName, const openfluid::core::UnitID_t &ID) const
openfluid::core::UnitsPtrList_t	OPENFLUID_GetUnits (const openfluid::core::UnitsClass_t &ClassName)
bool	OPENFLUID_IsUnitConnectedTo (openfluid::core::SpatialUnit *aUnit, const openfluid::core::UnitsClass_t &ClassNameTo, const openfluid::core::UnitID_t &IDTo) const
bool	OPENFLUID_IsUnitConnectedFrom (openfluid::core::SpatialUnit *aUnit, const openfluid::core::UnitsClass_t &ClassNameFrom, const openfluid::core::UnitID_t &IDFrom) const
bool	OPENFLUID_IsUnitChildOf (openfluid::core::SpatialUnit *aUnit, const openfluid::core::UnitsClass_t &ClassNameParent, const openfluid::core::UnitID_t &IDParent) const
bool	OPENFLUID_IsUnitParentOf (openfluid::core::SpatialUnit *aUnit, const openfluid::core::UnitsClass_t &ClassNameChild, const openfluid::core::UnitID_t &IDChild) const
	SimulationInspectorWare (WareType WType)
Protected Member Functions inherited from openfluid::ware::SimulationDrivenWare
void	appendToLog (openfluid::tools::FileLogger::LogType LType, const std::string &Msg) const
void	displayToConsole (openfluid::tools::FileLogger::LogType LType, const std::string &Msg) const
openfluid::base::ExceptionContext	computeWareContext (const std::string &CodeLoc="") const
openfluid::base::ExceptionContext	computeFrameworkContext (const std::string &CodeLoc="") const
openfluid::core::DateTime	OPENFLUID_GetBeginDate () const
openfluid::core::DateTime	OPENFLUID_GetEndDate () const
openfluid::core::DateTime	OPENFLUID_GetCurrentDate () const
openfluid::core::Duration_t	OPENFLUID_GetSimulationDuration () const
openfluid::core::Duration_t	OPENFLUID_GetDefaultDeltaT () const
openfluid::core::TimeIndex_t	OPENFLUID_GetCurrentTimeIndex () const
openfluid::core::TimeIndex_t	OPENFLUID_GetPreviousRunTimeIndex () const
openfluid::base::SimulationStatus::SimulationStage	OPENFLUID_GetCurrentStage () const
std::string	OPENFLUID_GetCurrentStageAsString () const
openfluid::base::SimulationStatus::SchedulingConstraint	OPENFLUID_GetSchedulingConstraint () const
virtual void	OPENFLUID_RaiseWarning (const std::string &Msg)
virtual void	OPENFLUID_RaiseWarning (const std::string &Source, const std::string &Msg) OPENFLUID_DEPRECATED
virtual void	OPENFLUID_RaiseError (const std::string &Msg)
virtual void	OPENFLUID_RaiseError (const std::string &Source, const std::string &Msg) OPENFLUID_DEPRECATED
	SimulationDrivenWare (WareType WType)
Protected Member Functions inherited from openfluid::ware::PluggableWare
bool	OPENFLUID_GetRunEnvironment (const std::string &Key, std::string &Val)
bool	OPENFLUID_GetRunEnvironment (const std::string &Key, bool &Val)
WareID_t	OPENFLUID_GetWareID () const
WareType	OPENFLUID_GetWareType () const
	PluggableWare (WareType WType)
Protected Attributes inherited from openfluid::ware::SimulationInspectorWare
openfluid::core::SpatialGraph *	mp_SpatialData
Protected Attributes inherited from openfluid::ware::PluggableWare
bool	m_Initialized

Constructor & Destructor Documentation

openfluid::ware::PluggableObserver::PluggableObserver

(

)

virtual openfluid::ware::PluggableObserver::~PluggableObserver ( )

virtual

Member Function Documentation

void openfluid::ware::PluggableObserver::initializeWare ( const WareID_t &  SimID )

virtual

Internally called by the framework.

Reimplemented from openfluid::ware::PluggableWare.

virtual void openfluid::ware::PluggableObserver::initParams ( const openfluid::ware::WareParams_t &  Params )

pure virtual

Initializes simulator parameters of the simulator, given as a hash map. Internally called by the framework.

virtual void openfluid::ware::PluggableObserver::onFinalizedRun ( )

pure virtual

Internally called by the framework.

virtual void openfluid::ware::PluggableObserver::onInitializedRun ( )

pure virtual

Internally called by the framework.

virtual void openfluid::ware::PluggableObserver::onPrepared ( )

pure virtual

Prepares data. Internally called by the framework.

virtual void openfluid::ware::PluggableObserver::onStepCompleted ( )

pure virtual

Internally called by the framework.

---

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

• ware/PluggableObserver.hpp