com.esri.arcgis.carto
Interface IRealTimeDestination

All Superinterfaces:
Serializable
All Known Implementing Classes:
RealTimeFeedManager

public interface IRealTimeDestination
extends Serializable

Provides access to members that display a destination to track as the current position updates.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 IMarkerSymbol getBearingToDestinationSymbol()
          The marker symbol used to point to the destination.
 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.
 boolean isShowBearingToDestination()
          Indicates if the bearing to the destination from the current location is displayed.
 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 setShowBearingToDestination(boolean pShow)
          Indicates if the bearing to the destination from the current location is displayed.
 

Method Detail

getDestinationLocation

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

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

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

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

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

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

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.

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

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

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

setDestinationLabel

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

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

getDestinationTextSymbol

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

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

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.

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

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

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

setShowBearingToDestination

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

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

getBearingToDestinationSymbol

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

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

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.

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.