base/FuncSignature.h File Reference

Header of function signature definition. More...


Namespaces

namespace  openfluid::base

Defines

#define BEGIN_SIGNATURE_HOOK
#define END_SIGNATURE_HOOK
#define DECLARE_SIGNATURE_ID(id)   Signature->ID = id;
#define DECLARE_SIGNATURE_NAME(name)   Signature->Name = name;
#define DECLARE_SIGNATURE_DESCRIPTION(desc)   Signature->Description = desc;
#define DECLARE_SIGNATURE_DOMAIN(domain)   Signature->Domain = domain;
#define DECLARE_SIGNATURE_PROCESS(process)   Signature->Process = process;
#define DECLARE_SIGNATURE_METHOD(method)   Signature->Method = method;
#define DECLARE_SIGNATURE_AUTHORNAME(name)   Signature->Author = name;
#define DECLARE_SIGNATURE_AUTHOREMAIL(email)   Signature->AuthorEmail = email;
#define DECLARE_SIGNATURE_VERSION(version)   Signature->Version = version;
#define DECLARE_SIGNATURE_STATUS(status)   Signature->Status = status;
#define DECLARE_SIGNATURE_SDKVERSION   Signature->setSDKVersion(STRINGIFY(OFELIB_VERSION));
#define DECLARE_FUNCTION_PARAM(name, description, unit)   Signature->HandledData.FunctionParams.push_back(openfluid::base::SignatureHandledDataItem((name),(""),description,unit));
#define DECLARE_PRODUCED_VAR(name, uclass, description, unit)   Signature->HandledData.ProducedVars.push_back(openfluid::base::SignatureHandledDataItem((name),uclass,description,unit));
#define DECLARE_UPDATED_VAR(name, uclass, description, unit)   Signature->HandledData.UpdatedVars.push_back(openfluid::base::SignatureHandledDataItem((name),uclass,description,unit));
#define DECLARE_REQUIRED_VAR(name, uclass, description, unit)   Signature->HandledData.RequiredVars.push_back(openfluid::base::SignatureHandledDataItem((name),uclass,description,unit));
#define DECLARE_REQUIRED_PREVVAR(name, uclass, description, unit)   Signature->HandledData.RequiredPrevVars.push_back(openfluid::base::SignatureHandledDataItem((name),uclass,description,unit));
#define DECLARE_USED_VAR(name, uclass, description, unit)   Signature->HandledData.UsedVars.push_back(openfluid::base::SignatureHandledDataItem((name),uclass,description,unit));
#define DECLARE_USED_PREVVAR(name, uclass, description, unit)   Signature->HandledData.UsedPrevVars.push_back(openfluid::base::SignatureHandledDataItem((name),uclass,description,unit));
#define DECLARE_REQUIRED_INPUTDATA(name, uclass, description, unit)   Signature->HandledData.RequiredInput.push_back(openfluid::base::SignatureHandledDataItem((name),uclass,description,unit));
#define DECLARE_USED_INPUTDATA(name, uclass, description, unit)   Signature->HandledData.UsedInput.push_back(openfluid::base::SignatureHandledDataItem((name),uclass,description,unit));
#define DECLARE_USED_EVENTS(uclass)   Signature->HandledData.UsedEventsOnUnits.push_back(uclass);
#define DECLARE_REQUIRED_EXTRAFILE(name)   Signature->HandledData.RequiredExtraFiles.push_back(name);
#define DECLARE_USED_EXTRAFILE(name)   Signature->HandledData.UsedExtraFiles.push_back(name);
#define DECLARE_SU_PRODUCED_VAR(name, description, unit)   Signature->HandledData.ProducedVars.push_back(openfluid::base::SignatureHandledDataItem(name,"SU",description,unit));
#define DECLARE_SU_UPDATED_VAR(name, description, unit)   Signature->HandledData.UpdatedVars.push_back(openfluid::base::SignatureHandledDataItem((name),("SU"),description,unit));
#define DECLARE_SU_REQUIRED_VAR(name, description, unit)   Signature->HandledData.RequiredVars.push_back(openfluid::base::SignatureHandledDataItem((name),("SU"),description,unit));
#define DECLARE_SU_REQUIRED_PREVVAR(name, description, unit)   Signature->HandledData.RequiredPrevVars.push_back(openfluid::base::SignatureHandledDataItem((name),("SU"),description,unit));
#define DECLARE_SU_USED_VAR(name, description, unit)   Signature->HandledData.UsedVars.push_back(openfluid::base::SignatureHandledDataItem((name),("SU"),description,unit));
#define DECLARE_SU_USED_PREVVAR(name, description, unit)   Signature->HandledData.UsedPrevVars.push_back(openfluid::base::SignatureHandledDataItem((name),("SU"),description,unit));
#define DECLARE_SU_REQUIRED_PROPERTY(name, description, unit)   Signature->HandledData.RequiredInput.push_back(openfluid::base::SignatureHandledDataItem((name),("SU"),description,unit));
#define DECLARE_SU_USED_PROPERTY(name, description, unit)   Signature->HandledData.UsedInput.push_back(openfluid::base::SignatureHandledDataItem((name),("SU"),description,unit));
#define DECLARE_SU_REQUIRED_INICOND(name, description, unit)   Signature->HandledData.RequiredInput.push_back(openfluid::base::SignatureHandledDataItem((name),("SU"),description,unit));
#define DECLARE_SU_USED_INICOND(name, description, unit)   Signature->HandledData.UsedInput.push_back(openfluid::base::SignatureHandledDataItem((name),("SU"),description,unit));
#define DECLARE_RS_PRODUCED_VAR(name, description, unit)   Signature->HandledData.ProducedVars.push_back(openfluid::base::SignatureHandledDataItem((name),("RS"),description,unit));
#define DECLARE_RS_UPDATED_VAR(name, description, unit)   Signature->HandledData.UpdatedVars.push_back(openfluid::base::SignatureHandledDataItem((name),("RS"),description,unit));
#define DECLARE_RS_REQUIRED_VAR(name, description, unit)   Signature->HandledData.RequiredVars.push_back(openfluid::base::SignatureHandledDataItem((name),("RS"),description,unit));
#define DECLARE_RS_USED_VAR(name, description, unit)   Signature->HandledData.UsedVars.push_back(openfluid::base::SignatureHandledDataItem((name),("RS"),description,unit));
#define DECLARE_RS_REQUIRED_PROPERTY(name, description, unit)   Signature->HandledData.RequiredInput.push_back(openfluid::base::SignatureHandledDataItem((name),("RS"),description,unit));
#define DECLARE_RS_REQUIRED_INICOND(name, description, unit)   Signature->HandledData.RequiredInput.push_back(openfluid::base::SignatureHandledDataItem((name),("RS"),description,unit));
#define DECLARE_GU_PRODUCED_VAR(name, description, unit)   Signature->HandledData.ProducedVars.push_back(openfluid::base::SignatureHandledDataItem((name),("GU"),description,unit));
#define DECLARE_GU_UPDATED_VAR(name, description, unit)   Signature->HandledData.UpdatedVars.push_back(openfluid::base::SignatureHandledDataItem((name),("GU"),description,unit));
#define DECLARE_GU_REQUIRED_VAR(name, description, unit)   Signature->HandledData.RequiredVars.push_back(openfluid::base::SignatureHandledDataItem((name),("GU"),description,unit));
#define DECLARE_GU_REQUIRED_PREVVAR(name, description, unit)   Signature->HandledData.RequiredPrevVars.push_back(openfluid::base::SignatureHandledDataItem((name),("GU"),description,unit));
#define DECLARE_GU_USED_VAR(name, description, unit)   Signature->HandledData.UsedVars.push_back(openfluid::base::SignatureHandledDataItem((name),("GU"),description,unit));
#define DECLARE_GU_USED_PREVVAR(name, description, unit)   Signature->HandledData.UsedPrevVars.push_back(openfluid::base::SignatureHandledDataItem((name),("GU"),description,unit));
#define DECLARE_GU_REQUIRED_PROPERTY(name, description, unit)   Signature->HandledData.RequiredInput.push_back(openfluid::base::SignatureHandledDataItem((name),("GU"),description,unit));
#define DECLARE_GU_REQUIRED_INICOND(name, description, unit)   Signature->HandledData.RequiredInput.push_back(openfluid::base::SignatureHandledDataItem((name),("GU"),description,unit));
#define DECLARE_USED_SU_EVENTS   Signature->HandledData.UsedEventsOnUnits.push_back("SU");
#define DECLARE_USED_RS_EVENTS   Signature->HandledData.UsedEventsOnUnits.push_back("RS");
#define DECLARE_USED_GU_EVENTS   Signature->HandledData.UsedEventsOnUnits.push_back("GU");

