AbstractSatellite (predict4java 1.3 API)

java.lang.Object
- com.github.amsacode.predict4java.AbstractSatellite

All Implemented Interfaces:

Satellite

Direct Known Subclasses:

DeepSpaceSatellite, LEOSatellite
```
public abstract class AbstractSatellite
extends Object
implements Satellite
```
Not thread safe!

Field Summary

Fields
Modifier and Type	Field and Description
`protected static double`	`ASTRONOMICAL_UNIT`
`protected static double`	`CK4`
`protected static double`	`EARTH_GRAVITATIONAL_CONSTANT`
`protected static double`	`EARTH_RADIUS`
`protected static double`	`EARTH_ROTATIONS_PER_SIDERIAL_DAY`
`protected static double`	`EARTH_ROTATIONS_RADIANS_PER_SIDERIAL_DAY`
`protected static double`	`MFACTOR`
`protected static double`	`PERIGEE_156_KM`
`protected static double`	`QOMS2T`
`protected static double`	`RHO`
`protected static double`	`S`
`protected static double`	`SOLAR_RADIUS`
`protected static double`	`SOLAR_RADIUS_KM`
`protected static double`	`SPEED_OF_LIGHT`

Fields inherited from interface com.github.amsacode.predict4java.Satellite
CK2, DEG2RAD, EARTH_RADIUS_KM, EPSILON, J2_HARMONIC, J3_HARMONIC, J4_HARMONIC, TWO_PI, TWO_THIRDS, XKE

Constructor Summary

Constructors
Constructor and Description

AbstractSatellite(TLE tle)

Constructors
Constructor and Description
`AbstractSatellite(TLE tle)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`calculatePhase(double xlt, double xnode, double omgadf)`
`protected void`	`calculatePositionAndVelocity(double rk, double uk, double xnodek, double xinck, double rdotk, double rfdotk)`
`SatPos`	`calculateSatelliteGroundTrack()` Calculates the ground track (sub satellite point) of the satellite, for the already determined position of the satellite.
`void`	`calculateSatelliteVectors(Date date)` Calculates the position and velocity vectors of the satellite.
`SatPos`	`calculateSatPosForGroundStation(GroundStationPosition gsPos)` Calculates the position of the satellite from the perspective of a ground station.
`protected static void`	`converge(double[] temp, double axn, double ayn, double capu)` Solves Keplers' Equation.
`double`	`getEclipseDepth()`
`SatPos`	`getPosition(GroundStationPosition gsPos, Date date)` Get the position of the satellite.
`protected double`	`getQoms24()`
`protected double`	`getS4()`
`TLE`	`getTLE()` Returns the currently assigned TLE for the satellite.
`protected static double`	`invert(double value)`
`protected static double`	`julianDateOfYear(double theYear)` Calculates the Julian Day of the Year.
`protected static void`	`magnitude(com.github.amsacode.predict4java.AbstractSatellite.Vector4 v)` Calculates scalar magnitude of a vector4 argument.
`protected static double`	`mod2PI(double testValue)` Calculates the modulus of 2 * PI.
`protected void`	`setPerigee(double perigee)` Sets perigee and checks and adjusts the calculation if the perigee is less tan 156KM.
`protected static double`	`sqr(double arg)` Returns the square of a double.
`boolean`	`willBeSeen(GroundStationPosition qth)` This function returns true if the satellite can ever rise above the horizon of the ground station.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CK4
```
protected static final double CK4
```
    See Also:
    
    Constant Field Values
  - EARTH_GRAVITATIONAL_CONSTANT
```
protected static final double EARTH_GRAVITATIONAL_CONSTANT
```
    See Also:
    
    Constant Field Values
  - S
```
protected static final double S
```
    See Also:
    
    Constant Field Values
  - QOMS2T
```
protected static final double QOMS2T
```
    See Also:
    
    Constant Field Values
  - EARTH_ROTATIONS_PER_SIDERIAL_DAY
```
protected static final double EARTH_ROTATIONS_PER_SIDERIAL_DAY
```
    See Also:
    
    Constant Field Values
  - EARTH_ROTATIONS_RADIANS_PER_SIDERIAL_DAY
```
protected static final double EARTH_ROTATIONS_RADIANS_PER_SIDERIAL_DAY
```
    See Also:
    
    Constant Field Values
  - RHO
```
protected static final double RHO
```
    See Also:
    
    Constant Field Values
  - MFACTOR
```
protected static final double MFACTOR
```
    See Also:
    
    Constant Field Values
  - SOLAR_RADIUS_KM
```
protected static final double SOLAR_RADIUS_KM
```
    See Also:
    
    Constant Field Values
  - ASTRONOMICAL_UNIT
```
protected static final double ASTRONOMICAL_UNIT
```
    See Also:
    
    Constant Field Values
  - SPEED_OF_LIGHT
```
protected static final double SPEED_OF_LIGHT
```
    See Also:
    
    Constant Field Values
  - PERIGEE_156_KM
```
protected static final double PERIGEE_156_KM
```
    See Also:
    
    Constant Field Values
  - EARTH_RADIUS
```
protected static final double EARTH_RADIUS
```
    See Also:
    
    Constant Field Values
  - SOLAR_RADIUS
```
protected static final double SOLAR_RADIUS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractSatellite
```
public AbstractSatellite(TLE tle)
```
- Method Detail
  - getTLE
```
public final TLE getTLE()
```
    Description copied from interface: Satellite
    
    Returns the currently assigned TLE for the satellite.
    
    Specified by:
    
    getTLE in interface Satellite
    
    Returns:
  - julianDateOfYear
