Package gov.nasa.gsfc.spdf.ssc

Class Request

java.lang.Object

gov.nasa.gsfc.spdf.ssc.Request

Direct Known Subclasses:

DataRequest, GraphRequest, KmlRequest

public class Request
extends java.lang.Object

This class represents a request for the Satellite Situation Center.

Version:

$Revison: $

Author:

B. Harris

Constructor Summary

Constructors

Constructor	Description
Request()	Constructs a default Request object.
Request(java.util.List<SatelliteSpecification> satellites, java.util.Calendar beginTime, java.util.Calendar endTime, BFieldModelOptions bFieldModelOptions)	Constructs an Request object with the given attribute values.

Method Summary

Modifier and Type	Method	Description
java.util.Calendar	getBeginTime()	Gets the beginTime of the requested information.
BFieldModelOptions	getBFieldModelOptions()	Gets the B field model options.
java.util.Calendar	getEndTime()	Gets the endTime of the requested information.
java.util.List<SatelliteSpecification>	getSatellites()	Gets the satellites.
void	list(java.io.PrintStream out)	Prints this object's value to the specified output stream.
void	setBeginTime(java.util.Calendar value)	Sets the beginTime of the requested information.
void	setBFieldModelOptions(BFieldModelOptions value)	Sets the B field model options.
void	setEndTime(java.util.Calendar value)	Sets the endTime of the requested information.
void	setSatellites(java.util.List<SatelliteSpecification> value)	Sets the satellites.

Methods inherited from class java.lang.Object

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

Constructor Detail

Request

public Request()

Constructs a default Request object.

Request

public Request(java.util.List<SatelliteSpecification> satellites,
               java.util.Calendar beginTime,
               java.util.Calendar endTime,
               BFieldModelOptions bFieldModelOptions)

Constructs an Request 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.

beginTime - beginning of time range.

endTime - end of time range.

bFieldModelOptions - B field model options.

Method Detail

getSatellites

public java.util.List<SatelliteSpecification> getSatellites()

Gets the satellites.

Returns:

satellite specifications

See Also:

setSatellites(java.util.List<gov.nasa.gsfc.spdf.ssc.SatelliteSpecification>)

setSatellites

public void setSatellites(java.util.List<SatelliteSpecification> value)

Sets the satellites.

Parameters:

value - new satellite specifications

See Also:

getSatellites()

getBeginTime

public java.util.Calendar getBeginTime()

Gets the beginTime of the requested information.

Returns:

beginTime

See Also:

setBeginTime(java.util.Calendar)

setBeginTime

public void setBeginTime(java.util.Calendar value)

Sets the beginTime of the requested information. 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:

value - new beginTime.

See Also:

getBeginTime()

getEndTime

public java.util.Calendar getEndTime()

Gets the endTime of the requested information.

Returns:

endTime

See Also:

setEndTime(java.util.Calendar)

setEndTime

public void setEndTime(java.util.Calendar value)

Sets the endTime of the requested information. 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:

value - new endTime.

See Also:

getEndTime()

getBFieldModelOptions

public BFieldModelOptions getBFieldModelOptions()

Gets the B field model options.

Returns:

B field model options. The value may be null if the model is not significant for this request or to indicate that default model values are to be used.

See Also:

setBFieldModelOptions(gov.nasa.gsfc.spdf.ssc.BFieldModelOptions)

setBFieldModelOptions

public void setBFieldModelOptions(BFieldModelOptions value)

Sets the B field model options.

Parameters:

value - new B field model options. A null value indicates the IGRF internal B field model and Tsyganenko 89c external B field model or that the model is not significant for this request.

See Also:

getBFieldModelOptions()

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