#include <ware/SimulationContributorWare.hpp>

Inheritance diagram for openfluid::ware::SimulationContributorWare:

[legend]

Collaboration diagram for openfluid::ware::SimulationContributorWare:

[legend]

Public Member Functions
virtual	~SimulationContributorWare ()

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)

Protected Member Functions
void	OPENFLUID_SetAttribute (openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, const openfluid::core::Value &Val)

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

void	OPENFLUID_SetAttribute (openfluid::core::SpatialUnit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, bool Val)

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

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

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

void	OPENFLUID_InitializeVariable (openfluid::core::SpatialUnit &aUnit, const openfluid::core::VariableName_t &VarName, const openfluid::core::Value &Val)

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

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

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

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

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

void	OPENFLUID_AppendVariable (openfluid::core::SpatialUnit &aUnit, const openfluid::core::VariableName_t &VarName, const openfluid::core::Value &Val)

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

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

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

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

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

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

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

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

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

void	OPENFLUID_AppendEvent (openfluid::core::SpatialUnit *UnitPtr, openfluid::core::Event &Ev)

void	OPENFLUID_AddUnit (const openfluid::core::UnitsClass_t &ClassName, openfluid::core::UnitID_t ID, openfluid::core::PcsOrd_t PcsOrder)

void	OPENFLUID_DeleteUnit (const openfluid::core::UnitsClass_t &ClassName, openfluid::core::UnitID_t ID)

bool	OPENFLUID_AddFromToConnection (const openfluid::core::UnitsClass_t &ClassNameFrom, openfluid::core::UnitID_t IDFrom, const openfluid::core::UnitsClass_t &ClassNameTo, openfluid::core::UnitID_t IDTo)

bool	OPENFLUID_AddFromToConnection (openfluid::core::SpatialUnit FromUnit, openfluid::core::SpatialUnit ToUnit)

bool	OPENFLUID_RemoveFromToConnection (const openfluid::core::UnitsClass_t &ClassNameFrom, openfluid::core::UnitID_t IDFrom, const openfluid::core::UnitsClass_t &ClassNameTo, openfluid::core::UnitID_t IDTo)

bool	OPENFLUID_RemoveFromToConnection (openfluid::core::SpatialUnit FromUnit, openfluid::core::SpatialUnit ToUnit)

bool	OPENFLUID_AddChildParentConnection (const openfluid::core::UnitsClass_t &ClassNameChild, openfluid::core::UnitID_t IDChild, const openfluid::core::UnitsClass_t &ClassNameParent, openfluid::core::UnitID_t IDParent)

bool	OPENFLUID_AddChildParentConnection (openfluid::core::SpatialUnit ChildUnit, openfluid::core::SpatialUnit ParentUnit)

bool	OPENFLUID_RemoveChildParentConnection (const openfluid::core::UnitsClass_t &ClassNameChild, openfluid::core::UnitID_t IDChild, const openfluid::core::UnitsClass_t &ClassNameParent, openfluid::core::UnitID_t IDParent)

bool	OPENFLUID_RemoveChildParentConnection (openfluid::core::SpatialUnit ChildUnit, openfluid::core::SpatialUnit ParentUnit)

void	OPENFLUID_BuildUnitsMatrix (const openfluid::core::UnitsClass_t &UnitsClass, const unsigned int &ColsNbr, const unsigned int &RowsNbr)

	SimulationContributorWare (WareType WType)

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)

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

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::SimulationContributorWare::SimulationContributorWare ( WareType WType )

inlineprotected

virtual openfluid::ware::SimulationContributorWare::~SimulationContributorWare ( )

inlinevirtual

Member Function Documentation

bool openfluid::ware::SimulationContributorWare::OPENFLUID_AddChildParentConnection	(	const openfluid::core::UnitsClass_t &	ClassNameChild,
		openfluid::core::UnitID_t	IDChild,
		const openfluid::core::UnitsClass_t &	ClassNameParent,
		openfluid::core::UnitID_t	IDParent
	)

protected

Adds a child-parent connection between two units

Parameters

[in]	ClassNameChild	class name of the "child" unit
[in]	IDChild	ID of the "child" unit
[in]	ClassNameParent	class name of the "parent" unit
[in]	IDParent	ID of the "parent" unit

Returns: false if the connection already exists

bool openfluid::ware::SimulationContributorWare::OPENFLUID_AddChildParentConnection	(	openfluid::core::SpatialUnit *	ChildUnit,
		openfluid::core::SpatialUnit *	ParentUnit
	)

