openfluid::ware::SimulationInspectorWare Class Reference

#include <ware/SimulationInspectorWare.hpp>

Public Member Functions
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
	PluggableWare ()=default
	PluggableWare (const PluggableWare &)=delete
	PluggableWare (PluggableWare &&)=default
PluggableWare &	operator= (const PluggableWare &)=delete
PluggableWare &	operator= (PluggableWare &&)=default
virtual	~PluggableWare ()=default
void	linkToRunEnvironment (const openfluid::core::MapValue *Env)

Protected Member Functions
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
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)
virtual void	OPENFLUID_RaiseError (const std::string &Msg)
virtual void	OPENFLUID_RaiseError (const std::string &Source, const std::string &Msg)
	SimulationDrivenWare (WareType WType)
bool	OPENFLUID_IsWareParameterExist (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName) const
openfluid::core::StringValue	OPENFLUID_GetWareParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName) const
bool	OPENFLUID_GetWareParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, openfluid::core::StringValue &Val) const
bool	OPENFLUID_GetWareParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, openfluid::core::DoubleValue &Val) const
bool	OPENFLUID_GetWareParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, openfluid::core::VectorValue &Val) const
bool	OPENFLUID_GetWareParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, openfluid::core::MatrixValue &Val) const
bool	OPENFLUID_GetWareParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, bool &Val) const
bool	OPENFLUID_GetWareParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, double &Val) const
bool	OPENFLUID_GetWareParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, long &Val) const
bool	OPENFLUID_GetWareParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, float &Val) const
bool	OPENFLUID_GetWareParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, int &Val) const
bool	OPENFLUID_GetWareParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, std::string &Val) const
bool	OPENFLUID_GetWareParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, std::vector< std::string > &Vals) const
bool	OPENFLUID_GetWareParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, std::vector< double > &Vals) const
bool	OPENFLUID_GetWareParameter (const openfluid::ware::WareParams_t &Params, const openfluid::ware::WareParamKey_t &ParamName, std::vector< long > &Vals) const
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
openfluid::core::SpatialGraph *	mp_SpatialData
Protected Attributes inherited from openfluid::ware::PluggableWare
bool	m_Initialized

Additional Inherited Members
Static Public Member Functions inherited from openfluid::ware::PluggableWare
static bool	isWellFormatted (const openfluid::ware::WareParamKey_t &ParameterKey)

Inheritance diagram for openfluid::ware::SimulationInspectorWare:

Collaboration diagram for openfluid::ware::SimulationInspectorWare:

Constructor & Destructor Documentation

SimulationInspectorWare()

openfluid::ware::SimulationInspectorWare::SimulationInspectorWare ( WareType  WType )

inlineprotected

~SimulationInspectorWare()

virtual openfluid::ware::SimulationInspectorWare::~SimulationInspectorWare ( )

inlinevirtual

Member Function Documentation

isLinked()

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

inlineprotectedvirtual

Reimplemented from openfluid::ware::SimulationDrivenWare.

linkToDatastore()

void openfluid::ware::SimulationInspectorWare::linkToDatastore ( openfluid::core::Datastore *  DStore )

inline

linkToSpatialGraph()

void openfluid::ware::SimulationInspectorWare::linkToSpatialGraph ( openfluid::core::SpatialGraph *  SGraph )

inline

OPENFLUID_GetAttribute() [1/5]

const openfluid::core::Value* openfluid::ware::SimulationInspectorWare::OPENFLUID_GetAttribute ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::AttributeName_t &  AttrName  ) const

protected

Returns attribute for a unit, as a StringValue

Parameters

[in]	UnitPtr	a Unit
[in]	AttrName	the name of the requested attribute

Returns

constant pointer to the value of the requested attribute

OPENFLUID_GetAttribute() [2/5]

void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetAttribute ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::AttributeName_t &  AttrName, double &  Val  ) const

protected

Gets attribute for a unit, as a double

Parameters

[in]	UnitPtr	a Unit
[in]	AttrName	the name of the requested attribute
[out]	Val	the value of the requested attribute

OPENFLUID_GetAttribute() [3/5]

