com.esri.arcgis.carto
Interface IGpsConnection

All Superinterfaces:
Serializable
All Known Implementing Classes:
GpsConnection

public interface IGpsConnection
extends Serializable

Provides access to members that control the connection properties of the communications port connected to a GPS receiver.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux


Method Summary
 short getBaudRate()
          The baud rate for the communications port connected to the GPS receiver.
 short getCommPort()
          The communications port connected to the GPS receiver.
 short getDataBits()
          The data bits setting for the communications port connected to the GPS receiver.
 int getParity()
          The parity setting for the communications port connected to the GPS receiver.
 int getStopBits()
          The stop bits setting for the communications port connected to the GPS receiver.
 void setBaudRate(short pRate)
          The baud rate for the communications port connected to the GPS receiver.
 void setCommPort(short pNumber)
          The communications port connected to the GPS receiver.
 void setDataBits(short pDataBits)
          The data bits setting for the communications port connected to the GPS receiver.
 void setParity(int pParity)
          The parity setting for the communications port connected to the GPS receiver.
 void setStopBits(int pStopBits)
          The stop bits setting for the communications port connected to the GPS receiver.
 

Method Detail

getCommPort

short getCommPort()
                  throws IOException,
                         AutomationException
The communications port connected to the GPS receiver. Starts with 1 = COM1, and increases (i.e., 2 = COM2, 3 = COM3, etc.). Defaults to 1.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The pNumber
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCommPort

void setCommPort(short pNumber)
                 throws IOException,
                        AutomationException
The communications port connected to the GPS receiver. Starts with 1 = COM1, and increases (i.e., 2 = COM2, 3 = COM3, etc.). Defaults to 1.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pNumber - The pNumber (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBaudRate

short getBaudRate()
                  throws IOException,
                         AutomationException
The baud rate for the communications port connected to the GPS receiver. Defaults to 9600.

Remarks

Specifies the baud rate of the GPS connection. The values correspond to values in the esriGpsBaudRate enumeration. In many cases this value will be the actual baud rate, but baud rates higher than 19200 will correspond to lower values in the enumeration since the property is represented as a 16 bit integer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The pRate
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBaudRate

void setBaudRate(short pRate)
                 throws IOException,
                        AutomationException
The baud rate for the communications port connected to the GPS receiver. Defaults to 9600.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pRate - The pRate (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataBits

short getDataBits()
                  throws IOException,
                         AutomationException
The data bits setting for the communications port connected to the GPS receiver. Data bits must be 5, 6, 7, or 8. Defaults to 8.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The pDataBits
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDataBits

void setDataBits(short pDataBits)
                 throws IOException,
                        AutomationException
The data bits setting for the communications port connected to the GPS receiver. Data bits must be 5, 6, 7, or 8. Defaults to 8.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pDataBits - The pDataBits (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStopBits

int getStopBits()
                throws IOException,
                       AutomationException
The stop bits setting for the communications port connected to the GPS receiver. Defaults to esriGpsStopBits1.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.carto.esriGpsStopBits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStopBits

void setStopBits(int pStopBits)
                 throws IOException,
                        AutomationException
The stop bits setting for the communications port connected to the GPS receiver. Defaults to esriGpsStopBits1.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pStopBits - A com.esri.arcgis.carto.esriGpsStopBits constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParity

int getParity()
              throws IOException,
                     AutomationException
The parity setting for the communications port connected to the GPS receiver. Defaults to esriGpsParityNone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.carto.esriGpsParity constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setParity

void setParity(int pParity)
               throws IOException,
                      AutomationException
The parity setting for the communications port connected to the GPS receiver. Defaults to esriGpsParityNone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pParity - A com.esri.arcgis.carto.esriGpsParity constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.