openfluid::base::PluggableFunction Class Reference

Abstract class for plugin interface. More...

Inheritance diagram for openfluid::base::PluggableFunction:

List of all members.

Public Member Functions
	PluggableFunction ()
virtual	~PluggableFunction ()
void	initializeFunction (openfluid::core::CoreRepository *CoreData, openfluid::base::ExecutionMessages *ExecMsgs, openfluid::base::EnvironmentProperties *FuncEnv, const unsigned int &MaxThreads, const openfluid::base::FuncID_t &FuncID)
void	finalizeFunction ()
virtual bool	initParams (openfluid::core::FuncParamsMap_t Params)=0
virtual bool	prepareData ()=0
virtual bool	checkConsistency ()=0
virtual bool	initializeRun (const SimulationInfo *SimInfo)=0
virtual bool	runStep (const SimulationStatus *SimStatus)=0
virtual bool	finalizeRun (const SimulationInfo *SimInfo)=0
Protected Member Functions
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::TimeStep_t Step, const openfluid::core::Value &Val)
void	OPENFLUID_SetVariable (openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t VarName, const openfluid::core::TimeStep_t Step, const double Val)
void	OPENFLUID_SetVariable (openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t VarName, const openfluid::core::TimeStep_t Step, const long Val)
void	OPENFLUID_SetVariable (openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t VarName, const openfluid::core::TimeStep_t Step, const bool Val)
void	OPENFLUID_SetVariable (openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t VarName, const openfluid::core::TimeStep_t Step, const std::string Val)
void	OPENFLUID_GetVariable (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t VarName, const openfluid::core::TimeStep_t Step, openfluid::core::Value *Val) const
void	OPENFLUID_GetVariable (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t VarName, const openfluid::core::TimeStep_t Step, openfluid::core::Value &Val) const
void	OPENFLUID_GetVariable (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t VarName, const openfluid::core::TimeStep_t Step, double *Val) const
void	OPENFLUID_GetVariable (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t VarName, const openfluid::core::TimeStep_t Step, double &Val) const
void	OPENFLUID_GetVariable (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t VarName, const openfluid::core::TimeStep_t Step, long *Val) const
void	OPENFLUID_GetVariable (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t VarName, const openfluid::core::TimeStep_t Step, long &Val) const
void	OPENFLUID_GetVariable (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t VarName, const openfluid::core::TimeStep_t Step, bool *Val) const
void	OPENFLUID_GetVariable (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t VarName, const openfluid::core::TimeStep_t Step, bool &Val) const
void	OPENFLUID_GetVariable (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t VarName, const openfluid::core::TimeStep_t Step, std::string *Val) const
void	OPENFLUID_GetVariable (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t VarName, const openfluid::core::TimeStep_t Step, std::string &Val) const
bool	OPENFLUID_IsVariableExist (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t VarName) const
bool	OPENFLUID_IsVariableExist (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t VarName, const openfluid::core::TimeStep_t Step) const
bool	OPENFLUID_IsVariableExist (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t VarName, const openfluid::core::TimeStep_t Step, const openfluid::core::Value::Type ValueType) const
bool	OPENFLUID_IsTypedVariableExist (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t VarName, const openfluid::core::Value::Type VarType) const
bool	OPENFLUID_IsTypedVariableExist (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t VarName, const openfluid::core::TimeStep_t Step, const openfluid::core::Value::Type VarType) const
void	OPENFLUID_SetInputData (openfluid::core::Unit *UnitPtr, const openfluid::core::InputDataName_t &InputName, const openfluid::core::Value &Val)
void	OPENFLUID_SetInputData (openfluid::core::Unit *UnitPtr, const openfluid::core::InputDataName_t &InputName, const double &Val)
void	OPENFLUID_SetInputData (openfluid::core::Unit *UnitPtr, const openfluid::core::InputDataName_t &InputName, const long &Val)
void	OPENFLUID_SetInputData (openfluid::core::Unit *UnitPtr, const openfluid::core::InputDataName_t &InputName, const std::string &Val)
void	OPENFLUID_GetInputData (const openfluid::core::Unit *UnitPtr, const openfluid::core::InputDataName_t InputName, openfluid::core::StringValue &Val) const
void	OPENFLUID_GetInputData (const openfluid::core::Unit *UnitPtr, const openfluid::core::InputDataName_t InputName, openfluid::core::DoubleValue *Val) const
void	OPENFLUID_GetInputData (const openfluid::core::Unit *UnitPtr, const openfluid::core::InputDataName_t InputName, openfluid::core::DoubleValue &Val) const
void	OPENFLUID_GetInputData (const openfluid::core::Unit *UnitPtr, const openfluid::core::InputDataName_t InputName, openfluid::core::VectorValue *Val) const
void	OPENFLUID_GetInputData (const openfluid::core::Unit *UnitPtr, const openfluid::core::InputDataName_t InputName, openfluid::core::VectorValue &Val) const
void	OPENFLUID_GetInputData (const openfluid::core::Unit *UnitPtr, const openfluid::core::InputDataName_t InputName, openfluid::core::MatrixValue &Val) const
void	OPENFLUID_GetInputData (const openfluid::core::Unit *UnitPtr, const openfluid::core::InputDataName_t InputName, double *Val) const
void	OPENFLUID_GetInputData (const openfluid::core::Unit *UnitPtr, const openfluid::core::InputDataName_t InputName, double &Val) const
void	OPENFLUID_GetInputData (const openfluid::core::Unit *UnitPtr, const openfluid::core::InputDataName_t InputName, long *Val) const
void	OPENFLUID_GetInputData (const openfluid::core::Unit *UnitPtr, const openfluid::core::InputDataName_t InputName, long &Val) const
void	OPENFLUID_GetInputData (const openfluid::core::Unit *UnitPtr, const openfluid::core::InputDataName_t InputName, std::string *Val) const
void	OPENFLUID_GetInputData (const openfluid::core::Unit *UnitPtr, const openfluid::core::InputDataName_t InputName, std::string &Val) const
bool	OPENFLUID_IsInputDataExist (const openfluid::core::Unit *UnitPtr, const openfluid::core::InputDataName_t InputName) const
bool	OPENFLUID_GetFunctionParameter (const openfluid::core::FuncParamsMap_t Params, const openfluid::core::FuncParamKey_t ParamName, openfluid::core::StringValue &Val) const
bool	OPENFLUID_GetFunctionParameter (const openfluid::core::FuncParamsMap_t Params, const openfluid::core::FuncParamKey_t ParamName, openfluid::core::DoubleValue &Val) const
bool	OPENFLUID_GetFunctionParameter (const openfluid::core::FuncParamsMap_t Params, const openfluid::core::FuncParamKey_t ParamName, openfluid::core::VectorValue &Val) const
bool	OPENFLUID_GetFunctionParameter (const openfluid::core::FuncParamsMap_t Params, const openfluid::core::FuncParamKey_t ParamName, openfluid::core::MatrixValue &Val) const
bool	OPENFLUID_GetFunctionParameter (const openfluid::core::FuncParamsMap_t Params, const openfluid::core::FuncParamKey_t ParamName, double *Val) const
bool	OPENFLUID_GetFunctionParameter (const openfluid::core::FuncParamsMap_t Params, const openfluid::core::FuncParamKey_t ParamName, double &Val) const
bool	OPENFLUID_GetFunctionParameter (const openfluid::core::FuncParamsMap_t Params, const openfluid::core::FuncParamKey_t ParamName, long *Val) const
bool	OPENFLUID_GetFunctionParameter (const openfluid::core::FuncParamsMap_t Params, const openfluid::core::FuncParamKey_t ParamName, long &Val) const
bool	OPENFLUID_GetFunctionParameter (const openfluid::core::FuncParamsMap_t Params, const openfluid::core::FuncParamKey_t ParamName, float *Val) const
bool	OPENFLUID_GetFunctionParameter (const openfluid::core::FuncParamsMap_t Params, const openfluid::core::FuncParamKey_t ParamName, float &Val) const
bool	OPENFLUID_GetFunctionParameter (const openfluid::core::FuncParamsMap_t Params, const openfluid::core::FuncParamKey_t ParamName, int *Val) const
bool	OPENFLUID_GetFunctionParameter (const openfluid::core::FuncParamsMap_t Params, const openfluid::core::FuncParamKey_t ParamName, int &Val) const
bool	OPENFLUID_GetFunctionParameter (const openfluid::core::FuncParamsMap_t Params, const openfluid::core::FuncParamKey_t ParamName, std::string *Val) const
bool	OPENFLUID_GetFunctionParameter (const openfluid::core::FuncParamsMap_t Params, const openfluid::core::FuncParamKey_t ParamName, std::string &Val) const
bool	OPENFLUID_GetFunctionParameter (const openfluid::core::FuncParamsMap_t Params, const openfluid::core::FuncParamKey_t ParamName, std::vector< std::string > *Vals) const
bool	OPENFLUID_GetFunctionParameter (const openfluid::core::FuncParamsMap_t Params, const openfluid::core::FuncParamKey_t ParamName, std::vector< std::string > &Vals) const
bool	OPENFLUID_GetFunctionParameter (const openfluid::core::FuncParamsMap_t Params, const openfluid::core::FuncParamKey_t ParamName, std::vector< double > *Vals) const
bool	OPENFLUID_GetFunctionParameter (const openfluid::core::FuncParamsMap_t Params, const openfluid::core::FuncParamKey_t ParamName, std::vector< double > &Vals) const
bool	OPENFLUID_GetFunctionParameter (const openfluid::core::FuncParamsMap_t Params, const openfluid::core::FuncParamKey_t ParamName, std::vector< long > *Vals) const
bool	OPENFLUID_GetFunctionParameter (const openfluid::core::FuncParamsMap_t Params, const openfluid::core::FuncParamKey_t ParamName, std::vector< long > &Vals) const
void	OPENFLUID_AppendEvent (openfluid::core::Unit *UnitPtr, openfluid::core::Event &Ev)
void	OPENFLUID_GetEvents (const openfluid::core::Unit *UnitPtr, const openfluid::core::DateTime BeginDate, const openfluid::core::DateTime EndDate, openfluid::core::EventsCollection *Events) const
void	OPENFLUID_GetEvents (const openfluid::core::Unit *UnitPtr, const openfluid::core::DateTime BeginDate, const openfluid::core::DateTime EndDate, openfluid::core::EventsCollection &Events) const
bool	OPENFLUID_IsUnitClassExist (openfluid::core::UnitClass_t ClassName)
bool	OPENFLUID_IsUnitExist (openfluid::core::UnitClass_t ClassName, openfluid::core::UnitID_t ID)
void	OPENFLUID_GetUnitsCount (unsigned int &UnitsCount)
bool	OPENFLUID_GetUnitsCount (const openfluid::core::UnitClass_t ClassName, unsigned int &UnitsCount)
bool	OPENFLUID_GetUnit (const openfluid::core::UnitClass_t &ClassName, const openfluid::core::UnitID_t &ID, openfluid::core::Unit *aUnit)
openfluid::core::Unit *	OPENFLUID_GetUnit (const openfluid::core::UnitClass_t &ClassName, const openfluid::core::UnitID_t &ID)
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)
bool	OPENFLUID_IsUnitConnectedTo (openfluid::core::Unit *aUnit, const openfluid::core::UnitClass_t &ClassNameTo, const openfluid::core::UnitID_t &IDTo)
bool	OPENFLUID_IsUnitConnectedFrom (openfluid::core::Unit *aUnit, const openfluid::core::UnitClass_t &ClassNameFrom, const openfluid::core::UnitID_t &IDFrom)
bool	OPENFLUID_IsUnitChildOf (openfluid::core::Unit *aUnit, const openfluid::core::UnitClass_t &ClassNameParent, const openfluid::core::UnitID_t &IDParent)
bool	OPENFLUID_IsUnitParentOf (openfluid::core::Unit *aUnit, const openfluid::core::UnitClass_t &ClassNameChild, const openfluid::core::UnitID_t &IDChild)
void	OPENFLUID_BuildUnitsMatrix (const openfluid::core::UnitClass_t &UnitsClass, const unsigned int &ColsNbr, const unsigned int &RowsNbr)
void	OPENFLUID_ExportUnitsGraphAsDotFile (const std::string &Filename)
void	OPENFLUID_RaiseWarning (std::string Sender, openfluid::core::TimeStep_t TimeStep, std::string Msg)
void	OPENFLUID_RaiseWarning (std::string Sender, std::string Msg)
void	OPENFLUID_RaiseWarning (std::string Sender, std::string Source, openfluid::core::TimeStep_t TimeStep, std::string Msg)
void	OPENFLUID_RaiseWarning (std::string Sender, std::string Source, std::string Msg)
void	OPENFLUID_RaiseError (std::string Sender, openfluid::core::TimeStep_t TimeStep, std::string Msg)
void	OPENFLUID_RaiseError (std::string Sender, std::string Msg)
void	OPENFLUID_RaiseError (std::string Sender, std::string Source, openfluid::core::TimeStep_t TimeStep, std::string Msg)
void	OPENFLUID_RaiseError (std::string Sender, std::string Source, std::string Msg)
bool	OPENFLUID_GetRunEnvironment (std::string Key, std::string *Val)
bool	OPENFLUID_GetRunEnvironment (std::string Key, bool *Val)
unsigned int	OPENFLUID_GetFunctionMaxThreads () const
void	OPENFLUID_SetFunctionMaxThreads (const unsigned int &MaxNumThreads)
Protected Attributes
openfluid::core::CoreRepository *	mp_CoreData
StdoutAndFileOutputStream	OPENFLUID_Logger