```
protected static double julianDateOfYear(double theYear)
```
    Calculates the Julian Day of the Year. The function Julian_Date_of_Year calculates the Julian Date of Day 0.0 of {year}. This function is used to calculate the Julian Date of any date by using Julian_Date_of_Year, DOY, and Fraction_of_Day. Astronomical Formulae for Calculators, Jean Meeus, pages 23-25. Calculate Julian Date of 0.0 Jan aYear
    
    Parameters:
    
    theYear - the year
    
    Returns:
    
    the Julian day number
  - sqr
```
protected static double sqr(double arg)
```
    Returns the square of a double.
    
    Parameters:
    
    arg - the value for which to get the double
    
    Returns:
    
    the arg squared
  - magnitude
```
protected static void magnitude(com.github.amsacode.predict4java.AbstractSatellite.Vector4 v)
```
    Calculates scalar magnitude of a vector4 argument.
    
    Parameters:
    
    v - the vector were measuring
  - mod2PI
```
protected static double mod2PI(double testValue)
```
    Calculates the modulus of 2 * PI.
    
    Parameters:
    
    testValue - the value under test
    
    Returns:
    
    the modulus
  - getPosition
```
public SatPos getPosition(GroundStationPosition gsPos,
                          Date date)
```
    Description copied from interface: Satellite
    
    Get the position of the satellite.
    
    Specified by:
    
    getPosition in interface Satellite
  - willBeSeen
```
public boolean willBeSeen(GroundStationPosition qth)
```
    Description copied from interface: Satellite
    
    This function returns true if the satellite can ever rise above the horizon of the ground station.
    
    Specified by:
    
    willBeSeen in interface Satellite
    
    Parameters:
    
    qth - the ground station position
    
    Returns:
    
    boolean whether or not the satellite will be seen
  - getS4
```
protected double getS4()
```
    Returns:
    
    the s4
  - getQoms24
```
protected double getQoms24()
```
    Returns:
    
    the qoms24
  - setPerigee
```
protected void setPerigee(double perigee)
```
    Sets perigee and checks and adjusts the calculation if the perigee is less tan 156KM.
    
    Parameters:
    
    perigee - the perigee to set
  - converge
```
protected static void converge(double[] temp,
                               double axn,
                               double ayn,
                               double capu)
```
    Solves Keplers' Equation.
    
    Parameters:
    
    temp - an array of temporary values we pass around as part of the orbit calculation.
    
    axn -
    
    ayn -
    
    capu -
  - calculateSatelliteVectors
```
public void calculateSatelliteVectors(Date date)
```
    Description copied from interface: Satellite
    
    Calculates the position and velocity vectors of the satellite. When observations for many ground stations have to be made for one satellite, this method can be used together with the calculateSatPosForGroundStation(..) method. This gives a performance improvement relative to using the all-in-one method getPosition(..).
    
    Specified by:
    
    calculateSatelliteVectors in interface Satellite
  - calculateSatelliteGroundTrack
```
public SatPos calculateSatelliteGroundTrack()
```
    Description copied from interface: Satellite
    
    Calculates the ground track (sub satellite point) of the satellite, for the already determined position of the satellite.
    
    Specified by:
    
    calculateSatelliteGroundTrack in interface Satellite
    
    Returns:
    
    satPos The SatPos object in which the ground track of the satellite is stored.
  - calculateSatPosForGroundStation
```
public SatPos calculateSatPosForGroundStation(GroundStationPosition gsPos)
```
    Description copied from interface: Satellite
    
    Calculates the position of the satellite from the perspective of a ground station. The position and velocity of the satellite must have been determined before (by calculateSatelliteVectors(..)). The ground track (sub satellite point) is not calculated, this should be done by calculateSatelliteGroundTrack(..).
    
    Specified by:
    
    calculateSatPosForGroundStation in interface Satellite
    
    Parameters:
    
    gsPos - The position of the ground station to perform the calculations for.
    
    Returns:
    
    satPos The SatPos object where the position of the satellite is stored, as seen from a ground station.
  - calculatePhase
```
protected void calculatePhase(double xlt,
                              double xnode,
                              double omgadf)
```
  - calculatePositionAndVelocity
```
protected void calculatePositionAndVelocity(double rk,
                                            double uk,
                                            double xnodek,
                                            double xinck,
                                            double rdotk,
                                            double rfdotk)
```
  - invert
```
protected static double invert(double value)
```
  - getEclipseDepth
```
public final double getEclipseDepth()
```
    Returns:
    
    the eclipseDepth

Class AbstractSatellite

Field Summary

Fields inherited from interface com.github.amsacode.predict4java.Satellite

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CK4

EARTH_GRAVITATIONAL_CONSTANT

S

QOMS2T

EARTH_ROTATIONS_PER_SIDERIAL_DAY

EARTH_ROTATIONS_RADIANS_PER_SIDERIAL_DAY

RHO

MFACTOR

SOLAR_RADIUS_KM

ASTRONOMICAL_UNIT

SPEED_OF_LIGHT

PERIGEE_156_KM

EARTH_RADIUS

SOLAR_RADIUS

Constructor Detail

AbstractSatellite

Method Detail

getTLE

julianDateOfYear

sqr

magnitude

mod2PI

getPosition

willBeSeen

getS4

getQoms24

setPerigee

converge

calculateSatelliteVectors

calculateSatelliteGroundTrack

calculateSatPosForGroundStation

calculatePhase

calculatePositionAndVelocity

invert

getEclipseDepth