void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetAttribute ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::AttributeName_t &  AttrName, long &  Val  ) const

protected

Gets attribute for a unit, as a long integer

Parameters

[in]	UnitPtr	a Unit
[in]	AttrName	the name of the requested attribute
[out]	Val	the value of the requested attribute

OPENFLUID_GetAttribute() [4/5]

void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetAttribute ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::AttributeName_t &  AttrName, openfluid::core::Value &  Val  ) const

protected

Gets attribute for a unit

Parameters

[in]	UnitPtr	a Unit
[in]	AttrName	the name of the requested attribute
[out]	Val	the value of the requested attribute

OPENFLUID_GetAttribute() [5/5]

void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetAttribute ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::AttributeName_t &  AttrName, std::string &  Val  ) const

protected

Gets attribute for a unit, as a string

Parameters

[in]	UnitPtr	a Unit
[in]	AttrName	the name of the requested attribute
[out]	Val	the value of the requested attribute

OPENFLUID_GetEvents() [1/2]

openfluid::core::EventsCollection openfluid::ware::SimulationInspectorWare::OPENFLUID_GetEvents ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::DateTime  BeginDate, const openfluid::core::DateTime  EndDate  ) const

protected

Returns discrete events happening on a unit during a time period

Parameters

[in]	UnitPtr	a Unit
[in]	BeginDate	the beginning of the time period
[in]	EndDate	the ending of the time period

Returns

the collection of event corresponding to the request

OPENFLUID_GetEvents() [2/2]

void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetEvents ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::DateTime  BeginDate, const openfluid::core::DateTime  EndDate, openfluid::core::EventsCollection &  Events  ) const

protected

Gets discrete events happening on a unit during a time period

Parameters

[in]	UnitPtr	a Unit
[in]	BeginDate	the beginning of the time period
[in]	EndDate	the ending of the time period
[out]	Events	the collection of event corresponding to the request

OPENFLUID_GetLatestVariable() [1/2]

openfluid::core::IndexedValue openfluid::ware::SimulationInspectorWare::OPENFLUID_GetLatestVariable ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::VariableName_t &  VarName  ) const

protected

Returns the latest available variable for a unit

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the requested variable

Returns

the value and timeindex of the requested variable

OPENFLUID_GetLatestVariable() [2/2]

void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetLatestVariable ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::VariableName_t &  VarName, openfluid::core::IndexedValue &  IndVal  ) const

protected

Gets the latest available variable for a unit

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the requested variable
[out]	IndVal	the value and timeindex of the requested variable

OPENFLUID_GetLatestVariables() [1/2]

openfluid::core::IndexedValueList openfluid::ware::SimulationInspectorWare::OPENFLUID_GetLatestVariables ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::VariableName_t &  VarName, const openfluid::core::TimeIndex_t  BeginIndex  ) const

protected

Returns the latest available variables for a unit since the given time index

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the requested variable
[in]	BeginIndex	The beginning time index of the search period

Returns

the list of time-indexed values of the requested variable

OPENFLUID_GetLatestVariables() [2/2]

void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetLatestVariables ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::VariableName_t &  VarName, const openfluid::core::TimeIndex_t  BeginIndex, openfluid::core::IndexedValueList &  IndValList  ) const

protected

Gets the latest available variables for a unit since the given time index

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the requested variable
[in]	BeginIndex	The beginning time index of the search period
[out]	IndValList	the list of time-indexed values of the requested variable

OPENFLUID_GetUnit() [1/2]

openfluid::core::SpatialUnit* openfluid::ware::SimulationInspectorWare::OPENFLUID_GetUnit ( const openfluid::core::UnitsClass_t &  ClassName, const openfluid::core::UnitID_t &  ID  ) const

protected

OPENFLUID_GetUnit() [2/2]

bool openfluid::ware::SimulationInspectorWare::OPENFLUID_GetUnit ( const openfluid::core::UnitsClass_t &  ClassName, const openfluid::core::UnitID_t &  ID, openfluid::core::SpatialUnit *&  aUnit  ) const

protected

Returns a pointer to the queried unit if exists

Parameters

[in]	ClassName	the queried class name
[in]	ID	the queried unit ID
[out]	aUnit	a pointer to the requested Unit, nullptr if the unit does not exist

Returns

false if the unit does not exist

OPENFLUID_GetUnits()

openfluid::core::UnitsPtrList_t openfluid::ware::SimulationInspectorWare::OPENFLUID_GetUnits ( const openfluid::core::UnitsClass_t &  ClassName )

protected

Returns a list of units of the requested class Returns an empty list if the units class does not exist.

Parameters

[in]

ClassName

the requested class

OPENFLUID_GetUnitsCount() [1/4]

unsigned int openfluid::ware::SimulationInspectorWare::OPENFLUID_GetUnitsCount ( ) const

protected

Returns the total number of units

Returns

the total units count

OPENFLUID_GetUnitsCount() [2/4]

unsigned int openfluid::ware::SimulationInspectorWare::OPENFLUID_GetUnitsCount ( const openfluid::core::UnitsClass_t &  ClassName ) const

protected

Returns the number of units of the class if the queried unit class exists

Parameters

[in]

ClassName

the queried class name

Returns

the number of units in the queried class, or 0 if the units class does not exist

OPENFLUID_GetUnitsCount() [3/4]

bool openfluid::ware::SimulationInspectorWare::OPENFLUID_GetUnitsCount ( const openfluid::core::UnitsClass_t &  ClassName, unsigned int &  UnitsCount  ) const

protected

Gets the number of units of the class if the queried unit class exists

Parameters

[in]	ClassName	the queried class name
[out]	UnitsCount	the number of units in the queried class

Returns

false if the unit class does not exist

OPENFLUID_GetUnitsCount() [4/4]

void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetUnitsCount ( unsigned int &  UnitsCount ) const

protected

Returns the total number of units

Parameters

[out]

UnitsCount

the total units count

OPENFLUID_GetVariable() [1/12]

const openfluid::core::Value* openfluid::ware::SimulationInspectorWare::OPENFLUID_GetVariable ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::VariableName_t &  VarName  ) const

protected

Returns the distributed variable value for a unit at the current time index

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the requested variable

Returns

a constant pointer the value of the requested variable

OPENFLUID_GetVariable() [2/12]

void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetVariable ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::VariableName_t &  VarName, bool &  Val  ) const

protected

Gets the distributed variable value for a unit at the current time index

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the requested variable
[out]	Val	the value of the requested variable

OPENFLUID_GetVariable() [3/12]

const openfluid::core::Value* openfluid::ware::SimulationInspectorWare::OPENFLUID_GetVariable ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::VariableName_t &  VarName, const openfluid::core::TimeIndex_t  Index  ) const

protected

Returns the distributed variable value for a unit at a time index

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the requested variable
[in]	Index	the time index for the value of the requested variable

Returns

a constant pointer the value of the requested variable

OPENFLUID_GetVariable() [4/12]

void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetVariable ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::VariableName_t &  VarName, const openfluid::core::TimeIndex_t  Index, bool &  Val  ) const

protected

Gets the distributed variable value for a unit at a time index

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the requested variable
[in]	Index	the time index for the value of the requested variable
[out]	Val	the value of the requested variable

OPENFLUID_GetVariable() [5/12]

void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetVariable ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::VariableName_t &  VarName, const openfluid::core::TimeIndex_t  Index, double &  Val  ) const

protected

Gets the distributed variable value for a unit at a time index

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the requested variable
[in]	Index	the time index for the value of the requested variable
[out]	Val	the value of the requested variable

OPENFLUID_GetVariable() [6/12]

void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetVariable ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::VariableName_t &  VarName, const openfluid::core::TimeIndex_t  Index, long &  Val  ) const

protected

Gets the distributed variable value for a unit at a time index

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the requested variable
[in]	Index	the time index for the value of the requested variable
[out]	Val	the value of the requested variable

OPENFLUID_GetVariable() [7/12]

void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetVariable ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::VariableName_t &  VarName, const openfluid::core::TimeIndex_t  Index, openfluid::core::Value &  Val  ) const

protected