---

Detailed Description

Abstract class for plugin interface.

Abstract class for plugin interface, defining the minimal structure for a simulation function.
All simulation functions must inherit from this class.

Author:

Jean-Christophe FABRE <fabrejc@supagro.inra.fr>

---

Constructor & Destructor Documentation

openfluid::base::PluggableFunction::PluggableFunction

(

)

Constructor

virtual openfluid::base::PluggableFunction::~PluggableFunction

(

)

[virtual]

Virtual destructor

---

Member Function Documentation

virtual bool openfluid::base::PluggableFunction::checkConsistency

(

)

[pure virtual]

Checks the function consistency. Internally called by the framework.

Implemented in openfluid::machine::InjectGenerator, openfluid::machine::InterpGenerator, openfluid::machine::RandomGenerator, and openfluid::machine::FixedGenerator.

void openfluid::base::PluggableFunction::finalizeFunction

(

)

Internally called by the framework.

virtual bool openfluid::base::PluggableFunction::finalizeRun

(

const SimulationInfo *

SimInfo

)

[pure virtual]

Internally called by the framework.

Implemented in openfluid::machine::InjectGenerator, openfluid::machine::InterpGenerator, openfluid::machine::RandomGenerator, and openfluid::machine::FixedGenerator.

void openfluid::base::PluggableFunction::initializeFunction	(	openfluid::core::CoreRepository *	CoreData,
		openfluid::base::ExecutionMessages *	ExecMsgs,
		openfluid::base::EnvironmentProperties *	FuncEnv,
		const unsigned int &	MaxThreads,
		const openfluid::base::FuncID_t &	FuncID
	)

Internally called by the framework.

virtual bool openfluid::base::PluggableFunction::initializeRun

(

const SimulationInfo *

SimInfo

)

[pure virtual]

Internally called by the framework.

Implemented in openfluid::machine::InjectGenerator, openfluid::machine::InterpGenerator, openfluid::machine::RandomGenerator, and openfluid::machine::FixedGenerator.

virtual bool openfluid::base::PluggableFunction::initParams

(

openfluid::core::FuncParamsMap_t

Params

)

[pure virtual]

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

Implemented in openfluid::machine::InjectGenerator, openfluid::machine::InterpGenerator, openfluid::machine::RandomGenerator, and openfluid::machine::FixedGenerator.

bool openfluid::base::PluggableFunction::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::base::PluggableFunction::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::base::PluggableFunction::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::base::PluggableFunction::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::base::PluggableFunction::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::base::PluggableFunction::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::base::PluggableFunction::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::base::PluggableFunction::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::base::PluggableFunction::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::base::PluggableFunction::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::base::PluggableFunction::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::base::PluggableFunction::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::base::PluggableFunction::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::base::PluggableFunction::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::base::PluggableFunction::OPENFLUID_ExportUnitsGraphAsDotFile

(

const std::string &

Filename

)

[protected]

Exports the graph of the landscape representation as a graphviz dot file. The file is saved in the output directory of the simulation.

Parameters:

[in]

Filename

the name of the export file

