com.esri.arcgis.carto
Class GpsFeed

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

All Implemented Interfaces:

IGpsFeed, IRealTimeFeed, IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

public class GpsFeed
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRealTimeFeed, IGpsFeed, IPersistStream, IConnectionPointContainer, Externalizable

Used to connected to a GPS unit through the communication port, implements IRealTimeFeed, and fires events when the GPS location changes.

Product Availability

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

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

GpsFeed()
Constructs a GpsFeed using ArcGIS Engine.

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

Method Summary

void	addIRealTimeFeedEventsListener(IRealTimeFeedEvents theListener) addIRealTimeFeedEventsListener.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
IGpsConnection	getConnection() The GPS connection object.
int	getConnectionError() Connection error information.
esriGpsDateTime	getCurrentDateTime() The current date and time.
esriGpsDgpsInfo	getCurrentDgpsInfo() The current DGPS information.
esriGpsDOPInfo	getCurrentDopInfo() The current DOP information.
esriGpsGroundCourse	getCurrentGroundCourse() The current ground course.
esriGpsMagneticVariance	getCurrentMagneticVariance() The current magnetic variance.
esriGpsPositionInfo	getCurrentPosition() The current position information from the real-time feed.
int	getCurrentSatelliteCount() The most recent number of satellites.
esriGpsSatelliteData	getCurrentSatelliteData(int index) The satellite data for the given index value.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ISpatialReference	getSpatialReference() The spatial reference of the real-time feed.
int	getStatus() The current status of the real-time feed.
int	getTestStatus() Reports the tested status of the connection(The connection need not be open).
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	removeIRealTimeFeedEventsListener(IRealTimeFeedEvents theListener) removeIRealTimeFeedEventsListener.
void	save(IStream pstm, int fClearDirty) save
void	setConnectionByRef(IGpsConnection ppConnection) The GPS connection object.
void	setSpatialReferenceByRef(ISpatialReference ppSpatialReference) The spatial reference of the real-time feed.
void	start() Starts the real-time feed.
void	stop() Stops the real-time feed.
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

GpsFeed

public GpsFeed()
        throws IOException,
               UnknownHostException

Constructs a GpsFeed using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GpsFeed

public GpsFeed(Object obj)
        throws IOException

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

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

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

addIRealTimeFeedEventsListener

public void addIRealTimeFeedEventsListener(IRealTimeFeedEvents theListener)
                                    throws IOException

addIRealTimeFeedEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.IRealTimeFeedEvents interface.

Throws:

IOException - If there are communications problems.

removeIRealTimeFeedEventsListener

public void removeIRealTimeFeedEventsListener(IRealTimeFeedEvents theListener)
                                       throws IOException

removeIRealTimeFeedEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.IRealTimeFeedEvents interface.

Throws:

IOException - If there are communications problems.

start

public void start()
           throws IOException,
                  AutomationException

Starts the real-time feed. If failed and sets error information in 'ConnectionError'.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

start in interface IRealTimeFeed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stop

public void stop()
          throws IOException,
                 AutomationException

Stops the real-time feed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

stop in interface IRealTimeFeed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

The spatial reference of the real-time feed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSpatialReference in interface IRealTimeFeed

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference ppSpatialReference)
                              throws IOException,
                                     AutomationException

The spatial reference of the real-time feed.

Product Availability

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

Specified by:

setSpatialReferenceByRef in interface IRealTimeFeed

Parameters:

ppSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStatus

public int getStatus()
              throws IOException,
                     AutomationException

The current status of the real-time feed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getStatus in interface IRealTimeFeed

Returns:

A com.esri.arcgis.carto.esriGpsConnectionStatus constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentPosition

public esriGpsPositionInfo getCurrentPosition()
                                       throws IOException,
                                              AutomationException

The current position information from the real-time feed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCurrentPosition in interface IRealTimeFeed

Returns:

A Structure: com.esri.arcgis.carto.esriGpsPositionInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentSatelliteCount

public int getCurrentSatelliteCount()
                             throws IOException,
                                    AutomationException

The most recent number of satellites.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCurrentSatelliteCount in interface IRealTimeFeed

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentSatelliteData

public esriGpsSatelliteData getCurrentSatelliteData(int index)
                                             throws IOException,
                                                    AutomationException

The satellite data for the given index value.

Product Availability

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

Specified by:

getCurrentSatelliteData in interface IRealTimeFeed

Parameters:

index - The index (in)

Returns:

A Structure: com.esri.arcgis.carto.esriGpsSatelliteData

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentMagneticVariance

public esriGpsMagneticVariance getCurrentMagneticVariance()
                                                   throws IOException,
                                                          AutomationException

The current magnetic variance.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCurrentMagneticVariance in interface IRealTimeFeed

Returns:

A Structure: com.esri.arcgis.carto.esriGpsMagneticVariance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentGroundCourse

public esriGpsGroundCourse getCurrentGroundCourse()
                                           throws IOException,
                                                  AutomationException

The current ground course.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCurrentGroundCourse in interface IRealTimeFeed

Returns:

A Structure: com.esri.arcgis.carto.esriGpsGroundCourse

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentDopInfo

public esriGpsDOPInfo getCurrentDopInfo()
                                 throws IOException,
                                        AutomationException

The current DOP information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCurrentDopInfo in interface IRealTimeFeed

Returns:

A Structure: com.esri.arcgis.carto.esriGpsDOPInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentDateTime

public esriGpsDateTime getCurrentDateTime()
                                   throws IOException,
                                          AutomationException

The current date and time.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCurrentDateTime in interface IRealTimeFeed

Returns:

A Structure: com.esri.arcgis.carto.esriGpsDateTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentDgpsInfo

public esriGpsDgpsInfo getCurrentDgpsInfo()
                                   throws IOException,
                                          AutomationException

The current DGPS information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCurrentDgpsInfo in interface IRealTimeFeed

Returns:

A Structure: com.esri.arcgis.carto.esriGpsDgpsInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionError

public int getConnectionError()
                       throws IOException,
                              AutomationException

Connection error information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getConnectionError in interface IRealTimeFeed

Returns:

A com.esri.arcgis.carto.esriGpsConnectionError constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnection

public IGpsConnection getConnection()
                             throws IOException,
                                    AutomationException

The GPS connection object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getConnection in interface IGpsFeed

Returns:

A reference to a com.esri.arcgis.carto.IGpsConnection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConnectionByRef

public void setConnectionByRef(IGpsConnection ppConnection)
                        throws IOException,
                               AutomationException

The GPS connection object.

Product Availability

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

Supported Platforms

Windows

Specified by:

setConnectionByRef in interface IGpsFeed

Parameters:

ppConnection - A reference to a com.esri.arcgis.carto.IGpsConnection (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTestStatus

public int getTestStatus()
                  throws IOException,
                         AutomationException

Reports the tested status of the connection(The connection need not be open).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTestStatus in interface IGpsFeed

Returns:

A com.esri.arcgis.carto.esriGpsConnectionStatus constant

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.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws IOException,
                                 AutomationException

enumConnectionPoints

Description

IConnectionPointContainer 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:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws IOException,
                                AutomationException

findConnectionPoint

Description

IConnectionPointContainer 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:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (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