agi.foundation.navigation.datareaders

(agi.foundation.navigation-2024r3.jar)

Class GpsSatelliteInformation

java.lang.Object

agi.foundation.navigation.datareaders.GpsSatelliteInformation

public class GpsSatelliteInformation
extends Object

Describes GPS satellite information from each line in the GPS data file.

Constructor Summary

Constructors

Constructor and Description
GpsSatelliteInformation(String line) Creates a new GpsSatelliteInformation object from a single line of the GPS data file.

Method Summary

Modifier and Type	Method and Description
NavigationBlockType	getBlock() Gets the block type for this satellite.
GregorianDate	getEndDateAsPseudoRandomNumber() Gets the date and time this satellite ended its designation as this PseudoRandomNumber (get / set).
boolean	getIsActive() Gets a value indicating whether this satellite is currently active, that is, whether it is currently designated as this PseudoRandomNumber (get / set).
String	getNotes() Gets the notes associated with the satellite.
int	getPseudoRandomNumber() Gets the GPS satellite's pseudo random number (PRN).
String	getSatelliteNumber() Gets the satellite's satellite number.
int	getSatelliteVehicleNumber() Gets the GPS satellite's vehicle number (SVN).
GregorianDate	getStartDateAsPseudoRandomNumber() Gets the date and time this satellite began its designation as this PseudoRandomNumber (get / set).
void	setBlock(NavigationBlockType value) Sets the block type for this satellite.
void	setEndDateAsPseudoRandomNumber(GregorianDate value) Sets the date and time this satellite ended its designation as this PseudoRandomNumber (get / set).
void	setIsActive(boolean value) Sets a value indicating whether this satellite is currently active, that is, whether it is currently designated as this PseudoRandomNumber (get / set).
void	setNotes(String value) Sets the notes associated with the satellite.
void	setPseudoRandomNumber(int value) Sets the GPS satellite's pseudo random number (PRN).
void	setSatelliteNumber(String value) Sets the satellite's satellite number.
void	setSatelliteVehicleNumber(int value) Sets the GPS satellite's vehicle number (SVN).
void	setStartDateAsPseudoRandomNumber(GregorianDate value) Sets the date and time this satellite began its designation as this PseudoRandomNumber (get / set).

Methods inherited from class java.lang.Object

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

Constructor Detail

GpsSatelliteInformation

public GpsSatelliteInformation(@Nonnull
                               String line)

Creates a new GpsSatelliteInformation object from a single line of the GPS data file.

Parameters:

line - String representing a single line from the GPS data file.

Throws:

ArgumentNullException - Thrown when line is null.

InvalidDataException - Thrown when there is an error parsing data from the line.

Method Detail

getPseudoRandomNumber

public final int getPseudoRandomNumber()

Gets the GPS satellite's pseudo random number (PRN).

setPseudoRandomNumber

public final void setPseudoRandomNumber(int value)

Sets the GPS satellite's pseudo random number (PRN).

getSatelliteVehicleNumber

public final int getSatelliteVehicleNumber()

Gets the GPS satellite's vehicle number (SVN).

setSatelliteVehicleNumber

public final void setSatelliteVehicleNumber(int value)

Sets the GPS satellite's vehicle number (SVN).

getSatelliteNumber

public final String getSatelliteNumber()

Gets the satellite's satellite number.

setSatelliteNumber

public final void setSatelliteNumber(String value)

Sets the satellite's satellite number.

getBlock

@Nonnull
public final NavigationBlockType getBlock()

Gets the block type for this satellite.

setBlock

public final void setBlock(@Nonnull
                           NavigationBlockType value)

Sets the block type for this satellite.

getStartDateAsPseudoRandomNumber

@Nonnull
public final GregorianDate getStartDateAsPseudoRandomNumber()

Gets the date and time this satellite began its designation as this PseudoRandomNumber (get / set).

setStartDateAsPseudoRandomNumber

public final void setStartDateAsPseudoRandomNumber(@Nonnull
                                                   GregorianDate value)

Sets the date and time this satellite began its designation as this PseudoRandomNumber (get / set).

getEndDateAsPseudoRandomNumber

@Nonnull
public final GregorianDate getEndDateAsPseudoRandomNumber()

Gets the date and time this satellite ended its designation as this PseudoRandomNumber (get / set).

setEndDateAsPseudoRandomNumber

public final void setEndDateAsPseudoRandomNumber(@Nonnull
                                                 GregorianDate value)

Sets the date and time this satellite ended its designation as this PseudoRandomNumber (get / set).

getIsActive

public final boolean getIsActive()

Gets a value indicating whether this satellite is currently active, that is, whether it is currently designated as this PseudoRandomNumber (get / set).

setIsActive

public final void setIsActive(boolean value)

Sets a value indicating whether this satellite is currently active, that is, whether it is currently designated as this PseudoRandomNumber (get / set).

getNotes

public final String getNotes()

Gets the notes associated with the satellite.

setNotes

public final void setNotes(String value)

Sets the notes associated with the satellite.