com.esri.arcgis.carto
Class GpsConnection

java.lang.Object
  extended by com.esri.arcgis.carto.GpsConnection
All Implemented Interfaces:
IGpsConnection, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

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

COM Class 'GpsConnection'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'Used to establish a connection to the computer's communication port.' 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 =

See Also:
Serialized Form

Field Summary
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.carto.IGpsConnection
IID, IIDf5570bc4_13ab_49ed_86a4_13488447a3fe, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Constructor Summary
GpsConnection()
          Constructs a GpsConnection using ArcGIS Engine.
GpsConnection(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GpsConnection theGpsConnection = (GpsConnection) obj;
 
Method Summary
 boolean equals(java.lang.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 java.lang.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.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 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(java.io.ObjectInput in)
           
 void release()
          Release a GpsConnection.
 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(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

GpsConnection

public GpsConnection()
              throws java.io.IOException,
                     java.net.UnknownHostException
Constructs a GpsConnection using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

GpsConnection

public GpsConnection(java.lang.Object obj)
              throws java.io.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:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a GpsConnection.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getCommPort

public 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.

Specified by:
getCommPort in interface IGpsConnection
Returns:
The pNumber
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCommPort

public 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.

Specified by:
setCommPort in interface IGpsConnection
Parameters:
pNumber - The pNumber (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBaudRate

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

Specified by:
getBaudRate in interface IGpsConnection
Returns:
The pRate
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBaudRate

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

Specified by:
setBaudRate in interface IGpsConnection
Parameters:
pRate - The pRate (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataBits

public 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.

Specified by:
getDataBits in interface IGpsConnection
Returns:
The pDataBits
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDataBits

public 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.

Specified by:
setDataBits in interface IGpsConnection
Parameters:
pDataBits - The pDataBits (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStopBits

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

Specified by:
getStopBits in interface IGpsConnection
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

public 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.

Specified by:
setStopBits in interface IGpsConnection
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

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

Specified by:
getParity in interface IGpsConnection
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

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

Specified by:
setParity in interface IGpsConnection
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.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException
isDirty

Specified by:
isDirty in interface IPersistStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

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

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

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

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException