View Javadoc

1   package edu.iris.Fissures.model;
2   
3   /***
4    * Interface for dealing with the different types of displayable data
5    * in seismology, including seismograms, picks, predicted arrivals,
6    * etc. Each of these will implement this interface which can be used when
7    * they are displayed, etc.
8    *
9    *
10   * Created: Tue Jul  6 14:42:24 1999
11   *
12   * @author Philip Crotwell
13   * @version 
14   */
15  public interface TimeData  {
16      
17      /*** returns the earliest time for which this object "has data".
18  	For a seismogram, this is the time of the first data point,
19  	while for a pick it would be the time of the pick.  */
20      public MicroSecondDate getBeginTime();
21      
22      /*** returns the width in time for this object. For a seismogram,
23       this would be the time from the first sample to the last sample,
24       while for a pick, this would be 0 and whatever time unit is
25       handy. 0 seconds would likely be the best choice.  */
26      public TimeInterval getTimeInterval();
27  
28      /*** returns the range of amplitudes for this object. For a
29       seismogram, this would be the range of amplitudes in whatever
30       units the seismogram is in. For things without amplitudes, for
31       example picks, this would return null.  */
32      public UnitRangeImpl getAmplitudeRange();
33  
34  } // TimeData