void openfluid::base::PluggableFunction::OPENFLUID_GetEvents	(	const openfluid::core::Unit *	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

Deprecated:

void openfluid::base::PluggableFunction::OPENFLUID_GetEvents	(	const openfluid::core::Unit *	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

unsigned int openfluid::base::PluggableFunction::OPENFLUID_GetFunctionMaxThreads

(

)

const [inline, protected]

Returns the maximum number of threads that can be concurrently run in threaded spatial loops

Returns:

the number of threads

bool openfluid::base::PluggableFunction::OPENFLUID_GetFunctionParameter	(	const openfluid::core::FuncParamsMap_t	Params,
		const openfluid::core::FuncParamKey_t	ParamName,
		openfluid::core::StringValue &	Val
	)		const [protected]

Gets a function parameter from the parameters set, as a StringValue

Parameters:

[in]	Params	the parameters set for the simulation function
[in]	ParamName	the name of the requested parameter
[out]	Val	the value of the requested parameter

bool openfluid::base::PluggableFunction::OPENFLUID_GetFunctionParameter	(	const openfluid::core::FuncParamsMap_t	Params,
		const openfluid::core::FuncParamKey_t	ParamName,
		openfluid::core::DoubleValue &	Val
	)		const [protected]

Gets a function parameter from the parameters set, as a DoubleValue

Parameters:

[in]	Params	the parameters set for the simulation function
[in]	ParamName	the name of the requested parameter
[out]	Val	the value of the requested parameter

bool openfluid::base::PluggableFunction::OPENFLUID_GetFunctionParameter	(	const openfluid::core::FuncParamsMap_t	Params,
		const openfluid::core::FuncParamKey_t	ParamName,
		openfluid::core::VectorValue &	Val
	)		const [protected]

Gets a function parameter from the parameters set, as a VectorValue

Parameters:

[in]	Params	the parameters set for the simulation function
[in]	ParamName	the name of the requested parameter
[out]	Val	the value of the requested parameter

bool openfluid::base::PluggableFunction::OPENFLUID_GetFunctionParameter	(	const openfluid::core::FuncParamsMap_t	Params,
		const openfluid::core::FuncParamKey_t	ParamName,
		openfluid::core::MatrixValue &	Val
	)		const [protected]

Gets a function parameter from the parameters set, as a MatrixValue

Parameters:

[in]	Params	the parameters set for the simulation function
[in]	ParamName	the name of the requested parameter
[out]	Val	the value of the requested parameter

bool openfluid::base::PluggableFunction::OPENFLUID_GetFunctionParameter	(	const openfluid::core::FuncParamsMap_t	Params,
		const openfluid::core::FuncParamKey_t	ParamName,
		double *	Val
	)		const [protected]

Gets a function parameter from the parameters set, as a double

Parameters:

[in]	Params	the parameters set for the simulation function
[in]	ParamName	the name of the requested parameter
[out]	Val	the value of the requested parameter

Deprecated:

bool openfluid::base::PluggableFunction::OPENFLUID_GetFunctionParameter	(	const openfluid::core::FuncParamsMap_t	Params,
		const openfluid::core::FuncParamKey_t	ParamName,
		double &	Val
	)		const [protected]

Gets a function parameter from the parameters set, as a double

Parameters:

[in]	Params	the parameters set for the simulation function
[in]	ParamName	the name of the requested parameter
[out]	Val	the value of the requested parameter

bool openfluid::base::PluggableFunction::OPENFLUID_GetFunctionParameter	(	const openfluid::core::FuncParamsMap_t	Params,
		const openfluid::core::FuncParamKey_t	ParamName,
		long *	Val
	)		const [protected]

Gets a function parameter value from the parameters set, as a long int

Parameters:

[in]	Params	the parameters set for the simulation function
[in]	ParamName	the name of the requested parameter
[out]	Val	the value of the requested parameter

Deprecated:

bool openfluid::base::PluggableFunction::OPENFLUID_GetFunctionParameter	(	const openfluid::core::FuncParamsMap_t	Params,
		const openfluid::core::FuncParamKey_t	ParamName,
		long &	Val
	)		const [protected]

Gets a function parameter value from the parameters set, as a long int

Parameters:

[in]	Params	the parameters set for the simulation function
[in]	ParamName	the name of the requested parameter
[out]	Val	the value of the requested parameter

bool openfluid::base::PluggableFunction::OPENFLUID_GetFunctionParameter	(	const openfluid::core::FuncParamsMap_t	Params,
		const openfluid::core::FuncParamKey_t	ParamName,
		float *	Val
	)		const [protected]

Gets a function parameter from the parameters set, as a float

Parameters:

[in]	Params	the parameters set for the simulation function
[in]	ParamName	the name of the requested parameter
[out]	Val	the value of the requested parameter

Deprecated:

bool openfluid::base::PluggableFunction::OPENFLUID_GetFunctionParameter	(	const openfluid::core::FuncParamsMap_t	Params,
		const openfluid::core::FuncParamKey_t	ParamName,
		float &	Val
	)		const [protected]

Gets a function parameter from the parameters set, as a float

Parameters:

[in]	Params	the parameters set for the simulation function
[in]	ParamName	the name of the requested parameter
[out]	Val	the value of the requested parameter

bool openfluid::base::PluggableFunction::OPENFLUID_GetFunctionParameter	(	const openfluid::core::FuncParamsMap_t	Params,
		const openfluid::core::FuncParamKey_t	ParamName,
		int *	Val
	)		const [protected]

Gets a function parameter value from the parameters set, as an int

Parameters:

[in]	Params	the parameters set for the simulation function
[in]	ParamName	the name of the requested parameter
[out]	Val	the value of the requested parameter

Deprecated:

bool openfluid::base::PluggableFunction::OPENFLUID_GetFunctionParameter	(	const openfluid::core::FuncParamsMap_t	Params,
		const openfluid::core::FuncParamKey_t	ParamName,
		int &	Val
	)		const [protected]

Gets a function parameter value from the parameters set, as an int

Parameters:

[in]	Params	the parameters set for the simulation function
[in]	ParamName	the name of the requested parameter
[out]	Val	the value of the requested parameter

bool openfluid::base::PluggableFunction::OPENFLUID_GetFunctionParameter	(	const openfluid::core::FuncParamsMap_t	Params,
		const openfluid::core::FuncParamKey_t	ParamName,
		std::string *	Val
	)		const [protected]

Gets a function parameter value from the parameters set, as a string

Parameters:

[in]	Params	the parameters set for the simulation function
[in]	ParamName	the name of the requested parameter
[out]	Val	the value of the requested parameter

Deprecated:

bool openfluid::base::PluggableFunction::OPENFLUID_GetFunctionParameter	(	const openfluid::core::FuncParamsMap_t	Params,
		const openfluid::core::FuncParamKey_t	ParamName,
		std::string &	Val
	)		const [protected]

Gets a function parameter value from the parameters set, as a string

Parameters:

[in]	Params	the parameters set for the simulation function
[in]	ParamName	the name of the requested parameter
[out]	Val	the value of the requested parameter

bool openfluid::base::PluggableFunction::OPENFLUID_GetFunctionParameter	(	const openfluid::core::FuncParamsMap_t	Params,
		const openfluid::core::FuncParamKey_t	ParamName,
		std::vector< std::string > *	Vals
	)		const [protected]

Gets a function parameter vector of values from the parameters set, as a vector of strings

Parameters:

[in]	Params	the parameters set for the simulation function
[in]	ParamName	the name of the requested parameter
[out]	Vals	the vector of values of the requested parameter

Deprecated:

bool openfluid::base::PluggableFunction::OPENFLUID_GetFunctionParameter	(	const openfluid::core::FuncParamsMap_t	Params,
		const openfluid::core::FuncParamKey_t	ParamName,
		std::vector< std::string > &	Vals
	)		const [protected]

Gets a function parameter vector of values from the parameters set, as a vector of strings

Parameters:

[in]	Params	the parameters set for the simulation function
[in]	ParamName	the name of the requested parameter
[out]	Vals	the vector of values of the requested parameter

bool openfluid::base::PluggableFunction::OPENFLUID_GetFunctionParameter	(	const openfluid::core::FuncParamsMap_t	Params,
		const openfluid::core::FuncParamKey_t	ParamName,
		std::vector< double > *	Vals
	)		const [protected]

Gets a function parameter vector of values from the parameters set, as a vector of doubles

Parameters:

[in]	Params	the parameters set for the simulation function
[in]	ParamName	the name of the requested parameter
[out]	Vals	the vector of values of the requested parameter

Deprecated:

bool openfluid::base::PluggableFunction::OPENFLUID_GetFunctionParameter	(	const openfluid::core::FuncParamsMap_t	Params,
		const openfluid::core::FuncParamKey_t	ParamName,
		std::vector< double > &	Vals
	)		const [protected]

Gets a function parameter vector of values from the parameters set, as a vector of doubles

Parameters:

[in]	Params	the parameters set for the simulation function
[in]	ParamName	the name of the requested parameter
[out]	Vals	the vector of values of the requested parameter

bool openfluid::base::PluggableFunction::OPENFLUID_GetFunctionParameter	(	const openfluid::core::FuncParamsMap_t	Params,
		const openfluid::core::FuncParamKey_t	ParamName,
		std::vector< long > *	Vals
	)		const [protected]

Gets a function parameter vector of values from the parameters set, as a vector of long ints

Parameters:

[in]	Params	the parameters set for the simulation function
[in]	ParamName	the name of the requested parameter
[out]	Vals	the vector of values of the requested parameter

Deprecated:

bool openfluid::base::PluggableFunction::OPENFLUID_GetFunctionParameter	(	const openfluid::core::FuncParamsMap_t	Params,
		const openfluid::core::FuncParamKey_t	ParamName,
		std::vector< long > &	Vals
	)		const [protected]

Gets a function parameter vector of values from the parameters set, as a vector of long ints

Parameters:

[in]	Params	the parameters set for the simulation function
[in]	ParamName	the name of the requested parameter
[out]	Vals	the vector of values of the requested parameter

void openfluid::base::PluggableFunction::OPENFLUID_GetInputData	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::InputDataName_t	InputName,
		openfluid::core::StringValue &	Val
	)		const [protected]

Gets input data for a unit, as a StringValue

Parameters:

[in]	UnitPtr	a Unit
[in]	InputName	the name of the requested property
[out]	Val	the value of the requested property

void openfluid::base::PluggableFunction::OPENFLUID_GetInputData	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::InputDataName_t	InputName,
		openfluid::core::DoubleValue *	Val
	)		const [protected]

