com.esri.arcgis.trackinganalyst
Class DirectionalVectorRendererProperties

java.lang.Object
  com.esri.arcgis.trackinganalyst.DirectionalVectorRendererProperties

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, ISupportErrorInfo, IDirectionalVectorRendererProperties, Externalizable, Serializable

public class DirectionalVectorRendererProperties
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDirectionalVectorRendererProperties, IPersist, IPersistStream, ISupportErrorInfo, IClone, IDocumentVersionSupportGEN, Externalizable

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

void	assign(IClone src) Assigns the properties of src to the receiver.
Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	getClassID(GUID[] pClassID) getClassID
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).
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
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
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isGlobalProperties() Indicates if the renderer properties object is the global version obtained from the Tracking Environment vs.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
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.
void	writeExternal(ObjectOutput out)

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.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws IOException,
                                       AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException