Temporal.Statistic.avgOverTimeLong()

Signature

double avgOverTimeLong(PropertyAtomLong pal, long stime, long etime, int sample_interval, boolean bound_by_stime)

Domain

ACTION, CONDITION, QUERY, BUI

Description

This method calculates the average of samples of the property over a given time interval[stime, etime].

Parameters

NameTypeDescription
palPropertyAtomLongThe property to average the value for.
stimelongstart time of the interval, 0 means use oldest value's timestamp as start time.
etimelongend time of the interval, 0 means use newest value's timestamp as end time.
sample_intervalintinterval between samples in milliseconds, should be greater than 0.
bound_by_stimebooleantrue implies for stime less than oldest value's time stamp[t0] use t0.

Returns

TypeDescription
doubleaverage of all the samples taken.

Cautions

If value did not exist through the entire interval an exception is thrown.