SimulatorSignatureMacros.hpp File Reference

#include <openfluid/ware/WareSignatureMacros.hpp>

Go to the source code of this file.

Macros
#define	BEGIN_SIMULATOR_SIGNATURE(id)
#define	END_SIMULATOR_SIGNATURE
#define	DECLARE_DOMAIN(domain)
#define	DECLARE_PROCESS(process)
#define	DECLARE_METHOD(method)
#define	DECLARE_USED_PARAMETER(name, description, unit)
#define	DECLARE_SIMULATOR_PARAM(name, description, unit)
#define	DECLARE_REQUIRED_PARAMETER(name, description, unit)
#define	DECLARE_PRODUCED_VARIABLE(name, uclass, description, unit)
#define	DECLARE_PRODUCED_VAR(name, uclass, description, unit)
#define	DECLARE_UPDATED_VARIABLE(name, uclass, description, unit)
#define	DECLARE_UPDATED_VAR(name, uclass, description, unit)
#define	DECLARE_REQUIRED_VARIABLE(name, uclass, description, unit)
#define	DECLARE_REQUIRED_VAR(name, uclass, description, unit)
#define	DECLARE_USED_VARIABLE(name, uclass, description, unit)
#define	DECLARE_USED_VAR(name, uclass, description, unit)
#define	DECLARE_PRODUCED_ATTRIBUTE(name, uclass, description, unit)
#define	DECLARE_REQUIRED_ATTRIBUTE(name, uclass, description, unit)
#define	DECLARE_USED_ATTRIBUTE(name, uclass, description, unit)
#define	DECLARE_USED_EVENTS(uclass)
#define	DECLARE_UPDATED_UNITSGRAPH(description)
#define	DECLARE_UPDATED_UNITSCLASS(uclass, description)
#define	DECLARE_REQUIRED_EXTRAFILE(name)
#define	DECLARE_USED_EXTRAFILE(name)
#define	DECLARE_SCHEDULING_UNDEFINED
#define	DECLARE_SCHEDULING_DEFAULT
#define	DECLARE_SCHEDULING_FIXED(deltat)
#define	DECLARE_SCHEDULING_RANGE(min, max)

Detailed Description

Author

Jean-Christophe FABRE jean-.nosp@m.chri.nosp@m.stoph.nosp@m.e.fa.nosp@m.bre@s.nosp@m.upag.nosp@m.ro.in.nosp@m.ra.f.nosp@m.r

Macro Definition Documentation

#define BEGIN_SIMULATOR_SIGNATURE

(

id

)

Macro for the beginning of definition of signature hook

#define DECLARE_DOMAIN

(

domain

)

Macro for declaration of the simulator application domain

#define DECLARE_METHOD

(

method

)

Macro for declaration of the simulator application numerical method

#define DECLARE_PROCESS

(

process

)

Macro for declaration of the simulator application processes

#define DECLARE_PRODUCED_ATTRIBUTE	(		name,
			uclass,
			description,
			unit
	)

Macro for declaration of a produced attribute

Parameters

[in]	name	name of the attribute
[in]	uclass	class of the concerned units
[in]	description	description of the attribute
[in]	unit	unit of the attribute. Could be an empty string if there is no unit

#define DECLARE_PRODUCED_VAR	(		name,
			uclass,
			description,
			unit
	)

Deprecated:

Since version 2.1.0. Use DECLARE_PRODUCED_VARIABLE instead

#define DECLARE_PRODUCED_VARIABLE	(		name,
			uclass,
			description,
			unit
	)

Macro for declaration of a produced variable

Parameters

[in]	name	name of the variable
[in]	uclass	class of the concerned units
[in]	description	description of the variable
[in]	unit	unit of the variable. Could be an empty string if there is no unit

#define DECLARE_REQUIRED_ATTRIBUTE	(		name,
			uclass,
			description,
			unit
	)

Macro for declaration of a required attribute

Parameters

[in]	name	name of the attribute
[in]	uclass	class of the concerned units
[in]	description	description of the attribute
[in]	unit	unit of the attribute. Could be an empty string if there is no unit

