com.esri.arcgis.carto
Interface IPositionTrails

All Superinterfaces:
Serializable
All Known Implementing Classes:
RealTimeFeedManager

public interface IPositionTrails
extends Serializable

Provides access to members that display trails of previous positions on the map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 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.
 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.
 boolean isShowLinearTrail()
          Indicates if the linear trail of the previous positions should be visible.
 boolean isShowMarkerTrails()
          Indicates if marker symbols shows previous positions.
 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 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 setShowLinearTrail(boolean pShow)
          Indicates if the linear trail of the previous positions should be visible.
 void setShowMarkerTrails(boolean pShow)
          Indicates if marker symbols shows previous positions.
 

Method Detail

isShowMarkerTrails

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

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

setShowMarkerTrails

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

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

getMarkerTrailColorRamp

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

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

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.

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

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

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

setMarkerTrailCount

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

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

getMarkerTrailDistance

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

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

setMarkerTrailDistance

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

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

getMarkerTrailSymbol

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

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

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.

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

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

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

setShowLinearTrail

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

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

getLinearTrailSymbol

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

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

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.

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

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

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

setLinearTrailDistance

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

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