net.sf.marineapi.nmea.util

Class SatelliteInfo

java.lang.Object

net.sf.marineapi.nmea.util.SatelliteInfo

public class SatelliteInfo
extends Object

SatelliteInfo represents the information about a single GPS satellite vehicle.

Author:

Kimmo Tuukkanen

See Also:

GSVSentence

Constructor Summary

Constructors

Constructor and Description
SatelliteInfo(String id, int elevation, int azimuth, int noise) Creates a new instance of SatelliteInfo

Method Summary

Modifier and Type	Method and Description
int	getAzimuth() Get satellite azimuth, in degrees from true north (0..359°).
int	getElevation() Get satellite elevation, in degrees (max. 90°).
String	getId() Get the ID of satellite vehicle, for example "05".
int	getNoise() Get satellite the signal noise ratio, in dB (0-99 dB).
void	setAzimuth(int azimuth) Set satellite azimuth, in degrees from true north (0..359°).
void	setElevation(int elevation) Set satellite elevation, in degrees (max. 90°).
void	setId(String id) Set the ID of satellite vehicle, for example "05".
void	setNoise(int noise) Set the satellite signal noise ratio, in dB (0-99 dB).

Methods inherited from class java.lang.Object

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

Constructor Detail

SatelliteInfo

public SatelliteInfo(String id,
                     int elevation,
                     int azimuth,
                     int noise)

Creates a new instance of SatelliteInfo

Parameters:

id - Satellite ID

elevation - Current elevation of the satellite

azimuth - Current azimuth of the satellite

noise - Current noise ratio of the satellite signal

Method Detail

getAzimuth

public int getAzimuth()

Get satellite azimuth, in degrees from true north (0..359°).

Returns:

azimuth value

getElevation

public int getElevation()

Get satellite elevation, in degrees (max. 90°).

Returns:

elevation value

getId

public String getId()

Get the ID of satellite vehicle, for example "05".

Returns:

ID String

getNoise

public int getNoise()

Get satellite the signal noise ratio, in dB (0-99 dB).

Returns:

Noise ratio

setAzimuth

public void setAzimuth(int azimuth)

Set satellite azimuth, in degrees from true north (0..359°).

Parameters:

azimuth - the azimuth to set

Throws:

IllegalArgumentException - If value is out of bounds 0..360 deg.

setElevation

public void setElevation(int elevation)

Set satellite elevation, in degrees (max. 90°).

Parameters:

elevation - the elevation to set

Throws:

IllegalArgumentException - If value is out of bounds 0..90 deg.

setId

public void setId(String id)

Set the ID of satellite vehicle, for example "05".

Parameters:

id - the id to set

setNoise

public void setNoise(int noise)

Set the satellite signal noise ratio, in dB (0-99 dB).

Parameters:

noise - the noise to set

Throws:

IllegalArgumentException - If value is out of bounds 0..99 dB.