Package gov.nasa.gsfc.spdf.ssc

Class BFieldModelParameters

  • public class BFieldModelParameters
extends java.lang.Object
    This class represents B field model parameters.

    Note: This class should be defined as a base class with subclasses for each unique model but the class is used in a SOAP Web Service which cannot accommodate a class hierarchy.

    Author:
    B. Harris

    • Constructor Summary

      Constructors 
      Constructor Description
      BFieldModelParameters()
      Constructs a BFieldModelParameters object with a default value.
      BFieldModelParameters​(ExternalBFieldModel model, boolean useFixedValues, short parameterValues, float solarWindPressure, int dst, float byImf, float bzImf)
      Constructs a BFieldModelParameters object with the given attribute values.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      float getByImf()
      Gets the BY IMF value.
      float getBzImf()
      Gets the BZ IMF value.
      int getDst()
      Gets the DST value.
      ExternalBFieldModel getModel()
      Gets the model.
      short getParameterValues()
      Gets the parameter value.
      float getSolarWindPressure()
      Gets the solar wind pressure value.
      boolean isUseFixedValues()
      Gets the value specifying whether to use fixed or observed parameter values.
      void list​(java.io.PrintStream out)
      Prints this object's value to the specified output stream.
      void setByImf​(float value)
      Sets the BY IMF value (range: -100 - 100nT).
      void setBzImf​(float value)
      Sets the BZ IMF value (range: -100 - 100nT).
      void setDst​(int value)
      Sets the DST value (range: -400 - 200nT).
      void setModel​(ExternalBFieldModel value)
      Sets the model.
      void setParameterValues​(short value)
      Sets the parameter value.
      void setSolarWindPressure​(float value)
      Sets the solar wind pressure value (range: 0 - 30nP).
      void setUseFixedValues​(boolean value)
      Sets the value specifying whether to use fixed or observed parameter values.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • BFieldModelParameters

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

      • BFieldModelParameters

        public BFieldModelParameters​(ExternalBFieldModel model,
                             boolean useFixedValues,
                             short parameterValues,
                             float solarWindPressure,
                             int dst,
                             float byImf,
                             float bzImf)
        Constructs a BFieldModelParameters object with the given attribute values.
        Parameters:
        model - identifies the model to use. Maybe one of the following: T87, T89c, T96.
        useFixedValues - specifies whether to use fixed or observed parameter values. Use of observed parameter values (false value) is not yet implemented.
        parameterValues - T87 and T89c parameter values.
        solarWindPressure - solar wind pressure T96 parameter value.
        dst - DST T96 parameter value.
        byImf - BY IMF T96 parameter value.
        bzImf - BZ IMF T96 parameter value.

    • Method Detail

      • isUseFixedValues

        public boolean isUseFixedValues()
        Gets the value specifying whether to use fixed or observed parameter values.
        Returns:
        value specifying whether to use fixed or observed parameter values.
        See Also:
        setUseFixedValues(boolean)

      • setUseFixedValues

        public void setUseFixedValues​(boolean value)
        Sets the value specifying whether to use fixed or observed parameter values.

        Note: the use of observed parameter values (i.e., useFixedValues = false) is not yet implemented.

        Parameters:
        value - new value
        See Also:
        isUseFixedValues()

      • getParameterValues

        public short getParameterValues()
        Gets the parameter value.
        Returns:
        parameter value
        See Also:
        setParameterValues(short)

      • setParameterValues

        public void setParameterValues​(short value)
        Sets the parameter value. T87 and T89c only. Parameter values
           T87               T89c
   0 == 0,0+         0 == 0,0+
   1 == 1-,1,1+      1 == 1-,1,1+
   2 == 2-,2,2+      2 == 2-,2,2+
   3 == 3-,3,3+      3 == 3-,3,3+
   4 == 4-,4,4+      4 == 4-,4,4+
   5 == ≥5-         5 == 5-,5,5+
                     6 ==  ≥6
        Parameters:
        value - new value
        See Also:
        getParameterValues()

      • getSolarWindPressure

        public float getSolarWindPressure()
        Gets the solar wind pressure value. T96 only.
        Returns:
        solar wind pressure value
        See Also:
        setSolarWindPressure(float)

      • setSolarWindPressure

        public void setSolarWindPressure​(float value)
        Sets the solar wind pressure value (range: 0 - 30nP). T96 only.
        Parameters:
        value - new value
        See Also:
        getSolarWindPressure()

      • getDst

        public int getDst()
        Gets the DST value. T96 only.
        Returns:
        DST value
        See Also:
        setDst(int)

      • setDst

        public void setDst​(int value)
        Sets the DST value (range: -400 - 200nT). T96 only.
        Parameters:
        value - new value
        See Also:
        getDst()

      • getByImf

        public float getByImf()
        Gets the BY IMF value. T96 only.
        Returns:
        BY IMF value
        See Also:
        setByImf(float)

      • setByImf

        public void setByImf​(float value)
        Sets the BY IMF value (range: -100 - 100nT). T96 only.
        Parameters:
        value - new value
        See Also:
        getByImf()

      • getBzImf

        public float getBzImf()
        Gets the BZ IMF value. T96 only.
        Returns:
        BZ IMF value
        See Also:
        setBzImf(float)

      • setBzImf

        public void setBzImf​(float value)
        Sets the BZ IMF value (range: -100 - 100nT). T96 only.
        Parameters:
        value - new value
        See Also:
        getBzImf()

      • list

        public void list​(java.io.PrintStream out)
        Prints this object's value to the specified output stream. This method is useful for debugging.
        Parameters:
        out - an output stream