Package gov.nasa.gsfc.spdf.ssc

Class SatelliteData

java.lang.Object

gov.nasa.gsfc.spdf.ssc.SatelliteData

public class SatelliteData
extends java.lang.Object

This class represents information about a satellite provided by the Satellite Situation Center.

The following describes some constant values that are required to interpret some fields of this class. Additional information is available in the SSCWeb Users Guide. Not a number value: The constant value -1.0E31 indicates that the quantity is not applicable.

Author:

B. Harris

Constructor Summary

Constructors

Constructor	Description
SatelliteData()	Constructs a SatelliteData with a null value.
SatelliteData(java.lang.String id, java.util.List<CoordinateData> coordinates, java.util.List<java.util.Calendar> time, java.util.List<BTraceData> bTraceData, java.util.List<java.lang.Double> radialLength, java.util.List<java.lang.Double> magneticStrength, java.util.List<java.lang.Double> neutralSheetDistance, java.util.List<java.lang.Double> bowShockDistance, java.util.List<java.lang.Double> magnetoPauseDistance, java.util.List<java.lang.Double> dipoleLValue, java.util.List<java.lang.Float> dipoleInvariantLatitude, java.util.List<SpaceRegion> spacecraftRegion, java.util.List<FootpointRegion> radialTraceFootpointRegion, java.util.List<java.lang.Double> bGseX, java.util.List<java.lang.Double> bGseY, java.util.List<java.lang.Double> bGseZ, java.util.List<FootpointRegion> northBTracedRegions, java.util.List<FootpointRegion> southBTracedRegions)	Constructs a SatelliteData with the given attribute values.

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.Double>	getBGseX()	Gets the bGseX value.
java.util.List<java.lang.Double>	getBGseY()	Gets the bGseY value.
java.util.List<java.lang.Double>	getBGseZ()	Gets the bGseZ value.
java.util.List<java.lang.Double>	getBowShockDistance()	Gets the bowShockDistance value.
java.util.List<BTraceData>	getBTraceData()	Gets the bTraceData value.
java.util.List<CoordinateData>	getCoordinates()	Gets the coordinates value.
java.util.List<java.lang.Float>	getDipoleInvariantLatitude()	Gets the dipoleInvariantLatitude value.
java.util.List<java.lang.Double>	getDipoleLValue()	Gets the dipoleLValue.
java.lang.String	getId()	Gets the satellite identifier for this data.
java.util.List<java.lang.Double>	getMagneticStrength()	Gets the magneticStrength value.
java.util.List<java.lang.Double>	getMagnetoPauseDistance()	Gets the magnetoPauseDistance value.
java.util.List<java.lang.Double>	getNeutralSheetDistance()	Gets the neutralSheetDistance value.
java.util.List<FootpointRegion>	getNorthBTracedRegions()	Gets the northBTracedRegions value.
java.util.List<java.lang.Double>	getRadialLength()	Gets the radialLength value.
java.util.List<FootpointRegion>	getRadialTraceFootpointRegion()	Gets the radialTraceFootpointRegion value.
java.util.List<FootpointRegion>	getSouthBTracedRegions()	Gets the southBTracedRegions value.
java.util.List<SpaceRegion>	getSpacecraftRegion()	Gets the spacecraftRegion value.
java.util.List<java.util.Calendar>	getTime()	Gets the time value.
void	setBGseX(java.util.List<java.lang.Double> value)	Sets the bGseX value.
void	setBGseY(java.util.List<java.lang.Double> value)	Sets the bGseY value.
void	setBGseZ(java.util.List<java.lang.Double> value)	Sets the bGseZ value.
void	setBowShockDistance(java.util.List<java.lang.Double> value)	Sets the bowShockDistance value.
void	setBTraceData(java.util.List<BTraceData> value)	Sets the bTraceData value.
void	setCoordinates(java.util.List<CoordinateData> value)	Sets the coordinates value.
void	setDipoleInvariantLatitude(java.util.List<java.lang.Float> value)	Sets the dipoleInvariantLatitude value.
void	setDipoleLValue(java.util.List<java.lang.Double> value)	Set the dipoleLValue.
void	setId(java.lang.String id)	Sets the satellite identifier to the given value.
void	setMagneticStrength(java.util.List<java.lang.Double> value)	Set the magneticStrength value.
void	setMagnetoPauseDistance(java.util.List<java.lang.Double> value)	Sets the magnetoPauseDistance value.
void	setNeutralSheetDistance(java.util.List<java.lang.Double> value)	Set the neutralSheetDistance value.
void	setNorthBTracedRegions(java.util.List<FootpointRegion> value)	Sets the northBTracedRegions value.
void	setRadialLength(java.util.List<java.lang.Double> value)	Set the radialLength value.
void	setRadialTraceFootpointRegion(java.util.List<FootpointRegion> value)	Sets the radialTraceFootpointRegion value.
void	setSouthBTracedRegions(java.util.List<FootpointRegion> value)	Sets the southBTracedRegions value.
void	setSpacecraftRegion(java.util.List<SpaceRegion> value)	Sets the spacecraftRegion value.
void	setTime(java.util.List<java.util.Calendar> value)	Sets the time value.

