com.esri.arcgis.carto
Class GpsConnection

java.lang.Object
  com.esri.arcgis.carto.GpsConnection

All Implemented Interfaces:

IGpsConnection, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

public class GpsConnection
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGpsConnection, IPersistStream, Externalizable

Used to establish a connection to the computer's communication port.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

GpsConnection()
Constructs a GpsConnection using ArcGIS Engine.

GpsConnection(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GpsConnection theGpsConnection = (GpsConnection) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
short	getBaudRate() The baud rate for the communications port connected to the GPS receiver.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
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.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getStopBits() The stop bits setting for the communications port connected to the GPS receiver.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
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.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

GpsConnection

public GpsConnection()
              throws IOException,
                     UnknownHostException

Constructs a GpsConnection using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GpsConnection

public GpsConnection(Object obj)
              throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GpsConnection theGpsConnection = (GpsConnection) obj;

Construct a GpsConnection using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GpsConnection.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getCommPort

public 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

Specified by:

getCommPort in interface IGpsConnection

Returns:

The pNumber

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCommPort

public 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

Specified by:

setCommPort in interface IGpsConnection

Parameters:

pNumber - The pNumber (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBaudRate

public 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

Specified by:

getBaudRate in interface IGpsConnection

Returns:

The pRate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBaudRate

public 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

Specified by:

setBaudRate in interface IGpsConnection

Parameters:

pRate - The pRate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataBits

public 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

Specified by:

getDataBits in interface IGpsConnection

Returns:

The pDataBits

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataBits

public 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

Specified by:

setDataBits in interface IGpsConnection

Parameters:

pDataBits - The pDataBits (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStopBits

public 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

Specified by:

getStopBits in interface IGpsConnection

Returns:

A com.esri.arcgis.carto.esriGpsStopBits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStopBits

public 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

Specified by:

setStopBits in interface IGpsConnection

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

public 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

Specified by:

getParity in interface IGpsConnection

Returns:

A com.esri.arcgis.carto.esriGpsParity constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParity

public 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

Specified by:

setParity in interface IGpsConnection

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.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException