Package gov.nasa.gsfc.spdf.ssc

Class BFieldModelOptions

java.lang.Object

gov.nasa.gsfc.spdf.ssc.BFieldModelOptions

public class BFieldModelOptions
extends java.lang.Object

This class represents B field model options.

Version:

$Revison: $

Author:

B. Harris

Constructor Summary

Constructors

Constructor	Description
BFieldModelOptions()	Constructs a BFieldModelOptions object with a default value.
BFieldModelOptions(InternalBFieldModel internalModel, BFieldModelParameters externalModel, double fieldLinesStopAltitude)	Constructs a BFieldModelOptions object with the given attribute values.

Method Summary

Modifier and Type	Method	Description
BFieldModelParameters	getExternalModel()	Gets the external B field model options.
double	getFieldLinesStopAltitude()	Gets the stop altitude for downward tracing of field lines (Kilometers).
InternalBFieldModel	getInternalModel()	Gets the internal B field model that is to be used.
void	list(java.io.PrintStream out)	Prints this object's value to the specified output stream.
void	setExternalModel(BFieldModelParameters value)	Sets the external B field model options.
void	setFieldLinesStopAltitude(double value)	Sets the stop altitude for downward tracing of field lines (Kilometers).
void	setInternalModel(InternalBFieldModel value)	Sets the internal B field model that is to be used.

Methods inherited from class java.lang.Object

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

Constructor Detail

BFieldModelOptions

public BFieldModelOptions()

Constructs a BFieldModelOptions object with a default value.

BFieldModelOptions

public BFieldModelOptions(InternalBFieldModel internalModel,
                          BFieldModelParameters externalModel,
                          double fieldLinesStopAltitude)

Constructs a BFieldModelOptions object with the given attribute values.

Parameters:

internalModel - specifies the internal B field model to use.

externalModel - specifies the external B field model to use. null indicates that no external model is to be used.

fieldLinesStopAltitude - specifies the stop altitude for downward tracing of field lines (Kilometers).

Method Detail

getInternalModel

public InternalBFieldModel getInternalModel()

Gets the internal B field model that is to be used.

Returns:

internal B field model

See Also:

setInternalModel(gov.nasa.gsfc.spdf.ssc.InternalBFieldModel)

setInternalModel

public void setInternalModel(InternalBFieldModel value)

Sets the internal B field model that is to be used.

Parameters:

value - new value

See Also:

getInternalModel()

getExternalModel

public BFieldModelParameters getExternalModel()

Gets the external B field model options.

Returns:

external B field model options

See Also:

setExternalModel(gov.nasa.gsfc.spdf.ssc.BFieldModelParameters)

setExternalModel

public void setExternalModel(BFieldModelParameters value)

Sets the external B field model options.

Parameters:

value - new value

See Also:

getExternalModel()

getFieldLinesStopAltitude

public double getFieldLinesStopAltitude()

Gets the stop altitude for downward tracing of field lines (Kilometers).

Returns:

stop altitude for downward tracing of field lines

See Also:

setFieldLinesStopAltitude(double)

setFieldLinesStopAltitude

public void setFieldLinesStopAltitude(double value)

Sets the stop altitude for downward tracing of field lines (Kilometers).

Parameters:

value - stop altitude for downward tracing of field lines

See Also:

getFieldLinesStopAltitude()

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