com.esri.arcgis.carto
Interface IRealTimeFeed

All Superinterfaces:

Serializable

All Known Implementing Classes:

GpsFeed, RealTimeFeedSimulator

public interface IRealTimeFeed
extends Serializable

Provides access to basic properties of RealTimeFeed.

Product Availability

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

Method Summary

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.
ISpatialReference	getSpatialReference() The spatial reference of the real-time feed.
int	getStatus() The current status of the real-time feed.
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.

Method Detail

start

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stop

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

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

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

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.

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

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

Returns:

A com.esri.arcgis.carto.esriGpsConnectionStatus constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentPosition

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentSatelliteCount

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

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentSatelliteData

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.

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

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentGroundCourse

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentDopInfo

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentDateTime

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentDgpsInfo

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionError

int getConnectionError()
                       throws IOException,
                              AutomationException

Connection error information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.carto.esriGpsConnectionError constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.