Rockwell Automation 9307 FactoryTalk EnergyMetrix - Manual (Page 136)

FactoryTalk EnergyMetrix Software
136
Total Function
The Total function returns the accumulated usage of the selected value logged between the
report start and end dates, and during the periods defined by the SeasonType, DayType,
and TimeOfUseType (or StartHour and EndHour) arguments. The Total function is
generally used for values such as energy (kWh, kVARh, gallons of oil) and production
units. It returns a Double value.
Usage
Quantity = Total(ValueType.enumValue)
Quantity = Total(ValueType.enumValue, SeasonType.enumValue)
Quantity = Total(ValueType.enumValue, SeasonType.enumValue,
DayType.enumValue)
Quantity = Total(ValueType.enumValue, DayType.enumValue)
Quantity = Total(ValueType.enumValue, startHour, endHour)
Quantity = Total(ValueType.enumValue, TimeOfUseType.enumValue)
Quantity = Total(ValueType.enumValue, SeasonType.enumValue,
DayType.enumValue, startHour, endHour)
Quantity = Total(ValueType.enumValue, SeasonType.enumValue,
DayType.enumValue, TimeOfUseType.enumValue)
Quantity = Total(ValueType.enumValue, DayType.enumValue,
TimeOfUseType.enumValue)
Comments
The startHour and endHour arguments are integers in the range of 1…24, where
24 = midnight.
Example
The following script calculates the total kWh used during the Summer season, on working
days, during the user-defined On Peak time-of-use period:
Quantity = Total(ValueType.RealEnergyNet, SeasonType.Summer,
DayType.NonWorkingDay, TimeOfUseType.OnPeak)
TotalRTPCharge Function
The TotalRTPCharge calculates the total charge for consumption values such as kWh and
kVARh, by using real time pricing data. It returns a Double value.
Meter tags that contain price data are passed as the priceMeterTagPath parameter by
listing the tag name as a fully-qualified or shortcut method tag name.