edu.sc.seis.fissuresUtil.display.registrar
Interface TimeConfig

All Superinterfaces:
DataSetSeismogramReceptacle
All Known Implementing Classes:
BasicTimeConfig, OriginAlignedTimeConfig, PhaseAlignedTimeConfig, RelativeTimeConfig, RTTimeRangeConfig

public interface TimeConfig
extends DataSetSeismogramReceptacle

TimeConfigs calculate the time ranges for a given set of seismograms Created: Tue Aug 27 14:45:38 2002


Method Summary
 void addListener(TimeListener listener)
          add adds the listener to the group of objects that are updated when this time config changes
 TimeEvent fireTimeEvent()
          fireTimeEvent causes the config to prepare a time event and fire it to all of its TimeEvent objects
 double getScale()
           
 double getShift()
           
 MicroSecondTimeRange getTime()
           
 MicroSecondTimeRange getTime(DataSetSeismogram seis)
           
 void removeListener(TimeListener listener)
          remove removes listener from the update group
 void shaleTime(double shift, double scale)
          shaleTime shifts then scales all the seismograms in the config.
 void shaleTime(double shift, double scale, DataSetSeismogram[] seismos)
          shaleTime performs a shale on the seismograms in the array
 
Methods inherited from interface edu.sc.seis.fissuresUtil.display.registrar.DataSetSeismogramReceptacle
add, clear, contains, getSeismograms, remove, reset, reset
 

Method Detail

shaleTime

void shaleTime(double shift,
               double scale)
shaleTime shifts then scales all the seismograms in the config. First, the shift value is used to move the begin time by shift*timeWidth. Then the scale value is used to adjust the end time so that the new timeWidth is scale*timeWidth. So, if shift = 1 and scale = 2, the shift is applied and the new begin time is equal to the old end time. Then the time width is modified to be two times its original size. The new time starts at the old begin time and lasts twice as long. An adjustment of shift = 0, scale = 1 will leave the seismograms unchanged. A scale value must be greater than 0, or it will reduce the time width to nothing.

Parameters:
shift - the percentage of current time width by which the seismograms will be shifted
scale - the percentage of the current time width that will exist after the end time is moved

shaleTime

void shaleTime(double shift,
               double scale,
               DataSetSeismogram[] seismos)
shaleTime performs a shale on the seismograms in the array


addListener

void addListener(TimeListener listener)
add adds the listener to the group of objects that are updated when this time config changes

Parameters:
listener - a TimeEventListener that will be updated as this config changes

removeListener

void removeListener(TimeListener listener)
remove removes listener from the update group

Parameters:
listener - a TimeEventListener that will no longer receive updates from this config

fireTimeEvent

TimeEvent fireTimeEvent()
fireTimeEvent causes the config to prepare a time event and fire it to all of its TimeEvent objects

Returns:
the ConfigEvent fired

getTime

MicroSecondTimeRange getTime()
Returns:
a MicroSecondTimeRange that covers the current generic time range of this TimeConfig

getTime

MicroSecondTimeRange getTime(DataSetSeismogram seis)
Parameters:
seis - a DataSetSeismogram a time is desired for
Returns:
a MicroSecondTimeRange describing the current time of the given seismogram in the time config

getShift

double getShift()

getScale

double getScale()