Enumerations

enum  openfluid::base::FuncStatus_t { openfluid::base::EXPERIMENTAL, openfluid::base::BETA, openfluid::base::STABLE }

Detailed Description

Header of function signature definition.

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

Define Documentation

#define BEGIN_SIGNATURE_HOOK

Value:

openfluid::base::FunctionSignature* GetPlugSignature() \
  { \
    openfluid::base::FunctionSignature* Signature = new openfluid::base::FunctionSignature(); \
    Signature->setSDKVersion(STRINGIFY(OFELIB_VERSION));
Macro for the beginning of definition of signature hook

#define DECLARE_FUNCTION_PARAM ( name,
description,
unit   )     Signature->HandledData.FunctionParams.push_back(openfluid::base::SignatureHandledDataItem((name),(""),description,unit));

Macro for declaration of a function 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_GU_PRODUCED_VAR ( name,
description,
unit   )     Signature->HandledData.ProducedVars.push_back(openfluid::base::SignatureHandledDataItem((name),("GU"),description,unit));

Macro for declaration of a produced variable on all GUs

Parameters:
[in] name name of the variable
[in] description description of the variable
[in] unit unit of the variable. Could be an empty string if there is no unit
Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_GU_REQUIRED_INICOND ( name,
description,
unit   )     Signature->HandledData.RequiredInput.push_back(openfluid::base::SignatureHandledDataItem((name),("GU"),description,unit));

