net.sf.marineapi.provider.event
Class SatelliteInfoEvent

java.lang.Object
  extended by java.util.EventObject
      extended by net.sf.marineapi.provider.event.ProviderEvent
          extended by net.sf.marineapi.provider.event.SatelliteInfoEvent
All Implemented Interfaces:
Serializable

public class SatelliteInfoEvent
extends ProviderEvent

SatelliteInfoEvent contains the satellite information collected by SatelliteInfoProvider.

Author:
Kimmo Tuukkanen
See Also:
GSASentence, GSVSentence, SatelliteInfo, Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
SatelliteInfoEvent(Object source, GSASentence gsa, List<SatelliteInfo> info)
           
 
Method Summary
 GpsFixStatus getGpsFixStatus()
          Returns the GPS fix status as reported by GSA sentence.
 FaaMode getGpsMode()
          Returns the GPS mode of operation as reported in GSA sentence.
 double getHorizontalPrecision()
          Returns the horizontal precision of GPS fix.
 double getPositionPrecision()
          Returns the overall precision of GPS fix.
 String[] getSatelliteIds()
          Returns the list of GPS satellites used for GPS fix.
 List<SatelliteInfo> getSatelliteInfo()
          Returns the current detailed satellite information.
 double getVerticalPrecision()
          Returns the vertical precision of GPS fix.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SatelliteInfoEvent

public SatelliteInfoEvent(Object source,
                          GSASentence gsa,
                          List<SatelliteInfo> info)
Parameters:
source -
Method Detail

getSatelliteIds

public String[] getSatelliteIds()
Returns the list of GPS satellites used for GPS fix.

Returns:
Satellite ids list as reported by GSA sentence.

getSatelliteInfo

public List<SatelliteInfo> getSatelliteInfo()
Returns the current detailed satellite information.

Returns:
List of SatelliteInfo objects from latest GSV sequence.

getHorizontalPrecision

public double getHorizontalPrecision()
Returns the horizontal precision of GPS fix.

Returns:
HDOP value as reported by GSA sentence.

getVerticalPrecision

public double getVerticalPrecision()
Returns the vertical precision of GPS fix.

Returns:
VDOP as reported by GSA sentence.

getPositionPrecision

public double getPositionPrecision()
Returns the overall precision of GPS fix.

Returns:
PDOP as reported by GSA sentence.

getGpsMode

public FaaMode getGpsMode()
Returns the GPS mode of operation as reported in GSA sentence.

Returns:
FaaMode enum value

getGpsFixStatus

public GpsFixStatus getGpsFixStatus()
Returns the GPS fix status as reported by GSA sentence.

Returns:
GpsFixStatus enum value


Copyright (C) 2010-2014 Java Marine API authors. All Rights Reserved.