Calculations
Calculation Modules table
This table shows the C# calculation modules.
| Property | Data Type | Description |
|---|---|---|
| Name | String | The unique name of the calculation module. |
| Assembly | String | A full path to the assembly (or assemblies) or C# source file(s) that contain the calculation modules. when defining more than one assembly or source file they are separated with pipes "|". Mixing assemblies and source files is not supported. |
| References | String | External assembly references needed in the compilation. |
Calculation Tasks
This table shows the CalcScheduler settings of the C# calculations.
| Property | Data Type | Description |
|---|---|---|
| Name | String | Name of the calculation task. |
| Module | ref. CalculationModule | Calculation module to be used. |
| Class | String | The name(s) of the calculation class(es) to be run by this task. More than one class can be defined by separating them with pipes "|". The classes will be run in the order they are defined. |
| User Parameters | String | User definable parameters that can be accessed in the calculation class using the ParameterProvider "Parameters". |
| Description | String | A description for the task. |
| Base Time | DateTime | The base time is a local time stamp the periods in the calculation task are aligned to. If the basetime is not defined, the defaults value 2300-01-01 00:00:00 is used. |
| Period Length | UInt32 | Defines the temporal resolution of the calculation task and is used to determine (with Basetime) the start times and lengths of calculated periods. |
| Period Length Unit | Enum | The time unit of the period length. |
| Offset | Int32 | Defines the period offset for the calculation task start time as a number of periods. Positive values point forward (to future) and negative values point backwards (to past). |
| Period Count | UInt32 | Period Count defined the number of consecutive periods to be calculated in the calculation task. |
| Scheduler Id | String | The scheduler identifier of the RTDB_CalcScheduler service that handles the scheduling of this task. |
| Schedule Base Time | DateTime | The base time of the calculation schedule. |
| Schedule Interval | UInt32 | The interval of the calculation schedule. |
| Schedule Interval Unit | Enum | The time unit of the interval. |
| Follow Wall Clock Time | Boolean | If true, calculation schedule will follow wall clock time, instead of UTC time. |
| Skip missed | Boolean | If true, skips missed periods when the calculation service has been turned off. If false, all missed periods will be calculated in the next calculation service start. |
| Disabled | Boolean | If true, the task will not run when the calculation service is started. |
Updated 10 days ago