com.esri.arcgis.geodatabase
Class NetworkGlobalTurnDelayCategory

java.lang.Object
  extended by com.esri.arcgis.geodatabase.NetworkGlobalTurnDelayCategory
All Implemented Interfaces:
INetworkGlobalTurnDelayCategory, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class NetworkGlobalTurnDelayCategory
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INetworkGlobalTurnDelayCategory, IClone, IXMLSerialize, IPersist, IPersistStream, IXMLVersionSupport, Externalizable

A container for defining global turn delay for a specified angle category and from, to, and cross road category.

Description

This object is new at ArcGIS 9.3.

The NetworkGlobalTurnDelayCategory object is used to specify the TurnDelayCategories for the NetworkGlobalTurnDelayEvaluator. Each NetworkGlobalTurnDelayCategory is defined by the turning angle, the road category for the starting and finishing road of the turn, and the road category for any other crossroads at that intersection. For each category, a travel time, measured in seconds, is specified.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
NetworkGlobalTurnDelayCategory()
          Constructs a NetworkGlobalTurnDelayCategory using ArcGIS Engine.
NetworkGlobalTurnDelayCategory(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NetworkGlobalTurnDelayCategory theNetworkGlobalTurnDelayCategory = (NetworkGlobalTurnDelayCategory) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 int getAngleCategory()
          The turn angle category (straight, reverse, right, or left) of turns in this turn delay category.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 int getCrossRoadCategory()
          The road category of the most major cross road of turns in this turn delay category.
 int getFromRoadCategory()
          The road category of the from road of turns in this turn delay category.
 String getMinNamespaceSupported()
          The minimum namespace the class can serialize to (eg the 90 namespace).
 double getSeconds()
          The expected traversal time in seconds of turns associated with this turn delay category (matching angle, from road, to road, and cross road categories).
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int getToRoadCategory()
          The road category of the to road of turns in this turn delay category.
 int hashCode()
          the hashcode for this object
 void initialize(double seconds, int angleCategory, int fromRoadCategory, int toRoadCategory, int crossRoadCategory)
          Initializes the seconds and specifies the referenced category of global turns.
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setSeconds(double seconds)
          The expected traversal time in seconds of turns associated with this turn delay category (matching angle, from road, to road, and cross road categories).
 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

NetworkGlobalTurnDelayCategory

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

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

NetworkGlobalTurnDelayCategory

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

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

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

initialize

public void initialize(double seconds,
                       int angleCategory,
                       int fromRoadCategory,
                       int toRoadCategory,
                       int crossRoadCategory)
                throws IOException,
                       AutomationException
Initializes the seconds and specifies the referenced category of global turns.

Remarks

The FromRoadCategory and ToRoadCategory parameters can only be set to esriNRCPrimary, esriNRCSecondary, or esriNRCLocal.

Product Availability

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

Specified by:
initialize in interface INetworkGlobalTurnDelayCategory
Parameters:
seconds - The seconds (in)
angleCategory - A com.esri.arcgis.geodatabase.esriNetworkTurnAngleCategory constant (in)
fromRoadCategory - A com.esri.arcgis.geodatabase.esriNetworkRoadCategory constant (in)
toRoadCategory - A com.esri.arcgis.geodatabase.esriNetworkRoadCategory constant (in)
crossRoadCategory - A com.esri.arcgis.geodatabase.esriNetworkRoadCategory constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSeconds

public double getSeconds()
                  throws IOException,
                         AutomationException
The expected traversal time in seconds of turns associated with this turn delay category (matching angle, from road, to road, and cross road categories).

Product Availability

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

Specified by:
getSeconds in interface INetworkGlobalTurnDelayCategory
Returns:
The seconds
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSeconds

public void setSeconds(double seconds)
                throws IOException,
                       AutomationException
The expected traversal time in seconds of turns associated with this turn delay category (matching angle, from road, to road, and cross road categories).

Product Availability

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

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

getAngleCategory

public int getAngleCategory()
                     throws IOException,
                            AutomationException
The turn angle category (straight, reverse, right, or left) of turns in this turn delay category.

Product Availability

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

Specified by:
getAngleCategory in interface INetworkGlobalTurnDelayCategory
Returns:
A com.esri.arcgis.geodatabase.esriNetworkTurnAngleCategory constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFromRoadCategory

public int getFromRoadCategory()
                        throws IOException,
                               AutomationException
The road category of the from road of turns in this turn delay category.

Remarks

The FromRoadCategory property can only be set to esriNRCPrimary, esriNRCSecondary, or esriNRCLocal.

Product Availability

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

Specified by:
getFromRoadCategory in interface INetworkGlobalTurnDelayCategory
Returns:
A com.esri.arcgis.geodatabase.esriNetworkRoadCategory constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getToRoadCategory

public int getToRoadCategory()
                      throws IOException,
                             AutomationException
The road category of the to road of turns in this turn delay category.

Remarks

The ToRoadCategory property can only be set to esriNRCPrimary, esriNRCSecondary, or esriNRCLocal.

Product Availability

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

Specified by:
getToRoadCategory in interface INetworkGlobalTurnDelayCategory
Returns:
A com.esri.arcgis.geodatabase.esriNetworkRoadCategory constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCrossRoadCategory

public int getCrossRoadCategory()
                         throws IOException,
                                AutomationException
The road category of the most major cross road of turns in this turn delay category.

Product Availability

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

Specified by:
getCrossRoadCategory in interface INetworkGlobalTurnDelayCategory
Returns:
A com.esri.arcgis.geodatabase.esriNetworkRoadCategory constant
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
Returns TRUE when 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
Returns TRUE when 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.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException
Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException
Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
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.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException
The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

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

Specified by:
getMinNamespaceSupported in interface IXMLVersionSupport
Returns:
The namespaceURI
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