Package gov.nasa.gsfc.spdf.ssc

Class BFieldTraceOptions

java.lang.Object

gov.nasa.gsfc.spdf.ssc.BFieldTraceOptions

public class BFieldTraceOptions
extends java.lang.Object

This class represents "B field trace" 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
BFieldTraceOptions()	Constructs a BFieldTraceOptions with a default value of CoordinateSystem.GEO, Hemisphere.SOUTH, footpointLatitude = footpointLongitude = fieldLineLength = false.
BFieldTraceOptions(CoordinateSystem coordinateSystem, Hemisphere hemisphere, boolean footpointLatitude, boolean footpointLongitude, boolean fieldLineLength)	Constructs a BFieldTraceOptions with the given attribute values.

Method Summary

Modifier and Type	Method	Description
CoordinateSystem	getCoordinateSystem()	Gets the coordinate system value.
Hemisphere	getHemisphere()	Gets the magnetic hemisphere value.
boolean	isFieldLineLength()	Gets the value indicating whether field line length values are to be output.
boolean	isFootpointLatitude()	Gets the value indicating whether footpoint latitude values are to be output.
boolean	isFootpointLongitude()	Gets the value indicating whether footpoint longitude values are to be output.
void	setCoordinateSystem(CoordinateSystem value)	Sets the coordinate system value.
void	setFieldLineLength(boolean value)	Sets the value indicating whether field line length values are to be output.
void	setFootpointLatitude(boolean value)	Sets the value indicating whether footpoint latitude values are to be output.
void	setFootpointLongitude(boolean value)	Sets the value indicating whether footpoint longitude values are to be output.
void	setHemisphere(Hemisphere value)	Set the magnetic hemisphere value.

Methods inherited from class java.lang.Object

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

Constructor Detail

BFieldTraceOptions

public BFieldTraceOptions()

Constructs a BFieldTraceOptions with a default value of CoordinateSystem.GEO, Hemisphere.SOUTH, footpointLatitude = footpointLongitude = fieldLineLength = false.

BFieldTraceOptions

public BFieldTraceOptions(CoordinateSystem coordinateSystem,
                          Hemisphere hemisphere,
                          boolean footpointLatitude,
                          boolean footpointLongitude,
                          boolean fieldLineLength)

Constructs a BFieldTraceOptions with the given attribute values.

Parameters:

coordinateSystem - identifies the coordinate system. Valid values are GEO and GM.

hemisphere - identifies the magnetic hemisphere

footpointLatitude - specifies whether footpoint latitude values are to be output

footpointLongitude - specifies whether footpoint longitude values are to be output

fieldLineLength - specifies whether field line length values are to be output

Method Detail

getCoordinateSystem

public CoordinateSystem getCoordinateSystem()

Gets the coordinate system value.

Returns:

coordinate system value

See Also:

setCoordinateSystem(gov.nasa.gsfc.spdf.ssc.CoordinateSystem)

setCoordinateSystem

public void setCoordinateSystem(CoordinateSystem value)

Sets the coordinate system value. Valid values are GEO and GM.

Parameters:

value - new value

See Also:

getCoordinateSystem(), CoordinateSystem

getHemisphere

public Hemisphere getHemisphere()

Gets the magnetic hemisphere value.

Returns:

hemisphere value

See Also:

setHemisphere(gov.nasa.gsfc.spdf.ssc.Hemisphere)

setHemisphere

public void setHemisphere(Hemisphere value)

Set the magnetic hemisphere value.

Parameters:

value - new value

See Also:

getHemisphere()

isFootpointLatitude

public boolean isFootpointLatitude()

Gets the value indicating whether footpoint latitude values are to be output.

Returns:

true if footpoint latitude values are to be output and false if not

See Also:

setFootpointLatitude(boolean)

setFootpointLatitude

public void setFootpointLatitude(boolean value)

Sets the value indicating whether footpoint latitude values are to be output.

Parameters:

value - new value

See Also:

isFootpointLatitude()

isFootpointLongitude

public boolean isFootpointLongitude()

Gets the value indicating whether footpoint longitude values are to be output.

Returns:

true if footpoint longitude values are to be output and false if not

See Also:

setFootpointLongitude(boolean)

setFootpointLongitude

public void setFootpointLongitude(boolean value)

Sets the value indicating whether footpoint longitude values are to be output.

Parameters:

value - new value

See Also:

isFootpointLongitude()

isFieldLineLength

public boolean isFieldLineLength()

Gets the value indicating whether field line length values are to be output.

Returns:

true if field line length values are to be output and false if not

See Also:

setFieldLineLength(boolean)

setFieldLineLength

public void setFieldLineLength(boolean value)

Sets the value indicating whether field line length values are to be output.

Parameters:

value - new value

See Also:

isFieldLineLength()