OSID Logo
OSID Specifications
metering package
Version 3.1.0
Interfaceosid.metering.Statistic
Implementsosid.OsidCompendium
Used Byosid.metering.StatisticList
osid.metering.StatisticLookupSession
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.Id the Id of the Meter
Compliancemandatory This method must be implemented.
MethodgetMeter
Description

Gets the Meter associated with this reading.

Returnosid.metering.Meter the Meter
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetMeteredObjectId
Description

Gets the metered object associated with this reading.

Returnosid.id.Id the metered object Id
Compliancemandatory This method must be implemented.
MethodgetSum
Description

Gets the total.

Returndecimal the sum
Compliancemandatory This method must be implemented.
MethodgetMean
Description

Gets the mean.

Returndecimal the mean
Compliancemandatory This method must be implemented.
MethodgetMedian
Description

Gets the median.

Returndecimal the mean
Compliancemandatory This method must be implemented.
MethodgetMode
Description

Gets the mode.

Returndecimal the mode
Compliancemandatory This method must be implemented.
MethodgetStandardDeviation
Description

Gets the standard deviation.

Returndecimal the standard deviation
Compliancemandatory This method must be implemented.
MethodgetRMS
Description

Gets the root mean square.

Returndecimal the rms
Compliancemandatory This method must be implemented.
MethodgetDelta
Description

Gets the difference between the end and start values.

Returndecimal the delta
Compliancemandatory This method must be implemented.
MethodgetPercentChange
Description

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

Returndecimal the delta
Compliancemandatory This method must be implemented.
MethodgetAverageRate
Description

Gets the average rate of change.

Parametersosid.calendaring.DateTimeResolutionunits the time units
Returndecimal the average rate
ErrorsNULL_ARGUMENT units is null
Compliancemandatory This 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.TypestatisticRecordType the statistic record type
Returnosid.metering.records.StatisticRecord the statistic record
ErrorsNULL_ARGUMENT statisticRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(statisticRecordType) is false
Compliancemandatory This method must be implemented.