com.esri.arcgis.carto
Interface IGpsDisplayProperties

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IGpsDisplayPropertiesProxy, RealTimeFeedManager

public interface IGpsDisplayProperties
extends java.io.Serializable

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

Description: 'Provides access to GPS display properties.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID34c8784f_8293_4f07_bda9_ca04f6b56e64
static int	xxDummy Deprecated. Internal use only

Method Summary

void	clearGpsDisplay() Clears the GPS display.
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	getEstimatedPositionSymbol() The marker symbol used to display the estimated current position if the signal is lost.
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	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.
double	getMinimumDisplayRate() The minimum amount of time in seconds between screen refreshes for the display of the current position.
IEnvelope	getPositionsExtent() Extent bounding all positions received from the current RealTimeFeed so far.
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.
boolean	isAutoPan() Indicates if the display extents are adjusted to keep the GPS position on the screen.
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	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	isShowMarkerTrailSpeed() Indicates if the base marker symbol size is based on the speed of the marker trail position.
boolean	isUseMinimumDisplayRate() Indicates if the minimum display rate value is in effect.
void	refreshGpsDisplay() Refreshes the GPS display.
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	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	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	setMinimumDisplayRate(double pRate) The minimum amount of time in seconds between screen refreshes for the display of the current position.
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	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	setShowMarkerTrailSpeed(boolean pShow) Indicates if the base marker symbol size is based on the speed of the marker trail position.
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	setUseMinimumDisplayRate(boolean pUse) Indicates if the minimum display rate value is in effect.

Field Detail

IID34c8784f_8293_4f07_bda9_ca04f6b56e64

static final int IID34c8784f_8293_4f07_bda9_ca04f6b56e64

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getMinimumDisplayRate

double getMinimumDisplayRate()
                             throws java.io.IOException,
                                    AutomationException

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

Returns:

The pRate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinimumDisplayRate

void setMinimumDisplayRate(double pRate)
                           throws java.io.IOException,
                                  AutomationException

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

Parameters:

pRate - The pRate (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseMinimumDisplayRate

boolean isUseMinimumDisplayRate()
                                throws java.io.IOException,
                                       AutomationException

Indicates if the minimum display rate value is in effect.

Returns:

The pUse

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseMinimumDisplayRate

void setUseMinimumDisplayRate(boolean pUse)
                              throws java.io.IOException,
                                     AutomationException

Indicates if the minimum display rate value is in effect.

Parameters:

pUse - The pUse (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowCurrentPosition

boolean isShowCurrentPosition()
                              throws java.io.IOException,
                                     AutomationException

Indicates if the current position is displayed.

Returns:

The pShow

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowCurrentPosition

void setShowCurrentPosition(boolean pShow)
                            throws java.io.IOException,
                                   AutomationException

Indicates if the current position is displayed.

Parameters:

pShow - The pShow (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBaseMarkerSymbol

IMarkerSymbol getBaseMarkerSymbol()
                                  throws java.io.IOException,
                                         AutomationException

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

Returns:

A reference to a com.esri.arcgis.display.IMarkerSymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBaseMarkerSymbolByRef

void setBaseMarkerSymbolByRef(IMarkerSymbol ppMarker)
                              throws java.io.IOException,
                                     AutomationException

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

Parameters:

ppMarker - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowEstimatedPosition

boolean isShowEstimatedPosition()
                                throws java.io.IOException,
                                       AutomationException

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

Returns:

The pShow

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowEstimatedPosition

void setShowEstimatedPosition(boolean pShow)
                              throws java.io.IOException,
                                     AutomationException

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

Parameters:

pShow - The pShow (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEstimatedPositionSymbol

IMarkerSymbol getEstimatedPositionSymbol()
                                         throws java.io.IOException,
                                                AutomationException

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

Returns:

A reference to a com.esri.arcgis.display.IMarkerSymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEstimatedPositionSymbolByRef

void setEstimatedPositionSymbolByRef(IMarkerSymbol ppMarker)
                                     throws java.io.IOException,
                                            AutomationException

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

Parameters:

ppMarker - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowCurrentAltitude

void setShowCurrentAltitude(boolean pShowVariation)
                            throws java.io.IOException,
                                   AutomationException

Indicates if the variation in the altitude is displayed.

Parameters:

pShowVariation - The pShowVariation (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowCurrentAltitude

boolean isShowCurrentAltitude()
                              throws java.io.IOException,
                                     AutomationException

Indicates if the variation in the altitude is displayed.

Returns:

The pShowVariation

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowCurrentBearing

boolean isShowCurrentBearing()
                             throws java.io.IOException,
                                    AutomationException

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

Returns:

The pShow

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowCurrentBearing

void setShowCurrentBearing(boolean pShow)
                           throws java.io.IOException,
                                  AutomationException

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

Parameters:

pShow - The pShow (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowCurrentSpeed

boolean isShowCurrentSpeed()
                           throws java.io.IOException,
                                  AutomationException

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

Returns:

The pShow

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowCurrentSpeed

void setShowCurrentSpeed(boolean pShow)
                         throws java.io.IOException,
                                AutomationException

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

Parameters:

pShow - The pShow (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowMarkerTrailAltitude

void setShowMarkerTrailAltitude(boolean pShowVariation)
                                throws java.io.IOException,
                                       AutomationException

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

Parameters:

pShowVariation - The pShowVariation (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowMarkerTrailAltitude

boolean isShowMarkerTrailAltitude()
                                  throws java.io.IOException,
                                         AutomationException

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

Returns:

The pShowVariation

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowMarkerTrailBearing

boolean isShowMarkerTrailBearing()
                                 throws java.io.IOException,
                                        AutomationException

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

Returns:

The pShow

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowMarkerTrailBearing

void setShowMarkerTrailBearing(boolean pShow)
                               throws java.io.IOException,
                                      AutomationException

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

Parameters:

pShow - The pShow (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowMarkerTrailSpeed

boolean isShowMarkerTrailSpeed()
                               throws java.io.IOException,
                                      AutomationException

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

Returns:

The pShow

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowMarkerTrailSpeed

void setShowMarkerTrailSpeed(boolean pShow)
                             throws java.io.IOException,
                                    AutomationException

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

Parameters:

pShow - The pShow (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpeedUnits

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

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

Returns:

A com.esri.arcgis.carto.esriGpsSpeedUnits constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpeedUnits

void setSpeedUnits(int pUnits)
                   throws java.io.IOException,
                          AutomationException

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

Parameters:

pUnits - A com.esri.arcgis.carto.esriGpsSpeedUnits constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLowSpeedValue

double getLowSpeedValue()
                        throws java.io.IOException,
                               AutomationException

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

Returns:

The pSpeed

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLowSpeedValue

void setLowSpeedValue(double pSpeed)
                      throws java.io.IOException,
                             AutomationException

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

Parameters:

pSpeed - The pSpeed (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpeedColorRampByRef

void setSpeedColorRampByRef(IColorRamp ppColorRamp)
                            throws java.io.IOException,
                                   AutomationException

The color ramp used to vary the color by speed.

Parameters:

ppColorRamp - A reference to a com.esri.arcgis.display.IColorRamp (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpeedColorRamp

IColorRamp getSpeedColorRamp()
                             throws java.io.IOException,
                                    AutomationException

The color ramp used to vary the color by speed.

Returns:

A reference to a com.esri.arcgis.display.IColorRamp

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLowAltitudeValue

double getLowAltitudeValue()
                           throws java.io.IOException,
                                  AutomationException

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

Returns:

The pAltitude

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLowAltitudeValue

void setLowAltitudeValue(double pAltitude)
                         throws java.io.IOException,
                                AutomationException

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

Parameters:

pAltitude - The pAltitude (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHighAltitudeValue

double getHighAltitudeValue()
                            throws java.io.IOException,
                                   AutomationException

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

Returns:

The pAltitude

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHighAltitudeValue

void setHighAltitudeValue(double pAltitude)
                          throws java.io.IOException,
                                 AutomationException

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

Parameters:

pAltitude - The pAltitude (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLowAltitudeSize

double getLowAltitudeSize()
                          throws java.io.IOException,
                                 AutomationException

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

Returns:

The pSize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLowAltitudeSize

void setLowAltitudeSize(double pSize)
                        throws java.io.IOException,
                               AutomationException

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

Parameters:

pSize - The pSize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHighSpeedValue

double getHighSpeedValue()
                         throws java.io.IOException,
                                AutomationException

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

Returns:

The pSize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHighSpeedValue

void setHighSpeedValue(double pSize)
                       throws java.io.IOException,
                              AutomationException

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

Parameters:

pSize - The pSize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHighAltitudeSize

double getHighAltitudeSize()
                           throws java.io.IOException,
                                  AutomationException

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

Returns:

The pSize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHighAltitudeSize

void setHighAltitudeSize(double pSize)
                         throws java.io.IOException,
                                AutomationException

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

Parameters:

pSize - The pSize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAutoPan

void setAutoPan(boolean autoPan)
                throws java.io.IOException,
                       AutomationException

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

Parameters:

autoPan - The autoPan (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAutoPan

boolean isAutoPan()
                  throws java.io.IOException,
                         AutomationException

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

Returns:

The autoPan

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAltitudeUnits

void setAltitudeUnits(int pAltitudeUnits)
                      throws java.io.IOException,
                             AutomationException

The units used for altitude in the GPS display.

Parameters:

pAltitudeUnits - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAltitudeUnits

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

The units used for altitude in the GPS display.

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLatLongDisplayFormat

void setLatLongDisplayFormat(int latLongFormat)
                             throws java.io.IOException,
                                    AutomationException

The latitude-longitude display format for the GPS display.

Parameters:

latLongFormat - A com.esri.arcgis.carto.esriGpsLatLongFormat constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLatLongDisplayFormat

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

The latitude-longitude display format for the GPS display.

Returns:

A com.esri.arcgis.carto.esriGpsLatLongFormat constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPositionsExtent

IEnvelope getPositionsExtent()
                             throws java.io.IOException,
                                    AutomationException

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refreshGpsDisplay

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

Refreshes the GPS display.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearGpsDisplay

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

Clears the GPS display.

Throws:

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

AutomationException - If the ArcObject component throws an exception.