protected

Adds a child-parent connection between two units

Parameters

[in]	ChildUnit	pointer to the "child" unit
[in]	ParentUnit	pointer to the "parent" unit

Returns: false if the connection already exists

bool openfluid::ware::SimulationContributorWare::OPENFLUID_AddFromToConnection	(	const openfluid::core::UnitsClass_t &	ClassNameFrom,
		openfluid::core::UnitID_t	IDFrom,
		const openfluid::core::UnitsClass_t &	ClassNameTo,
		openfluid::core::UnitID_t	IDTo
	)

protected

Adds a from-to connection between two units

Parameters

[in]	ClassNameFrom	class name of the "from" unit
[in]	IDFrom	ID of the "from" unit
[in]	ClassNameTo	class name of the "to" unit
[in]	IDTo	ID of the "to" unit

Returns: false if the unit connection already exists

bool openfluid::ware::SimulationContributorWare::OPENFLUID_AddFromToConnection	(	openfluid::core::SpatialUnit *	FromUnit,
		openfluid::core::SpatialUnit *	ToUnit
	)

protected

Adds a from-to connection between two units

Parameters

[in]	FromUnit	pointer to the "from" unit
[in]	ToUnit	pointer to the "to" unit

Returns: false if the connection already exists

void openfluid::ware::SimulationContributorWare::OPENFLUID_AddUnit	(	const openfluid::core::UnitsClass_t &	ClassName,
		openfluid::core::UnitID_t	ID,
		openfluid::core::PcsOrd_t	PcsOrder
	)

protected

Adds a unit to the set of units if not already exists

Parameters

[in]	ClassName	class name of the added unit
[in]	ID	ID of the added unit
[in]	PcsOrder	Process order of the added unit

void openfluid::ware::SimulationContributorWare::OPENFLUID_AppendEvent	(	openfluid::core::SpatialUnit *	UnitPtr,
		openfluid::core::Event &	Ev
	)

protected

Appends an event on a unit

Parameters

[in]	UnitPtr	a Unit
[in]	Ev	the event to append

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

protected

Appends a distributed variable value for a unit at the end of the previously added values for this variable

Parameters

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

void openfluid::ware::SimulationContributorWare::OPENFLUID_AppendVariable	(	openfluid::core::SpatialUnit &	aUnit,
		const openfluid::core::VariableName_t &	VarName,
		const openfluid::core::Value &	Val
	)

protected

Appends a distributed variable value for a unit at the end of the previously added values for this variable

Parameters

[in]	aUnit	a Unit
[in]	VarName	the name of the variable
[in]	Val	the added value of the variable

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

protected

Appends a distributed double variable value for a unit at the end of the previously added values for this variable

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the variable
[in]	Val	the added value of the variable (double)

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

protected

Appends a distributed long variable value for a unit at the end of the previously added values for this variable

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the variable
[in]	Val	the added value of the variable (long)

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

protected

Appends a distributed boolean variable value for a unit at the end of the previously added values for this variable

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the variable
[in]	Val	the added value of the variable (bool)

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

protected

Appends a distributed string variable value for a unit at the end of the previously added values for this variable

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the variable
[in]	Val	the added value of the variable (string)

Warning: Use std::string("text") instead of "text" as a value for the Val parameter to avoid the automatic overloading between char* and bool types

void openfluid::ware::SimulationContributorWare::OPENFLUID_BuildUnitsMatrix	(	const openfluid::core::UnitsClass_t &	UnitsClass,
		const unsigned int &	ColsNbr,
		const unsigned int &	RowsNbr
	)

protected

Builds a ColsNbr x RowsNbr unix matrix with bi-directionnal connections

Parameters

[in]	UnitsClass	the name of units class
[in]	ColsNbr	the number of units on the X axis
[in]	RowsNbr	the number of units on the Y axis

void openfluid::ware::SimulationContributorWare::OPENFLUID_DeleteUnit	(	const openfluid::core::UnitsClass_t &	ClassName,
		openfluid::core::UnitID_t	ID
	)

protected

Deletes a unit from the set of units if exists

Parameters

[in]	ClassName	class name of the removed unit
[in]	ID	ID of the added unit

Returns: true if the unit has been correctly deleted

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

protected

Initializes a distributed variable value for a unit

Parameters

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

