Package gov.nasa.gsfc.spdf.ssc

Class OutputOptions

java.lang.Object

gov.nasa.gsfc.spdf.ssc.OutputOptions

public class OutputOptions
extends java.lang.Object

This class represents output options for an SSC data request.

Version:

$Revison: $

Author:

B. Harris

Constructor Summary

Constructors

Constructor	Description
OutputOptions()	Constructs a OutputOptions object with a default value that specifies the output of only GSE X,Y,Z values.
OutputOptions(boolean allLocationFilters, java.util.List<FilteredCoordinateOptions> coordinateOptions, RegionOptions regionOptions, ValueOptions valueOptions, DistanceFromOptions distanceFromOptions, int minMaxPoints, java.util.List<BFieldTraceOptions> bFieldTraceOptions)	Constructs a OutputOptions 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<FilteredCoordinateOptions>	getCoordinateOptions()	Gets the coordinate options.
DistanceFromOptions	getDistanceFromOptions()	Gets the distance-from options.
int	getMinMaxPoints()	Gets the number of points used to determine minima and maxima values.
RegionOptions	getRegionOptions()	Gets the region options.
ValueOptions	getValueOptions()	Gets the value options.
boolean	isAllLocationFilters()	Gets the "all location filter" option value.
void	list(java.io.PrintStream out)	Prints this object's value to the specified output stream.
void	setAllLocationFilters(boolean value)	Sets the "all location filter" option value.
void	setBFieldTraceOptions(java.util.List<BFieldTraceOptions> value)	Sets the B field trace listing options.
void	setCoordinateOptions(java.util.List<FilteredCoordinateOptions> value)	Sets the coordinate options.
void	setDistanceFromOptions(DistanceFromOptions value)	Sets the distance-from options.
void	setMinMaxPoints(int value)	Sets the number of points used to determine minima and maxima values.
void	setRegionOptions(RegionOptions value)	Sets the region 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

OutputOptions

public OutputOptions()

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

OutputOptions

public OutputOptions(boolean allLocationFilters,
                     java.util.List<FilteredCoordinateOptions> coordinateOptions,
                     RegionOptions regionOptions,
                     ValueOptions valueOptions,
                     DistanceFromOptions distanceFromOptions,
                     int minMaxPoints,
                     java.util.List<BFieldTraceOptions> bFieldTraceOptions)

Constructs a OutputOptions object with the given attribute values.

Parameters:

allLocationFilters - specifies whether all or or just one or more of the specified location filters must be satisfied

coordinateOptions - coordinate options

regionOptions - regions options

valueOptions - value options

distanceFromOptions - distance from options

minMaxPoints - number of points used to determine minima or maxima values

bFieldTraceOptions - B field trace options

Method Detail

isAllLocationFilters

public boolean isAllLocationFilters()

Gets the "all location filter" option value.

Returns:

true if all location filters must be satisfied and false if only one must be satisfied

See Also:

setAllLocationFilters(boolean)

setAllLocationFilters

public void setAllLocationFilters(boolean value)

Sets the "all location filter" option value.

Parameters:

value - new value

See Also:

isAllLocationFilters()

getCoordinateOptions

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

Gets the coordinate options.

Returns:

coordinate options

See Also:

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

setCoordinateOptions

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

Sets the coordinate options.

Parameters:

value - new value

See Also:

getCoordinateOptions()

getRegionOptions

public RegionOptions getRegionOptions()

Gets the region options.

Returns:

region options

See Also:

setRegionOptions(gov.nasa.gsfc.spdf.ssc.RegionOptions)

setRegionOptions

public void setRegionOptions(RegionOptions value)

Sets the region options.

Parameters:

value - new value

See Also:

getRegionOptions()

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

getMinMaxPoints

public int getMinMaxPoints()

Gets the number of points used to determine minima and maxima values.

Returns:

number of points used to determine minima and maxima values

See Also:

setMinMaxPoints(int)

setMinMaxPoints

public void setMinMaxPoints(int value)

Sets the number of points used to determine minima and maxima values.

Parameters:

value - new value

See Also:

getMinMaxPoints()

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