RealTimeFeedManager (ArcObjects Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto
Class RealTimeFeedManager

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

All Implemented Interfaces:: IActiveViewEvents, IGpsDisplayProperties, IPositionTrails, IRealTimeDestination, IRealTimeFeedEvents, IRealTimeFeedManager, IRealTimeFeedSnap, IRealTimeLog, IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable, EventListener

public class RealTimeFeedManager
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRealTimeFeedManager, IGpsDisplayProperties, IPositionTrails, IRealTimeLog, IRealTimeDestination, IRealTimeFeedSnap, IPersistStream, IRealTimeFeedEvents, IActiveViewEvents, IConnectionPointContainer, Externalizable
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRealTimeFeedManager, IGpsDisplayProperties, IPositionTrails, IRealTimeLog, IRealTimeDestination, IRealTimeFeedSnap, IPersistStream, IRealTimeFeedEvents, IActiveViewEvents, IConnectionPointContainer, Externalizable

The real-time feed manager object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:: Serialized Form

Constructor Summary
`RealTimeFeedManager()` Constructs a RealTimeFeedManager using ArcGIS Engine.
`RealTimeFeedManager(Object obj)` Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. `RealTimeFeedManager theRealTimeFeedManager = (RealTimeFeedManager) obj;`

Method Summary
`void`	`addIRealTimeFeedManagerEventsListener(IRealTimeFeedManagerEvents theListener)` addIRealTimeFeedManagerEventsListener.
`void`	`afterDraw(IActiveViewEventsAfterDrawEvent theEvent)` Fired after the specified phase is drawn.
`void`	`afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent)` Fired after an individual view item is drawn.
`void`	`clearGpsDisplay()` Clears the GPS display.
`void`	`connectionStatusUpdated(IRealTimeFeedEventsConnectionStatusUpdatedEvent theEvent)` Reports the connection information when it is updated.
`void`	`contentsChanged(IActiveViewEventsContentsChangedEvent theEvent)` Fired when the contents of the view changes.
`void`	`contentsCleared(IActiveViewEventsContentsClearedEvent theEvent)` Fired when the contents of the view is cleared.
`void`	`dateTimeUpdated(IRealTimeFeedEventsDateTimeUpdatedEvent theEvent)` Reports the date and time when it is updated.
`void`	`dgpsInfoUpdated(IRealTimeFeedEventsDgpsInfoUpdatedEvent theEvent)` Reports the DGPS information when it is updated.
`void`	`dopInfoUpdated(IRealTimeFeedEventsDopInfoUpdatedEvent theEvent)` Reports the current DOP information when it is updated.
`void`	`enumConnectionPoints(IEnumConnectionPoints[] ppEnum)` enumConnectionPoints
`boolean`	`equals(Object o)` Compare this object with another
`void`	`findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)` findConnectionPoint
`void`	`focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent)` Fired when a new map is made active.
`int`	`getAltitudeUnits()` The units used for altitude in the GPS display.
`IMarkerSymbol`	`getBaseMarkerSymbol()` The marker symbol used to display the current position under normal circumstances.
`IMarkerSymbol`	`getBearingToDestinationSymbol()` The marker symbol used to point to the destination.
`void`	`getClassID(GUID[] pClassID)` getClassID
`static String`	`getClsid()` getClsid.
`String`	`getDestinationLabel()` The label string for the destination.
`IPoint`	`getDestinationLocation()` The location of the destination point.
`IMarkerSymbol`	`getDestinationSymbol()` The symbol used to show the destination.
`ITextSymbol`	`getDestinationTextSymbol()` The text symbol used to display the destination label.
`IMarkerSymbol`	`getEstimatedPositionSymbol()` The marker symbol used to display the estimated current position if the signal is lost.
`IGpsFeed`	`getGpsFeed()` The GPS feed object.
`double`	`getHighAltitudeSize()` The maximum altitude size used in calculating the current size of the base marker symbol.
`double`	`getHighAltitudeValue()` The maximum altitude value used in calculating the size of the base marker symbol.
`double`	`getHighSpeedValue()` The maximum speed value used in calculating the size of the base marker symbol.
`int`	`getLatLongDisplayFormat()` The latitude-longitude display format for the GPS display.
`double`	`getLinearTrailDistance()` The distance, in map units, of the linear trail behind the current position.
`ILineSymbol`	`getLinearTrailSymbol()` The line symbol to use for a linear trail.
`IFeatureClass`	`getLogFile()` The feature class used to log positions.
`double`	`getLogRate()` The time, in seconds, between storing positions in the log file.
`double`	`getLowAltitudeSize()` The minimum altitude size used in calculating the current size of the base marker symbol.
`double`	`getLowAltitudeValue()` The minimum altitude value used in calculating the size of the base marker symbol.
`double`	`getLowSpeedValue()` The minimum speed value used in calculating the size of the base marker symbol.
`IMap`	`getMap()` The map on which to display the current position.
`IColorRamp`	`getMarkerTrailColorRamp()` A color ramp to use for displaying the marker trails.
`int`	`getMarkerTrailCount()` The number of marker symbols to show as a trail.
`double`	`getMarkerTrailDistance()` The distance, in map units, of the distance between marker trails.
`IMarkerSymbol`	`getMarkerTrailSymbol()` The marker symbol to use for a marker trail.
`double`	`getMinimumDisplayRate()` The minimum amount of time in seconds between screen refreshes for the display of the current position.
`double`	`getMinimumLogDeflectionAngle()` The minimum deflection angle to use when deciding when to log points.
`double`	`getMinimumLogDistance()` The minimum distance between points before they are logged.
`IEnvelope`	`getPositionsExtent()` Extent bounding all positions received from the current RealTimeFeed so far.
`IRealTimeFeed`	`getRealTimeFeed()` The real-time feed.
`IRealTimeFeedSimulator`	`getRealTimeFeedSimulator()` The real-time feed simulator.
`void`	`getSizeMax(_ULARGE_INTEGER[] pcbSize)` getSizeMax
`double`	`getSnapDistance()` The snap distance, in map units.
`IArray`	`getSnapLayers()` The list of layers used for snapping.
`IColorRamp`	`getSpeedColorRamp()` The color ramp used to vary the color by speed.
`int`	`getSpeedUnits()` The units to use for the speed of the current position.
`void`	`groundCourseUpdated(IRealTimeFeedEventsGroundCourseUpdatedEvent theEvent)` Reports the current ground variance when it is updated.
`int`	`hashCode()` the hashcode for this object
`boolean`	`isAutoPan()` Indicates if the display extents are adjusted to keep the GPS position on the screen.
`void`	`isDirty()` isDirty
`boolean`	`isLogEstimatedPosition()` Indicates if positions are logged if the signal is lost.
`boolean`	`isLogging()` Indicates if the data is being logged.
`boolean`	`isShowBearingToDestination()` Indicates if the bearing to the destination from the current location is displayed.
`boolean`	`isShowCurrentAltitude()` Indicates if the variation in the altitude is displayed.
`boolean`	`isShowCurrentBearing()` Indicates if the current heading (bearing) is displayed as an angle for the base marker symbol.
`boolean`	`isShowCurrentPosition()` Indicates if the current position is displayed.
`boolean`	`isShowCurrentSpeed()` Indicates if the base marker symbol size is varied based on the speed of the current position.
`boolean`	`isShowEstimatedPosition()` Indicates if the estimated position is displayed when the signal is lost.
`boolean`	`isShowLinearTrail()` Indicates if the linear trail of the previous positions should be visible.
`boolean`	`isShowMarkerTrailAltitude()` Indicates if the variation in the altitude is displayed in the marker trail.
`boolean`	`isShowMarkerTrailBearing()` Indicates if the trail heading (bearing) is displayed as an angle of the base marker symbol.
`boolean`	`isShowMarkerTrails()` Indicates if marker symbols shows previous positions.
`boolean`	`isShowMarkerTrailSpeed()` Indicates if the base marker symbol size is based on the speed of the marker trail position.
`boolean`	`isSnapToLines()` Indicates if positions are snapped to the lines in the snap layers' feature geometries.
`boolean`	`isSnapToNodes()` Indicates if positions are snapped to the nodes in the snap layers' feature geometries.
`boolean`	`isSnapToVertices()` Indicates if positions are snapped to the vertices in the snap layers' feature geometries.
`boolean`	`isUseLogRate()` Indicates if the log rate is used for sampling data.
`boolean`	`isUseMinimumDisplayRate()` Indicates if the minimum display rate value is in effect.
`boolean`	`isUseMinimumLogDeflectionAngle()` Indicates if the minimum log deflection angle is used for sampling data.
`boolean`	`isUseMinimumLogDistance()` Indicates if the minimum log rate is used for sampling data.
`void`	`itemAdded(IActiveViewEventsItemAddedEvent theEvent)` Fired when an item is added to the view.
`void`	`itemDeleted(IActiveViewEventsItemDeletedEvent theEvent)` Fired when an item is deleted from the view.
`void`	`itemReordered(IActiveViewEventsItemReorderedEvent theEvent)` Fired when a view item is reordered.
`void`	`load(IStream pstm)` load
`void`	`magneticVarianceUpdated(IRealTimeFeedEventsMagneticVarianceUpdatedEvent theEvent)` Reports the current magnetic variance when it is updated.
`void`	`positionUpdated(IRealTimeFeedEventsPositionUpdatedEvent theEvent)` Reports the current position when it is updated.
`void`	`readExternal(ObjectInput in)`
`void`	`refreshGpsDisplay()` Refreshes the GPS display.
`void`	`removeIRealTimeFeedManagerEventsListener(IRealTimeFeedManagerEvents theListener)` removeIRealTimeFeedManagerEventsListener.
`void`	`satelliteInfoUpdated(IRealTimeFeedEventsSatelliteInfoUpdatedEvent theEvent)` Reports the current satellite information when it is updated.
`void`	`save(IStream pstm, int fClearDirty)` save
`void`	`selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent)` Call this function to fire the selection changed event.
`void`	`setAltitudeUnits(int pAltitudeUnits)` The units used for altitude in the GPS display.
`void`	`setAutoPan(boolean autoPan)` Indicates if the display extents are adjusted to keep the GPS position on the screen.
`void`	`setBaseMarkerSymbolByRef(IMarkerSymbol ppMarker)` The marker symbol used to display the current position under normal circumstances.
`void`	`setBearingToDestinationSymbolByRef(IMarkerSymbol ppSymbol)` The marker symbol used to point to the destination.
`void`	`setDestinationLabel(String label)` The label string for the destination.
`void`	`setDestinationLocation(IPoint ppPoint)` The location of the destination point.
`void`	`setDestinationSymbolByRef(IMarkerSymbol ppSymbol)` The symbol used to show the destination.
`void`	`setDestinationTextSymbolByRef(ITextSymbol ppSymbol)` The text symbol used to display the destination label.
`void`	`setEstimatedPositionSymbolByRef(IMarkerSymbol ppMarker)` The marker symbol used to display the estimated current position if the signal is lost.
`void`	`setHighAltitudeSize(double pSize)` The maximum altitude size used in calculating the current size of the base marker symbol.
`void`	`setHighAltitudeValue(double pAltitude)` The maximum altitude value used in calculating the size of the base marker symbol.
`void`	`setHighSpeedValue(double pSize)` The maximum speed value used in calculating the size of the base marker symbol.
`void`	`setLatLongDisplayFormat(int latLongFormat)` The latitude-longitude display format for the GPS display.
`void`	`setLinearTrailDistance(double pDistance)` The distance, in map units, of the linear trail behind the current position.
`void`	`setLinearTrailSymbolByRef(ILineSymbol ppSymbol)` The line symbol to use for a linear trail.
`void`	`setLogEstimatedPosition(boolean pLogEstimated)` Indicates if positions are logged if the signal is lost.
`void`	`setLogFileByRef(IFeatureClass ppFeatureClass)` The feature class used to log positions.
`void`	`setLogRate(double pRate)` The time, in seconds, between storing positions in the log file.
`void`	`setLowAltitudeSize(double pSize)` The minimum altitude size used in calculating the current size of the base marker symbol.
`void`	`setLowAltitudeValue(double pAltitude)` The minimum altitude value used in calculating the size of the base marker symbol.
`void`	`setLowSpeedValue(double pSpeed)` The minimum speed value used in calculating the size of the base marker symbol.
`void`	`setMapByRef(IMap ppMap)` The map on which to display the current position.
`void`	`setMarkerTrailColorRampByRef(IColorRamp ppRamp)` A color ramp to use for displaying the marker trails.
`void`	`setMarkerTrailCount(int pCount)` The number of marker symbols to show as a trail.
`void`	`setMarkerTrailDistance(double pDistance)` The distance, in map units, of the distance between marker trails.
`void`	`setMarkerTrailSymbolByRef(IMarkerSymbol ppSymbol)` The marker symbol to use for a marker trail.
`void`	`setMinimumDisplayRate(double pRate)` The minimum amount of time in seconds between screen refreshes for the display of the current position.
`void`	`setMinimumLogDeflectionAngle(double pAngle)` The minimum deflection angle to use when deciding when to log points.
`void`	`setMinimumLogDistance(double pDistance)` The minimum distance between points before they are logged.
`void`	`setRealTimeFeedByRef(IRealTimeFeed ppRealTimeFeed)` The real-time feed.
`void`	`setShowBearingToDestination(boolean pShow)` Indicates if the bearing to the destination from the current location is displayed.
`void`	`setShowCurrentAltitude(boolean pShowVariation)` Indicates if the variation in the altitude is displayed.
`void`	`setShowCurrentBearing(boolean pShow)` Indicates if the current heading (bearing) is displayed as an angle for the base marker symbol.
`void`	`setShowCurrentPosition(boolean pShow)` Indicates if the current position is displayed.
`void`	`setShowCurrentSpeed(boolean pShow)` Indicates if the base marker symbol size is varied based on the speed of the current position.
`void`	`setShowEstimatedPosition(boolean pShow)` Indicates if the estimated position is displayed when the signal is lost.
`void`	`setShowLinearTrail(boolean pShow)` Indicates if the linear trail of the previous positions should be visible.
`void`	`setShowMarkerTrailAltitude(boolean pShowVariation)` Indicates if the variation in the altitude is displayed in the marker trail.
`void`	`setShowMarkerTrailBearing(boolean pShow)` Indicates if the trail heading (bearing) is displayed as an angle of the base marker symbol.
`void`	`setShowMarkerTrails(boolean pShow)` Indicates if marker symbols shows previous positions.
`void`	`setShowMarkerTrailSpeed(boolean pShow)` Indicates if the base marker symbol size is based on the speed of the marker trail position.
`void`	`setSnapDistance(double pDistance)` The snap distance, in map units.
`void`	`setSnapLayersByRef(IArray ppArray)` The list of layers used for snapping.
`void`	`setSnapToLines(boolean pSnap)` Indicates if positions are snapped to the lines in the snap layers' feature geometries.
`void`	`setSnapToNodes(boolean pSnap)` Indicates if positions are snapped to the nodes in the snap layers' feature geometries.
`void`	`setSnapToVertices(boolean pSnap)` Indicates if positions are snapped to the vertices in the snap layers' feature geometries.
`void`	`setSpeedColorRampByRef(IColorRamp ppColorRamp)` The color ramp used to vary the color by speed.
`void`	`setSpeedUnits(int pUnits)` The units to use for the speed of the current position.
`void`	`setUseLogRate(boolean pUse)` Indicates if the log rate is used for sampling data.
`void`	`setUseMinimumDisplayRate(boolean pUse)` Indicates if the minimum display rate value is in effect.
`void`	`setUseMinimumLogDeflectionAngle(boolean pUse)` Indicates if the minimum log deflection angle is used for sampling data.
`void`	`setUseMinimumLogDistance(boolean pUse)` Indicates if the minimum log rate is used for sampling data.
`void`	`spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent)` Fired when the spatial reference is changed.
`void`	`stampGpsPosition()` Stamp current position values to the selected log file.
`void`	`startLogging()` Start logging to the current log file.
`void`	`stopLogging()` Stop logging to the current log file.
`void`	`viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent)` Fired when view is refreshed before draw happens.
`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

RealTimeFeedManager

public RealTimeFeedManager()
                    throws IOException,
                           UnknownHostException

Constructs a RealTimeFeedManager using ArcGIS Engine.

Throws:: IOException - if there are interop problems; UnknownHostException - if there are interop problems

RealTimeFeedManager

public RealTimeFeedManager(Object obj)
                    throws IOException

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

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

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

addIRealTimeFeedManagerEventsListener

public void addIRealTimeFeedManagerEventsListener(IRealTimeFeedManagerEvents theListener)
                                           throws IOException

addIRealTimeFeedManagerEventsListener. Listen to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.carto.IRealTimeFeedManagerEvents interface.
Throws:: IOException - If there are communications problems.

removeIRealTimeFeedManagerEventsListener

public void removeIRealTimeFeedManagerEventsListener(IRealTimeFeedManagerEvents theListener)
                                              throws IOException

removeIRealTimeFeedManagerEventsListener. Stop listening to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.carto.IRealTimeFeedManagerEvents interface.
Throws:: IOException - If there are communications problems.

getRealTimeFeed

public IRealTimeFeed getRealTimeFeed()
                              throws IOException,
                                     AutomationException

The real-time feed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getRealTimeFeed in interface IRealTimeFeedManager

Returns:: A reference to a com.esri.arcgis.carto.IRealTimeFeed
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setRealTimeFeedByRef

public void setRealTimeFeedByRef(IRealTimeFeed ppRealTimeFeed)
                          throws IOException,
                                 AutomationException

The real-time feed.

Product Availability

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

Specified by:: setRealTimeFeedByRef in interface IRealTimeFeedManager

Parameters:: ppRealTimeFeed - A reference to a com.esri.arcgis.carto.IRealTimeFeed (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMap

public IMap getMap()
            throws IOException,
                   AutomationException

The map on which to display the current position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMap in interface IRealTimeFeedManager

Returns:: A reference to a com.esri.arcgis.carto.IMap
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMapByRef

public void setMapByRef(IMap ppMap)
                 throws IOException,
                        AutomationException

The map on which to display the current position.

Product Availability

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

Specified by:: setMapByRef in interface IRealTimeFeedManager

Parameters:: ppMap - A reference to a com.esri.arcgis.carto.IMap (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getGpsFeed

public IGpsFeed getGpsFeed()
                    throws IOException,
                           AutomationException

The GPS feed object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getGpsFeed in interface IRealTimeFeedManager

Returns:: A reference to a com.esri.arcgis.carto.IGpsFeed
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getRealTimeFeedSimulator

public IRealTimeFeedSimulator getRealTimeFeedSimulator()
                                                throws IOException,
                                                       AutomationException

The real-time feed simulator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getRealTimeFeedSimulator in interface IRealTimeFeedManager

Returns:: A reference to a com.esri.arcgis.carto.IRealTimeFeedSimulator
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMinimumDisplayRate

public double getMinimumDisplayRate()
                             throws IOException,
                                    AutomationException

The minimum amount of time in seconds between screen refreshes for the display of the current position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMinimumDisplayRate in interface IGpsDisplayProperties

Returns:: The pRate
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMinimumDisplayRate

public void setMinimumDisplayRate(double pRate)
                           throws IOException,
                                  AutomationException

The minimum amount of time in seconds between screen refreshes for the display of the current position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setMinimumDisplayRate in interface IGpsDisplayProperties

Parameters:: pRate - The pRate (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isUseMinimumDisplayRate

public boolean isUseMinimumDisplayRate()
                                throws IOException,
                                       AutomationException

Indicates if the minimum display rate value is in effect.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isUseMinimumDisplayRate in interface IGpsDisplayProperties

Returns:: The pUse
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setUseMinimumDisplayRate

public void setUseMinimumDisplayRate(boolean pUse)
                              throws IOException,
                                     AutomationException

Indicates if the minimum display rate value is in effect.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setUseMinimumDisplayRate in interface IGpsDisplayProperties

Parameters:: pUse - The pUse (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isShowCurrentPosition

public boolean isShowCurrentPosition()
                              throws IOException,
                                     AutomationException

Indicates if the current position is displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isShowCurrentPosition in interface IGpsDisplayProperties

Returns:: The pShow
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setShowCurrentPosition

public void setShowCurrentPosition(boolean pShow)
                            throws IOException,
                                   AutomationException

Indicates if the current position is displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setShowCurrentPosition in interface IGpsDisplayProperties

Parameters:: pShow - The pShow (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getBaseMarkerSymbol

public IMarkerSymbol getBaseMarkerSymbol()
                                  throws IOException,
                                         AutomationException

The marker symbol used to display the current position under normal circumstances.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBaseMarkerSymbol in interface IGpsDisplayProperties

Returns:: A reference to a com.esri.arcgis.display.IMarkerSymbol
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setBaseMarkerSymbolByRef

public void setBaseMarkerSymbolByRef(IMarkerSymbol ppMarker)
                              throws IOException,
                                     AutomationException

The marker symbol used to display the current position under normal circumstances.

Product Availability

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

Specified by:: setBaseMarkerSymbolByRef in interface IGpsDisplayProperties

Parameters:: ppMarker - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isShowEstimatedPosition

public boolean isShowEstimatedPosition()
                                throws IOException,
                                       AutomationException

Indicates if the estimated position is displayed when the signal is lost.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isShowEstimatedPosition in interface IGpsDisplayProperties

Returns:: The pShow
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setShowEstimatedPosition

public void setShowEstimatedPosition(boolean pShow)
                              throws IOException,
                                     AutomationException

Indicates if the estimated position is displayed when the signal is lost.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setShowEstimatedPosition in interface IGpsDisplayProperties

Parameters:: pShow - The pShow (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getEstimatedPositionSymbol

public IMarkerSymbol getEstimatedPositionSymbol()
                                         throws IOException,
                                                AutomationException

The marker symbol used to display the estimated current position if the signal is lost.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getEstimatedPositionSymbol in interface IGpsDisplayProperties

Returns:: A reference to a com.esri.arcgis.display.IMarkerSymbol
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setEstimatedPositionSymbolByRef

public void setEstimatedPositionSymbolByRef(IMarkerSymbol ppMarker)
                                     throws IOException,
                                            AutomationException

The marker symbol used to display the estimated current position if the signal is lost.

Product Availability

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

Specified by:: setEstimatedPositionSymbolByRef in interface IGpsDisplayProperties

Parameters:: ppMarker - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setShowCurrentAltitude

public void setShowCurrentAltitude(boolean pShowVariation)
                            throws IOException,
                                   AutomationException

Indicates if the variation in the altitude is displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setShowCurrentAltitude in interface IGpsDisplayProperties

Parameters:: pShowVariation - The pShowVariation (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isShowCurrentAltitude

public boolean isShowCurrentAltitude()
                              throws IOException,
                                     AutomationException

Indicates if the variation in the altitude is displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isShowCurrentAltitude in interface IGpsDisplayProperties

Returns:: The pShowVariation
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isShowCurrentBearing

public boolean isShowCurrentBearing()
                             throws IOException,
                                    AutomationException

Indicates if the current heading (bearing) is displayed as an angle for the base marker symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isShowCurrentBearing in interface IGpsDisplayProperties

Returns:: The pShow
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setShowCurrentBearing

public void setShowCurrentBearing(boolean pShow)
                           throws IOException,
                                  AutomationException

Indicates if the current heading (bearing) is displayed as an angle for the base marker symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setShowCurrentBearing in interface IGpsDisplayProperties

Parameters:: pShow - The pShow (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isShowCurrentSpeed

public boolean isShowCurrentSpeed()
                           throws IOException,
                                  AutomationException

Indicates if the base marker symbol size is varied based on the speed of the current position. Defaults to false.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isShowCurrentSpeed in interface IGpsDisplayProperties

Returns:: The pShow
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setShowCurrentSpeed

public void setShowCurrentSpeed(boolean pShow)
                         throws IOException,
                                AutomationException

Indicates if the base marker symbol size is varied based on the speed of the current position. Defaults to false.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setShowCurrentSpeed in interface IGpsDisplayProperties

Parameters:: pShow - The pShow (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setShowMarkerTrailAltitude

public void setShowMarkerTrailAltitude(boolean pShowVariation)
                                throws IOException,
                                       AutomationException

Indicates if the variation in the altitude is displayed in the marker trail.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setShowMarkerTrailAltitude in interface IGpsDisplayProperties

Parameters:: pShowVariation - The pShowVariation (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isShowMarkerTrailAltitude

public boolean isShowMarkerTrailAltitude()
                                  throws IOException,
                                         AutomationException

Indicates if the variation in the altitude is displayed in the marker trail.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isShowMarkerTrailAltitude in interface IGpsDisplayProperties

Returns:: The pShowVariation
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isShowMarkerTrailBearing

public boolean isShowMarkerTrailBearing()
                                 throws IOException,
                                        AutomationException

Indicates if the trail heading (bearing) is displayed as an angle of the base marker symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isShowMarkerTrailBearing in interface IGpsDisplayProperties

Returns:: The pShow
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setShowMarkerTrailBearing

public void setShowMarkerTrailBearing(boolean pShow)
                               throws IOException,
                                      AutomationException

Indicates if the trail heading (bearing) is displayed as an angle of the base marker symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setShowMarkerTrailBearing in interface IGpsDisplayProperties

Parameters:: pShow - The pShow (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isShowMarkerTrailSpeed

public boolean isShowMarkerTrailSpeed()
                               throws IOException,
                                      AutomationException

Indicates if the base marker symbol size is based on the speed of the marker trail position. Defaults to false.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isShowMarkerTrailSpeed in interface IGpsDisplayProperties

Returns:: The pShow
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setShowMarkerTrailSpeed

public void setShowMarkerTrailSpeed(boolean pShow)
                             throws IOException,
                                    AutomationException

Indicates if the base marker symbol size is based on the speed of the marker trail position. Defaults to false.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setShowMarkerTrailSpeed in interface IGpsDisplayProperties

Parameters:: pShow - The pShow (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSpeedUnits

public int getSpeedUnits()
                  throws IOException,
                         AutomationException

The units to use for the speed of the current position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSpeedUnits in interface IGpsDisplayProperties

Returns:: A com.esri.arcgis.carto.esriGpsSpeedUnits constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSpeedUnits

public void setSpeedUnits(int pUnits)
                   throws IOException,
                          AutomationException

The units to use for the speed of the current position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSpeedUnits in interface IGpsDisplayProperties

Parameters:: pUnits - A com.esri.arcgis.carto.esriGpsSpeedUnits constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLowSpeedValue

public double getLowSpeedValue()
                        throws IOException,
                               AutomationException

The minimum speed value used in calculating the size of the base marker symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLowSpeedValue in interface IGpsDisplayProperties

Returns:: The pSpeed
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setLowSpeedValue

public void setLowSpeedValue(double pSpeed)
                      throws IOException,
                             AutomationException

The minimum speed value used in calculating the size of the base marker symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setLowSpeedValue in interface IGpsDisplayProperties

Parameters:: pSpeed - The pSpeed (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSpeedColorRampByRef

public void setSpeedColorRampByRef(IColorRamp ppColorRamp)
                            throws IOException,
                                   AutomationException

The color ramp used to vary the color by speed.

Product Availability

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

Specified by:: setSpeedColorRampByRef in interface IGpsDisplayProperties

Parameters:: ppColorRamp - A reference to a com.esri.arcgis.display.IColorRamp (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSpeedColorRamp

public IColorRamp getSpeedColorRamp()
                             throws IOException,
                                    AutomationException

The color ramp used to vary the color by speed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSpeedColorRamp in interface IGpsDisplayProperties

Returns:: A reference to a com.esri.arcgis.display.IColorRamp
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLowAltitudeValue

public double getLowAltitudeValue()
                           throws IOException,
                                  AutomationException

The minimum altitude value used in calculating the size of the base marker symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLowAltitudeValue in interface IGpsDisplayProperties

Returns:: The pAltitude
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setLowAltitudeValue

public void setLowAltitudeValue(double pAltitude)
                         throws IOException,
                                AutomationException

The minimum altitude value used in calculating the size of the base marker symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setLowAltitudeValue in interface IGpsDisplayProperties

Parameters:: pAltitude - The pAltitude (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHighAltitudeValue

public double getHighAltitudeValue()
                            throws IOException,
                                   AutomationException

The maximum altitude value used in calculating the size of the base marker symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getHighAltitudeValue in interface IGpsDisplayProperties

Returns:: The pAltitude
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHighAltitudeValue

public void setHighAltitudeValue(double pAltitude)
                          throws IOException,
                                 AutomationException

The maximum altitude value used in calculating the size of the base marker symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setHighAltitudeValue in interface IGpsDisplayProperties

Parameters:: pAltitude - The pAltitude (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLowAltitudeSize

public double getLowAltitudeSize()
                          throws IOException,
                                 AutomationException

The minimum altitude size used in calculating the current size of the base marker symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLowAltitudeSize in interface IGpsDisplayProperties

Returns:: The pSize
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setLowAltitudeSize

public void setLowAltitudeSize(double pSize)
                        throws IOException,
                               AutomationException

The minimum altitude size used in calculating the current size of the base marker symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setLowAltitudeSize in interface IGpsDisplayProperties

Parameters:: pSize - The pSize (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHighSpeedValue

public double getHighSpeedValue()
                         throws IOException,
                                AutomationException

The maximum speed value used in calculating the size of the base marker symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getHighSpeedValue in interface IGpsDisplayProperties

Returns:: The pSize
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHighSpeedValue

public void setHighSpeedValue(double pSize)
                       throws IOException,
                              AutomationException

The maximum speed value used in calculating the size of the base marker symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setHighSpeedValue in interface IGpsDisplayProperties

Parameters:: pSize - The pSize (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHighAltitudeSize

public double getHighAltitudeSize()
                           throws IOException,
                                  AutomationException

The maximum altitude size used in calculating the current size of the base marker symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getHighAltitudeSize in interface IGpsDisplayProperties

Returns:: The pSize
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHighAltitudeSize

public void setHighAltitudeSize(double pSize)
                         throws IOException,
                                AutomationException

The maximum altitude size used in calculating the current size of the base marker symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setHighAltitudeSize in interface IGpsDisplayProperties

Parameters:: pSize - The pSize (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setAutoPan

public void setAutoPan(boolean autoPan)
                throws IOException,
                       AutomationException

Indicates if the display extents are adjusted to keep the GPS position on the screen.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setAutoPan in interface IGpsDisplayProperties

Parameters:: autoPan - The autoPan (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isAutoPan

public boolean isAutoPan()
                  throws IOException,
                         AutomationException

Indicates if the display extents are adjusted to keep the GPS position on the screen.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isAutoPan in interface IGpsDisplayProperties

Returns:: The autoPan
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setAltitudeUnits

public void setAltitudeUnits(int pAltitudeUnits)
                      throws IOException,
                             AutomationException

The units used for altitude in the GPS display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setAltitudeUnits in interface IGpsDisplayProperties

Parameters:: pAltitudeUnits - A com.esri.arcgis.system.esriUnits constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getAltitudeUnits

public int getAltitudeUnits()
                     throws IOException,
                            AutomationException

The units used for altitude in the GPS display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getAltitudeUnits in interface IGpsDisplayProperties

Returns:: A com.esri.arcgis.system.esriUnits constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setLatLongDisplayFormat

public void setLatLongDisplayFormat(int latLongFormat)
                             throws IOException,
                                    AutomationException

The latitude-longitude display format for the GPS display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setLatLongDisplayFormat in interface IGpsDisplayProperties

Parameters:: latLongFormat - A com.esri.arcgis.carto.esriGpsLatLongFormat constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLatLongDisplayFormat

public int getLatLongDisplayFormat()
                            throws IOException,
                                   AutomationException

The latitude-longitude display format for the GPS display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLatLongDisplayFormat in interface IGpsDisplayProperties

Returns:: A com.esri.arcgis.carto.esriGpsLatLongFormat constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getPositionsExtent

public IEnvelope getPositionsExtent()
                             throws IOException,
                                    AutomationException

Extent bounding all positions received from the current RealTimeFeed so far.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getPositionsExtent in interface IGpsDisplayProperties

Returns:: A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

refreshGpsDisplay

public void refreshGpsDisplay()
                       throws IOException,
                              AutomationException

Refreshes the GPS display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: refreshGpsDisplay in interface IGpsDisplayProperties

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

clearGpsDisplay

public void clearGpsDisplay()
                     throws IOException,
                            AutomationException

Clears the GPS display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: clearGpsDisplay in interface IGpsDisplayProperties

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isShowMarkerTrails

public boolean isShowMarkerTrails()
                           throws IOException,
                                  AutomationException

Indicates if marker symbols shows previous positions. Defaults to false.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isShowMarkerTrails in interface IPositionTrails

Returns:: The pShow
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setShowMarkerTrails

public void setShowMarkerTrails(boolean pShow)
                         throws IOException,
                                AutomationException

Indicates if marker symbols shows previous positions. Defaults to false.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setShowMarkerTrails in interface IPositionTrails

Parameters:: pShow - The pShow (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMarkerTrailColorRamp

public IColorRamp getMarkerTrailColorRamp()
                                   throws IOException,
                                          AutomationException

A color ramp to use for displaying the marker trails.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMarkerTrailColorRamp in interface IPositionTrails

Returns:: A reference to a com.esri.arcgis.display.IColorRamp
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMarkerTrailColorRampByRef

public void setMarkerTrailColorRampByRef(IColorRamp ppRamp)
                                  throws IOException,
                                         AutomationException

A color ramp to use for displaying the marker trails.

Product Availability

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

Specified by:: setMarkerTrailColorRampByRef in interface IPositionTrails

Parameters:: ppRamp - A reference to a com.esri.arcgis.display.IColorRamp (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMarkerTrailCount

public int getMarkerTrailCount()
                        throws IOException,
                               AutomationException

The number of marker symbols to show as a trail.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMarkerTrailCount in interface IPositionTrails

Returns:: The pCount
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMarkerTrailCount

public void setMarkerTrailCount(int pCount)
                         throws IOException,
                                AutomationException

The number of marker symbols to show as a trail.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setMarkerTrailCount in interface IPositionTrails

Parameters:: pCount - The pCount (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMarkerTrailDistance

public double getMarkerTrailDistance()
                              throws IOException,
                                     AutomationException

The distance, in map units, of the distance between marker trails.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMarkerTrailDistance in interface IPositionTrails

Returns:: The pDistance
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMarkerTrailDistance

public void setMarkerTrailDistance(double pDistance)
                            throws IOException,
                                   AutomationException

The distance, in map units, of the distance between marker trails.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setMarkerTrailDistance in interface IPositionTrails

Parameters:: pDistance - The pDistance (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMarkerTrailSymbol

public IMarkerSymbol getMarkerTrailSymbol()
                                   throws IOException,
                                          AutomationException

The marker symbol to use for a marker trail.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMarkerTrailSymbol in interface IPositionTrails

Returns:: A reference to a com.esri.arcgis.display.IMarkerSymbol
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMarkerTrailSymbolByRef

public void setMarkerTrailSymbolByRef(IMarkerSymbol ppSymbol)
                               throws IOException,
                                      AutomationException

The marker symbol to use for a marker trail.

Product Availability

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

Specified by:: setMarkerTrailSymbolByRef in interface IPositionTrails

Parameters:: ppSymbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isShowLinearTrail

public boolean isShowLinearTrail()
                          throws IOException,
                                 AutomationException

Indicates if the linear trail of the previous positions should be visible. Defaults to false.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isShowLinearTrail in interface IPositionTrails

Returns:: The pShow
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setShowLinearTrail

public void setShowLinearTrail(boolean pShow)
                        throws IOException,
                               AutomationException

Indicates if the linear trail of the previous positions should be visible. Defaults to false.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setShowLinearTrail in interface IPositionTrails

Parameters:: pShow - The pShow (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLinearTrailSymbol

public ILineSymbol getLinearTrailSymbol()
                                 throws IOException,
                                        AutomationException

The line symbol to use for a linear trail.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLinearTrailSymbol in interface IPositionTrails

Returns:: A reference to a com.esri.arcgis.display.ILineSymbol
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setLinearTrailSymbolByRef

public void setLinearTrailSymbolByRef(ILineSymbol ppSymbol)
                               throws IOException,
                                      AutomationException

The line symbol to use for a linear trail.

Product Availability

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

Specified by:: setLinearTrailSymbolByRef in interface IPositionTrails

Parameters:: ppSymbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLinearTrailDistance

public double getLinearTrailDistance()
                              throws IOException,
                                     AutomationException

The distance, in map units, of the linear trail behind the current position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLinearTrailDistance in interface IPositionTrails

Returns:: The pDistance
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setLinearTrailDistance

public void setLinearTrailDistance(double pDistance)
                            throws IOException,
                                   AutomationException

The distance, in map units, of the linear trail behind the current position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setLinearTrailDistance in interface IPositionTrails

Parameters:: pDistance - The pDistance (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLogFile

public IFeatureClass getLogFile()
                         throws IOException,
                                AutomationException

The feature class used to log positions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLogFile in interface IRealTimeLog

Returns:: A reference to a com.esri.arcgis.geodatabase.IFeatureClass
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setLogFileByRef

public void setLogFileByRef(IFeatureClass ppFeatureClass)
                     throws IOException,
                            AutomationException

The feature class used to log positions.

Product Availability

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

Specified by:: setLogFileByRef in interface IRealTimeLog

Parameters:: ppFeatureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLogRate

public double getLogRate()
                  throws IOException,
                         AutomationException

The time, in seconds, between storing positions in the log file. Defaults to 5 seconds.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLogRate in interface IRealTimeLog

Returns:: The pRate
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setLogRate

public void setLogRate(double pRate)
                throws IOException,
                       AutomationException

The time, in seconds, between storing positions in the log file. Defaults to 5 seconds.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setLogRate in interface IRealTimeLog

Parameters:: pRate - The pRate (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMinimumLogDistance

public double getMinimumLogDistance()
                             throws IOException,
                                    AutomationException

The minimum distance between points before they are logged. Overrides the log rate, if the minimum distance has not been traveled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMinimumLogDistance in interface IRealTimeLog

Returns:: The pDistance
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMinimumLogDistance

public void setMinimumLogDistance(double pDistance)
                           throws IOException,
                                  AutomationException

The minimum distance between points before they are logged. Overrides the log rate, if the minimum distance has not been traveled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setMinimumLogDistance in interface IRealTimeLog

Parameters:: pDistance - The pDistance (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMinimumLogDeflectionAngle

public double getMinimumLogDeflectionAngle()
                                    throws IOException,
                                           AutomationException

The minimum deflection angle to use when deciding when to log points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMinimumLogDeflectionAngle in interface IRealTimeLog

Returns:: The pAngle
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMinimumLogDeflectionAngle

public void setMinimumLogDeflectionAngle(double pAngle)
                                  throws IOException,
                                         AutomationException

The minimum deflection angle to use when deciding when to log points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setMinimumLogDeflectionAngle in interface IRealTimeLog

Parameters:: pAngle - The pAngle (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isUseLogRate

public boolean isUseLogRate()
                     throws IOException,
                            AutomationException

Indicates if the log rate is used for sampling data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isUseLogRate in interface IRealTimeLog

Returns:: The pUse
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setUseLogRate

public void setUseLogRate(boolean pUse)
                   throws IOException,
                          AutomationException

Indicates if the log rate is used for sampling data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setUseLogRate in interface IRealTimeLog

Parameters:: pUse - The pUse (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isUseMinimumLogDistance

public boolean isUseMinimumLogDistance()
                                throws IOException,
                                       AutomationException

Indicates if the minimum log rate is used for sampling data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isUseMinimumLogDistance in interface IRealTimeLog

Returns:: The pUse
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setUseMinimumLogDistance

public void setUseMinimumLogDistance(boolean pUse)
                              throws IOException,
                                     AutomationException

Indicates if the minimum log rate is used for sampling data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setUseMinimumLogDistance in interface IRealTimeLog

Parameters:: pUse - The pUse (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isUseMinimumLogDeflectionAngle

public boolean isUseMinimumLogDeflectionAngle()
                                       throws IOException,
                                              AutomationException

Indicates if the minimum log deflection angle is used for sampling data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isUseMinimumLogDeflectionAngle in interface IRealTimeLog

Returns:: The pUse
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setUseMinimumLogDeflectionAngle

public void setUseMinimumLogDeflectionAngle(boolean pUse)
                                     throws IOException,
                                            AutomationException

Indicates if the minimum log deflection angle is used for sampling data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setUseMinimumLogDeflectionAngle in interface IRealTimeLog

Parameters:: pUse - The pUse (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

startLogging

public void startLogging()
                  throws IOException,
                         AutomationException

Start logging to the current log file.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: startLogging in interface IRealTimeLog

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

stopLogging

public void stopLogging()
                 throws IOException,
                        AutomationException

Stop logging to the current log file.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: stopLogging in interface IRealTimeLog

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isLogging

public boolean isLogging()
                  throws IOException,
                         AutomationException

Indicates if the data is being logged.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isLogging in interface IRealTimeLog

Returns:: The pLogging
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

stampGpsPosition

public void stampGpsPosition()
                      throws IOException,
                             AutomationException

Stamp current position values to the selected log file.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: stampGpsPosition in interface IRealTimeLog

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setLogEstimatedPosition

public void setLogEstimatedPosition(boolean pLogEstimated)
                             throws IOException,
                                    AutomationException

Indicates if positions are logged if the signal is lost.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setLogEstimatedPosition in interface IRealTimeLog

Parameters:: pLogEstimated - The pLogEstimated (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isLogEstimatedPosition

public boolean isLogEstimatedPosition()
                               throws IOException,
                                      AutomationException

Indicates if positions are logged if the signal is lost.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isLogEstimatedPosition in interface IRealTimeLog

Returns:: The pLogEstimated
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDestinationLocation

public IPoint getDestinationLocation()
                              throws IOException,
                                     AutomationException

The location of the destination point.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDestinationLocation in interface IRealTimeDestination

Returns:: A reference to a com.esri.arcgis.geometry.IPoint
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDestinationLocation

public void setDestinationLocation(IPoint ppPoint)
                            throws IOException,
                                   AutomationException

The location of the destination point.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDestinationLocation in interface IRealTimeDestination

Parameters:: ppPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDestinationSymbol

public IMarkerSymbol getDestinationSymbol()
                                   throws IOException,
                                          AutomationException

The symbol used to show the destination.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDestinationSymbol in interface IRealTimeDestination

Returns:: A reference to a com.esri.arcgis.display.IMarkerSymbol
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDestinationSymbolByRef

public void setDestinationSymbolByRef(IMarkerSymbol ppSymbol)
                               throws IOException,
                                      AutomationException

The symbol used to show the destination.

Product Availability

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

Specified by:: setDestinationSymbolByRef in interface IRealTimeDestination

Parameters:: ppSymbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDestinationLabel

public String getDestinationLabel()
                           throws IOException,
                                  AutomationException

The label string for the destination.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDestinationLabel in interface IRealTimeDestination

Returns:: The label
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDestinationLabel

public void setDestinationLabel(String label)
                         throws IOException,
                                AutomationException

The label string for the destination.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDestinationLabel in interface IRealTimeDestination

Parameters:: label - The label (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDestinationTextSymbol

public ITextSymbol getDestinationTextSymbol()
                                     throws IOException,
                                            AutomationException

The text symbol used to display the destination label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDestinationTextSymbol in interface IRealTimeDestination

Returns:: A reference to a com.esri.arcgis.display.ITextSymbol
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDestinationTextSymbolByRef

public void setDestinationTextSymbolByRef(ITextSymbol ppSymbol)
                                   throws IOException,
                                          AutomationException

The text symbol used to display the destination label.

Product Availability

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

Specified by:: setDestinationTextSymbolByRef in interface IRealTimeDestination

Parameters:: ppSymbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isShowBearingToDestination

public boolean isShowBearingToDestination()
                                   throws IOException,
                                          AutomationException

Indicates if the bearing to the destination from the current location is displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isShowBearingToDestination in interface IRealTimeDestination

Returns:: The pShow
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setShowBearingToDestination

public void setShowBearingToDestination(boolean pShow)
                                 throws IOException,
                                        AutomationException

Indicates if the bearing to the destination from the current location is displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setShowBearingToDestination in interface IRealTimeDestination

Parameters:: pShow - The pShow (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getBearingToDestinationSymbol

public IMarkerSymbol getBearingToDestinationSymbol()
                                            throws IOException,
                                                   AutomationException

The marker symbol used to point to the destination.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBearingToDestinationSymbol in interface IRealTimeDestination

Returns:: A reference to a com.esri.arcgis.display.IMarkerSymbol
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setBearingToDestinationSymbolByRef

public void setBearingToDestinationSymbolByRef(IMarkerSymbol ppSymbol)
                                        throws IOException,
                                               AutomationException

The marker symbol used to point to the destination.

Product Availability

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

Specified by:: setBearingToDestinationSymbolByRef in interface IRealTimeDestination

Parameters:: ppSymbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSnapLayers

public IArray getSnapLayers()
                     throws IOException,
                            AutomationException

The list of layers used for snapping.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSnapLayers in interface IRealTimeFeedSnap

Returns:: A reference to a com.esri.arcgis.system.IArray
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSnapLayersByRef

public void setSnapLayersByRef(IArray ppArray)
                        throws IOException,
                               AutomationException

The list of layers used for snapping.

Product Availability

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

Specified by:: setSnapLayersByRef in interface IRealTimeFeedSnap

Parameters:: ppArray - A reference to a com.esri.arcgis.system.IArray (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSnapDistance

public double getSnapDistance()
                       throws IOException,
                              AutomationException

The snap distance, in map units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSnapDistance in interface IRealTimeFeedSnap

Returns:: The pDistance
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSnapDistance

public void setSnapDistance(double pDistance)
                     throws IOException,
                            AutomationException

The snap distance, in map units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSnapDistance in interface IRealTimeFeedSnap

Parameters:: pDistance - The pDistance (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSnapToVertices

public boolean isSnapToVertices()
                         throws IOException,
                                AutomationException

Indicates if positions are snapped to the vertices in the snap layers' feature geometries. Defaults to false.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSnapToVertices in interface IRealTimeFeedSnap

Returns:: The pSnap
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSnapToVertices

public void setSnapToVertices(boolean pSnap)
                       throws IOException,
                              AutomationException

Indicates if positions are snapped to the vertices in the snap layers' feature geometries. Defaults to false.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSnapToVertices in interface IRealTimeFeedSnap

Parameters:: pSnap - The pSnap (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSnapToLines

public boolean isSnapToLines()
                      throws IOException,
                             AutomationException

Indicates if positions are snapped to the lines in the snap layers' feature geometries. Defaults to false.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSnapToLines in interface IRealTimeFeedSnap

Returns:: The pSnap
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSnapToLines

public void setSnapToLines(boolean pSnap)
                    throws IOException,
                           AutomationException

Indicates if positions are snapped to the lines in the snap layers' feature geometries. Defaults to false.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSnapToLines in interface IRealTimeFeedSnap

Parameters:: pSnap - The pSnap (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSnapToNodes

public boolean isSnapToNodes()
                      throws IOException,
                             AutomationException

Indicates if positions are snapped to the nodes in the snap layers' feature geometries. Defaults to false.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSnapToNodes in interface IRealTimeFeedSnap

Returns:: The pSnap
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSnapToNodes

public void setSnapToNodes(boolean pSnap)
                    throws IOException,
                           AutomationException

Indicates if positions are snapped to the nodes in the snap layers' feature geometries. Defaults to false.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSnapToNodes in interface IRealTimeFeedSnap

Parameters:: pSnap - The pSnap (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.

positionUpdated

public void positionUpdated(IRealTimeFeedEventsPositionUpdatedEvent theEvent)
                     throws IOException,
                            AutomationException

Reports the current position when it is updated. 'estimate' is true if the signal is lost and the position is estimated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: positionUpdated in interface IRealTimeFeedEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

magneticVarianceUpdated

public void magneticVarianceUpdated(IRealTimeFeedEventsMagneticVarianceUpdatedEvent theEvent)
                             throws IOException,
                                    AutomationException

Reports the current magnetic variance when it is updated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: magneticVarianceUpdated in interface IRealTimeFeedEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

groundCourseUpdated

public void groundCourseUpdated(IRealTimeFeedEventsGroundCourseUpdatedEvent theEvent)
                         throws IOException,
                                AutomationException

Reports the current ground variance when it is updated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: groundCourseUpdated in interface IRealTimeFeedEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

dopInfoUpdated

public void dopInfoUpdated(IRealTimeFeedEventsDopInfoUpdatedEvent theEvent)
                    throws IOException,
                           AutomationException

Reports the current DOP information when it is updated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: dopInfoUpdated in interface IRealTimeFeedEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

satelliteInfoUpdated

public void satelliteInfoUpdated(IRealTimeFeedEventsSatelliteInfoUpdatedEvent theEvent)
                          throws IOException,
                                 AutomationException

Reports the current satellite information when it is updated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: satelliteInfoUpdated in interface IRealTimeFeedEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

dateTimeUpdated

public void dateTimeUpdated(IRealTimeFeedEventsDateTimeUpdatedEvent theEvent)
                     throws IOException,
                            AutomationException

Reports the date and time when it is updated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: dateTimeUpdated in interface IRealTimeFeedEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

dgpsInfoUpdated

public void dgpsInfoUpdated(IRealTimeFeedEventsDgpsInfoUpdatedEvent theEvent)
                     throws IOException,
                            AutomationException

Reports the DGPS information when it is updated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: dgpsInfoUpdated in interface IRealTimeFeedEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

connectionStatusUpdated

public void connectionStatusUpdated(IRealTimeFeedEventsConnectionStatusUpdatedEvent theEvent)
                             throws IOException,
                                    AutomationException

Reports the connection information when it is updated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: connectionStatusUpdated in interface IRealTimeFeedEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

contentsChanged

public void contentsChanged(IActiveViewEventsContentsChangedEvent theEvent)
                     throws IOException,
                            AutomationException

Fired when the contents of the view changes.

Remarks

The Map object fires this event when a new document is loaded. Adding a new layer to a Map does not trigger this event.

The PageLayout object fires the event when IGraphicsContainer::DeleteAllElements in called and when a new document is loaded.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: contentsChanged in interface IActiveViewEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IActiveView.contentsChanged()

contentsCleared

public void contentsCleared(IActiveViewEventsContentsClearedEvent theEvent)
                     throws IOException,
                            AutomationException

Fired when the contents of the view is cleared.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: contentsCleared in interface IActiveViewEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

itemAdded

public void itemAdded(IActiveViewEventsItemAddedEvent theEvent)
               throws IOException,
                      AutomationException

Fired when an item is added to the view.

Remarks

The Map fires the event every time a new layer is added.

The PageLayout fires this event whenever a new element is added to the layout. Elements include not only graphics but data frames as well.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: itemAdded in interface IActiveViewEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

itemDeleted

public void itemDeleted(IActiveViewEventsItemDeletedEvent theEvent)
                 throws IOException,
                        AutomationException

Fired when an item is deleted from the view.

Remarks

The PageLayout object fires this event whenever elements are deleted from the layout.

The Map object fires this event when a layer is removed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: itemDeleted in interface IActiveViewEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

itemReordered

public void itemReordered(IActiveViewEventsItemReorderedEvent theEvent)
                   throws IOException,
                          AutomationException

Fired when a view item is reordered.

Remarks

The Map objects only fire this event whenever IMap::MoveLayer is called. In the ArcMap application, this occurs when you reorder layers in the table of contents. The Map will also fire this event when new layers are added.

The PageLayout object fires this event when changing the order of graphics. For example, IGraphicsContainer::BringToFront, PutElementOrder, SendToBack, SendBackward, and BringForward all fire this event. These functions are on ArcMap's Drawing menu under the Order pull right menu. Although the Map object is also a graphics container, it does not fire this event when its graphics are reordered.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: itemReordered in interface IActiveViewEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

selectionChanged

public void selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent)
                      throws IOException,
                             AutomationException

Call this function to fire the selection changed event.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: selectionChanged in interface IActiveViewEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

viewRefreshed

public void viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent)
                   throws IOException,
                          AutomationException

Fired when view is refreshed before draw happens.

Description

Method that gets fired in response to IActiveView::Refresh and IActiveView::PartialRefresh.

Remarks

This event is useful in the case where you're watching for something to change in the view and there aren't any specific events for that change (e.g. ContentsChanged, ItemAdded). You can always listen for this method as a last resort. Care must be taken however to be very efficient in your implementation of this event because it will be called quite often.

The event parameters directly coincide with the arguments to IActiveView::PartialRefresh. For additional information about the arguments, see the help for that method.

If the event object connects to both the layout and a map, then the view parameter tells you which object initiated the event.

In an implementation of this method you typically want to check the phase and respond to only one. Otherwise, your code will execute multiple times per drawing sequence.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: viewRefreshed in interface IActiveViewEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

afterDraw

public void afterDraw(IActiveViewEventsAfterDrawEvent theEvent)
               throws IOException,
                      AutomationException

Fired after the specified phase is drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: afterDraw in interface IActiveViewEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

afterItemDraw

public void afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent)
                   throws IOException,
                          AutomationException

Fired after an individual view item is drawn. Example: view items include layers in a map or elements in a page layout.

Remarks

AfterItemDraw can be used to execute after each individual item has drawn. Event firing can be an expensive operation (time consuming) when there are many layers in a map, however. As a result, the AfterItemDraw event is only fired when the IViewManger::VerboseEvents property is set to True. By default this property is False.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: afterItemDraw in interface IActiveViewEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

focusMapChanged

public void focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent)
                     throws IOException,
                            AutomationException

Fired when a new map is made active.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: focusMapChanged in interface IActiveViewEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

spatialReferenceChanged

public void spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent)
                             throws IOException,
                                    AutomationException

Fired when the spatial reference is changed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: spatialReferenceChanged in interface IActiveViewEvents

Parameters:: theEvent - The event
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

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto Class RealTimeFeedManager

Product Availability

Supported Platforms

RealTimeFeedManager

RealTimeFeedManager

getClsid

equals

hashCode

addIRealTimeFeedManagerEventsListener

removeIRealTimeFeedManagerEventsListener

getRealTimeFeed

Product Availability

Supported Platforms

setRealTimeFeedByRef

Product Availability

getMap

Product Availability

Supported Platforms

setMapByRef

Product Availability

getGpsFeed

Product Availability

Supported Platforms

getRealTimeFeedSimulator

Product Availability

Supported Platforms

getMinimumDisplayRate

Product Availability

Supported Platforms

setMinimumDisplayRate

Product Availability

Supported Platforms

isUseMinimumDisplayRate

Product Availability

Supported Platforms

setUseMinimumDisplayRate

Product Availability

Supported Platforms

isShowCurrentPosition

Product Availability

Supported Platforms

setShowCurrentPosition

Product Availability

Supported Platforms

getBaseMarkerSymbol

Product Availability

Supported Platforms

setBaseMarkerSymbolByRef

Product Availability

isShowEstimatedPosition

Product Availability

Supported Platforms

setShowEstimatedPosition

Product Availability

Supported Platforms

getEstimatedPositionSymbol

Product Availability

Supported Platforms

setEstimatedPositionSymbolByRef

Product Availability

setShowCurrentAltitude

Product Availability

Supported Platforms

isShowCurrentAltitude

Product Availability

Supported Platforms

isShowCurrentBearing

Product Availability

Supported Platforms

setShowCurrentBearing

Product Availability

Supported Platforms

isShowCurrentSpeed

Product Availability

Supported Platforms

setShowCurrentSpeed

Product Availability

Supported Platforms

setShowMarkerTrailAltitude

Product Availability

com.esri.arcgis.carto
Class RealTimeFeedManager