com.esri.arcgis.carto
Interface IGpsConnection

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GpsConnection, IGpsConnectionProxy

public interface IGpsConnection
extends java.io.Serializable

COM Interface 'IGpsConnection'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control the connection properties of the communications port connected to a GPS receiver.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDf5570bc4_13ab_49ed_86a4_13488447a3fe
static int	xxDummy Deprecated. Internal use only

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.

Field Detail

IIDf5570bc4_13ab_49ed_86a4_13488447a3fe

static final int IIDf5570bc4_13ab_49ed_86a4_13488447a3fe

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getCommPort

short getCommPort()
                  throws java.io.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.

Returns:

The pNumber

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCommPort

void setCommPort(short pNumber)
                 throws java.io.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.

Parameters:

pNumber - The pNumber (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBaudRate

short getBaudRate()
                  throws java.io.IOException,
                         AutomationException

The baud rate for the communications port connected to the GPS receiver. Defaults to 9600.

Returns:

The pRate

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBaudRate

void setBaudRate(short pRate)
                 throws java.io.IOException,
                        AutomationException

The baud rate for the communications port connected to the GPS receiver. Defaults to 9600.

Parameters:

pRate - The pRate (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataBits

short getDataBits()
                  throws java.io.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.

Returns:

The pDataBits

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataBits

void setDataBits(short pDataBits)
                 throws java.io.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.

Parameters:

pDataBits - The pDataBits (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStopBits

int getStopBits()
                throws java.io.IOException,
                       AutomationException

The stop bits setting for the communications port connected to the GPS receiver. Defaults to esriGpsStopBits1.

Returns:

A com.esri.arcgis.carto.esriGpsStopBits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStopBits

void setStopBits(int pStopBits)
                 throws java.io.IOException,
                        AutomationException

The stop bits setting for the communications port connected to the GPS receiver. Defaults to esriGpsStopBits1.

Parameters:

pStopBits - A com.esri.arcgis.carto.esriGpsStopBits constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParity

int getParity()
              throws java.io.IOException,
                     AutomationException

The parity setting for the communications port connected to the GPS receiver. Defaults to esriGpsParityNone.

Returns:

A com.esri.arcgis.carto.esriGpsParity constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParity

void setParity(int pParity)
               throws java.io.IOException,
                      AutomationException

The parity setting for the communications port connected to the GPS receiver. Defaults to esriGpsParityNone.

Parameters:

pParity - A com.esri.arcgis.carto.esriGpsParity constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.