Methods inherited from class java.lang.Object

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

Constructor Detail

SatelliteData

public SatelliteData()

Constructs a SatelliteData with a null value.

SatelliteData

public SatelliteData(java.lang.String id,
                     java.util.List<CoordinateData> coordinates,
                     java.util.List<java.util.Calendar> time,
                     java.util.List<BTraceData> bTraceData,
                     java.util.List<java.lang.Double> radialLength,
                     java.util.List<java.lang.Double> magneticStrength,
                     java.util.List<java.lang.Double> neutralSheetDistance,
                     java.util.List<java.lang.Double> bowShockDistance,
                     java.util.List<java.lang.Double> magnetoPauseDistance,
                     java.util.List<java.lang.Double> dipoleLValue,
                     java.util.List<java.lang.Float> dipoleInvariantLatitude,
                     java.util.List<SpaceRegion> spacecraftRegion,
                     java.util.List<FootpointRegion> radialTraceFootpointRegion,
                     java.util.List<java.lang.Double> bGseX,
                     java.util.List<java.lang.Double> bGseY,
                     java.util.List<java.lang.Double> bGseZ,
                     java.util.List<FootpointRegion> northBTracedRegions,
                     java.util.List<FootpointRegion> southBTracedRegions)

Constructs a SatelliteData with the given attribute values.

Parameters:

id - satellite identifier

coordinates - coordinate values

time - time values

bTraceData - B-trace data

radialLength - radial length values

magneticStrength - magnetic strength values

neutralSheetDistance - distance from neutral sheet values

bowShockDistance - distance from bow shock values

magnetoPauseDistance - distance from magneto pause values

dipoleLValue - dipole L values

dipoleInvariantLatitude - dipole invariant latitude values

spacecraftRegion - spacecraft region values

radialTraceFootpointRegion - radial trace footpoint region values

bGseX - B GSE X values

bGseY - B GSE Y values

bGseZ - B GSE Z values

northBTracedRegions - north B-traced region values

southBTracedRegions - south B-traced region values

Method Detail

getId

public java.lang.String getId()

Gets the satellite identifier for this data.

Returns:

satellied id

See Also:

setId(java.lang.String)

setId

public void setId(java.lang.String id)

Sets the satellite identifier to the given value.

Parameters:

id - new id value

See Also:

getId()

getCoordinates

public java.util.List<CoordinateData> getCoordinates()

Gets the coordinates value.

Returns:

coordinates value

See Also:

setCoordinates(java.util.List<gov.nasa.gsfc.spdf.ssc.CoordinateData>)

setCoordinates

public void setCoordinates(java.util.List<CoordinateData> value)

