Package gov.nasa.gsfc.spdf.ssc

Class TimeSeriesGraphOptions

java.lang.Object

gov.nasa.gsfc.spdf.ssc.GraphOptions

gov.nasa.gsfc.spdf.ssc.TimeSeriesGraphOptions

public class TimeSeriesGraphOptions
extends GraphOptions

This class represents options for an SSC Time Series plot request.

Version:

$Revison: $

Author:

B. Harris

Constructor Summary

Constructors

Constructor	Description
TimeSeriesGraphOptions()	Constructs a TimeSeriesGraphOptions object with a default value that specifies the output of only GSE X,Y,Z values.
TimeSeriesGraphOptions(java.util.List<CoordinateOptions> coordinateOptions, ValueOptions valueOptions, DistanceFromOptions distanceFromOptions, java.util.List<BFieldTraceOptions> bFieldTraceOptions)	Constructs a TimeSeriesGraphOptions object with the given attribute values.

Method Summary

Modifier and Type	Method	Description
java.util.List<BFieldTraceOptions>	getBFieldTraceOptions()	Gets the B field trace options.
java.util.List<CoordinateOptions>	getCoordinateOptions()	Gets the coordinate options.
DistanceFromOptions	getDistanceFromOptions()	Gets the distance-from options.
ValueOptions	getValueOptions()	Gets the value options.
void	list(java.io.PrintStream out)	Prints this object's value to the specified output stream.
void	setBFieldTraceOptions(java.util.List<BFieldTraceOptions> value)	Sets the B field trace listing options.
void	setCoordinateOptions(java.util.List<CoordinateOptions> value)	Sets the coordinate options.
void	setDistanceFromOptions(DistanceFromOptions value)	Sets the distance-from options.
void	setValueOptions(ValueOptions value)	Sets the value options.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeSeriesGraphOptions

public TimeSeriesGraphOptions()

Constructs a TimeSeriesGraphOptions object with a default value that specifies the output of only GSE X,Y,Z values.

TimeSeriesGraphOptions

public TimeSeriesGraphOptions(java.util.List<CoordinateOptions> coordinateOptions,
                              ValueOptions valueOptions,
                              DistanceFromOptions distanceFromOptions,
                              java.util.List<BFieldTraceOptions> bFieldTraceOptions)

Constructs a TimeSeriesGraphOptions object with the given attribute values.

Parameters:

coordinateOptions - coordinate options

valueOptions - value options

distanceFromOptions - distance from options

bFieldTraceOptions - B field trace options

Method Detail

getCoordinateOptions

public java.util.List<CoordinateOptions> getCoordinateOptions()

Gets the coordinate options.

Returns:

coordinate options

See Also:

setCoordinateOptions(java.util.List<gov.nasa.gsfc.spdf.ssc.CoordinateOptions>)

setCoordinateOptions

public void setCoordinateOptions(java.util.List<CoordinateOptions> value)

Sets the coordinate options.

Parameters:

value - new value

See Also:

getCoordinateOptions()

getValueOptions

public ValueOptions getValueOptions()

Gets the value options.

Returns:

value listing options

See Also:

setValueOptions(gov.nasa.gsfc.spdf.ssc.ValueOptions)

setValueOptions

public void setValueOptions(ValueOptions value)

Sets the value options.

Parameters:

value - new value

See Also:

getValueOptions()

getDistanceFromOptions

public DistanceFromOptions getDistanceFromOptions()

Gets the distance-from options.

Returns:

distance-from options

See Also:

setDistanceFromOptions(gov.nasa.gsfc.spdf.ssc.DistanceFromOptions)

setDistanceFromOptions

public void setDistanceFromOptions(DistanceFromOptions value)

Sets the distance-from options.

Parameters:

value - new value

See Also:

getDistanceFromOptions()

getBFieldTraceOptions

public java.util.List<BFieldTraceOptions> getBFieldTraceOptions()

Gets the B field trace options.

Returns:

B field trace options

See Also:

setBFieldTraceOptions(java.util.List<gov.nasa.gsfc.spdf.ssc.BFieldTraceOptions>)

setBFieldTraceOptions

public void setBFieldTraceOptions(java.util.List<BFieldTraceOptions> value)

Sets the B field trace listing options.

Parameters:

value - new value

See Also:

getBFieldTraceOptions()

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