Rockwell Automation 9307 FactoryTalk EnergyMetrix - Manual (Page 253)

9 • ReportsPlus
253
Enums
Months Collection
The Months object is a collection of Month objects. The Months and Month objects
provide an easy way for MPR script code to process data in monthly periods.
Instancing
The Months object is a creatable object.
Accessing
The Report object automatically creates one Months object (accessible by using the
Report.Months property) and MPR script code can create additional Months objects if
needed.
TargetTotal(ValueType.enumValu
e[, DateTime startDate,
DateTime endDate]) Calculates the target value of the specified value type for the meter 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 meter 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.
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.enumV
alue, 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
Enum Description
MeterType.Manual
MeterType.Water
MeterType.Air
MeterType.Gas
MeterType.Electric
MeterType.Steam
MeterType.Environmental The type of the meter. If additional meter types are created in the
database, the additional meter type names can be used as enums.