com.esri.arcgis.networkanalyst
Interface ITrafficProvider

All Superinterfaces:

Serializable

public interface ITrafficProvider
extends Serializable

Provides access to traffic provider.

Remarks

ITrafficProvider is used to return enumerators over traffic speed and incident data.

Product Availability

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

Method Summary

IEnumTrafficRegionIncidents	getIncidentsData(IArray pRegions, ITrafficProviderCredentials pProviderCredentials) Retrieves enumerator for incident data sequence for the specified task.
IFields	getIncidentsFeatureClassFields() Retrieves fields for incident feature class.
IEnumTrafficRegionSpeeds	getSpeedsData(int predictionDepthInMinutes, IArray pRegions, ITrafficProviderCredentials pProviderCredentials) Retrieves enumerator for traffic data sequence for the specified task.

Method Detail

getSpeedsData

IEnumTrafficRegionSpeeds getSpeedsData(int predictionDepthInMinutes,
                                       IArray pRegions,
                                       ITrafficProviderCredentials pProviderCredentials)
                                       throws IOException,
                                              AutomationException

Retrieves enumerator for traffic data sequence for the specified task.

Remarks

Based on an array of objects implementing ITrafficRegion, an object implementing ITrafficProviderCredentials, and a prediction depth cutoff value, GetSpeedsData returns an enumerator of traffic speed entries by region.

Product Availability

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

Parameters:

predictionDepthInMinutes - The predictionDepthInMinutes (in)

pRegions - A reference to a com.esri.arcgis.system.IArray (in)

pProviderCredentials - A reference to a com.esri.arcgis.networkanalyst.ITrafficProviderCredentials (in)

Returns:

A reference to a com.esri.arcgis.networkanalyst.IEnumTrafficRegionSpeeds

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIncidentsData

IEnumTrafficRegionIncidents getIncidentsData(IArray pRegions,
                                             ITrafficProviderCredentials pProviderCredentials)
                                             throws IOException,
                                                    AutomationException

Retrieves enumerator for incident data sequence for the specified task.

Remarks

Based on an array of objects implementing ITrafficRegion and an object implementing ITrafficProviderCredentials, GetIncidentsData returns an enumerator of traffic incident entries by region.

Product Availability

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

Parameters:

pRegions - A reference to a com.esri.arcgis.system.IArray (in)

pProviderCredentials - A reference to a com.esri.arcgis.networkanalyst.ITrafficProviderCredentials (in)

Returns:

A reference to a com.esri.arcgis.networkanalyst.IEnumTrafficRegionIncidents

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIncidentsFeatureClassFields

IFields getIncidentsFeatureClassFields()
                                       throws IOException,
                                              AutomationException

Retrieves fields for incident feature class.

Remarks

Incident data is placed in an output feature class. GetIncidentsFeatureClassFields specifies the schema for the output class.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.