Sets the coordinates value.

Parameters:

value - new coordinates value

See Also:

getCoordinates()

getTime

public java.util.List<java.util.Calendar> getTime()

Gets the time value.

Returns:

time value

See Also:

setTime(java.util.List<java.util.Calendar>)

setTime

public void setTime(java.util.List<java.util.Calendar> value)

Sets the time value.

Parameters:

value - new time value

See Also:

getTime()

getBTraceData

public java.util.List<BTraceData> getBTraceData()

Gets the bTraceData value.

Returns:

bTraceData value

See Also:

setBTraceData(java.util.List<gov.nasa.gsfc.spdf.ssc.BTraceData>)

setBTraceData

public void setBTraceData(java.util.List<BTraceData> value)

Sets the bTraceData value.

Parameters:

value - new bTraceData value

See Also:

getBTraceData()

getRadialLength

public java.util.List<java.lang.Double> getRadialLength()

Gets the radialLength value.

Returns:

radialLength value

See Also:

setRadialLength(java.util.List<java.lang.Double>)

setRadialLength

public void setRadialLength(java.util.List<java.lang.Double> value)

Set the radialLength value.

Parameters:

value - new radialLength value

See Also:

getRadialLength()

getMagneticStrength

public java.util.List<java.lang.Double> getMagneticStrength()

Gets the magneticStrength value. A value of -1.0E31 indicates that the value is "not available" at that point.

Returns:

magneticStrength value

See Also:

setMagneticStrength(java.util.List<java.lang.Double>)

setMagneticStrength

public void setMagneticStrength(java.util.List<java.lang.Double> value)

Set the magneticStrength value.

Parameters:

value - new magenticStrength value

See Also:

getMagneticStrength()

getNeutralSheetDistance

public java.util.List<java.lang.Double> getNeutralSheetDistance()

Gets the neutralSheetDistance value. A value of -1.0E31 indicates that the value is "not available" at that point.

Returns:

neutralSheetDistance value

See Also:

setNeutralSheetDistance(java.util.List<java.lang.Double>)

setNeutralSheetDistance

public void setNeutralSheetDistance(java.util.List<java.lang.Double> value)

Set the neutralSheetDistance value.

Parameters:

value - new neutralSheetDistance value

See Also:

getNeutralSheetDistance()

getBowShockDistance

public java.util.List<java.lang.Double> getBowShockDistance()

Gets the bowShockDistance value.

Returns:

bowShockDistance value

See Also:

setBowShockDistance(java.util.List<java.lang.Double>)

setBowShockDistance

public void setBowShockDistance(java.util.List<java.lang.Double> value)

Sets the bowShockDistance value.

Parameters:

value - new bowShockDistance value

See Also:

getBowShockDistance()

getMagnetoPauseDistance

public java.util.List<java.lang.Double> getMagnetoPauseDistance()

Gets the magnetoPauseDistance value.

Returns:

magnetoPauseDistance value

See Also:

setMagnetoPauseDistance(java.util.List<java.lang.Double>)

setMagnetoPauseDistance

public void setMagnetoPauseDistance(java.util.List<java.lang.Double> value)

Sets the magnetoPauseDistance value.

Parameters:

value - new magnetoPauseDistance value

See Also:

getMagnetoPauseDistance()

getDipoleLValue

public java.util.List<java.lang.Double> getDipoleLValue()

Gets the dipoleLValue.

Returns:

dipoleLValue

See Also:

setDipoleLValue(java.util.List<java.lang.Double>)

setDipoleLValue

public void setDipoleLValue(java.util.List<java.lang.Double> value)

Set the dipoleLValue.

Parameters:

value - new dipoleLValue

See Also:

getDipoleLValue()

getDipoleInvariantLatitude

public java.util.List<java.lang.Float> getDipoleInvariantLatitude()

Gets the dipoleInvariantLatitude value.

Returns:

dipoleInvariantLatitude value

See Also:

