Package gov.nasa.gsfc.spdf.ssc

Class KmlRequest

java.lang.Object

gov.nasa.gsfc.spdf.ssc.Request

gov.nasa.gsfc.spdf.ssc.KmlRequest

public class KmlRequest
extends Request

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

Version:

$Revison: $

Author:

B. Harris

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	getNorthBFieldTraceFootpoint()	Gets the north B-field trace footpoint value.
boolean	getSouthBFieldTraceFootpoint()	Gets the south B-field trace footpoint value.
boolean	getTrajectory()	Gets the trajectory value.
void	list(java.io.PrintStream out)	Prints this object's value to the specified output stream.
void	setNorthBFieldTraceFootpoint(boolean value)	Sets the north B-field trace footpoint value.
void	setSouthBFieldTraceFootpoint(boolean value)	Sets the south B-field trace footpoint value.
void	setTrajectory(boolean value)	Sets the trajectory value.

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

KmlRequest

public KmlRequest()

Constructs an KmlRequest object with a default value.

KmlRequest

public KmlRequest(java.util.List<SatelliteSpecification> satellites,
                  java.util.Calendar beginTime,
                  java.util.Calendar endTime,
                  BFieldModelOptions bFieldModelOptions,
                  boolean trajectory,
                  boolean northBFieldTraceFootpoint,
                  boolean southBFieldTraceFootpoint)

Constructs a KmlRequest 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).

trajectory - option indicating whether trajectory information is requested (required).

northBFieldTraceFootpoint - option indicating whether north B-Field trace footpoint information is requested (required).

southBFieldTraceFootpoint - option indicating whether south B-Field trace footpoint information is requested (required).

Method Detail

getTrajectory

public boolean getTrajectory()

Gets the trajectory value.

Returns:

trajectory value.

See Also:

setTrajectory(boolean)

setTrajectory

public void setTrajectory(boolean value)

Sets the trajectory value.

Parameters:

value - new value.

See Also:

getTrajectory()

getNorthBFieldTraceFootpoint

public boolean getNorthBFieldTraceFootpoint()

Gets the north B-field trace footpoint value.

Returns:

north B-field trace footpoint value.

See Also:

setNorthBFieldTraceFootpoint(boolean)

setNorthBFieldTraceFootpoint

public void setNorthBFieldTraceFootpoint(boolean value)

Sets the north B-field trace footpoint value.

Parameters:

value - new value.

See Also:

getNorthBFieldTraceFootpoint()

getSouthBFieldTraceFootpoint

public boolean getSouthBFieldTraceFootpoint()

Gets the south B-field trace footpoint value.

Returns:

south B-field trace footpoint value.

See Also:

setSouthBFieldTraceFootpoint(boolean)

setSouthBFieldTraceFootpoint

public void setSouthBFieldTraceFootpoint(boolean value)

Sets the south B-field trace footpoint value.

Parameters:

value - new value.

See Also:

getSouthBFieldTraceFootpoint()

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