Functions
Function name | Function parameters | Return type | Explanation |
|---|---|---|---|
VE4_GetMPointName | ID As String | String | Returns the name of the metering point. |
VE4_GetMPointPerLength | ID As String | Byte | Returns the period length for the metering point. |
VE4_GetObisPerLength | OBIS As String | Byte | Returns the period length for the specified OBIS identifier. |
VE4_GetOBISUnit | OBIS As String | String | Returns the unit for the specified OBIS identifier. |
VE4_GetMPointStatus | ID As String, OBIS As String, FirstDate As Date, LastDate As Date | String | Returns the status of the metering point for the specified time range. |
VE4_GetMPointPerCount | ID As String, OBIS As String, FirstDate As Date, LastDate As Date | Integer | Returns the number of periods for the metering point within the specified time range. |
VE4_CalcMPointSum | ID As String, OBIS As String, FirstDate As Date, LastDate As Date | Double | Calculates the sum of the values for the metering point over the specified time range. |
VE4_CalcMPointMax | ID As String, OBIS As String, FirstDate As Date, LastDate As Date | Double | Calculates the maximum value for the metering point over the specified time range. |
VE4_GetMPointMaxDate | ID As String, OBIS As String, FirstDate As Date, LastDate As Date | Date | Returns the date of the maximum value for the metering point within the specified time range. |
VE4_CalcMPointMin | ID As String, OBIS As String, FirstDate As Date, LastDate As Date | Double | Calculates the minimum value for the metering point over the specified time range. |
VE4_GetMPointMinDate | ID As String, OBIS As String, FirstDate As Date, LastDate As Date | Date | Returns the date of the minimum value for the metering point within the specified time range. |
VE4_CalcMPointAverage | ID As String, OBIS As String, FirstDate As Date, LastDate As Date | Double | Calculates the average value for the metering point over the specified time range. |
VE4_CalcMPointBaseValue | ID As String, OBIS As String, Day As Date, Interval As Integer, BaseFunction As Integer, IntervalFunction As Integer | Double | Calculates the base value (e.g. daily value) of the metering point using specific functions. |
VE4_CalcMPointTariffValue | ID As String, OBIS As String, FirstDate As Date, LastDate As Date, StartTime As Date, Duration As Integer, BaseFunction As Integer, IntervalFunction As Integer | Double | Calculates the tariff value for the metering point over the specified time range using specific functions and a specified duration. |
VE4_CalcCCenterMPointSum | CostCenter As String, MeteringPoint As String, OBIS As String, FirstDate As Date, LastDate As Date | Double | Calculates the sum for the cost centre. |
VE4_CalcEBenefitMPointSum | EnergyBenefit As String, MeteringPoint As String, OBIS As String, FirstDate As Date, LastDate As Date | Double | Calculates the sum for the metering point associated with a specific energy use. |
VE4_CalcMSystemMPointSum | MachineSystem As String, MeteringPoint As String, OBIS As String, FirstDate As Date, LastDate As Date | Double | Calculates the sum for a machine/system. |
VE4_CalcCCenterSum | UserMedium As String, CostCenter As String, OBIS As String, FirstDate As Date, LastDate As Date, PeriodLength As Byte | Double | Calculates the total for a cost centre for a specific medium over the specified time range. |
VE4_CalcEBenefitSum | UserMedium As String, EnergyBenefit As String, OBIS As String, FirstDate As Date, LastDate As Date, PeriodLegth As Byte | Double | Calculates the total for an energy use for a specific medium over the specified time range. |
VE4_CalcMSystemSum | UserMedium As String, MachineSystem As String, OBIS As String, FirstDate As Date, LastDate As Date, PeriodLegth As Byte | Double | Calculates the total for a machine/system for a specific medium over the specified time range. |
VE4_GetOBISShortname | OBIS As String | String | Returns the short name for the specified OBIS identifier. |
VE4_GetTimeWhen | ID As String, OBIS As String, FirstDate As Date, LastDate As Date, MinVal As Double, MaxVal As Double | Double | Returns the time span during which the values were between MinVal and MaxVal. |
VE4_GetPIndicatorName | ID As String | String | Returns the name of the indicator. |
VE4_GetPIndicatorStatus | ID As String, OBIS As String, FirstDate As Date, LastDate As Date | String | Returns the status of the indicator for the specified time range. |
VE4_GetPIndicatorPerCount | ID As String, OBIS As String, FirstDate As Date, LastDate As Date | Integer | Returns the number of periods for the indicator within the specified time range. |
VE4_CalcPIndicatorSum | ID As String, OBIS As String, FirstDate As Date, LastDate As Date | Double | Calculates the sum of the values for the indicator over the specified time range. |
VE4_CalcPIndicatorMax | ID As String, OBIS As String, FirstDate As Date, LastDate As Date | Double | Calculates the maximum value for the indicator over the specified time range. |
VE4_GetPIndicatorMaxDate | ID As String, OBIS As String, FirstDate As Date, LastDate As Date | Date | Returns the date of the maximum value for the indicator within the specified time range. |
VE4_CalcPIndicatorMin | ID As String, OBIS As String, FirstDate As Date, LastDate As Date | Double | Calculates the minimum value for the indicator over the specified time range. |
VE4_GetPIndicatorMinDate | ID As String, OBIS As String, FirstDate As Date, LastDate As Date | Date | Returns the date of the minimum value for the indicator within the specified time range. |
VE4_CalcPIndicatorAverage | ID As String, OBIS As String, FirstDate As Date, LastDate As Date | Double | Calculates the average value for the indicator over the specified time range. |
VE4_CalcPIndicatorBaseValue | ID As String, OBIS As String, Day As Date, Interval As Integer, BaseFunction As Integer, IntervalFunction As Integer | Double | Calculates the base value (e.g. daily value) of the indicator using specific functions. |
VE4_CalcPIndicatorTariffValue | ID As String, OBIS As String, FirstDate As Date, LastDate As Date, StartTime As Date, Duration As Integer, BaseFunction As Integer, IntervalFunction As Integer | Double | Calculates the tariff value of the indicator over the specified time range using specific functions and a specified duration. |