Rockwell Automation 9307 FactoryTalk EnergyMetrix - Manual (Page 251)

9 • ReportsPlus
251
Properties
Methods
Value type or tag related methods (for example, Average and Peak) of the Meter object
return results based on the selected meter. For more information on usage of the methods,
refer to the applicable rate schedule functions.
Property R/W Description
GroupId As Int R/W The database id that identifies the group containing the
meter
MeterId As Int R/W The database id that identifies the meter
MeterType As Int R/W The type of the meter
Name As String R/W The name of the meter
Method Description
Average(ValueType.enumValue[,
DateTime startDate, DateTime
endDate]) Calculates the average of the specified value type over the report date/time
range (or the specified date/time range if optional startDate and endDate
arguments are present). Returns a Double value
CostAllocate(billingReport As
String,
costAllocationRateSchedule As
String[, DateTime startDate,
DateTime endDate]) As Double Calculate the cost allocation by using the specified billing report and rate
schedule for the report date/time range (or the specified date/time range if
optional startDate and endDate arguments are present)
FixedTarget(ValueType.enumValue[,
DateTime startDate, DateTime
endDate]) Returns the value of the most recent instance of the selected ValueType with
a time stamp less than or equal to the report startDate (or specified startDate
if optional startDate and endDate arguments are present). Returns a Double
value. If no value is found, returns the value Double.NaN.
GetData(ValueType.enumValue,
DateTime utcTimeStamp) Returns the value of the most recent logged value of the selected ValueType,
looking back from the utcTimeStamp argument for a duration of one
logging interval. The result is an Object variable which contains the tag
value or Nothing if no tag value can be found
GetTagData(int meterTagId,
DateTime utcTimeStamp) Returns the value of the most recent instance of the selected meterTagId,
looking back from the utcTimeStamp argument for a duration of one
logging interval. The result is an Object variable which contains the tag
value or Nothing if no tag value can be found
GetUnit(ValueType.enumValue) Returns a String containing the Units value associated with the selected
value type
Lowest(ValueType.enumValue[,
DateTime startDate, DateTime
endDate]) Returns the smallest 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
LowestTimestamp(ValueType.enumVal
ue[, DateTime startDate, DateTime
endDate]) Returns a DateTime structure containing the UTC time stamp of the
smallest 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)