ucar.unidata.data
Class DataTimeRange

java.lang.Object
  extended by ucar.unidata.data.DataTimeRange

public class DataTimeRange
extends Object

Class DataTimeRange specifies a time range

Version:
$Revision: 1.6 $
Author:
IDV Development Team

Field Summary
static String[] ENDMODELABELS
          Time range mode
static int MODE_ANIMATION
          Time range mode
static int MODE_DATA
          Time range mode
static int MODE_FIXED
          Time range mode
static int MODE_RELATIVE
          Time range mode
static int[] MODES
          Time range mode
static String[] STARTMODELABELS
          Time range mode
 
Constructor Summary
DataTimeRange()
          ctor
 
Method Summary
 boolean applyTimeProperties()
          apply the properties
 Date getEndFixedDate()
          get the property
 long getEndFixedTime()
          Get the EndFixedTime property.
 int getEndMode()
          Get the EndMode property.
 double getEndOffsetMinutes()
          Get the EndOffsetMinutes property.
 String getLabelText()
          Label that describes the range
 Date getStartFixedDate()
          get the property
 long getStartFixedTime()
          Get the StartFixedTime property.
 int getStartMode()
          Get the StartMode property.
 double getStartOffsetMinutes()
          Get the StartOffsetMinutes property.
 JLabel getTimeModeLabel()
          get the time model label
 Real[] getTimeRange(Real dataStartTime, Real dataEndTime, Real aniValue)
          calculate time range
 void setEndFixedTime(Date d)
          set the property
 void setEndFixedTime(long value)
          Set the EndFixedTime property.
 void setEndMode(int value)
          Set the EndMode property.
 void setEndOffsetMinutes(double value)
          Set the EndOffsetMinutes property.
 void setOneLineLabel(boolean v)
          set onelinelabel
 void setStartFixedTime(Date d)
          set the property
 void setStartFixedTime(long value)
          Set the StartFixedTime property.
 void setStartMode(int value)
          Set the StartMode property.
 void setStartOffsetMinutes(double value)
          Set the StartOffsetMinutes property.
 boolean showDialog()
          Show the dialog
 String toString()
          Get a String representation of this object
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

MODE_DATA

public static final int MODE_DATA
Time range mode

See Also:
Constant Field Values

MODE_ANIMATION

public static final int MODE_ANIMATION
Time range mode

See Also:
Constant Field Values

MODE_FIXED

public static final int MODE_FIXED
Time range mode

See Also:
Constant Field Values

MODE_RELATIVE

public static final int MODE_RELATIVE
Time range mode

See Also:
Constant Field Values

MODES

public static int[] MODES
Time range mode


STARTMODELABELS

public static String[] STARTMODELABELS
Time range mode


ENDMODELABELS

public static String[] ENDMODELABELS
Time range mode

Constructor Detail

DataTimeRange

public DataTimeRange()
ctor

Method Detail

getTimeRange

public Real[] getTimeRange(Real dataStartTime,
                           Real dataEndTime,
                           Real aniValue)
                    throws VisADException,
                           RemoteException
calculate time range

Parameters:
dataStartTime - data start time
dataEndTime - data end time
aniValue - animation time
Returns:
The time range
Throws:
RemoteException - On badness
VisADException - On badness

getTimeModeLabel

public JLabel getTimeModeLabel()
get the time model label

Returns:
time model label

showDialog

public boolean showDialog()
Show the dialog

Returns:
success

applyTimeProperties

public boolean applyTimeProperties()
apply the properties

Returns:
success

setOneLineLabel

public void setOneLineLabel(boolean v)
set onelinelabel

Parameters:
v - one line label

getLabelText

public String getLabelText()
Label that describes the range

Returns:
Label

toString

public String toString()
Get a String representation of this object

Overrides:
toString in class Object
Returns:
a String representation of this object

setStartMode

public void setStartMode(int value)
Set the StartMode property.

Parameters:
value - The new value for StartMode

getStartMode

public int getStartMode()
Get the StartMode property.

Returns:
The StartMode

setEndMode

public void setEndMode(int value)
Set the EndMode property.

Parameters:
value - The new value for EndMode

getEndMode

public int getEndMode()
Get the EndMode property.

Returns:
The EndMode

setStartOffsetMinutes

public void setStartOffsetMinutes(double value)
Set the StartOffsetMinutes property.

Parameters:
value - The new value for StartOffsetMinutes

getStartOffsetMinutes

public double getStartOffsetMinutes()
Get the StartOffsetMinutes property.

Returns:
The StartOffsetMinutes

setEndOffsetMinutes

public void setEndOffsetMinutes(double value)
Set the EndOffsetMinutes property.

Parameters:
value - The new value for EndOffsetMinutes

getEndOffsetMinutes

public double getEndOffsetMinutes()
Get the EndOffsetMinutes property.

Returns:
The EndOffsetMinutes

setStartFixedTime

public void setStartFixedTime(long value)
Set the StartFixedTime property.

Parameters:
value - The new value for StartFixedTime

setStartFixedTime

public void setStartFixedTime(Date d)
set the property

Parameters:
d - value

setEndFixedTime

public void setEndFixedTime(Date d)
set the property

Parameters:
d - value

getStartFixedDate

public Date getStartFixedDate()
get the property

Returns:
the property

getEndFixedDate

public Date getEndFixedDate()
get the property

Returns:
the property

getStartFixedTime

public long getStartFixedTime()
Get the StartFixedTime property.

Returns:
The StartFixedTime

setEndFixedTime

public void setEndFixedTime(long value)
Set the EndFixedTime property.

Parameters:
value - The new value for EndFixedTime

getEndFixedTime

public long getEndFixedTime()
Get the EndFixedTime property.

Returns:
The EndFixedTime