Gets the distributed variable value for a unit at a time index

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the requested variable
[in]	Index	the time index for the value of the requested variable
[out]	Val	the value of the requested variable

OPENFLUID_GetVariable() [8/12]

void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetVariable ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::VariableName_t &  VarName, const openfluid::core::TimeIndex_t  Index, std::string &  Val  ) const

protected

Gets the distributed variable value for a unit at a time index

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the requested variable
[in]	Index	the time index for the value of the requested variable
[out]	Val	the value of the requested variable

OPENFLUID_GetVariable() [9/12]

void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetVariable ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::VariableName_t &  VarName, double &  Val  ) const

protected

Gets the distributed variable value for a unit at the current time index

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the requested variable
[out]	Val	the value of the requested variable

OPENFLUID_GetVariable() [10/12]

void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetVariable ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::VariableName_t &  VarName, long &  Val  ) const

protected

Gets the distributed variable value for a unit at the current time index

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the requested variable
[out]	Val	the value of the requested variable

OPENFLUID_GetVariable() [11/12]

void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetVariable ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::VariableName_t &  VarName, openfluid::core::Value &  Val  ) const

protected

Gets the distributed variable value for a unit at the current time index

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the requested variable
[out]	Val	the value of the requested variable

OPENFLUID_GetVariable() [12/12]

void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetVariable ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::VariableName_t &  VarName, std::string &  Val  ) const

protected

Gets the distributed variable value for a unit at the current time index

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the requested variable
[out]	Val	the value of the requested variable

OPENFLUID_GetVariables() [1/2]

openfluid::core::IndexedValueList openfluid::ware::SimulationInspectorWare::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

protected

Returns the available variables for a unit during a given period (between two time indexes)

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the requested variable
[in]	BeginIndex	the time index for the beginning of the period
[in]	EndIndex	the time index for the end of the period

Returns

the list of time-indexed values of the requested variable

OPENFLUID_GetVariables() [2/2]

void openfluid::ware::SimulationInspectorWare::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

protected

Gets the available variables for a unit during a given period (between two time indexes)

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the requested variable
[in]	BeginIndex	the time index for the beginning of the period
[in]	EndIndex	the time index for the end of the period
[out]	IndValList	the list of time-indexed values of the requested variable

OPENFLUID_IsAttributeExist()

bool openfluid::ware::SimulationInspectorWare::OPENFLUID_IsAttributeExist ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::AttributeName_t &  AttrName  ) const

protected

Returns true if a distributed attribute exists, false otherwise

Parameters

[in]	UnitPtr	a Unit
[in]	AttrName	the name of the queried attribute

OPENFLUID_IsTypedVariableExist() [1/2]

bool openfluid::ware::SimulationInspectorWare::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

protected

Returns true if a distributed variable exists and if a value has been set for the given index and if the type set for this variable is the given type, false otherwise

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the requested variable
[in]	Index	the time index for the value of the variable
[in]	VarType	the type of the variable

OPENFLUID_IsTypedVariableExist() [2/2]

bool openfluid::ware::SimulationInspectorWare::OPENFLUID_IsTypedVariableExist ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::VariableName_t &  VarName, const openfluid::core::Value::Type  VarType  ) const

protected

Returns true if a distributed variable exists and if the type set for this variable is the given type, false otherwise

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the requested variable
[in]	VarType	the type of the variable

OPENFLUID_IsUnitChildOf()

bool openfluid::ware::SimulationInspectorWare::OPENFLUID_IsUnitChildOf ( openfluid::core::SpatialUnit *  aUnit, const openfluid::core::UnitsClass_t &  ClassNameParent, const openfluid::core::UnitID_t &  IDParent  ) const

protected

Returns true if a given unit is "a child of" another unit

Parameters

[in]	aUnit	the given unit
[in]	ClassNameParent	the class name of the other unit to test
[in]	IDParent	the ID of the other unit to test

Returns

true if the given unit is "a child of" the other unit

OPENFLUID_IsUnitClassExist()

bool openfluid::ware::SimulationInspectorWare::OPENFLUID_IsUnitClassExist ( const openfluid::core::UnitsClass_t &  ClassName ) const

