gov.nasa.gsfc.spdf.ssc
Class OrbitGraphOptions

java.lang.Object
  gov.nasa.gsfc.spdf.ssc.GraphOptions
      gov.nasa.gsfc.spdf.ssc.OrbitGraphOptions

public class OrbitGraphOptions
extends GraphOptions

This class represents options for an SSC orbit graphing request.

Version:

$Revison: $

Author:

B. Harris

Constructor Summary

OrbitGraphOptions()
Constructs a OrbitGraphOptions object with default attribute values.

OrbitGraphOptions(CoordinateSystem coordinateSystem, boolean combined, boolean xyView, boolean xzView, boolean yzView, boolean xrView, boolean sunToRight, GraphScale manualScale, boolean evenAxesScales, boolean showBowShockMagnetopause, float solarWindPressure, float imfBz, GraphFormatOptions formatOptions)
Constructs a GraphOptions object with the given attribute values.

Method Summary

CoordinateSystem	getCoordinateSystem() Gets the coordinateSystem value.
GraphFormatOptions	getFormatOptions() Gets the output format options.
float	getImfBz() Gets the IMF Bz value to use when displaying the bow shock and magnetopause (units of nT).
GraphScale	getManualScale() Gets the manual scale value.
float	getSolarWindPressure() Gets the solar wind pressure value to use when displaying the bow shock and magnetopause (units of nP).
boolean	isCombined() Gets the combined value.
boolean	isEvenAxesScales() Get whether even axes scales or even axes lengths should be employed.
boolean	isShowBowShockMagnetopause() Gets whether the bow shock and magnetopause should be shown.
boolean	isSunToRight() Gets the graphs orientation with respect to the sun.
boolean	isXrView() Gets the xrView value.
boolean	isXyView() Gets the xyView value.
boolean	isXzView() Gets the xzView value.
boolean	isYzView() Gets the yzView value.
void	setCombined(boolean value) Sets the combined value.
void	setCoordinateSystem(CoordinateSystem value) Sets the coordinateSystem value.
void	setEvenAxesScales(boolean value) Sets whether even axes scales or even axes lengths should be employed.
void	setFormatOptions(GraphFormatOptions value) Sets the output format options.
void	setImfBz(float value) Sets the IMF Bz value to use when displaying the bow shock and magnetopause (units of nT).
void	setManualScale(GraphScale value) Sets the manual scale value.
void	setShowBowShockMagnetopause(boolean value) Sets whether the bow shock and magnetopause should be shown (only valid for GSE coordinates).
void	setSolarWindPressure(float value) Sets the solar wind pressure value to use when displaying the bow shock and magnetopause (units of nP).
void	setSunToRight(boolean value) Sets the graphs orientation with respect to the sun.
void	setXrView(boolean value) Sets the xrView value.
void	setXyView(boolean value) Sets the xyView value.
void	setXzView(boolean value) Sets the xzView value.
void	setYzView(boolean value) Sets the yzView value.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrbitGraphOptions

public OrbitGraphOptions()

Constructs a OrbitGraphOptions object with default attribute values.

OrbitGraphOptions

public OrbitGraphOptions(CoordinateSystem coordinateSystem,
                         boolean combined,
                         boolean xyView,
                         boolean xzView,
                         boolean yzView,
                         boolean xrView,
                         boolean sunToRight,
                         GraphScale manualScale,
                         boolean evenAxesScales,
                         boolean showBowShockMagnetopause,
                         float solarWindPressure,
                         float imfBz,
                         GraphFormatOptions formatOptions)

Constructs a GraphOptions object with the given attribute values.

Parameters:

coordinateSystem - the coordinate system

combined - indicates whether the specified views should produce seperate graph files or a single combined one

xyView - indicates whether an XY view of the graph should be produced

xzView - indicates whether an XZ view of the graph should be produced

yzView - indicates whether an YZ view of the graph should be produced

xrView - indicates whether an XR view of the graph should be produced

sunToRight - graph's orientation with respect to the Sun

manualScale - specifies the manual scale values

evenAxesScales - specifies whether even axes scales or even axes lengths should be employed

showBowShockMagnetopause - specifies whether to show the bow shock and magnetopause

solarWindPressure - solar wind pressure to use when displaying the bow shock and magnetopause

imfBz - IMF Bz value to use when displaying the bow shock and magnetopause

formatOptions - output format options

Method Detail

getCoordinateSystem

public CoordinateSystem getCoordinateSystem()

Gets the coordinateSystem value.

Returns:

coordinateSystem value.

See Also:

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

setCoordinateSystem