setDipoleInvariantLatitude(java.util.List<java.lang.Float>)

setDipoleInvariantLatitude

public void setDipoleInvariantLatitude(java.util.List<java.lang.Float> value)

Sets the dipoleInvariantLatitude value.

Parameters:

value - new dipoleInvariantLatitude value

See Also:

getDipoleInvariantLatitude()

getSpacecraftRegion

public java.util.List<SpaceRegion> getSpacecraftRegion()

Gets the spacecraftRegion value.

Returns:

spacecraftRegion values

See Also:

setSpacecraftRegion(java.util.List<gov.nasa.gsfc.spdf.ssc.SpaceRegion>)

setSpacecraftRegion

public void setSpacecraftRegion(java.util.List<SpaceRegion> value)

Sets the spacecraftRegion value.

Parameters:

value - new spacecraftRegion value

See Also:

getSpacecraftRegion()

getRadialTraceFootpointRegion

public java.util.List<FootpointRegion> getRadialTraceFootpointRegion()

Gets the radialTraceFootpointRegion value.

Returns:

radialTraceFootpointRegion values

See Also:

setRadialTraceFootpointRegion(java.util.List<gov.nasa.gsfc.spdf.ssc.FootpointRegion>)

setRadialTraceFootpointRegion

public void setRadialTraceFootpointRegion(java.util.List<FootpointRegion> value)

Sets the radialTraceFootpointRegion value.

Parameters:

value - new radialTraceFootpointRegion value

See Also:

getRadialTraceFootpointRegion()

getBGseX

public java.util.List<java.lang.Double> getBGseX()

Gets the bGseX value. A value of -1.0E31 indicates that the value is "not available" at that point.

Returns:

bGseX value

See Also:

setBGseX(java.util.List<java.lang.Double>)

setBGseX

public void setBGseX(java.util.List<java.lang.Double> value)

Sets the bGseX value.

Parameters:

value - new bGseX value

See Also:

getBGseX()

getBGseY

public java.util.List<java.lang.Double> getBGseY()

Gets the bGseY value. A value of -1.0E31 indicates that the value is "not available" at that point.

Returns:

bGseY value

See Also:

setBGseY(java.util.List<java.lang.Double>)

setBGseY

public void setBGseY(java.util.List<java.lang.Double> value)

Sets the bGseY value.

Parameters:

value - new bGseY value

See Also:

getBGseY()

getBGseZ

public java.util.List<java.lang.Double> getBGseZ()

Gets the bGseZ value. A value of -1.0E31 indicates that the value is "not available" at that point.

Returns:

bGseZ value

See Also:

setBGseZ(java.util.List<java.lang.Double>)

setBGseZ

public void setBGseZ(java.util.List<java.lang.Double> value)

Sets the bGseZ value.

Parameters:

value - new bGseZ value

See Also:

getBGseZ()

getNorthBTracedRegions

public java.util.List<FootpointRegion> getNorthBTracedRegions()

Gets the northBTracedRegions value.

Returns:

northBTracedRegions values

See Also:

setNorthBTracedRegions(java.util.List<gov.nasa.gsfc.spdf.ssc.FootpointRegion>)

setNorthBTracedRegions

public void setNorthBTracedRegions(java.util.List<FootpointRegion> value)

Sets the northBTracedRegions value.

Parameters:

value - new northBTracedRegions value

See Also:

getNorthBTracedRegions()

getSouthBTracedRegions

public java.util.List<FootpointRegion> getSouthBTracedRegions()

Gets the southBTracedRegions value.

Returns:

southBTracedRegions values

See Also:

setSouthBTracedRegions(java.util.List<gov.nasa.gsfc.spdf.ssc.FootpointRegion>)

setSouthBTracedRegions

public void setSouthBTracedRegions(java.util.List<FootpointRegion> value)

Sets the southBTracedRegions value.

Parameters:

value - new southBTracedRegions value

See Also:

getSouthBTracedRegions()