AnimationSetInfo (Unidata IDV API v6.3)

java.lang.Object
- ucar.visad.display.AnimationSetInfo

public class AnimationSetInfo
extends java.lang.Object

Holds state for constructing synthetic animation sets

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String[]`	`ENDMODELABELS` Mode for constructing set
`static java.lang.String[]`	`STARTMODELABELS` Mode for constructing set
`static int`	`TIMEMODE_CURRENT` Mode for constructing set
`static int`	`TIMEMODE_DATA` Mode for constructing set
`static int`	`TIMEMODE_FIXED` Mode for constructing set
`static int`	`TIMEMODE_RELATIVE` Mode for constructing set
`static int[]`	`TIMEMODES` Mode for constructing set

Constructor Summary

Constructors
Constructor and Description

AnimationSetInfo()
ctor

AnimationSetInfo(AnimationSetInfo that)
copy ctor

Constructors
Constructor and Description
`AnimationSetInfo()` ctor
`AnimationSetInfo(AnimationSetInfo that)` copy ctor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(AnimationSetInfo that)` _more_
`boolean`	`getActive()` Get the Active property.
`protected visad.Set`	`getBaseTimes()` Get the base times
`java.util.Date`	`getEndFixedDate()` get the property
`long`	`getEndFixedTime()` Get the EndFixedTime property.
`int`	`getEndMode()` Get the EndMode property.
`double`	`getEndOffsetMinutes()` Get the EndOffsetMinutes property.
`double`	`getIntervalMinutes()` Get the IntervalMinutes property.
`boolean`	`getIsTimeDriver()` Is this the ViewManager time driver?
`double`	`getPollMinutes()` Get the PollMinutes property.
`double`	`getRoundTo()` Get the RoundTo property.
`java.util.Date`	`getStartFixedDate()` get the property
`long`	`getStartFixedTime()` Get the StartFixedTime property.
`int`	`getStartMode()` Get the StartMode property.
`double`	`getStartOffsetMinutes()` Get the StartOffsetMinutes property.
`protected visad.Set`	`makeTimeSet(DisplayMaster displayMaster)` Create the time set
`static double`	`roundTo(double roundTo, double seconds)` Utility to round the given seconds
`void`	`setActive(boolean value)` Set the Active property.
`protected void`	`setBaseTimes(visad.Set times)` Set the base time
`void`	`setEndFixedTime(java.util.Date d)` set 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`	`setIntervalMinutes(double value)` Set the IntervalMinutes property.
`void`	`setIsTimeDriver(boolean yesorno)` Set whether this the ViewManager time driver
`void`	`setPollMinutes(double value)` Set the PollMinutes property.
`void`	`setRoundTo(double value)` Set the RoundTo property.
`void`	`setStartFixedTime(java.util.Date d)` set 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`	`usingCurrentTime()` Do we use the now time for either our start or end time

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TIMEMODE_DATA
```
public static final int TIMEMODE_DATA
```
    Mode for constructing set
    
    See Also:
    
    Constant Field Values
  - TIMEMODE_CURRENT
```
public static final int TIMEMODE_CURRENT
```
    Mode for constructing set
    
    See Also:
    
    Constant Field Values
  - TIMEMODE_FIXED
```
public static final int TIMEMODE_FIXED
```
    Mode for constructing set
    
    See Also:
    
    Constant Field Values
  - TIMEMODE_RELATIVE
```
public static final int TIMEMODE_RELATIVE
```
    Mode for constructing set
    
    See Also:
    
    Constant Field Values
  - TIMEMODES
```
public static int[] TIMEMODES
```
    Mode for constructing set
  - STARTMODELABELS
```
public static java.lang.String[] STARTMODELABELS
```
    Mode for constructing set
  - ENDMODELABELS
```
public static java.lang.String[] ENDMODELABELS
```
    Mode for constructing set
- Constructor Detail
  - AnimationSetInfo
```
public AnimationSetInfo()
```
    ctor
  - AnimationSetInfo
```
public AnimationSetInfo(AnimationSetInfo that)
```
    copy ctor
    
    Parameters:
    
    that - object to copy from
- Method Detail
  - equals
```
public boolean equals(AnimationSetInfo that)
```
    _more_
    
    Parameters:
    
    that - _more_
    
    Returns:
    
    _more_
  - roundTo
```
public static double roundTo(double roundTo,
                             double seconds)
```
    Utility to round the given seconds
    
    Parameters:
    
    roundTo - the seconds to round to
    
    seconds - time to round
    
    Returns:
    
    Rounded value
  - setBaseTimes
```
protected void setBaseTimes(visad.Set times)
```
    Set the base time
    
    Parameters:
    
    times - the times
  - getBaseTimes
```
protected visad.Set getBaseTimes()
```
    Get the base times
    
    Returns:
    
    the base times
  - makeTimeSet
```
protected visad.Set makeTimeSet(DisplayMaster displayMaster)
                         throws visad.VisADException,
                                java.rmi.RemoteException
```
    Create the time set
    
    Parameters:
    
    displayMaster - The display master we're in
    
    Returns:
    
    The time set
    
    Throws:
    
    java.rmi.RemoteException - On badness
    
    visad.VisADException - On badness
  - usingCurrentTime
```
public boolean usingCurrentTime()
```
    Do we use the now time for either our start or end time
    
    Returns:
    
    Use now time
  - setActive
```
public void setActive(boolean value)
```
    Set the Active property.
    
    Parameters:
    
    value - The new value for Active
  - getActive
```
public boolean getActive()
```
    Get the Active property.
    
    Returns:
    
    The Active
  - 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
  - setIntervalMinutes
```
public void setIntervalMinutes(double value)
```
    Set the IntervalMinutes property.
    
    Parameters:
    
    value - The new value for IntervalMinutes
  - getIntervalMinutes
```
public double getIntervalMinutes()
```
    Get the IntervalMinutes property.
    
    Returns:
    
    The IntervalMinutes
  - setPollMinutes
```
public void setPollMinutes(double value)
```
    Set the PollMinutes property.
    
    Parameters:
    
    value - The new value for PollMinutes
  - getPollMinutes
```
public double getPollMinutes()
```
    Get the PollMinutes property.
    
    Returns:
    
    The PollMinutes
  - 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
  - setRoundTo
```
public void setRoundTo(double value)
```
    Set the RoundTo property.
    
    Parameters:
    
    value - The new value for RoundTo
  - getRoundTo
```
public double getRoundTo()
```
    Get the RoundTo property.
    
    Returns:
    
    The RoundTo
  - setStartFixedTime
```
public void setStartFixedTime(long value)
```
    Set the StartFixedTime property.
    
    Parameters:
    
    value - The new value for StartFixedTime
  - setStartFixedTime
```
public void setStartFixedTime(java.util.Date d)
```
    set property
    
    Parameters:
    
    d - property
  - setEndFixedTime
```
public void setEndFixedTime(java.util.Date d)
```
    set property
    
    Parameters:
    
    d - property
  - getStartFixedDate
```
public java.util.Date getStartFixedDate()
```
    get the property
    
    Returns:
    
    property
  - getEndFixedDate
```
public java.util.Date getEndFixedDate()
```
    get the property
    
    Returns:
    
    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
  - getIsTimeDriver
```
public boolean getIsTimeDriver()
```
    Is this the ViewManager time driver?
    
    Returns:
    
    true if it is the time driver
  - setIsTimeDriver
```
public void setIsTimeDriver(boolean yesorno)
```
    Set whether this the ViewManager time driver
    
    Parameters:
    
    yesorno - true to be the time driver

Class AnimationSetInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TIMEMODE_DATA

TIMEMODE_CURRENT

TIMEMODE_FIXED

TIMEMODE_RELATIVE

TIMEMODES

STARTMODELABELS

ENDMODELABELS

Constructor Detail

AnimationSetInfo

AnimationSetInfo

Method Detail

equals

roundTo

setBaseTimes

getBaseTimes

makeTimeSet

usingCurrentTime

setActive

getActive

setStartMode

getStartMode

setEndMode

getEndMode

setIntervalMinutes

getIntervalMinutes

setPollMinutes

getPollMinutes

setStartOffsetMinutes

getStartOffsetMinutes

setEndOffsetMinutes

getEndOffsetMinutes

setRoundTo

getRoundTo

setStartFixedTime

setStartFixedTime

setEndFixedTime

getStartFixedDate

getEndFixedDate

getStartFixedTime

setEndFixedTime

getEndFixedTime

getIsTimeDriver

setIsTimeDriver