Package gov.nasa.gsfc.spdf.ssc

Class ValueOptions

  • All Implemented Interfaces:
    java.lang.Cloneable
    public class ValueOptions
extends java.lang.Object
implements java.lang.Cloneable
    This class represents value listing options. A description of these values is available at the Satellite Situation Center help.
    Version:
    $Revison: $
    Author:
    B. Harris

    • Constructor Summary

      Constructors 
      Constructor Description
      ValueOptions()
      Constructs a ValueOptions object with a default value.
      ValueOptions​(boolean radialDistance, boolean bFieldStrength, boolean dipoleLValue, boolean dipoleInvLat)
      Constructs a ValueOptions object with the given attribute values.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object clone()  
      boolean isBFieldStrength()
      Gets the value indicating whether the B field strength value is to be included in the listing.
      boolean isDipoleInvLat()
      Gets the value indicating whether the dipole invariant latitudes value is to be included in the listing.
      boolean isDipoleLValue()
      Gets the value indicating whether the dipole L value is to be included in the listing.
      boolean isRadialDistance()
      Gets the value indicating whether the radial distance value is to be included in the listing.
      void setBFieldStrength​(boolean value)
      Sets the value indicating whether the B field strength value is to be included in the listing.
      void setDipoleInvLat​(boolean value)
      Sets the value indicating whether the dipole invariant latitudes value is to be included in the listing.
      void setDipoleLValue​(boolean value)
      Sets the value indicating whether the dipole L value is to be included in the listing.
      void setRadialDistance​(boolean value)
      Sets the value indicating whether the radial distance value is to be included in the listing.

      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ValueOptions

        public ValueOptions()
        Constructs a ValueOptions object with a default value.

      • ValueOptions

        public ValueOptions​(boolean radialDistance,
                    boolean bFieldStrength,
                    boolean dipoleLValue,
                    boolean dipoleInvLat)
        Constructs a ValueOptions object with the given attribute values.
        Parameters:
        radialDistance - specifies whether the radial distance value is to be included in the listing.
        bFieldStrength - specifies whether the B field strength value is to be included in the listing.
        dipoleLValue - specifies whether the dipole L value is to be included in the listing.
        dipoleInvLat - specifies whether the dipole invariant latitude value is to be included in the listing.

    • Method Detail

      • isRadialDistance

        public boolean isRadialDistance()
        Gets the value indicating whether the radial distance value is to be included in the listing.
        Returns:
        true if the radial distance value is to be included in the listing, false if not
        See Also:
        setRadialDistance(boolean)

      • setRadialDistance

        public void setRadialDistance​(boolean value)
        Sets the value indicating whether the radial distance value is to be included in the listing.
        Parameters:
        value - new value
        See Also:
        isRadialDistance()

      • isBFieldStrength

        public boolean isBFieldStrength()
        Gets the value indicating whether the B field strength value is to be included in the listing.
        Returns:
        true if the B field strength value is to be included in the listing, false if not
        See Also:
        setBFieldStrength(boolean)

      • setBFieldStrength

        public void setBFieldStrength​(boolean value)
        Sets the value indicating whether the B field strength value is to be included in the listing.
        Parameters:
        value - new value
        See Also:
        isBFieldStrength()

      • isDipoleLValue

        public boolean isDipoleLValue()
        Gets the value indicating whether the dipole L value is to be included in the listing.
        Returns:
        true if the dipole L value is to be included in the listing, false if not
        See Also:
        setDipoleLValue(boolean)

      • setDipoleLValue

        public void setDipoleLValue​(boolean value)
        Sets the value indicating whether the dipole L value is to be included in the listing.
        Parameters:
        value - new value
        See Also:
        isDipoleLValue()

      • isDipoleInvLat

        public boolean isDipoleInvLat()
        Gets the value indicating whether the dipole invariant latitudes value is to be included in the listing.
        Returns:
        true if the dipole invariant latitudes value is to be included in the listing, false if not
        See Also:
        setDipoleInvLat(boolean)

      • setDipoleInvLat

        public void setDipoleInvLat​(boolean value)
        Sets the value indicating whether the dipole invariant latitudes value is to be included in the listing.
        Parameters:
        value - new value
        See Also:
        isDipoleInvLat()

      • clone

        public java.lang.Object clone()
        Overrides:
        clone in class java.lang.Object