com.esri.arcgis.carto
Interface IRealTimeFeed

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GpsFeed, IRealTimeFeedProxy, RealTimeFeedSimulator

public interface IRealTimeFeed
extends java.io.Serializable

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

Description: 'Provides access to basic properties of RealTimeFeed.' 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	IID57736c36_7c6e_4c58_b8cb_b1efb385b47c
static int	xxDummy Deprecated. Internal use only

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.

Field Detail

IID57736c36_7c6e_4c58_b8cb_b1efb385b47c

static final int IID57736c36_7c6e_4c58_b8cb_b1efb385b47c

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

start

void start()
           throws java.io.IOException,
                  AutomationException

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

stop

void stop()
          throws java.io.IOException,
                 AutomationException

Stops the real-time feed.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

The spatial reference of the real-time feed.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

void setSpatialReferenceByRef(ISpatialReference ppSpatialReference)
                              throws java.io.IOException,
                                     AutomationException

The spatial reference of the real-time feed.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStatus

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

The current status of the real-time feed.

Returns:

A com.esri.arcgis.carto.esriGpsConnectionStatus constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentPosition

esriGpsPositionInfo getCurrentPosition()
                                       throws java.io.IOException,
                                              AutomationException

The current position information from the real-time feed.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentSatelliteCount

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

The most recent number of satellites.

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentSatelliteData

esriGpsSatelliteData getCurrentSatelliteData(int index)
                                             throws java.io.IOException,
                                                    AutomationException

The satellite data for the given index value.

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentMagneticVariance

esriGpsMagneticVariance getCurrentMagneticVariance()
                                                   throws java.io.IOException,
                                                          AutomationException

The current magnetic variance.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentGroundCourse

esriGpsGroundCourse getCurrentGroundCourse()
                                           throws java.io.IOException,
                                                  AutomationException

The current ground course.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentDopInfo

esriGpsDOPInfo getCurrentDopInfo()
                                 throws java.io.IOException,
                                        AutomationException

The current DOP information.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentDateTime

esriGpsDateTime getCurrentDateTime()
                                   throws java.io.IOException,
                                          AutomationException

The current date and time.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentDgpsInfo

esriGpsDgpsInfo getCurrentDgpsInfo()
                                   throws java.io.IOException,
                                          AutomationException

The current DGPS information.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConnectionError

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

Connection error information.

Returns:

A com.esri.arcgis.carto.esriGpsConnectionError constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.