void openfluid::ware::SimulationContributorWare::OPENFLUID_InitializeVariable	(	openfluid::core::SpatialUnit &	aUnit,
		const openfluid::core::VariableName_t &	VarName,
		const openfluid::core::Value &	Val
	)

protected

Initializes a distributed variable value for a unit

Parameters

[in]	aUnit	a Unit
[in]	VarName	the name of the variable
[in]	Val	the added value of the variable

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

protected

Initializes a distributed double variable value for a unit

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the variable
[in]	Val	the added value of the variable (double)

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

protected

Initializes a distributed long variable value for a unit

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the variable
[in]	Val	the added value of the variable (long)

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

protected

Initializes a distributed boolean variable value for a unit

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the variable
[in]	Val	the added value of the variable (bool)

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

protected

Initializes a distributed string variable value for a unit

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the variable
[in]	Val	the added value of the variable (string)

Warning: Use std::string("text") instead of "text" as a value for the Val parameter to avoid the automatic overloading between char* and bool types

bool openfluid::ware::SimulationContributorWare::OPENFLUID_RemoveChildParentConnection	(	const openfluid::core::UnitsClass_t &	ClassNameChild,
		openfluid::core::UnitID_t	IDChild,
		const openfluid::core::UnitsClass_t &	ClassNameParent,
		openfluid::core::UnitID_t	IDParent
	)

protected

Removes a child-parent connection between two units

Parameters

[in]	ClassNameChild	class name of the "child" unit
[in]	IDChild	ID of the "child" unit
[in]	ClassNameParent	class name of the "parent" unit
[in]	IDParent	ID of the "parent" unit

Returns: false if the connection does not exist

bool openfluid::ware::SimulationContributorWare::OPENFLUID_RemoveChildParentConnection	(	openfluid::core::SpatialUnit *	ChildUnit,
		openfluid::core::SpatialUnit *	ParentUnit
	)

protected

Removes a child-parent connection between two units

Parameters

[in]	ChildUnit	pointer to the "child" unit
[in]	ParentUnit	pointer to the "parent" unit

Returns: false if the connection does not exist

bool openfluid::ware::SimulationContributorWare::OPENFLUID_RemoveFromToConnection	(	const openfluid::core::UnitsClass_t &	ClassNameFrom,
		openfluid::core::UnitID_t	IDFrom,
		const openfluid::core::UnitsClass_t &	ClassNameTo,
		openfluid::core::UnitID_t	IDTo
	)

protected

Removes a from-to connection between two units

Parameters

[in]	ClassNameFrom	class name of the "from" unit
[in]	IDFrom	ID of the "from" unit
[in]	ClassNameTo	class name of the "to" unit
[in]	IDTo	ID of the "to" unit

Returns: false if the unit connection does not exist

bool openfluid::ware::SimulationContributorWare::OPENFLUID_RemoveFromToConnection	(	openfluid::core::SpatialUnit *	FromUnit,
		openfluid::core::SpatialUnit *	ToUnit
	)

protected

Removes a from-to connection between two units

Parameters

[in]	FromUnit	pointer to the "from" unit
[in]	ToUnit	pointer to the "to" unit

Returns: false if the connection does not exist

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

protected

Sets attribute for a unit

Parameters

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

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

protected

Sets attribute for a unit, as a double

Parameters

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

void openfluid::ware::SimulationContributorWare::OPENFLUID_SetAttribute	(	openfluid::core::SpatialUnit *	UnitPtr,
		const openfluid::core::AttributeName_t &	AttrName,
		bool	Val
	)

protected

Sets attribute for a unit, as a boolean

Parameters

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

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

protected

Sets attribute for a unit, as a long integer

Parameters

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

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

protected

Sets attribute for a unit, as a string

Parameters

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

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

protected

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

Parameters

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

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

protected

Sets a distributed double variable value for a unit at the current time index

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the variable
[in]	Val	the added value of the variable (double)

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

protected

Sets a distributed double variable value for a unit at the current time index

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the variable
[in]	Val	the added value of the variable (long)

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

protected

Sets a distributed double variable value for a unit at the current time index

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the variable
[in]	Val	the added value of the variable (bool)

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

protected

Sets a distributed double variable value for a unit at the current time index

Parameters

[in]	UnitPtr	a Unit
[in]	VarName	the name of the variable
[in]	Val	the added value of the variable (string)

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

ware/SimulationContributorWare.hpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation