TPTP 4.5.0 Platform Project
Public API Specification

org.eclipse.hyades.ui.widgets.grapher
Interface GraphSource

All Superinterfaces:
BasicGraphSource
All Known Implementing Classes:
TestGraphSource

public interface GraphSource
extends BasicGraphSource

The GraphSource defines an interface to the graph data that a Graph implementation will query when rendering the graph. This interface provides a variety of methods to query the current data set.

See Also:
TestGraphSource

Field Summary
 
Fields inherited from interface org.eclipse.hyades.ui.widgets.grapher.BasicGraphSource
NEGATIVE_INFINITY, POSITIVE_INFINITY
 
Method Summary
 double getAverageBetween(double x, double x2)
          Get the average of values between the provided times, inclusive of x and exclusive of x2
 double getCountBetween(double x, double x2)
          Get the count of value entries between the provided times, inclusive of x and exclusive of x2
 double getMax()
          Get the maximum time this graph has data at
 double getMaxBetween(double x, double x2)
          Get the max of values between the provided times, inclusive of x and exclusive of x2
 double getMin()
          Get the minimum time this graph has data at
 double getMinBetween(double x, double x2)
          Get the min of values between the provided times, inclusive of x and exclusive of x2
 double getSessionMax()
          Get the maxnimum time this graph could have data at.
 double getSessionMin()
          Get the minimum time this graph could have data at.
 double getStandardDeviationBetween(double x, double x2)
          Get the standard deviation of values between the provided times, inclusive of x and exclusive of x2
 double getSumBetween(double x, double x2)
          Get the sum of values between the provided times, inclusive of x and exclusive of x2
 double getValueAt(double x)
          Get the value at or immediately before the provided time
 double getValueMax()
          Get the maximum value this graph source holds
 double getValueMin()
          Get the minimum value this graph source holds
 

Method Detail

getMin

double getMin()
Get the minimum time this graph has data at

Specified by:
getMin in interface BasicGraphSource
Returns:
the minimum time this graph has data at

getMax

double getMax()
Get the maximum time this graph has data at

Specified by:
getMax in interface BasicGraphSource
Returns:
the maximum time this graph has data at

getSessionMin

double getSessionMin()
Get the minimum time this graph could have data at. The first point at which data could have been returned.

Returns:
the first point at which data could have been returned.

getSessionMax

double getSessionMax()
Get the maxnimum time this graph could have data at. The last point at which data could have been returned.

Returns:
the last point at which data could have been returned.

getValueMax

double getValueMax()
Get the maximum value this graph source holds

Returns:
the maximum value this graph source holds

getValueMin

double getValueMin()
Get the minimum value this graph source holds

Returns:
the minimum value this graph source holds

getValueAt

double getValueAt(double x)
Get the value at or immediately before the provided time

Parameters:
x - the time to get the value at
Returns:
the value at or immediately before the provided time

getAverageBetween

double getAverageBetween(double x,
                         double x2)
Get the average of values between the provided times, inclusive of x and exclusive of x2

Parameters:
x - the start time to average from
x2 - the end time to average to
Returns:
the average of the values between x and x2

getSumBetween

double getSumBetween(double x,
                     double x2)
Get the sum of values between the provided times, inclusive of x and exclusive of x2

Parameters:
x - the start time to sum from
x2 - the end time to sum to
Returns:
the sumof the values between x and x2

getMaxBetween

double getMaxBetween(double x,
                     double x2)
Get the max of values between the provided times, inclusive of x and exclusive of x2

Parameters:
x - the start time to get the max from
x2 - the end time to get the max to
Returns:
the max of the values between x and x2

getMinBetween

double getMinBetween(double x,
                     double x2)
Get the min of values between the provided times, inclusive of x and exclusive of x2

Parameters:
x - the start time to get the min from
x2 - the end time to get the min to
Returns:
the min of the values between x and x2

getCountBetween

double getCountBetween(double x,
                       double x2)
Get the count of value entries between the provided times, inclusive of x and exclusive of x2

Parameters:
x - the start time to get the count from
x2 - the end time to get the count to
Returns:
the count of the value entries between x and x2

getStandardDeviationBetween

double getStandardDeviationBetween(double x,
                                   double x2)
Get the standard deviation of values between the provided times, inclusive of x and exclusive of x2

Parameters:
x - the start time to get the stddev from
x2 - the end time to get the stddev to
Returns:
the stddev of the value entries between x and x2

TPTP 4.5.0 Platform Project
Public API Specification