#include <openfluid/config.hpp>
#include <openfluid/dllexport.hpp>
#include <openfluid/core/TypeDefs.hpp>
#include <openfluid/core/DateTime.hpp>
#include <openfluid/ware/WareSignature.hpp>
Go to the source code of this file.
Namespaces | |
openfluid | |
openfluid::ware | |
Macros | |
#define | BEGIN_SIMULATOR_SIGNATURE(id) |
#define | END_SIMULATOR_SIGNATURE |
#define | DECLARE_DOMAIN(domain) Signature->Domain = domain; |
#define | DECLARE_PROCESS(process) Signature->Process = process; |
#define | DECLARE_METHOD(method) Signature->Method = method; |
#define | DECLARE_SIMULATOR_PARAM(name, description, unit) Signature->HandledData.SimulatorParams.push_back(openfluid::ware::SignatureHandledDataItem((name),(""),description,unit)); |
#define | DECLARE_PRODUCED_VAR(name, uclass, description, unit) Signature->HandledData.ProducedVars.push_back(openfluid::ware::SignatureHandledTypedDataItem((name),uclass,description,unit)); |
#define | DECLARE_UPDATED_VAR(name, uclass, description, unit) Signature->HandledData.UpdatedVars.push_back(openfluid::ware::SignatureHandledTypedDataItem((name),uclass,description,unit)); |
#define | DECLARE_REQUIRED_VAR(name, uclass, description, unit) Signature->HandledData.RequiredVars.push_back(openfluid::ware::SignatureHandledTypedDataItem((name),uclass,description,unit)); |
#define | DECLARE_USED_VAR(name, uclass, description, unit) Signature->HandledData.UsedVars.push_back(openfluid::ware::SignatureHandledTypedDataItem((name),uclass,description,unit)); |
#define | DECLARE_PRODUCED_ATTRIBUTE(name, uclass, description, unit) Signature->HandledData.ProducedAttribute.push_back(openfluid::ware::SignatureHandledDataItem((name),uclass,description,unit)); |
#define | DECLARE_REQUIRED_ATTRIBUTE(name, uclass, description, unit) Signature->HandledData.RequiredAttribute.push_back(openfluid::ware::SignatureHandledDataItem((name),uclass,description,unit)); |
#define | DECLARE_USED_ATTRIBUTE(name, uclass, description, unit) Signature->HandledData.UsedAttribute.push_back(openfluid::ware::SignatureHandledDataItem((name),uclass,description,unit)); |
#define | DECLARE_USED_EVENTS(uclass) Signature->HandledData.UsedEventsOnUnits.push_back(uclass); |
#define | DECLARE_UPDATED_UNITSGRAPH(description) Signature->HandledUnitsGraph.UpdatedUnitsGraph = (description); |
#define | DECLARE_UPDATED_UNITSCLASS(uclass, description) Signature->HandledUnitsGraph.UpdatedUnitsClass.push_back(openfluid::ware::SignatureHandledUnitsClassItem(uclass,description)); |
#define | DECLARE_REQUIRED_EXTRAFILE(name) Signature->HandledData.RequiredExtraFiles.push_back(name); |
#define | DECLARE_USED_EXTRAFILE(name) Signature->HandledData.UsedExtraFiles.push_back(name); |
#define | DECLARE_SCHEDULING_UNDEFINED Signature->TimeScheduling.setAsUndefined(); |
#define | DECLARE_SCHEDULING_DEFAULT Signature->TimeScheduling.setAsDefaultDeltaT(); |
#define | DECLARE_SCHEDULING_FIXED(deltat) Signature->TimeScheduling.setAsFixed(deltat); |
#define | DECLARE_SCHEDULING_RANGE(min, max) Signature->TimeScheduling.setAsRange(min,max); |
Typedefs | |
typedef std::string | openfluid::ware::SimMethod_t |
typedef std::string | openfluid::ware::SimProcess_t |
typedef std::string | openfluid::ware::SimDomain_t |
#define BEGIN_SIMULATOR_SIGNATURE | ( | id | ) |
Macro for the beginning of definition of signature hook
#define DECLARE_DOMAIN | ( | domain | ) | Signature->Domain = domain; |
Macro for declaration of the simulator application domain
#define DECLARE_METHOD | ( | method | ) | Signature->Method = method; |
Macro for declaration of the simulator application numerical method
#define DECLARE_PROCESS | ( | process | ) | Signature->Process = process; |
Macro for declaration of the simulator application processes
#define DECLARE_PRODUCED_ATTRIBUTE | ( | name, | |
uclass, | |||
description, | |||
unit | |||
) | Signature->HandledData.ProducedAttribute.push_back(openfluid::ware::SignatureHandledDataItem((name),uclass,description,unit)); |
Macro for declaration of a produced attribute
[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 | |||
) | Signature->HandledData.ProducedVars.push_back(openfluid::ware::SignatureHandledTypedDataItem((name),uclass,description,unit)); |
Macro for declaration of a produced variable
[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 | |||
) | Signature->HandledData.RequiredAttribute.push_back(openfluid::ware::SignatureHandledDataItem((name),uclass,description,unit)); |
Macro for declaration of a required attribute
[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 | ) | Signature->HandledData.RequiredExtraFiles.push_back(name); |
Macro for declaration of required file
[in] | name | name of the file |
#define DECLARE_REQUIRED_VAR | ( | name, | |
uclass, | |||
description, | |||
unit | |||
) | Signature->HandledData.RequiredVars.push_back(openfluid::ware::SignatureHandledTypedDataItem((name),uclass,description,unit)); |
Macro for declaration of a required variable
[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 Signature->TimeScheduling.setAsDefaultDeltaT(); |
Macro for declaration of time scheduling as default delta T
#define DECLARE_SCHEDULING_FIXED | ( | deltat | ) | Signature->TimeScheduling.setAsFixed(deltat); |
Macro for declaration of fixed time scheduling
[in] | deltat | fixed time scheduling value |
#define DECLARE_SCHEDULING_RANGE | ( | min, | |
max | |||
) | Signature->TimeScheduling.setAsRange(min,max); |
Macro for declaration of range of time scheduling
[in] | min | minimal time scheduling value |
[in] | max | maximal time scheduling value |
#define DECLARE_SCHEDULING_UNDEFINED Signature->TimeScheduling.setAsUndefined(); |
Macro for declaration of time scheduling as undefined
#define DECLARE_SIMULATOR_PARAM | ( | name, | |
description, | |||
unit | |||
) | Signature->HandledData.SimulatorParams.push_back(openfluid::ware::SignatureHandledDataItem((name),(""),description,unit)); |
Macro for declaration of a simulator parameter
[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_UPDATED_UNITSCLASS | ( | uclass, | |
description | |||
) | Signature->HandledUnitsGraph.UpdatedUnitsClass.push_back(openfluid::ware::SignatureHandledUnitsClassItem(uclass,description)); |
Macro for declaration of units class creation or update
[in] | uclass | name of the created or updated class |
[in] | description | description of the updated class |
#define DECLARE_UPDATED_UNITSGRAPH | ( | description | ) | Signature->HandledUnitsGraph.UpdatedUnitsGraph = (description); |
Macro for declaration of units graph modification
[in] | description | description of modification |
#define DECLARE_UPDATED_VAR | ( | name, | |
uclass, | |||
description, | |||
unit | |||
) | Signature->HandledData.UpdatedVars.push_back(openfluid::ware::SignatureHandledTypedDataItem((name),uclass,description,unit)); |
Macro for declaration of an updated variable
[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 | |||
) | Signature->HandledData.UsedAttribute.push_back(openfluid::ware::SignatureHandledDataItem((name),uclass,description,unit)); |
Macro for declaration of a used attribute
[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 | ) | Signature->HandledData.UsedEventsOnUnits.push_back(uclass); |
Macro for declaration of used events
[in] | uclass | class of the concerned units |
#define DECLARE_USED_EXTRAFILE | ( | name | ) | Signature->HandledData.UsedExtraFiles.push_back(name); |
Macro for declaration of used file
[in] | name | name of the file |
#define DECLARE_USED_VAR | ( | name, | |
uclass, | |||
description, | |||
unit | |||
) | Signature->HandledData.UsedVars.push_back(openfluid::ware::SignatureHandledTypedDataItem((name),uclass,description,unit)); |
Macro for declaration of an used variable
[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