Package gov.nasa.gsfc.spdf.ssc

Class MapProjectionGraphOptions

java.lang.Object

gov.nasa.gsfc.spdf.ssc.GraphOptions

gov.nasa.gsfc.spdf.ssc.MapProjectionGraphOptions

public class MapProjectionGraphOptions
extends GraphOptions

This class represents options for an SSC Mapped Projection plot request.

Version:

$Revison: $

Author:

B. Harris

Constructor Summary

Constructors

Constructor	Description
MapProjectionGraphOptions()	Constructs a MapProjectionGraphOptions object with a default value that specifies a radial trace, GEO with continents, cylindrical projection, and no ground stations.
MapProjectionGraphOptions(Trace trace, ProjectionCoordinateSystem coordinateSystem, boolean showContinents, MapProjection projection, java.util.List<java.lang.String> groundStations, MapLimits mapLimits, PolarMapOrientation polarMapOrientation, float longitudeVerticalDown, java.lang.String title, GraphFormatOptions formatOptions)	Constructs a MapProjectionGraphOptions object with the given attribute values.

Method Summary

Modifier and Type	Method	Description
ProjectionCoordinateSystem	getCoordinateSystem()	Gets the coordinate system option.
GraphFormatOptions	getFormatOptions()	Gets the output format options.
java.util.List<java.lang.String>	getGroundStations()	Gets the ground station identifiers.
float	getLongitudeVerticalDown()	Gets the longitude vertical down value.
MapLimits	getMapLimits()	Gets the map limits.
PolarMapOrientation	getPolarMapOrientation()	Gets the polar map orientation option.
MapProjection	getProjection()	Gets the map projection option.
java.lang.String	getTitle()	Gets the title value.
Trace	getTrace()	Gets the trace option.
boolean	isShowContinents()	Gets the flag indicating whether continents are to be shown.
void	list(java.io.PrintStream out)	Prints this object's value to the specified output stream.
void	setCoordinateSystem(ProjectionCoordinateSystem value)	Sets the coordinate system option.
void	setFormatOptions(GraphFormatOptions value)	Sets the output format options.
void	setGroundStations(java.util.List<java.lang.String> value)	Sets the ground station identifiers.
void	setLongitudeVerticalDown(float value)	Sets the longitude vertical down value.
void	setMapLimits(MapLimits value)	Sets the map limits.
void	setPolarMapOrientation(PolarMapOrientation value)	Sets the polar map orientation option.
void	setProjection(MapProjection value)	Sets the map projection option.
void	setShowContinents(boolean value)	Sets the flag indicating whether continents are to be shown.
void	setTitle(java.lang.String value)	Sets the title value.
void	setTrace(Trace value)	Sets the trace option.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapProjectionGraphOptions

public MapProjectionGraphOptions()

Constructs a MapProjectionGraphOptions object with a default value that specifies a radial trace, GEO with continents, cylindrical projection, and no ground stations.

MapProjectionGraphOptions

public MapProjectionGraphOptions(Trace trace,
                                 ProjectionCoordinateSystem coordinateSystem,
                                 boolean showContinents,
                                 MapProjection projection,
                                 java.util.List<java.lang.String> groundStations,
                                 MapLimits mapLimits,
                                 PolarMapOrientation polarMapOrientation,
                                 float longitudeVerticalDown,
                                 java.lang.String title,
                                 GraphFormatOptions formatOptions)

Constructs a MapProjectionGraphOptions object with the given attribute values.

Parameters:

trace - trace options

coordinateSystem - coordinate system

showContinents - whether to show continents

projection - type of map projection

groundStations - ground stations to show

mapLimits - mapping limits

polarMapOrientation - polar map orientation

longitudeVerticalDown - longitude vertical down value

title - graph title

formatOptions - graph format options

Method Detail

getTrace

public Trace getTrace()

Gets the trace option.

Returns:

trace option value

See Also:

setTrace(gov.nasa.gsfc.spdf.ssc.Trace)

setTrace

public void setTrace(Trace value)

Sets the trace option.

Parameters:

value - new trace option value

See Also:

getTrace()

getCoordinateSystem

public ProjectionCoordinateSystem getCoordinateSystem()

Gets the coordinate system option.

Returns:

coordinate system option

See Also:

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

setCoordinateSystem

public void setCoordinateSystem(ProjectionCoordinateSystem value)

Sets the coordinate system option.

Parameters:

value - new coordinate system value

See Also:

getCoordinateSystem()

isShowContinents

public boolean isShowContinents()

Gets the flag indicating whether continents are to be shown. This option is only effective for coordinateSystem = GEO. Continents are not shown for other coordinate systems.

Returns:

true if continents are to be shown. false if continents are not to be shown.

See Also:

setShowContinents(boolean)

setShowContinents

public void setShowContinents(boolean value)

Sets the flag indicating whether continents are to be shown.

Parameters:

value - new flag value

See Also:

isShowContinents()

getProjection

public MapProjection getProjection()

Gets the map projection option.

Returns:

projection option

See Also:

setProjection(gov.nasa.gsfc.spdf.ssc.MapProjection)

setProjection

public void setProjection(MapProjection value)

Sets the map projection option.

Parameters:

value - new projection value

See Also:

getProjection()

getGroundStations

public java.util.List<java.lang.String> getGroundStations()

Gets the ground station identifiers.

Returns:

list of ground station identifiers

See Also:

setGroundStations(java.util.List<java.lang.String>)

setGroundStations

public void setGroundStations(java.util.List<java.lang.String> value)

Sets the ground station identifiers.

Parameters:

value - new ground station identifiers

See Also:

getGroundStations()

getMapLimits

public MapLimits getMapLimits()

Gets the map limits.

Returns:

map limits

See Also:

setMapLimits(gov.nasa.gsfc.spdf.ssc.MapLimits)

setMapLimits

public void setMapLimits(MapLimits value)

Sets the map limits.

Parameters:

value - new map limits

See Also:

getMapLimits()

getPolarMapOrientation

public PolarMapOrientation getPolarMapOrientation()

Gets the polar map orientation option.

Returns:

polar map orientation

See Also:

setPolarMapOrientation(gov.nasa.gsfc.spdf.ssc.PolarMapOrientation)

setPolarMapOrientation

public void setPolarMapOrientation(PolarMapOrientation value)

Sets the polar map orientation option.

Parameters:

value - new polar map orientation

See Also:

getPolarMapOrientation()

getLongitudeVerticalDown

public float getLongitudeVerticalDown()

Gets the longitude vertical down value.

Returns:

longitude vertical down value

See Also:

setLongitudeVerticalDown(float)

setLongitudeVerticalDown

public void setLongitudeVerticalDown(float value)

Sets the longitude vertical down value.

Parameters:

value - new longitude vertical down value

See Also:

getLongitudeVerticalDown()

getTitle

public java.lang.String getTitle()

Gets the title value.

Returns:

title

See Also:

setTitle(java.lang.String)

setTitle

public void setTitle(java.lang.String value)

Sets the title value.

Parameters:

value - new title

See Also:

getTitle()

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()

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