public class BFieldModelParameters
extends java.lang.Object
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.
Constructor and 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.
|
Modifier and Type | Method and 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.
|
public BFieldModelParameters()
public BFieldModelParameters(ExternalBFieldModel model, boolean useFixedValues, short parameterValues, float solarWindPressure, int dst, float byImf, float bzImf)
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.public ExternalBFieldModel getModel()
setModel(gov.nasa.gsfc.spdf.ssc.ExternalBFieldModel)
public void setModel(ExternalBFieldModel value)
value
- new model valuegetModel()
public boolean isUseFixedValues()
setUseFixedValues(boolean)
public void setUseFixedValues(boolean value)
Note: the use of observed parameter values (i.e., useFixedValues = false) is not yet implemented.
value
- new valueisUseFixedValues()
public short getParameterValues()
setParameterValues(short)
public void setParameterValues(short value)
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
value
- new valuegetParameterValues()
public float getSolarWindPressure()
setSolarWindPressure(float)
public void setSolarWindPressure(float value)
value
- new valuegetSolarWindPressure()
public int getDst()
setDst(int)
public void setDst(int value)
value
- new valuegetDst()
public float getByImf()
setByImf(float)
public void setByImf(float value)
value
- new valuegetByImf()
public float getBzImf()
setBzImf(float)
public void setBzImf(float value)
value
- new valuegetBzImf()
public void list(java.io.PrintStream out)
out
- an output streamSSC Feedback.
Copyright © 2003-2018 United States Government as represented by the National Aeronautics and Space Administration. No copyright is claimed in the United States under Title 17, U.S.Code. All Other Rights Reserved.