com.esri.arcgis.trackinganalyst
Class DirectionalVectorRendererProperties

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.DirectionalVectorRendererProperties
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IDirectionalVectorRendererProperties, Serializable

public class DirectionalVectorRendererProperties
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDirectionalVectorRendererProperties

Contains the properties required to perform directional vector rendering.

Description

This object is a storage object for 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.

See Also:
Serialized Form

Constructor Summary
DirectionalVectorRendererProperties()
          Constructs a DirectionalVectorRendererProperties using ArcGIS Engine.
DirectionalVectorRendererProperties(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DirectionalVectorRendererProperties theDirectionalVectorRendererProperties = (DirectionalVectorRendererProperties) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 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.
 int hashCode()
          the hashcode for this object
 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.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

DirectionalVectorRendererProperties

public DirectionalVectorRendererProperties()
                                    throws IOException,
                                           UnknownHostException
Constructs a DirectionalVectorRendererProperties using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

DirectionalVectorRendererProperties

public DirectionalVectorRendererProperties(Object obj)
                                    throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DirectionalVectorRendererProperties theDirectionalVectorRendererProperties = (DirectionalVectorRendererProperties) obj;

Construct a DirectionalVectorRendererProperties using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to DirectionalVectorRendererProperties.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getSymbol

public 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.

Specified by:
getSymbol in interface IDirectionalVectorRendererProperties
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

public 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.

Specified by:
setSymbol in interface IDirectionalVectorRendererProperties
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

public 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.

Specified by:
isGlobalProperties in interface IDirectionalVectorRendererProperties
Returns:
The pbvGlobal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGlobalProperties

public 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.

Specified by:
setGlobalProperties in interface IDirectionalVectorRendererProperties
Parameters:
pbvGlobal - The pbvGlobal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeInterval

public 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.

Specified by:
getTimeInterval in interface IDirectionalVectorRendererProperties
Returns:
The pdTimeValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeInterval

public 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.

Specified by:
setTimeInterval in interface IDirectionalVectorRendererProperties
Parameters:
pdTimeValue - The pdTimeValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeIntervalUnits

public 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.

Specified by:
getTimeIntervalUnits in interface IDirectionalVectorRendererProperties
Returns:
A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeIntervalUnits

public 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.

Specified by:
setTimeIntervalUnits in interface IDirectionalVectorRendererProperties
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

public 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.

Specified by:
getSpeedField in interface IDirectionalVectorRendererProperties
Returns:
The pbstrSpeed
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSpeedField

public 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.

Specified by:
setSpeedField in interface IDirectionalVectorRendererProperties
Parameters:
pbstrSpeed - The pbstrSpeed (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHeadingField

public 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.

Specified by:
getHeadingField in interface IDirectionalVectorRendererProperties
Returns:
The pbstrHeading
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHeadingField

public 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.

Specified by:
setHeadingField in interface IDirectionalVectorRendererProperties
Parameters:
pbstrHeading - The pbstrHeading (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpeedUnits

public 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.

Specified by:
getSpeedUnits in interface IDirectionalVectorRendererProperties
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

public 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.

Specified by:
setSpeedUnits in interface IDirectionalVectorRendererProperties
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

public 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.

Specified by:
setHeadingReference in interface IDirectionalVectorRendererProperties
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

public 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.

Specified by:
getHeadingReference in interface IDirectionalVectorRendererProperties
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.