inlineprotected

Deprecated:

Since version 2.1.0. Use openfluid::ware::SimulationInspectorWare::OPENFLUID_IsUnitsClassExist instead

OPENFLUID_IsUnitConnectedFrom()

bool openfluid::ware::SimulationInspectorWare::OPENFLUID_IsUnitConnectedFrom ( openfluid::core::SpatialUnit *  aUnit, const openfluid::core::UnitsClass_t &  ClassNameFrom, const openfluid::core::UnitID_t &  IDFrom  ) const

protected

Returns true if a given unit is connected "from" another unit

Parameters

[in]	aUnit	the given unit
[in]	ClassNameFrom	the class name of the other unit to test
[in]	IDFrom	the ID of the other unit to test

Returns

true if the given unit is connected "from" the other unit

OPENFLUID_IsUnitConnectedTo()

bool openfluid::ware::SimulationInspectorWare::OPENFLUID_IsUnitConnectedTo ( openfluid::core::SpatialUnit *  aUnit, const openfluid::core::UnitsClass_t &  ClassNameTo, const openfluid::core::UnitID_t &  IDTo  ) const

protected

Returns true if a given unit is connected "to" another unit

Parameters

[in]	aUnit	the given unit
[in]	ClassNameTo	the class name of the other unit to test
[in]	IDTo	the ID of the other unit to test

Returns

true if the given unit is connected "to" the other unit

OPENFLUID_IsUnitExist()

bool openfluid::ware::SimulationInspectorWare::OPENFLUID_IsUnitExist ( const openfluid::core::UnitsClass_t &  ClassName, openfluid::core::UnitID_t  ID  ) const

protected

Returns true if the queried unit exists

Parameters

[in]	ClassName	the class of the queried unit
[in]	ID	the ID of the queried unit

OPENFLUID_IsUnitParentOf()

bool openfluid::ware::SimulationInspectorWare::OPENFLUID_IsUnitParentOf ( openfluid::core::SpatialUnit *  aUnit, const openfluid::core::UnitsClass_t &  ClassNameChild, const openfluid::core::UnitID_t &  IDChild  ) const

protected

Returns true if a given unit is "parent of" another unit

Parameters

[in]	aUnit	the given unit
[in]	ClassNameChild	the class name of the other unit to test
[in]	IDChild	the ID of the other unit to test

Returns

true if the given unit is "parent of" the other unit

OPENFLUID_IsUnitsClassExist()

bool openfluid::ware::SimulationInspectorWare::OPENFLUID_IsUnitsClassExist ( const openfluid::core::UnitsClass_t &  ClassName ) const

protected

Returns true if the queried unit class exists

Parameters

[in]

ClassName

the queried class name

OPENFLUID_IsVariableExist() [1/3]

bool openfluid::ware::SimulationInspectorWare::OPENFLUID_IsVariableExist ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::VariableName_t &  VarName  ) const

protected

Returns true if a distributed variable exists, false otherwise

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the requested variable

OPENFLUID_IsVariableExist() [2/3]

bool openfluid::ware::SimulationInspectorWare::OPENFLUID_IsVariableExist ( const openfluid::core::SpatialUnit *  UnitPtr, const openfluid::core::VariableName_t &  VarName, const openfluid::core::TimeIndex_t  Index  ) const

protected

Returns true if a distributed variable exists and if a value has been set for the given index, false otherwise

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the requested variable
[in]	Index	the time index for the value of the variable

OPENFLUID_IsVariableExist() [3/3]

bool openfluid::ware::SimulationInspectorWare::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

protected

Returns true if a distributed variable exists and if a value has been set for the given index and if the value type is the given type, false otherwise

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the requested variable
[in]	Index	the time index for the value of the variable
[in]	ValueType	the type of the value

Member Data Documentation

mp_SpatialData

openfluid::core::SpatialGraph* openfluid::ware::SimulationInspectorWare::mp_SpatialData

protected

Pointer to the spatial graph. It should be used with care. Prefer using the OPENFLUID_Xxxx methods.

---

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

• ware/SimulationInspectorWare.hpp