com.esri.arcgis.trackinganalyst
Interface IDirectionalVectorRendererProperties

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

DirectionalVectorRendererProperties, IDirectionalVectorRendererPropertiesProxy

public interface IDirectionalVectorRendererProperties
extends java.io.Serializable

COM Interface 'IDirectionalVectorRendererProperties'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description: 'Provides access to the properties which govern the directional vector rendering.' 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	IID684bb0fe_57a8_49f1_9b13_89a0422ea714
static int	xxDummy Deprecated. Internal use only

Method Summary

java.lang.String	getHeadingField() Provides field name containing heading; empty indicates heading is to be calculated.
void	getHeadingReference(boolean[] pbIsNorthRef, boolean[] pbIsClockwise) Provides the reference used by heading field (e.g., true, true for typical heading measurement (north, clockwise).
java.lang.String	getSpeedField() Provides field name containing speed; empty indicates speed is to be calculated.
void	getSpeedUnits(int[] peDistanceUnits, int[] peTimeUnits) Provides the units used by speed field (e.g., esriMiles, enumHours for mi/hr).
ISymbol	getSymbol() Provides the line symbol to be used for rendering the directional vector.
double	getTimeInterval() Provides the time interval represented by the directional vector; see property TimeIntervalUnits for this value’s units.
int	getTimeIntervalUnits() Provides the time interval units represented by the directional vector; see property TimeInterval for the time value.
boolean	isGlobalProperties() Indicates if the renderer properties object is the global version obtained from the Tracking Environment vs.
void	setGlobalProperties(boolean pbvGlobal) Indicates if the renderer properties object is the global version obtained from the Tracking Environment vs.
void	setHeadingField(java.lang.String pbstrHeading) Provides field name containing heading; empty indicates heading is to be calculated.
void	setHeadingReference(boolean bIsNorthRef, boolean bIsClockwise) Sets the reference used by heading field (e.g., true, true for typical heading measurement (north, clockwise).
void	setSpeedField(java.lang.String pbstrSpeed) Provides field name containing speed; empty indicates speed is to be calculated.
void	setSpeedUnits(int eDistanceUnits, int eTimeUnits) Sets the units used by speed field (e.g., esriMiles, enumHours for mi/hr).
void	setSymbol(ISymbol ppiSymbol) Provides the line symbol to be used for rendering the directional vector.
void	setTimeInterval(double pdTimeValue) Provides the time interval represented by the directional vector; see property TimeIntervalUnits for this value’s units.
void	setTimeIntervalUnits(int peTimeUnits) Provides the time interval units represented by the directional vector; see property TimeInterval for the time value.

Field Detail

IID684bb0fe_57a8_49f1_9b13_89a0422ea714

static final int IID684bb0fe_57a8_49f1_9b13_89a0422ea714

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

getSymbol

ISymbol getSymbol()
                  throws java.io.IOException,
                         AutomationException

Provides the line symbol to be used for rendering the directional vector.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymbol

void setSymbol(ISymbol ppiSymbol)
               throws java.io.IOException,
                      AutomationException

Provides the line symbol to be used for rendering the directional vector.

Parameters:

ppiSymbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isGlobalProperties

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

Indicates if the renderer properties object is the global version obtained from the Tracking Environment vs. a layer specific version.

Returns:

The pbvGlobal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGlobalProperties

void setGlobalProperties(boolean pbvGlobal)
                         throws java.io.IOException,
                                AutomationException

Indicates if the renderer properties object is the global version obtained from the Tracking Environment vs. a layer specific version.

Parameters:

pbvGlobal - The pbvGlobal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeInterval

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

Provides the time interval represented by the directional vector; see property TimeIntervalUnits for this value’s units.

Returns:

The pdTimeValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeInterval

void setTimeInterval(double pdTimeValue)
                     throws java.io.IOException,
                            AutomationException

Provides the time interval represented by the directional vector; see property TimeIntervalUnits for this value’s units.

Parameters:

pdTimeValue - The pdTimeValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeIntervalUnits

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

Provides the time interval units represented by the directional vector; see property TimeInterval for the time value.

Returns:

A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeIntervalUnits

void setTimeIntervalUnits(int peTimeUnits)
                          throws java.io.IOException,
                                 AutomationException

Provides the time interval units represented by the directional vector; see property TimeInterval for the time value.

Parameters:

peTimeUnits - A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpeedField

java.lang.String getSpeedField()
                               throws java.io.IOException,
                                      AutomationException

Provides field name containing speed; empty indicates speed is to be calculated. This property is for a future enhancement.

Returns:

The pbstrSpeed

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpeedField

void setSpeedField(java.lang.String pbstrSpeed)
                   throws java.io.IOException,
                          AutomationException

Provides field name containing speed; empty indicates speed is to be calculated. This property is for a future enhancement.

Parameters:

pbstrSpeed - The pbstrSpeed (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHeadingField

java.lang.String getHeadingField()
                                 throws java.io.IOException,
                                        AutomationException

Provides field name containing heading; empty indicates heading is to be calculated. This property is for a future enhancement.

Returns:

The pbstrHeading

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHeadingField

void setHeadingField(java.lang.String pbstrHeading)
                     throws java.io.IOException,
                            AutomationException

Provides field name containing heading; empty indicates heading is to be calculated. This property is for a future enhancement.

Parameters:

pbstrHeading - The pbstrHeading (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpeedUnits

void getSpeedUnits(int[] peDistanceUnits,
                   int[] peTimeUnits)
                   throws java.io.IOException,
                          AutomationException

Provides the units used by speed field (e.g., esriMiles, enumHours for mi/hr). This property is for a future enhancement.

Parameters:

peDistanceUnits - A com.esri.arcgis.system.esriUnits constant (out: use single element array)

peTimeUnits - A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpeedUnits

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

Sets the units used by speed field (e.g., esriMiles, enumHours for mi/hr). This property is for a future enhancement.

Parameters:

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

eTimeUnits - A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHeadingReference

void setHeadingReference(boolean bIsNorthRef,
                         boolean bIsClockwise)
                         throws java.io.IOException,
                                AutomationException

Sets the reference used by heading field (e.g., true, true for typical heading measurement (north, clockwise). This property is for a future enhancement.

Parameters:

bIsNorthRef - The bIsNorthRef (in)

bIsClockwise - The bIsClockwise (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHeadingReference

void getHeadingReference(boolean[] pbIsNorthRef,
                         boolean[] pbIsClockwise)
                         throws java.io.IOException,
                                AutomationException

Provides the reference used by heading field (e.g., true, true for typical heading measurement (north, clockwise). This property is for a future enhancement.

Parameters:

pbIsNorthRef - The pbIsNorthRef (out: use single element array)

pbIsClockwise - The pbIsClockwise (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.