Macro for declaration of a required initial condition on all GUs

Parameters:
[in] name name of the initial condition
[in] description description of the initial condition
[in] unit unit of the initial condition. Could be an empty string if there is no unit
Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_GU_REQUIRED_PREVVAR ( name,
description,
unit   )     Signature->HandledData.RequiredPrevVars.push_back(openfluid::base::SignatureHandledDataItem((name),("GU"),description,unit));

Macro for declaration of a required variable on all GUs, using a value produced on a previous time step

Parameters:
[in] name name of the variable
[in] description description of the variable
[in] unit unit of the variable. Could be an empty string if there is no unit
Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_GU_REQUIRED_PROPERTY ( name,
description,
unit   )     Signature->HandledData.RequiredInput.push_back(openfluid::base::SignatureHandledDataItem((name),("GU"),description,unit));

Macro for declaration of a required property on all GUs

Parameters:
[in] name name of the property
[in] description description of the property
[in] unit unit of the property. Could be an empty string if there is no unit
Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_GU_REQUIRED_VAR ( name,
description,
unit   )     Signature->HandledData.RequiredVars.push_back(openfluid::base::SignatureHandledDataItem((name),("GU"),description,unit));

Macro for declaration of a required variable on all GUs

Parameters:
[in] name name of the variable
[in] description description of the variable
[in] unit unit of the variable. Could be an empty string if there is no unit
Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_GU_UPDATED_VAR ( name,
description,
unit   )     Signature->HandledData.UpdatedVars.push_back(openfluid::base::SignatureHandledDataItem((name),("GU"),description,unit));

