Rockwell Automation 9307 FactoryTalk EnergyMetrix - Manual (Page 248)

FactoryTalk EnergyMetrix Software
248
Intervals Collection
The Intervals object is a collection of Interval objects. The Intervals and Interval objects
provide an easy way for MPR script code to process data in intervals specified by the user
when they run a Multi-purpose Report. Interval types are Day, Week, Month.
Instancing
The Intervals object is a creatable object.
Accessing
The Report object automatically creates one Intervals object (accessible by using the
Report.Intervals property) and MPR script code can create additional Intervals objects if
needed.
TargetTotal(ValueType.enumValue[,
DateTime startDate, DateTime
endDate]) Calculates the target value of the specified value type for the group for the
report date/time range (or the specified date/time range if the optional
startDate and endDate arguments are present).
This method works with targets saved for the group in ChartsPlus X-Y trend
charts. The active target selected is the target with a start date/time less than
or equal to the report (or interval) start date/time. Saved targets are selected
based on the associated Y (ordinate) value type and represent a linear
relationship with up to 3 X (abscissa) value types. For example, in a target of
Consumption per Unit Production, Consumption is the Y quantity and
Production is the X quantity.
Returns a Double value. If no active target is found, returns zero. If multiple
targets are active within the group then the values are aggregated and their
total is returned.
Total(valueType As Integer[,
DateTime startDate, DateTime
endDate]) Calculate the consumption of the specified value type for the group for the
report date/time range (or the specified date/time range if optional startDate
and endDate arguments are present). If the 'Log Delta Value' attribute is
selected, this function is equivalent to the Sum() function. Returns a Double
value
TotalRTPCharge(ValueType.enumValu
e, int priceTagId[, DateTime
startDate, DateTime endDate]) Calculates the total charge for consumption values by using real time pricing
data contained in the meter tag priceTagId. The function operates over the
report date/time range (or the specified date/time range if optional startDate
and endDate arguments are present). It returns a Double value
Method Description