Package gov.nasa.gsfc.spdf.ssc

Class DistanceFromOptions

  • All Implemented Interfaces:
    java.lang.Cloneable
    public class DistanceFromOptions
extends java.lang.Object
implements java.lang.Cloneable
    This class represents "distance from" 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
      DistanceFromOptions()
      Constructs a DistanceFromOptions object with a default value.
      DistanceFromOptions​(boolean neutralSheet, boolean bowShock, boolean mPause, boolean bGseXYZ)
      Constructs a DistanceFromOptions object with the given attribute values.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object clone()  
      boolean isBGseXYZ()
      Gets the value indicating whether the distance between the spacecraft and the ???
      boolean isBowShock()
      Gets the value indicating whether the distance between the spacecraft and the bow shock is to be included in the listing.
      boolean isMPause()
      Gets the value indicating whether the distance between the spacecraft and the magnetopause is to be included in the listing.
      boolean isNeutralSheet()
      Gets the value indicating whether the distance between the spacecraft and the neutral sheet is to be included in the listing.
      void setBGseXYZ​(boolean value)
      Sets the value indicating whether the distance between the spacecraft and the ???
      void setBowShock​(boolean value)
      Sets the value indicating whether the distance between the spacecraft and the bow shock is to be included in the listing.
      void setMPause​(boolean value)
      Sets the value indicating whether the distance between the spacecraft and the magnetopause is to be included in the listing.
      void setNeutralSheet​(boolean value)
      Sets the value indicating whether the distance between the spacecraft and the neutral sheet 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

      • DistanceFromOptions

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

      • DistanceFromOptions

        public DistanceFromOptions​(boolean neutralSheet,
                           boolean bowShock,
                           boolean mPause,
                           boolean bGseXYZ)
        Constructs a DistanceFromOptions object with the given attribute values.
        Parameters:
        neutralSheet - specifies whether the distance between the spacecraft and the neutral sheet is to be included in the listing.
        bowShock - specifies whether the distance between the spacecraft and the bow shock is to be included in the listing.
        mPause - specifies whether the distance between the spacecraft and the magnetopause is to be included in the listing.
        bGseXYZ - specifies whether the distance between the spacecraft and the ??? is to be included in the listing.

    • Method Detail

      • isNeutralSheet

        public boolean isNeutralSheet()
        Gets the value indicating whether the distance between the spacecraft and the neutral sheet is to be included in the listing.
        Returns:
        true if the distance between the spacecraft and the neutral sheet is to be included in the list, false if not
        See Also:
        setNeutralSheet(boolean)

      • setNeutralSheet

        public void setNeutralSheet​(boolean value)
        Sets the value indicating whether the distance between the spacecraft and the neutral sheet is to be included in the listing.
        Parameters:
        value - new value
        See Also:
        isNeutralSheet()

      • isBowShock

        public boolean isBowShock()
        Gets the value indicating whether the distance between the spacecraft and the bow shock is to be included in the listing.
        Returns:
        true if the distance between the spacecraft and the bow shock is to be included in the list, false if not
        See Also:
        setBowShock(boolean)

      • setBowShock

        public void setBowShock​(boolean value)
        Sets the value indicating whether the distance between the spacecraft and the bow shock is to be included in the listing.
        Parameters:
        value - new value
        See Also:
        isBowShock()

      • isMPause

        public boolean isMPause()
        Gets the value indicating whether the distance between the spacecraft and the magnetopause is to be included in the listing.
        Returns:
        true if the distance between the spacecraft and the magnetopause is to be included in the list, false if not
        See Also:
        setMPause(boolean)

      • setMPause

        public void setMPause​(boolean value)
        Sets the value indicating whether the distance between the spacecraft and the magnetopause is to be included in the listing.
        Parameters:
        value - new value
        See Also:
        isMPause()

      • isBGseXYZ

        public boolean isBGseXYZ()
        Gets the value indicating whether the distance between the spacecraft and the ??? is to be included in the listing.
        Returns:
        true if the distance between the spacecraft and the ??? is to be included in the list, false if not
        See Also:
        setBGseXYZ(boolean)

      • setBGseXYZ

        public void setBGseXYZ​(boolean value)
        Sets the value indicating whether the distance between the spacecraft and the ??? is to be included in the listing.
        Parameters:
        value - new value
        See Also:
        isBGseXYZ()

      • clone

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