Macro for declaration of an updated variable on all GUs

Parameters:
[in] name name of the variable
[in] description description of the variable
[in] unit unit of the variable. Could be an empty string if there is no unit
Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_GU_USED_PREVVAR ( name,
description,
unit   )     Signature->HandledData.UsedPrevVars.push_back(openfluid::base::SignatureHandledDataItem((name),("GU"),description,unit));

Macro for declaration of an used variable on all GUs, using a value produced on a previous time step

Parameters:
[in] name name of the variable
[in] description description of the variable
[in] unit unit of the variable. Could be an empty string if there is no unit
Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_GU_USED_VAR ( name,
description,
unit   )     Signature->HandledData.UsedVars.push_back(openfluid::base::SignatureHandledDataItem((name),("GU"),description,unit));

Macro for declaration of an used variable on all GUs

Parameters:
[in] name name of the variable
[in] description description of the variable
[in] unit unit of the variable. Could be an empty string if there is no unit
Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_PRODUCED_VAR ( name,
uclass,
description,
unit   )     Signature->HandledData.ProducedVars.push_back(openfluid::base::SignatureHandledDataItem((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_EXTRAFILE ( name   )     Signature->HandledData.RequiredExtraFiles.push_back(name);

Macro for declaration of required file

Parameters:
[in] name name of the file

#define DECLARE_REQUIRED_INPUTDATA ( name,
uclass,
description,
unit   )     Signature->HandledData.RequiredInput.push_back(openfluid::base::SignatureHandledDataItem((name),uclass,description,unit));

Macro for declaration of a required input data

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

#define DECLARE_REQUIRED_PREVVAR ( name,
uclass,
description,
unit   )     Signature->HandledData.RequiredPrevVars.push_back(openfluid::base::SignatureHandledDataItem((name),uclass,description,unit));

Macro for declaration of a required variable, using a value produced on a previous time step

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_VAR ( name,
uclass,
description,
unit   )     Signature->HandledData.RequiredVars.push_back(openfluid::base::SignatureHandledDataItem((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_RS_PRODUCED_VAR ( name,
description,
unit   )     Signature->HandledData.ProducedVars.push_back(openfluid::base::SignatureHandledDataItem((name),("RS"),description,unit));

Macro for declaration of a produced variable on all RSs

Parameters:
[in] name name of the variable
[in] description description of the variable
[in] unit unit of the variable. Could be an empty string if there is no unit
Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_RS_REQUIRED_INICOND ( name,
description,
unit   )     Signature->HandledData.RequiredInput.push_back(openfluid::base::SignatureHandledDataItem((name),("RS"),description,unit));

Macro for declaration of a required initial condition on all RSs

Parameters:
[in] name name of the initial condition
[in] description description of the initial condition
[in] unit unit of the initial condition. Could be an empty string if there is no unit
Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_RS_REQUIRED_PROPERTY ( name,
description,
unit   )     Signature->HandledData.RequiredInput.push_back(openfluid::base::SignatureHandledDataItem((name),("RS"),description,unit));

Macro for declaration of a required property on all RSs

Parameters:
[in] name name of the property
[in] description description of the property
[in] unit unit of the property. Could be an empty string if there is no unit
Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_RS_REQUIRED_VAR ( name,
description,
unit   )     Signature->HandledData.RequiredVars.push_back(openfluid::base::SignatureHandledDataItem((name),("RS"),description,unit));

Macro for declaration of a required variable on all RSs

Parameters:
[in] name name of the variable
[in] description description of the variable
[in] unit unit of the variable. Could be an empty string if there is no unit
Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_RS_UPDATED_VAR ( name,
description,
unit   )     Signature->HandledData.UpdatedVars.push_back(openfluid::base::SignatureHandledDataItem((name),("RS"),description,unit));

Macro for declaration of an updated variable on all RSs

Parameters:
[in] name name of the variable
[in] description description of the variable
[in] unit unit of the variable. Could be an empty string if there is no unit
Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_RS_USED_VAR ( name,
description,
unit   )     Signature->HandledData.UsedVars.push_back(openfluid::base::SignatureHandledDataItem((name),("RS"),description,unit));

Macro for declaration of an used variable on all RSs

Parameters:
[in] name name of the variable
[in] description description of the variable
[in] unit unit of the variable. Could be an empty string if there is no unit
Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_SIGNATURE_AUTHOREMAIL ( email   )     Signature->AuthorEmail = email;

Macro for declaration of the function author email

#define DECLARE_SIGNATURE_AUTHORNAME ( name   )     Signature->Author = name;

Macro for declaration of the function author name

#define DECLARE_SIGNATURE_DESCRIPTION ( desc   )     Signature->Description = desc;

Macro for declaration of the function description

#define DECLARE_SIGNATURE_DOMAIN ( domain   )     Signature->Domain = domain;

Macro for declaration of the function application domain

#define DECLARE_SIGNATURE_ID ( id   )     Signature->ID = id;

Macro for declaration of the function ID

#define DECLARE_SIGNATURE_METHOD ( method   )     Signature->Method = method;

Macro for declaration of the function application numerical method

#define DECLARE_SIGNATURE_NAME ( name   )     Signature->Name = name;

Macro for declaration of the function name

#define DECLARE_SIGNATURE_PROCESS ( process   )     Signature->Process = process;

Macro for declaration of the function application processes

#define DECLARE_SIGNATURE_SDKVERSION   Signature->setSDKVersion(STRINGIFY(OFELIB_VERSION));

Macro for declaration of SDK version used to build the function

#define DECLARE_SIGNATURE_STATUS ( status   )     Signature->Status = status;

Macro for declaration of the function status

#define DECLARE_SIGNATURE_VERSION ( version   )     Signature->Version = version;

Macro for declaration of the function version

#define DECLARE_SU_PRODUCED_VAR ( name,
description,
unit   )     Signature->HandledData.ProducedVars.push_back(openfluid::base::SignatureHandledDataItem(name,"SU",description,unit));

Macro for declaration of a produced variable on all SUs

Parameters:
[in] name name of the variable
[in] description description of the variable
[in] unit unit of the variable. Could be an empty string if there is no unit
Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_SU_REQUIRED_INICOND ( name,
description,
unit   )     Signature->HandledData.RequiredInput.push_back(openfluid::base::SignatureHandledDataItem((name),("SU"),description,unit));

Macro for declaration of a required initial condition on all SUs

Parameters:
[in] name name of the initial condition
[in] description description of the initial condition
[in] unit unit of the initial condition. Could be an empty string if there is no unit
Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_SU_REQUIRED_PREVVAR ( name,
description,
unit   )     Signature->HandledData.RequiredPrevVars.push_back(openfluid::base::SignatureHandledDataItem((name),("SU"),description,unit));

Macro for declaration of a required variable on all SUs, using a value produced on a previous time step

Parameters:
[in] name name of the variable
[in] description description of the variable
[in] unit unit of the variable. Could be an empty string if there is no unit
Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_SU_REQUIRED_PROPERTY ( name,
description,
unit   )     Signature->HandledData.RequiredInput.push_back(openfluid::base::SignatureHandledDataItem((name),("SU"),description,unit));

Macro for declaration of a required property on all SUs

Parameters:
[in] name name of the property
[in] description description of the property
[in] unit unit of the property. Could be an empty string if there is no unit
Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_SU_REQUIRED_VAR ( name,
description,
unit   )     Signature->HandledData.RequiredVars.push_back(openfluid::base::SignatureHandledDataItem((name),("SU"),description,unit));

Macro for declaration of a required variable on all SUs

Parameters:
[in] name name of the variable
[in] description description of the variable
[in] unit unit of the variable. Could be an empty string if there is no unit
Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_SU_UPDATED_VAR ( name,
description,
unit   )     Signature->HandledData.UpdatedVars.push_back(openfluid::base::SignatureHandledDataItem((name),("SU"),description,unit));

Macro for declaration of an updated variable on all SUs

Parameters:
[in] name name of the variable
[in] description description of the variable
[in] unit unit of the variable. Could be an empty string if there is no unit
Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_SU_USED_INICOND ( name,
description,
unit   )     Signature->HandledData.UsedInput.push_back(openfluid::base::SignatureHandledDataItem((name),("SU"),description,unit));

Macro for declaration of a used initial condition on all SUs

Parameters:
[in] name name of the initial condition
[in] description description of the initial condition
[in] unit unit of the initial condition. Could be an empty string if there is no unit
Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_SU_USED_PREVVAR ( name,
description,
unit   )     Signature->HandledData.UsedPrevVars.push_back(openfluid::base::SignatureHandledDataItem((name),("SU"),description,unit));

Macro for declaration of an used variable on all SUs, using a value produced on a previous time step

Parameters:
[in] name name of the variable
[in] description description of the variable
[in] unit unit of the variable. Could be an empty string if there is no unit
Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_SU_USED_PROPERTY ( name,
description,
unit   )     Signature->HandledData.UsedInput.push_back(openfluid::base::SignatureHandledDataItem((name),("SU"),description,unit));

Macro for declaration of a used property on all SUs

Parameters:
[in] name name of the property
[in] description description of the property
[in] unit unit of the property. Could be an empty string if there is no unit
Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_SU_USED_VAR ( name,
description,
unit   )     Signature->HandledData.UsedVars.push_back(openfluid::base::SignatureHandledDataItem((name),("SU"),description,unit));

Macro for declaration of an used variable on all SUs

Parameters:
[in] name name of the variable
[in] description description of the variable
[in] unit unit of the variable. Could be an empty string if there is no unit
Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_UPDATED_VAR ( name,
uclass,
description,
unit   )     Signature->HandledData.UpdatedVars.push_back(openfluid::base::SignatureHandledDataItem((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_EVENTS ( uclass   )     Signature->HandledData.UsedEventsOnUnits.push_back(uclass);

Macro for declaration of used events

Parameters:
[in] uclass class of the concerned units

#define DECLARE_USED_EXTRAFILE ( name   )     Signature->HandledData.UsedExtraFiles.push_back(name);

Macro for declaration of used file

Parameters:
[in] name name of the file

#define DECLARE_USED_GU_EVENTS   Signature->HandledData.UsedEventsOnUnits.push_back("GU");

Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_USED_INPUTDATA ( name,
uclass,
description,
unit   )     Signature->HandledData.UsedInput.push_back(openfluid::base::SignatureHandledDataItem((name),uclass,description,unit));

Macro for declaration of a used input data

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

#define DECLARE_USED_PREVVAR ( name,
uclass,
description,
unit   )     Signature->HandledData.UsedPrevVars.push_back(openfluid::base::SignatureHandledDataItem((name),uclass,description,unit));

Macro for declaration of an used variable, using a value produced on a previous time step

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_RS_EVENTS   Signature->HandledData.UsedEventsOnUnits.push_back("RS");

Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_USED_SU_EVENTS   Signature->HandledData.UsedEventsOnUnits.push_back("SU");

Deprecated:
Deprecated macro, it is available for compatibility only.

#define DECLARE_USED_VAR ( name,
uclass,
description,
unit   )     Signature->HandledData.UsedVars.push_back(openfluid::base::SignatureHandledDataItem((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_SIGNATURE_HOOK

Value:

return Signature; \
  }
Macro for the end of definition of signature hook

Generated using Doxygen 1.5.8
Creative Commons License Creative Commons By-NC-ND license