Package gov.nasa.gsfc.spdf.ssc

Class DataFileRequest

java.lang.Object

gov.nasa.gsfc.spdf.ssc.Request

gov.nasa.gsfc.spdf.ssc.DataRequest

gov.nasa.gsfc.spdf.ssc.DataFileRequest

public class DataFileRequest
extends DataRequest

This class represents a listing request for the SatelliteSituationCenterInterface.getDataFiles(DataFileRequest) method.

Version:

$Revison: $

Author:

B. Harris

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
FormatOptions	getFormatOptions()	Gets the format and units listing options.
void	list(java.io.PrintStream out)	Prints this object's value to the specified output stream.
boolean	outputIsCdf()	Provides flag indicating whether this request's results are to be CDF files.
void	setFormatOptions(FormatOptions value)	Sets the format and units listing options.

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

getLocationFilterOptions, getOutputOptions, getRegionFilterOptions, setLocationFilterOptions, setOutputOptions, setRegionFilterOptions

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

DataFileRequest

public DataFileRequest()

Constructs a DataFileRequest object with a default value. The default options are to output GSE X, Y, and Z values with no filter options.

DataFileRequest

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

Constructs a DataFileRequest object with the given attribute values.

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

outputOptions - output listing options (required)

regionFilters - region filter options

locationFilters - location filter options

formatOptions - output format and units listing options

Method Detail

getFormatOptions

public FormatOptions getFormatOptions()

Gets the format and units listing options.

Returns:

format and units listing options

See Also:

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

setFormatOptions

public void setFormatOptions(FormatOptions value)

Sets the format and units listing options.

Parameters:

value - new value

See Also:

getFormatOptions()

outputIsCdf

public boolean outputIsCdf()

Provides flag indicating whether this request's results are to be CDF files.

Returns:

true if this request specifies the results are to be CDF files, false if the results are to be text files

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 DataRequest

Parameters:

out - an output stream