driver.ted.utilities.Almanac
Class T_ReadAlmanac

java.lang.Object
  extended by driver.ted.utilities.Almanac.T_ReadAlmanac
All Implemented Interfaces:
java.io.Serializable

public class T_ReadAlmanac
extends java.lang.Object
implements java.io.Serializable

See Also:
Serialized Form

Constructor Summary
T_ReadAlmanac(java.lang.String almanacFileName)
          Constructor - opens the almanac file pointed to by almanacFileName
 
Method Summary
 double getAFOne(int PRNNumber)
           
 double getAFZero(int PRNNumber)
           
 java.lang.String getAlmanacName()
          Returns the name of the almanac as defined in the almanac file
 boolean getAlmanacReadStatus()
          Returns a status of the alamanc read operation.
 double getEccentricity(int PRNNumber)
          Returns the eccentricity value for a given PRN
 long getGPSTOA()
          Returns the Time of week parameter for the almanac.
 int getGPSWeek()
          Returns the GPS week of the almanac - usually from the latest epoch
 int getHealth(int PRNNumber)
           
 double getInclinationOffset(int PRNNumber)
          Returns the inclination offset from 0.3 semi-circles for a given PRN
 double getMeanAnomaly(int PRNNumber)
           
 int getNumberOfSVs()
          Returns the number of SVs in the almanac
 double getOmega(int PRNNumber)
           
 double getOmegaDot(int PRNNumber)
           
 double getOmegaZero(int PRNNumber)
           
 int getSatConfig(int PRNNumber)
           
 double getSqrtSemiMajorAxis(int PRNNumber)
           
 int getSVN(int PRNNumber)
          Returns the SVN number for a given PRN.
 int getURA(int PRNNumber)
          Returns the User Range Accuracy number for a given PRN
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

T_ReadAlmanac

public T_ReadAlmanac(java.lang.String almanacFileName)
Constructor - opens the almanac file pointed to by almanacFileName

Parameters:
almanacFileName - The full path to the almanac file to open
Method Detail

getAlmanacReadStatus

public boolean getAlmanacReadStatus()
Returns a status of the alamanc read operation. If the almanac was read successfully, will return true, otherwise false.

Returns:
True if almanac read successfully, otherwise false

getNumberOfSVs

public int getNumberOfSVs()
Returns the number of SVs in the almanac

Returns:
Number of SVs in the almanac

getAlmanacName

public java.lang.String getAlmanacName()
Returns the name of the almanac as defined in the almanac file

Returns:
String The name of the almanac

getGPSWeek

public int getGPSWeek()
Returns the GPS week of the almanac - usually from the latest epoch

Returns:
GPS week since latest epoch

getGPSTOA

public long getGPSTOA()
Returns the Time of week parameter for the almanac. (The time at which the almanac curve fit was performed)

Returns:
Long, Time Of week

getSVN

public int getSVN(int PRNNumber)
           throws java.lang.ArrayIndexOutOfBoundsException
Returns the SVN number for a given PRN. PRN must be between 1-32

Parameters:
PRNNumber - PRN for which SVN is desired
Returns:
SVN number associated with PRN
Throws:
java.lang.ArrayIndexOutOfBoundsException - PRN must be between 1 and 32

getURA

public int getURA(int PRNNumber)
           throws java.lang.ArrayIndexOutOfBoundsException
Returns the User Range Accuracy number for a given PRN

Parameters:
PRNNumber - The PRN for which the URA is desired
Returns:
The URA value (between 1-15)
Throws:
java.lang.ArrayIndexOutOfBoundsException - PRN must be between 1 and 32

getEccentricity

public double getEccentricity(int PRNNumber)
                       throws java.lang.ArrayIndexOutOfBoundsException
Returns the eccentricity value for a given PRN

Parameters:
PRNNumber - The PRN for which the eccentricity is desired.
Returns:
eccentricity
Throws:
java.lang.ArrayIndexOutOfBoundsException - PRN must be between 1 and 32

getInclinationOffset

public double getInclinationOffset(int PRNNumber)
                            throws java.lang.ArrayIndexOutOfBoundsException
Returns the inclination offset from 0.3 semi-circles for a given PRN

Parameters:
PRNNumber - The PRN for which the inclination offset is desired
Returns:
the inclination offset in semi-circles
Throws:
java.lang.ArrayIndexOutOfBoundsException - PRN must be between 1 and 32

getOmegaDot

public double getOmegaDot(int PRNNumber)
                   throws java.lang.ArrayIndexOutOfBoundsException
Parameters:
PRNNumber -
Returns:
Omega dot for the given PRN
Throws:
java.lang.ArrayIndexOutOfBoundsException

getSqrtSemiMajorAxis

public double getSqrtSemiMajorAxis(int PRNNumber)
                            throws java.lang.ArrayIndexOutOfBoundsException
Parameters:
PRNNumber -
Returns:
Semi-major axis for the given PRN
Throws:
java.lang.ArrayIndexOutOfBoundsException

getOmegaZero

public double getOmegaZero(int PRNNumber)
                    throws java.lang.ArrayIndexOutOfBoundsException
Parameters:
PRNNumber -
Returns:
Omega zero for the given PRN
Throws:
java.lang.ArrayIndexOutOfBoundsException

getOmega

public double getOmega(int PRNNumber)
                throws java.lang.ArrayIndexOutOfBoundsException
Parameters:
PRNNumber -
Returns:
Omega for the given PRN
Throws:
java.lang.ArrayIndexOutOfBoundsException

getMeanAnomaly

public double getMeanAnomaly(int PRNNumber)
                      throws java.lang.ArrayIndexOutOfBoundsException
Parameters:
PRNNumber -
Returns:
Mean anomaly for the given PRN
Throws:
java.lang.ArrayIndexOutOfBoundsException

getAFZero

public double getAFZero(int PRNNumber)
                 throws java.lang.ArrayIndexOutOfBoundsException
Parameters:
PRNNumber -
Returns:
Zeroth order clock correction for the given PRN
Throws:
java.lang.ArrayIndexOutOfBoundsException

getAFOne

public double getAFOne(int PRNNumber)
                throws java.lang.ArrayIndexOutOfBoundsException
Parameters:
PRNNumber -
Returns:
First order clock correction for the given PRN
Throws:
java.lang.ArrayIndexOutOfBoundsException

getHealth

public int getHealth(int PRNNumber)
              throws java.lang.ArrayIndexOutOfBoundsException
Parameters:
PRNNumber -
Returns:
health value for the given PRN
Throws:
java.lang.ArrayIndexOutOfBoundsException

getSatConfig

public int getSatConfig(int PRNNumber)
                 throws java.lang.ArrayIndexOutOfBoundsException
Parameters:
PRNNumber -
Returns:
Satellite configuration for the given PRN
Throws:
java.lang.ArrayIndexOutOfBoundsException