#define DECLARE_REQUIRED_EXTRAFILE

(

name

)

Macro for declaration of required file

Parameters

[in]

name

name of the file

#define DECLARE_REQUIRED_PARAMETER	(		name,
			description,
			unit
	)

Macro for declaration of a required simulator parameter

Parameters

[in]	name	name of the parameter
[in]	description	description of the parameter
[in]	unit	unit of the parameter. Could be an empty string if there is no unit

#define DECLARE_REQUIRED_VAR	(		name,
			uclass,
			description,
			unit
	)

Deprecated:

Since version 2.1.0. Use DECLARE_REQUIRED_VARIABLE instead

#define DECLARE_REQUIRED_VARIABLE	(		name,
			uclass,
			description,
			unit
	)

Macro for declaration of a required variable

Parameters

[in]	name	name of the variable
[in]	uclass	class of the concerned units
[in]	description	description of the variable
[in]	unit	unit of the variable. Could be an empty string if there is no unit

#define DECLARE_SCHEDULING_DEFAULT

Macro for declaration of time scheduling as default delta T

#define DECLARE_SCHEDULING_FIXED

(

deltat

)

Macro for declaration of fixed time scheduling

Parameters

[in]

deltat

fixed time scheduling value

#define DECLARE_SCHEDULING_RANGE	(		min,
			max
	)

Macro for declaration of range of time scheduling

Parameters

[in]	min	minimal time scheduling value
[in]	max	maximal time scheduling value

#define DECLARE_SCHEDULING_UNDEFINED

Macro for declaration of time scheduling as undefined

#define DECLARE_SIMULATOR_PARAM	(		name,
			description,
			unit
	)

Deprecated:

Since version 2.1.0. Use DECLARE_USED_PARAMETER instead

#define DECLARE_UPDATED_UNITSCLASS	(		uclass,
			description
	)

Macro for declaration of units class creation or update

Parameters

[in]	uclass	name of the created or updated class
[in]	description	description of the updated class

#define DECLARE_UPDATED_UNITSGRAPH

(

description

)

Macro for declaration of units graph modification

Parameters

[in]

description

description of modification

#define DECLARE_UPDATED_VAR	(		name,
			uclass,
			description,
			unit
	)

Deprecated:

Since version 2.1.0. Use DECLARE_UPDATED_VARIABLE instead

#define DECLARE_UPDATED_VARIABLE	(		name,
			uclass,
			description,
			unit
	)

Macro for declaration of an updated variable

Parameters

[in]	name	name of the variable
[in]	uclass	class of the concerned units
[in]	description	description of the variable
[in]	unit	unit of the variable. Could be an empty string if there is no unit

#define DECLARE_USED_ATTRIBUTE	(		name,
			uclass,
			description,
			unit
	)

Macro for declaration of a used attribute

Parameters

[in]	name	name of the attribute
[in]	uclass	class of the concerned units
[in]	description	description of the attribute
[in]	unit	unit of the attribute. Could be an empty string if there is no unit

#define DECLARE_USED_EVENTS

(

uclass

)

Macro for declaration of used events

Parameters

[in]

uclass

class of the concerned units

#define DECLARE_USED_EXTRAFILE

(

name

)

Macro for declaration of used file

Parameters

[in]

name

name of the file

#define DECLARE_USED_PARAMETER	(		name,
			description,
			unit
	)

Macro for declaration of an used simulator parameter

Parameters

[in]	name	name of the parameter
[in]	description	description of the parameter
[in]	unit	unit of the parameter. Could be an empty string if there is no unit

#define DECLARE_USED_VAR	(		name,
			uclass,
			description,
			unit
	)

Deprecated:

Since version 2.1.0. Use DECLARE_USED_VARIABLE instead

#define DECLARE_USED_VARIABLE	(		name,
			uclass,
			description,
			unit
	)

Macro for declaration of an used variable

Parameters

[in]	name	name of the variable
[in]	uclass	class of the concerned units
[in]	description	description of the variable
[in]	unit	unit of the variable. Could be an empty string if there is no unit

#define END_SIMULATOR_SIGNATURE

Macro for the end of definition of signature hook