public void setCoordinateSystem(CoordinateSystem value)

Sets the coordinateSystem value.

Parameters:

value - new value

See Also:

getCoordinateSystem()

isCombined

public boolean isCombined()

Gets the combined value.

Returns:

combined value

See Also:

setCombined(boolean)

setCombined

public void setCombined(boolean value)

Sets the combined value.

Parameters:

value - new combined value

See Also:

isCombined()

isXyView

public boolean isXyView()

Gets the xyView value.

Returns:

xyView value

See Also:

setXyView(boolean)

setXyView

public void setXyView(boolean value)

Sets the xyView value.

Parameters:

value - new xyView value

See Also:

isXyView()

isXzView

public boolean isXzView()

Gets the xzView value.

Returns:

xzView value

See Also:

setXzView(boolean)

setXzView

public void setXzView(boolean value)

Sets the xzView value.

Parameters:

value - new xzView value

See Also:

isXzView()

isYzView

public boolean isYzView()

Gets the yzView value.

Returns:

yzView value

See Also:

setYzView(boolean)

setYzView

public void setYzView(boolean value)

Sets the yzView value.

Parameters:

value - new yzView value

See Also:

isYzView()

isXrView

public boolean isXrView()

Gets the xrView value.

Returns:

xrView value

See Also:

setXrView(boolean)

setXrView

public void setXrView(boolean value)

Sets the xrView value.

Parameters:

value - new xrView value

See Also:

isXrView()

isSunToRight

public boolean isSunToRight()

Gets the graphs orientation with respect to the sun.

Returns:

whether graph is oriented with the sun to the right

See Also:

setSunToRight(boolean)

setSunToRight

public void setSunToRight(boolean value)

Sets the graphs orientation with respect to the sun.

Parameters:

value - whether graph is oriented with the sun to the right

See Also:

isSunToRight()

getManualScale

public GraphScale getManualScale()

Gets the manual scale value.

Returns:

manual scale value

See Also:

setManualScale(gov.nasa.gsfc.spdf.ssc.GraphScale)

setManualScale

public void setManualScale(GraphScale value)

Sets the manual scale value. A null value indicates that automatic scaling should be employed.

Parameters:

value - new manual scale value

See Also:

getManualScale()

isEvenAxesScales

public boolean isEvenAxesScales()

Get whether even axes scales or even axes lengths should be employed.

Returns:

whether an even axis scale is to be employed.

See Also:

setEvenAxesScales(boolean)

setEvenAxesScales

public void setEvenAxesScales(boolean value)

Sets whether even axes scales or even axes lengths should be employed.

Parameters:

value - new even exes scales value. A false value indicates that even axes lengths should be used instead.

See Also:

isEvenAxesScales()

isShowBowShockMagnetopause

public boolean isShowBowShockMagnetopause()

Gets whether the bow shock and magnetopause should be shown.

Returns:

true if bow shock and magnetopause are to be shown. Otherwise, false.

See Also:

setShowBowShockMagnetopause(boolean)

setShowBowShockMagnetopause

public void setShowBowShockMagnetopause(boolean value)

Sets whether the bow shock and magnetopause should be shown (only valid for GSE coordinates).

Parameters:

value - new value

See Also:

isShowBowShockMagnetopause()

getSolarWindPressure

public float getSolarWindPressure()

Gets the solar wind pressure value to use when displaying the bow shock and magnetopause (units of nP).

Returns:

solar wind pressure (units of nP)

See Also:

setSolarWindPressure(float)

setSolarWindPressure

public void setSolarWindPressure(float value)

Sets the solar wind pressure value to use when displaying the bow shock and magnetopause (units of nP).

Parameters:

value - new solar wind pressure (units of nP)

See Also:

getSolarWindPressure()

getImfBz

public float getImfBz()

Gets the IMF Bz value to use when displaying the bow shock and magnetopause (units of nT).

Returns:

IMF Bz value (units of nT)

See Also:

setImfBz(float)

setImfBz

public void setImfBz(float value)

Sets the IMF Bz value to use when displaying the bow shock and magnetopause (units of nT).

Parameters:

value - new IMF Bz value (units of nT)

See Also:

getImfBz()

getFormatOptions

public GraphFormatOptions getFormatOptions()

Gets the output format options.

Returns:

output format options

See Also:

setFormatOptions(gov.nasa.gsfc.spdf.ssc.GraphFormatOptions)

setFormatOptions

public void setFormatOptions(GraphFormatOptions value)

Sets the output format options.

Parameters:

value - new format options. A null value indicates that default values should be used.

See Also:

getFormatOptions()