Package gov.nasa.gsfc.spdf.ssc

Class DataRequest

java.lang.Object

gov.nasa.gsfc.spdf.ssc.Request

gov.nasa.gsfc.spdf.ssc.DataRequest

Direct Known Subclasses:

DataFileRequest

public class DataRequest
extends Request

This class represents a request for information from the Satellite Situation Center.

Version:

$Revison: $

Author:

B. Harris

Constructor Summary

Constructors

Constructor	Description
DataRequest()	Constructs an DataRequest object with a default value.
DataRequest(java.util.List<SatelliteSpecification> satellites, java.util.Calendar beginTime, java.util.Calendar endTime, BFieldModelOptions bFieldModelOptions, OutputOptions outputOptions, RegionFilterOptions regionFilters, LocationFilterOptions locationFilters)	Constructs a DataRequest object with the given attribute values.

Method Summary

Modifier and Type	Method	Description
LocationFilterOptions	getLocationFilterOptions()	Gets the location filter options.
OutputOptions	getOutputOptions()	Gets the output options.
RegionFilterOptions	getRegionFilterOptions()	Gets the region filter options.
void	list(java.io.PrintStream out)	Prints this object's value to the specified output stream.
void	setLocationFilterOptions(LocationFilterOptions value)	Sets the location filter options.
void	setOutputOptions(OutputOptions value)	Sets the output options.
void	setRegionFilterOptions(RegionFilterOptions value)	Sets the region filter options.

Methods inherited from class gov.nasa.gsfc.spdf.ssc.Request

getBeginTime, getBFieldModelOptions, getEndTime, getSatellites, setBeginTime, setBFieldModelOptions, setEndTime, setSatellites

Methods inherited from class java.lang.Object

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

Constructor Detail

DataRequest

public DataRequest()

Constructs an DataRequest object with a default value.

DataRequest

public DataRequest(java.util.List<SatelliteSpecification> satellites,
                   java.util.Calendar beginTime,
                   java.util.Calendar endTime,
                   BFieldModelOptions bFieldModelOptions,
                   OutputOptions outputOptions,
                   RegionFilterOptions regionFilters,
                   LocationFilterOptions locationFilters)

Constructs a DataRequest object with the given attribute values. If the requested time interval is outside the range of information available at SSC, the results will only include what is available at SSC.

Parameters:

satellites - identifies the satellites that information is being requested for (required).

beginTime - beginning of time range (required).

endTime - end of time range (required).

bFieldModelOptions - B field model options (optional).

outputOptions - output options (required).

regionFilters - region filter options (optional).

locationFilters - location filter options (optional).

Method Detail

getOutputOptions

public OutputOptions getOutputOptions()

Gets the output options.

Returns:

output options

See Also:

setOutputOptions(gov.nasa.gsfc.spdf.ssc.OutputOptions)

setOutputOptions

public void setOutputOptions(OutputOptions value)

Sets the output options.

Parameters:

value - new value

See Also:

getOutputOptions()

getRegionFilterOptions

public RegionFilterOptions getRegionFilterOptions()

Gets the region filter options.

Returns:

region filter options

See Also:

setRegionFilterOptions(gov.nasa.gsfc.spdf.ssc.RegionFilterOptions)

setRegionFilterOptions

public void setRegionFilterOptions(RegionFilterOptions value)

Sets the region filter options.

Parameters:

value - new value

See Also:

getRegionFilterOptions()

getLocationFilterOptions

public LocationFilterOptions getLocationFilterOptions()

Gets the location filter options.

Returns:

location filter options

See Also:

setLocationFilterOptions(gov.nasa.gsfc.spdf.ssc.LocationFilterOptions)

setLocationFilterOptions

public void setLocationFilterOptions(LocationFilterOptions value)

Sets the location filter options.

Parameters:

value - new value

See Also:

getLocationFilterOptions()

list

public void list(java.io.PrintStream out)

Prints this object's value to the specified output stream. This method is useful for debugging.

Overrides:

list in class Request

Parameters:

out - an output stream