Rockwell Automation 9307 FactoryTalk EnergyMetrix - Manual (Page 252)

FactoryTalk EnergyMetrix Software
252
NLowest(ValueType.enumValue, int
N[, DateTime startDate, DateTime
endDate]) Returns a Double array of N elements containing the N smallest instances of
the selected ValueType over the report date/time range (or the specified
date/time range if optional startDate and endDate arguments are present)
NLowestTimestamps(ValueType.enumV
alue, int N[, DateTime startDate,
DateTime endDate]) Returns a DateTime array of N elements containing the UTC time stamps of
the N smallest instances of the selected ValueType over the report date/time
range (or the specified date/time range if optional startDate and endDate
arguments are present)
NPeaks(ValueType.enumValue, int
N[, DateTime startDate, DateTime
endDate]) Returns a Double array of N elements containing the N largest instances of
the selected ValueType over the report date/time range (or the specified
date/time range if optional startDate and endDate arguments are present)
NPeakTimestamps(ValueType.enumVal
ue, int N[, DateTime startDate,
DateTime endDate]) Returns a DateTime array of N elements containing the UTC time stamps of
the N largest instances of the selected ValueType over the report date/time
range (or the specified date/time range if optional startDate and endDate
arguments are present)
Peak(ValueType.enumValue[,
DateTime startDate, DateTime
endDate]) Returns the largest instance of the selected ValueType over the report date/
time range (or the specified date/time range if optional startDate and
endDate arguments are present). Returns a Double value
PeakTimestamp(ValueType.enumValue
[, DateTime startDate, DateTime
endDate]) Returns a DateTime structure containing the UTC time stamp of the largest
instance of the selected ValueType over the report date/time range (or the
specified date/time range if optional startDate and endDate arguments are
present)
Ratchet(ValueType.enumValue, int
intervalInMonths[, DateTime
ratchetEndDate]) Returns the largest instance of the selected ValueType over the specified
intervalInMonths ending with the report date/time range (or the specified
date/time range if the optional ratchetEndDate argument is present). The
intervalInMonths overlaps the effective date/time range. Returns a Double
value
RunRateSchedule(rateScheduleName
As String [, variableName As
String]
[, DateTime startDate, DateTime
endDate]) Run a rate schedule against the meter for the report date/time range (or the
specified date/time range if optional startDate and endDate arguments are
present) and return the value of the specified variableName argument as a
Double value.
The variableName argument may be any of the following:
 The rate schedule's TotalCharges variable. This is the default value and
will be returned if the variableName argument is omitted.
 Charge or RatePerUnit of the final line item in the rate schedule
 Any run-time parameter in the rate schedule
 Any global variable declared in the rate schedule
Sum(ValueType.enumValue[,
DateTime startDate, DateTime
endDate]) Returns the arithmetic sum of the selected ValueType over the report date/
time range (or the specified date/time range if optional startDate and
endDate arguments are present). Returns a Double value
Method Description