openfluid::ware::SimulationContributorWare Class Reference

#include <ware/SimulationContributorWare.hpp>

Inheritance diagram for openfluid::ware::SimulationContributorWare:

List of all members.

Public Member Functions
virtual	~SimulationContributorWare ()
Protected Member Functions
void	OPENFLUID_SetAttribute (openfluid::core::Unit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, const openfluid::core::Value &Val)
void	OPENFLUID_SetAttribute (openfluid::core::Unit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, const double &Val)
void	OPENFLUID_SetAttribute (openfluid::core::Unit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, const long &Val)
void	OPENFLUID_SetAttribute (openfluid::core::Unit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, const std::string &Val)
void	OPENFLUID_InitializeVariable (openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::Value &Val)
void	OPENFLUID_InitializeVariable (openfluid::core::Unit &aUnit, const openfluid::core::VariableName_t &VarName, const openfluid::core::Value &Val)
void	OPENFLUID_InitializeVariable (openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, const double &Val)
void	OPENFLUID_InitializeVariable (openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, const long &Val)
void	OPENFLUID_InitializeVariable (openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, const bool &Val)
void	OPENFLUID_InitializeVariable (openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, const std::string &Val)
void	OPENFLUID_AppendVariable (openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::Value &Val)
void	OPENFLUID_AppendVariable (openfluid::core::Unit &aUnit, const openfluid::core::VariableName_t &VarName, const openfluid::core::Value &Val)
void	OPENFLUID_AppendVariable (openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, const double &Val)
void	OPENFLUID_AppendVariable (openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, const long &Val)
void	OPENFLUID_AppendVariable (openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, const bool &Val)
void	OPENFLUID_AppendVariable (openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, const std::string &Val)
void	OPENFLUID_SetVariable (openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::Value &Val)
void	OPENFLUID_SetVariable (openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, const double &Val)
void	OPENFLUID_SetVariable (openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, const long &Val)
void	OPENFLUID_SetVariable (openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, const bool &Val)
void	OPENFLUID_SetVariable (openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, const std::string &Val)
void	OPENFLUID_AppendEvent (openfluid::core::Unit *UnitPtr, openfluid::core::Event &Ev)
void	OPENFLUID_AddUnit (openfluid::core::UnitClass_t ClassName, openfluid::core::UnitID_t ID, openfluid::core::PcsOrd_t PcsOrder)
void	OPENFLUID_DeleteUnit (openfluid::core::UnitClass_t ClassName, openfluid::core::UnitID_t ID)
bool	OPENFLUID_AddFromToConnection (openfluid::core::UnitClass_t ClassNameFrom, openfluid::core::UnitID_t IDFrom, openfluid::core::UnitClass_t ClassNameTo, openfluid::core::UnitID_t IDTo)
bool	OPENFLUID_AddFromToConnection (openfluid::core::Unit *FromUnit, openfluid::core::Unit *ToUnit)
bool	OPENFLUID_RemoveFromToConnection (openfluid::core::UnitClass_t ClassNameFrom, openfluid::core::UnitID_t IDFrom, openfluid::core::UnitClass_t ClassNameTo, openfluid::core::UnitID_t IDTo)
bool	OPENFLUID_RemoveFromToConnection (openfluid::core::Unit *FromUnit, openfluid::core::Unit *ToUnit)
bool	OPENFLUID_AddChildParentConnection (openfluid::core::UnitClass_t ClassNameChild, openfluid::core::UnitID_t IDChild, openfluid::core::UnitClass_t ClassNameParent, openfluid::core::UnitID_t IDParent)
bool	OPENFLUID_AddChildParentConnection (openfluid::core::Unit *ChildUnit, openfluid::core::Unit *ParentUnit)
bool	OPENFLUID_RemoveChildParentConnection (openfluid::core::UnitClass_t ClassNameChild, openfluid::core::UnitID_t IDChild, openfluid::core::UnitClass_t ClassNameParent, openfluid::core::UnitID_t IDParent)
bool	OPENFLUID_RemoveChildParentConnection (openfluid::core::Unit *ChildUnit, openfluid::core::Unit *ParentUnit)
void	OPENFLUID_BuildUnitsMatrix (const openfluid::core::UnitClass_t &UnitsClass, const unsigned int &ColsNbr, const unsigned int &RowsNbr)
	SimulationContributorWare (WareType WType)

---

Constructor & Destructor Documentation

openfluid::ware::SimulationContributorWare::SimulationContributorWare

(

WareType

WType

)

[inline, protected]

virtual openfluid::ware::SimulationContributorWare::~SimulationContributorWare

(

)

[inline, virtual]

---

Member Function Documentation

bool openfluid::ware::SimulationContributorWare::OPENFLUID_AddChildParentConnection	(	openfluid::core::UnitClass_t	ClassNameChild,
		openfluid::core::UnitID_t	IDChild,
		openfluid::core::UnitClass_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::Unit *	ChildUnit,
		openfluid::core::Unit *	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	(	openfluid::core::UnitClass_t	ClassNameFrom,
		openfluid::core::UnitID_t	IDFrom,
		openfluid::core::UnitClass_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::Unit *	FromUnit,
		openfluid::core::Unit *	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	(	openfluid::core::UnitClass_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::Unit *	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::Unit *	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

Deprecated:

void openfluid::ware::SimulationContributorWare::OPENFLUID_AppendVariable	(	openfluid::core::Unit &	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::Unit *	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::Unit *	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::Unit *	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::Unit *	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)

void openfluid::ware::SimulationContributorWare::OPENFLUID_BuildUnitsMatrix	(	const openfluid::core::UnitClass_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	(	openfluid::core::UnitClass_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::Unit *	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

Deprecated:

void openfluid::ware::SimulationContributorWare::OPENFLUID_InitializeVariable	(	openfluid::core::Unit &	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::Unit *	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::Unit *	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::Unit *	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::Unit *	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)

bool openfluid::ware::SimulationContributorWare::OPENFLUID_RemoveChildParentConnection	(	openfluid::core::UnitClass_t	ClassNameChild,
		openfluid::core::UnitID_t	IDChild,
		openfluid::core::UnitClass_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::Unit *	ChildUnit,
		openfluid::core::Unit *	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	(	openfluid::core::UnitClass_t	ClassNameFrom,
		openfluid::core::UnitID_t	IDFrom,
		openfluid::core::UnitClass_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::Unit *	FromUnit,
		openfluid::core::Unit *	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::Unit *	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::Unit *	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::Unit *	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::Unit *	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::Unit *	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::Unit *	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::Unit *	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::Unit *	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::Unit *	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