org.ka2ddo.yaac.io

Class GpsdConnector

java.lang.Object

org.ka2ddo.ax25.Connector

org.ka2ddo.yaac.io.PortConnector

org.ka2ddo.yaac.io.GpsdConnector

All Implemented Interfaces:

java.lang.Runnable, java.lang.Thread.UncaughtExceptionHandler

public class GpsdConnector
extends PortConnector
implements java.lang.Runnable, java.lang.Thread.UncaughtExceptionHandler

This class provides a driver to connect YAAC to a gpsd daemon, so that YAAC can use a shared GPS receiver, or non-standard hardware that acts like a GPS receiver or speaks protocols other than NMEA 0183.

More information can be found at the gpsd website.

Author:

Andrew Pavlin, KA2DDO

Nested Class Summary

Nested classes/interfaces inherited from class org.ka2ddo.yaac.io.PortConnector

PortConnector.PortStatsType

Nested classes/interfaces inherited from class org.ka2ddo.ax25.Connector

Connector.ConnectorType, Connector.PortStats

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Set<PortConfig.Fields>	BLANK_FIELDS Set of PortConfig field identifiers for fields that should not be copied from another system and should therefore be blanked out when copying configuration files.
static java.lang.String	CONFIG_GUI The fully-qualified platform-wildcarded class name for the configuration editor for GpsdConnector.
static java.util.Map<PortConfig.Fields,PortConfig.RequireHints>	REQ_FIELDS List of PortConfig field identifiers that are mandated for this port type to work, and the ResourceBundle key to prompt for a value if missing.
static java.lang.String	TYPE_NAME The configuration type name for GPSD ports.

Fields inherited from class org.ka2ddo.yaac.io.PortConnector

currentCfg, portConfig

Fields inherited from class org.ka2ddo.ax25.Connector

CAP_ADSB, CAP_FAST_RF_9600, CAP_FULL_DUPLEX, CAP_GPS_DATA, CAP_HF, CAP_IGATE, CAP_KENWOOD_CMD, CAP_OPENTRAC, CAP_OTHER_TRANSPORT, CAP_RAW_AX25, CAP_RCV_PACKET_DATA, CAP_RF, CAP_SUBCLIENT, CAP_WAYPOINT_SENDER, CAP_WEATHER, CAP_XMT_PACKET_DATA, stats

Constructor Summary

Constructors

Constructor and Description
GpsdConnector()

Method Summary

Modifier and Type	Method and Description
void	close() Shut down this port connection.
void	configure(PortConfig config) Update the configuration of the connector to match the updated setup.
static void	fillinConfigDefaults(PortConfig.Cfg cfg) Set the correct defaults for a port in process of being created.
int	getBitRate() Get the bit transmission rate on this port.
int	getCapabilities() Specify what capabilities a port of this type has.
boolean	isOpen() Reports whether this PortConnector has an open connection to its port.
void	run() Read the socket connection until it closes.
java.lang.String	toString() Returns a string representation of the GpsdConnector object.
void	uncaughtException(java.lang.Thread t, java.lang.Throwable e) Method invoked when the given thread terminates due to the given uncaught exception.

Methods inherited from class org.ka2ddo.yaac.io.PortConnector

addPortEventListener, createPort, fillinConfigDefaultsForType, fireFailed, fireReceiving, fireTransmitting, getCollectedStatsTypes, getPortConfig, getPortConnectorClass, getPortConnectorInactivityTimer, getStats, portConnectorClasses, portTypeNames, registerPortConnectorType, removePortEventListener, setPortConfig

Methods inherited from class org.ka2ddo.ax25.Connector

addFrameListener, finalize, fireConsumeFrame, fireConsumeFrame, getCallsign, getStats, getType, hasCapability, removeFrameListener

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_NAME

public static final java.lang.String TYPE_NAME

The configuration type name for GPSD ports.

See Also:

Constant Field Values

CONFIG_GUI

public static final java.lang.String CONFIG_GUI

The fully-qualified platform-wildcarded class name for the configuration editor for GpsdConnector.

See Also:

Constant Field Values

BLANK_FIELDS

public static final java.util.Set<PortConfig.Fields> BLANK_FIELDS

Set of PortConfig field identifiers for fields that should not be copied from another system and should therefore be blanked out when copying configuration files.

REQ_FIELDS

public static final java.util.Map<PortConfig.Fields,PortConfig.RequireHints> REQ_FIELDS

List of PortConfig field identifiers that are mandated for this port type to work, and the ResourceBundle key to prompt for a value if missing.

Constructor Detail

GpsdConnector

public GpsdConnector()

Method Detail

fillinConfigDefaults

public static void fillinConfigDefaults(PortConfig.Cfg cfg)

Set the correct defaults for a port in process of being created.

Parameters:

cfg - PortConfig.Cfg whose defaults should be adjusted

configure

public void configure(PortConfig config)
               throws java.io.IOException,
                      java.lang.IllegalArgumentException

Update the configuration of the connector to match the updated setup.

Specified by:

configure in class PortConnector

Parameters:

config - PortConfig defining new port settings

Throws:

java.io.IOException - if interface changes could not be applied

java.lang.IllegalArgumentException - if type information is invalid for changing the settings of this PortConnector

isOpen

public boolean isOpen()

Reports whether this PortConnector has an open connection to its port.

Specified by:

isOpen in class Connector

Returns:

boolean true if PortConnector is open

run

public void run()

Read the socket connection until it closes.

Specified by:

run in interface java.lang.Runnable

See Also:

Thread.run()

close

public void close()

Shut down this port connection. Expected to be overridden by sub-classes.

Overrides:

close in class Connector

getCapabilities

public int getCapabilities()

Specify what capabilities a port of this type has.

Overrides:

getCapabilities in class Connector

Returns:

bitmask of capability flags

See Also:

Connector.CAP_GPS_DATA

getBitRate

public int getBitRate()

Get the bit transmission rate on this port.

Overrides:

getBitRate in class PortConnector

Returns:

guesstimated bit rate in bits per second (baud)

toString

public java.lang.String toString()

Returns a string representation of the GpsdConnector object.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.

uncaughtException

public final void uncaughtException(java.lang.Thread t,
                                    java.lang.Throwable e)

Method invoked when the given thread terminates due to the given uncaught exception.

Specified by:

uncaughtException in interface java.lang.Thread.UncaughtExceptionHandler

Parameters:

t - the thread

e - the exception