Gets input data for a unit, as a DoubleValue

Parameters:

[in]	UnitPtr	a Unit
[in]	InputName	the name of the requested property
[out]	Val	the value of the requested property

Deprecated:

void openfluid::base::PluggableFunction::OPENFLUID_GetInputData	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::InputDataName_t	InputName,
		openfluid::core::DoubleValue &	Val
	)		const [protected]

Gets input data for a unit, as a DoubleValue

Parameters:

[in]	UnitPtr	a Unit
[in]	InputName	the name of the requested property
[out]	Val	the value of the requested property

void openfluid::base::PluggableFunction::OPENFLUID_GetInputData	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::InputDataName_t	InputName,
		openfluid::core::VectorValue *	Val
	)		const [protected]

Gets input data for a unit, as a VectorValue

Parameters:

[in]	UnitPtr	a Unit
[in]	InputName	the name of the requested property
[out]	Val	the value of the requested property

Deprecated:

void openfluid::base::PluggableFunction::OPENFLUID_GetInputData	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::InputDataName_t	InputName,
		openfluid::core::VectorValue &	Val
	)		const [protected]

Gets input data for a unit, as a VectorValue

Parameters:

[in]	UnitPtr	a Unit
[in]	InputName	the name of the requested property
[out]	Val	the value of the requested property

