OSID Logo
OSID Specifications
metering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.metering.Statistic
Implementsosid.OsidCompendium
Description

A Statistic represents a reading of a Meter for a reference metered object over a period of time.

MethodgetMeterId
Description

Gets the Id of the Meter associated with this reading.

Returnosid.id.Idthe Id of the Meter
CompliancemandatoryThis method must be implemented.
MethodgetMeter
Description

Gets the Meter associated with this reading.

Returnosid.metering.Meterthe Meter
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetMeteredObjectId
Description

Gets the metered object associated with this reading.

Returnosid.id.Idthe metered object Id
CompliancemandatoryThis method must be implemented.
MethodgetSum
Description

Gets the total.

Returndecimalthe sum
CompliancemandatoryThis method must be implemented.
MethodgetMean
Description

Gets the mean.

Returndecimalthe mean
CompliancemandatoryThis method must be implemented.
MethodgetMedian
Description

Gets the median.

Returndecimalthe mean
CompliancemandatoryThis method must be implemented.
MethodgetMode
Description

Gets the mode.

Returndecimalthe mode
CompliancemandatoryThis method must be implemented.
MethodgetStandardDeviation
Description

Gets the standard deviation.

Returndecimalthe standard deviation
CompliancemandatoryThis method must be implemented.
MethodgetRMS
Description

Gets the root mean square.

Returndecimalthe rms
CompliancemandatoryThis method must be implemented.
MethodgetDelta
Description

Gets the difference between the end and start values.

Returndecimalthe delta
CompliancemandatoryThis method must be implemented.
MethodgetPercentChange
Description

Gets the percent change between the end and start values (e.g. 50.25%).

Returndecimalthe delta
CompliancemandatoryThis method must be implemented.
MethodgetAverageRate
Description

Gets the average rate of change.

Parametersosid.calendaring.DateTimeResolutionunitsthe time units
Returndecimalthe average rate
ErrorsNULL_ARGUMENT units is null
CompliancemandatoryThis method must be implemented.
MethodgetStatisticRecord
Description

Gets the statistic record corresponding to the given Statistic record Type. This method is used to retrieve an object implementing the requested record. The statisticRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(statisticRecordType) is true .

Parametersosid.type.TypestatisticRecordTypethe statistic record type
Returnosid.metering.records.StatisticRecordthe statistic record
ErrorsNULL_ARGUMENT statisticRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(statisticRecordType) is false
CompliancemandatoryThis method must be implemented.