dshelper_average__define

Source: dataset/helpers/average/dshelper_average__define.pro

 dshelper_average
        Class to provide averaging options to datasets

 Members:
        average.time    double  The averaging interval to use (0.0
                                implies no averaging) [seconds]
        average.spacing double  The spacing between successive
                                averages (if this is bigger than the
                                averaging time then there are gaps
                                between averages, if it is smaller,
                                then the averages overlap, zero is
                                equivalent to equality) [seconds]
        average.sf      float   The factor by which the averaging
                                parameters must be scaled when
                                reporting (one of 1.0, 60., 3600.,
                                86400., for seconds, minutes, hours or
                                days).
        average.compel  byte    Whether averaging is to be done even
                                if the method thinks it's silly to do
                                so.
        averaging_done  byte    Flag that is set when the dataset has
                                been averaged.

 History:
        Extracted from rates class: 19/11/99; SJT
        Add member documentation: 1/8/01; SJT
        Added compel member: 27/9/01; SJT



James Tappin 2005-02-04