com.esri.arcgis.trackinganalyst
Interface IDirectionalVectorRendererProperties

All Superinterfaces:

Serializable

All Known Implementing Classes:

DirectionalVectorRendererProperties

public interface IDirectionalVectorRendererProperties
extends Serializable

Provides access to the properties which govern the directional vector rendering.

Description

This interface provides access to functions and properties needed to render a directional line that indicates where a feature will be in a configured period of time.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Method Summary

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).
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(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(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.

Method Detail

getSymbol

ISymbol getSymbol()
                  throws IOException,
                         AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbol

void setSymbol(ISymbol ppiSymbol)
               throws IOException,
                      AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isGlobalProperties

boolean isGlobalProperties()
                           throws IOException,
                                  AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pbvGlobal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGlobalProperties

void setGlobalProperties(boolean pbvGlobal)
                         throws IOException,
                                AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

pbvGlobal - The pbvGlobal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeInterval

double getTimeInterval()
                       throws IOException,
                              AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pdTimeValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeInterval

void setTimeInterval(double pdTimeValue)
                     throws IOException,
                            AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

pdTimeValue - The pdTimeValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeIntervalUnits

int getTimeIntervalUnits()
                         throws IOException,
                                AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeIntervalUnits

void setTimeIntervalUnits(int peTimeUnits)
                          throws IOException,
                                 AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpeedField

String getSpeedField()
                     throws IOException,
                            AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pbstrSpeed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpeedField

void setSpeedField(String pbstrSpeed)
                   throws IOException,
                          AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

pbstrSpeed - The pbstrSpeed (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeadingField

String getHeadingField()
                       throws IOException,
                              AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pbstrHeading

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeadingField

void setHeadingField(String pbstrHeading)
                     throws IOException,
                            AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

pbstrHeading - The pbstrHeading (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpeedUnits

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

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpeedUnits

void setSpeedUnits(int eDistanceUnits,
                   int eTimeUnits)
                   throws IOException,
                          AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeadingReference

void setHeadingReference(boolean bIsNorthRef,
                         boolean bIsClockwise)
                         throws 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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

bIsNorthRef - The bIsNorthRef (in)

bIsClockwise - The bIsClockwise (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeadingReference

void getHeadingReference(boolean[] pbIsNorthRef,
                         boolean[] pbIsClockwise)
                         throws 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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.