void openfluid::base::PluggableFunction::OPENFLUID_GetInputData	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::InputDataName_t	InputName,
		openfluid::core::MatrixValue &	Val
	)		const [protected]

Gets input data for a unit, as a MatrixValue

Parameters:

[in]	UnitPtr	a Unit
[in]	InputName	the name of the requested property
[out]	Val	the value of the requested property

void openfluid::base::PluggableFunction::OPENFLUID_GetInputData	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::InputDataName_t	InputName,
		double *	Val
	)		const [protected]

Gets input data for a unit, as a double

Parameters:

[in]	UnitPtr	a Unit
[in]	InputName	the name of the requested property
[out]	Val	the value of the requested property

Deprecated:

void openfluid::base::PluggableFunction::OPENFLUID_GetInputData	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::InputDataName_t	InputName,
		double &	Val
	)		const [protected]

Gets input data for a unit, as a double

Parameters:

[in]	UnitPtr	a Unit
[in]	InputName	the name of the requested property
[out]	Val	the value of the requested property

void openfluid::base::PluggableFunction::OPENFLUID_GetInputData	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::InputDataName_t	InputName,
		long *	Val
	)		const [protected]

Gets input data for a unit, as a long integer

Parameters:

[in]	UnitPtr	a Unit
[in]	InputName	the name of the requested property
[out]	Val	the value of the requested property

Deprecated:

void openfluid::base::PluggableFunction::OPENFLUID_GetInputData	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::InputDataName_t	InputName,
		long &	Val
	)		const [protected]

Gets input data for a unit, as a long integer

Parameters:

[in]	UnitPtr	a Unit
[in]	InputName	the name of the requested property
[out]	Val	the value of the requested property

void openfluid::base::PluggableFunction::OPENFLUID_GetInputData	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::InputDataName_t	InputName,
		std::string *	Val
	)		const [protected]

Gets input data for a unit, as a string

Parameters:

[in]	UnitPtr	a Unit
[in]	InputName	the name of the requested property
[out]	Val	the value of the requested property

Deprecated:

void openfluid::base::PluggableFunction::OPENFLUID_GetInputData	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::InputDataName_t	InputName,
		std::string &	Val
	)		const [protected]

Gets input data for a unit, as a string

Parameters:

[in]	UnitPtr	a Unit
[in]	InputName	the name of the requested property
[out]	Val	the value of the requested property

bool openfluid::base::PluggableFunction::OPENFLUID_GetRunEnvironment	(	std::string	Key,
		std::string *	Val
	)		[protected]

Gets an environment string value associated to a Key

Parameters:

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

bool openfluid::base::PluggableFunction::OPENFLUID_GetRunEnvironment	(	std::string	Key,
		bool *	Val
	)		[protected]

Gets an environment boolean value associated to a Key

Parameters:

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

bool openfluid::base::PluggableFunction::OPENFLUID_GetUnit	(	const openfluid::core::UnitClass_t &	ClassName,
		const openfluid::core::UnitID_t &	ID,
		openfluid::core::Unit *	aUnit
	)		[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, NULL if the unit does not exist

Returns:

false if the unit does not exist

openfluid::core::Unit* openfluid::base::PluggableFunction::OPENFLUID_GetUnit	(	const openfluid::core::UnitClass_t &	ClassName,
		const openfluid::core::UnitID_t &	ID
	)		[protected]

void openfluid::base::PluggableFunction::OPENFLUID_GetUnitsCount

(

unsigned int &

UnitsCount

)

[protected]

Returns the total number of units

Parameters:

[out]

UnitsCount

the queried class name

bool openfluid::base::PluggableFunction::OPENFLUID_GetUnitsCount	(	const openfluid::core::UnitClass_t	ClassName,
		unsigned int &	UnitsCount
	)		[protected]

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

Parameters:

[in]	ClassName	the queried class name
[out]	UnitsCount	the queried class name

Returns:

false if the unit class does not exist

void openfluid::base::PluggableFunction::OPENFLUID_GetVariable	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::VariableName_t	VarName,
		const openfluid::core::TimeStep_t	Step,
		openfluid::core::Value *	Val
	)		const [protected]

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

Parameters:

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

Deprecated:

void openfluid::base::PluggableFunction::OPENFLUID_GetVariable	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::VariableName_t	VarName,
		const openfluid::core::TimeStep_t	Step,
		openfluid::core::Value &	Val
	)		const [protected]

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

Parameters:

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

void openfluid::base::PluggableFunction::OPENFLUID_GetVariable	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::VariableName_t	VarName,
		const openfluid::core::TimeStep_t	Step,
		double *	Val
	)		const [protected]

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

Parameters:

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

Deprecated:

void openfluid::base::PluggableFunction::OPENFLUID_GetVariable	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::VariableName_t	VarName,
		const openfluid::core::TimeStep_t	Step,
		double &	Val
	)		const [protected]

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

Parameters:

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

void openfluid::base::PluggableFunction::OPENFLUID_GetVariable	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::VariableName_t	VarName,
		const openfluid::core::TimeStep_t	Step,
		long *	Val
	)		const [protected]

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

Parameters:

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

Deprecated:

void openfluid::base::PluggableFunction::OPENFLUID_GetVariable	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::VariableName_t	VarName,
		const openfluid::core::TimeStep_t	Step,
		long &	Val
	)		const [protected]

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

Parameters:

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

void openfluid::base::PluggableFunction::OPENFLUID_GetVariable	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::VariableName_t	VarName,
		const openfluid::core::TimeStep_t	Step,
		bool *	Val
	)		const [protected]

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

Parameters:

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

Deprecated:

void openfluid::base::PluggableFunction::OPENFLUID_GetVariable	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::VariableName_t	VarName,
		const openfluid::core::TimeStep_t	Step,
		bool &	Val
	)		const [protected]

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

Parameters:

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

void openfluid::base::PluggableFunction::OPENFLUID_GetVariable	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::VariableName_t	VarName,
		const openfluid::core::TimeStep_t	Step,
		std::string *	Val
	)		const [protected]

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

Parameters:

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

Deprecated:

void openfluid::base::PluggableFunction::OPENFLUID_GetVariable	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::VariableName_t	VarName,
		const openfluid::core::TimeStep_t	Step,
		std::string &	Val
	)		const [protected]

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

Parameters:

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

bool openfluid::base::PluggableFunction::OPENFLUID_IsInputDataExist	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::InputDataName_t	InputName
	)		const [protected]

Returns true if a distributed input data exists, false otherwise

Parameters:

[in]	UnitPtr	a Unit
[in]	InputName	the name of the queried variable

bool openfluid::base::PluggableFunction::OPENFLUID_IsTypedVariableExist	(	const openfluid::core::Unit *	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

bool openfluid::base::PluggableFunction::OPENFLUID_IsTypedVariableExist	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::VariableName_t	VarName,
		const openfluid::core::TimeStep_t	Step,
		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 step 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]	Step	the time step for the value of the variable
[in]	VarType	the type of the variable

bool openfluid::base::PluggableFunction::OPENFLUID_IsUnitChildOf	(	openfluid::core::Unit *	aUnit,
		const openfluid::core::UnitClass_t &	ClassNameParent,
		const openfluid::core::UnitID_t &	IDParent
	)		[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

bool openfluid::base::PluggableFunction::OPENFLUID_IsUnitClassExist

(

openfluid::core::UnitClass_t

ClassName

)

[protected]

Returns true if the queried unit class exists

Parameters:

[in]

ClassName

the queried class name

bool openfluid::base::PluggableFunction::OPENFLUID_IsUnitConnectedFrom	(	openfluid::core::Unit *	aUnit,
		const openfluid::core::UnitClass_t &	ClassNameFrom,
		const openfluid::core::UnitID_t &	IDFrom
	)		[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

bool openfluid::base::PluggableFunction::OPENFLUID_IsUnitConnectedTo	(	openfluid::core::Unit *	aUnit,
		const openfluid::core::UnitClass_t &	ClassNameTo,
		const openfluid::core::UnitID_t &	IDTo
	)		[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

bool openfluid::base::PluggableFunction::OPENFLUID_IsUnitExist	(	openfluid::core::UnitClass_t	ClassName,
		openfluid::core::UnitID_t	ID
	)		[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

bool openfluid::base::PluggableFunction::OPENFLUID_IsUnitParentOf	(	openfluid::core::Unit *	aUnit,
		const openfluid::core::UnitClass_t &	ClassNameChild,
		const openfluid::core::UnitID_t &	IDChild
	)		[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

bool openfluid::base::PluggableFunction::OPENFLUID_IsVariableExist	(	const openfluid::core::Unit *	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

bool openfluid::base::PluggableFunction::OPENFLUID_IsVariableExist	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::VariableName_t	VarName,
		const openfluid::core::TimeStep_t	Step
	)		const [protected]

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

Parameters:

[in]	UnitPtr	a Unit
[in]	VarName	the name of the requested variable
[in]	Step	the time step for the value of the variable

bool openfluid::base::PluggableFunction::OPENFLUID_IsVariableExist	(	const openfluid::core::Unit *	UnitPtr,
		const openfluid::core::VariableName_t	VarName,
		const openfluid::core::TimeStep_t	Step,
		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 step 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]	Step	the time step for the value of the variable
[in]	ValueType	the type of the value

void openfluid::base::PluggableFunction::OPENFLUID_RaiseError	(	std::string	Sender,
		openfluid::core::TimeStep_t	TimeStep,
		std::string	Msg
	)		[protected]

Raises a time-marked error message to the kernel. This stops the simulation the next time the kernel has the control

Parameters:

[in]	Sender	the sender of the message
[in]	TimeStep	the time step number when the message occurred
[in]	Msg	the content of the message

void openfluid::base::PluggableFunction::OPENFLUID_RaiseError	(	std::string	Sender,
		std::string	Msg
	)		[protected]

Raises an error message to the kernel. This stops the simulation the next time the kernel has the control

Parameters:

[in]	Sender	the sender of the message
[in]	Msg	the content of the message

void openfluid::base::PluggableFunction::OPENFLUID_RaiseError	(	std::string	Sender,
		std::string	Source,
		openfluid::core::TimeStep_t	TimeStep,
		std::string	Msg
	)		[protected]

Raises a time-marked error message to the kernel. This stops the simulation the next time the kernel has the control

Parameters:

[in]	Sender	the sender of the message
[in]	Source	of the message (location in the sender)
[in]	TimeStep	the time step number when the message occurred
[in]	Msg	the content of the message

void openfluid::base::PluggableFunction::OPENFLUID_RaiseError	(	std::string	Sender,
		std::string	Source,
		std::string	Msg
	)		[protected]

Raises an error message to the kernel. This stops the simulation the next time the kernel has the control

Parameters:

[in]	Sender	the sender of the message
[in]	Source	of the message (location in the sender)
[in]	Msg	the content of the message

void openfluid::base::PluggableFunction::OPENFLUID_RaiseWarning	(	std::string	Sender,
		openfluid::core::TimeStep_t	TimeStep,
		std::string	Msg
	)		[protected]

Raises a time-marked warning message to the kernel. This do not stops the simulation

Parameters:

[in]	Sender	the sender of the message
[in]	TimeStep	the time step number when the message occurred
[in]	Msg	the content of the message

void openfluid::base::PluggableFunction::OPENFLUID_RaiseWarning	(	std::string	Sender,
		std::string	Msg
	)		[protected]

Raises a warning message to the kernel. This do not stops the simulation

Parameters:

[in]	Sender	the sender of the message
[in]	Msg	the content of the message

void openfluid::base::PluggableFunction::OPENFLUID_RaiseWarning	(	std::string	Sender,
		std::string	Source,
		openfluid::core::TimeStep_t	TimeStep,
		std::string	Msg
	)		[protected]

Raises a time-marked warning message to the kernel. This do not stops the simulation

Parameters:

[in]	Sender	the sender of the message
[in]	Source	the source of the message
[in]	TimeStep	the time step number when the message occurred
[in]	Msg	the content of the message

void openfluid::base::PluggableFunction::OPENFLUID_RaiseWarning	(	std::string	Sender,
		std::string	Source,
		std::string	Msg
	)		[protected]

Raises a warning message to the kernel. This do not stops the simulation

Parameters:

[in]	Sender	the sender of the message
[in]	Source	the source of the message
[in]	Msg	the content of the message

bool openfluid::base::PluggableFunction::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::base::PluggableFunction::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::base::PluggableFunction::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::base::PluggableFunction::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::base::PluggableFunction::OPENFLUID_SetFunctionMaxThreads

(

const unsigned int &

MaxNumThreads

)

[protected]

Sets the maximum number of threads that can be concurrently run in threaded spatial loops

Parameters:

[in]

MaxNumThreads

the number of threads

void openfluid::base::PluggableFunction::OPENFLUID_SetInputData	(	openfluid::core::Unit *	UnitPtr,
		const openfluid::core::InputDataName_t &	InputName,
		const openfluid::core::Value &	Val
	)		[protected]

Sets input data for a unit

Parameters:

[in]	UnitPtr	a Unit
[in]	InputName	the name of the set property
[in]	Val	the value of the set property

void openfluid::base::PluggableFunction::OPENFLUID_SetInputData	(	openfluid::core::Unit *	UnitPtr,
		const openfluid::core::InputDataName_t &	InputName,
		const double &	Val
	)		[protected]

Sets input data for a unit, as a double

Parameters:

[in]	UnitPtr	a Unit
[in]	InputName	the name of the set property
[in]	Val	the value of the set property

void openfluid::base::PluggableFunction::OPENFLUID_SetInputData	(	openfluid::core::Unit *	UnitPtr,
		const openfluid::core::InputDataName_t &	InputName,
		const long &	Val
	)		[protected]

Sets input data for a unit, as a long integer

Parameters:

[in]	UnitPtr	a Unit
[in]	InputName	the name of the set property
[in]	Val	the value of the set property

void openfluid::base::PluggableFunction::OPENFLUID_SetInputData	(	openfluid::core::Unit *	UnitPtr,
		const openfluid::core::InputDataName_t &	InputName,
		const std::string &	Val
	)		[protected]

Sets input data for a unit, as a string

Parameters:

[in]	UnitPtr	a Unit
[in]	InputName	the name of the set property
[out]	Val	the value of the set property

void openfluid::base::PluggableFunction::OPENFLUID_SetVariable	(	openfluid::core::Unit *	UnitPtr,
		const openfluid::core::VariableName_t	VarName,
		const openfluid::core::TimeStep_t	Step,
		const openfluid::core::Value &	Val
	)		[protected]

Sets a distributed variable value for a unit at a time step

Parameters:

[in]	UnitPtr	a Unit
[in]	VarName	the name of the variable
[in]	Step	the time step for the value of the variable
[in]	Val	the added value of the variable

void openfluid::base::PluggableFunction::OPENFLUID_SetVariable	(	openfluid::core::Unit *	UnitPtr,
		const openfluid::core::VariableName_t	VarName,
		const openfluid::core::TimeStep_t	Step,
		const double	Val
	)		[protected]

Sets a distributed double variable value for a unit at a time step

Parameters:

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

void openfluid::base::PluggableFunction::OPENFLUID_SetVariable	(	openfluid::core::Unit *	UnitPtr,
		const openfluid::core::VariableName_t	VarName,
		const openfluid::core::TimeStep_t	Step,
		const long	Val
	)		[protected]

Sets a distributed double variable value for a unit at a time step

Parameters:

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

void openfluid::base::PluggableFunction::OPENFLUID_SetVariable	(	openfluid::core::Unit *	UnitPtr,
		const openfluid::core::VariableName_t	VarName,
		const openfluid::core::TimeStep_t	Step,
		const bool	Val
	)		[protected]

Sets a distributed double variable value for a unit at a time step

Parameters:

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

void openfluid::base::PluggableFunction::OPENFLUID_SetVariable	(	openfluid::core::Unit *	UnitPtr,
		const openfluid::core::VariableName_t	VarName,
		const openfluid::core::TimeStep_t	Step,
		const std::string	Val
	)		[protected]

Sets a distributed double variable value for a unit at a time step

Parameters:

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

virtual bool openfluid::base::PluggableFunction::prepareData

(

)

[pure virtual]

Prepares data. Internally called by the framework.

Implemented in openfluid::machine::Generator.

virtual bool openfluid::base::PluggableFunction::runStep

(

const SimulationStatus *

SimStatus

)

[pure virtual]

Internally called by the framework.

Implemented in openfluid::machine::InjectGenerator, openfluid::machine::InterpGenerator, openfluid::machine::RandomGenerator, and openfluid::machine::FixedGenerator.

---

Member Data Documentation

openfluid::core::CoreRepository* openfluid::base::PluggableFunction::mp_CoreData [protected]

Pointer to the core repository (const). It should be used with care. Prefer to use the OPENFLUID_Xxxx methods.

StdoutAndFileOutputStream openfluid::base::PluggableFunction::OPENFLUID_Logger [protected]