com.esri.arcgis.geodatabase
Interface IHistoricalTrafficData

All Superinterfaces:

Serializable

All Known Implementing Classes:

TrafficData

public interface IHistoricalTrafficData
extends Serializable

Provides access to members in historical traffic data.

Product Availability

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

Method Summary

String	getFirstTimeSliceFieldName() The field name of the first time slice of the given period in the profile table.
Date	getFirstTimeSliceStartTime() The start time of valid period of a day for traffic data.
String	getJoinTableBaseTravelTimeFieldName() The field name for base travel time in the join table.
int	getJoinTableBaseTravelTimeUnits() Base travel time units.
String	getJoinTableName() The name of the join table between edges and profiles.
IStringArray	getJoinTableProfileIDFieldNames() The field names of the historic join table pointing to speed profiles.
String	getLastTimeSliceFieldName() The field name of the last time slice of the given period in the profile table.
String	getProfilesTableName() The name of the table containing profiles.
int	getTimeSliceDurationInMinutes() The duration of time slice in minutes.
void	setFirstTimeSliceFieldName(String firstTimeSliceFieldName) The field name of the first time slice of the given period in the profile table.
void	setFirstTimeSliceStartTime(Date firstTimeSliceStartTime) The start time of valid period of a day for traffic data.
void	setJoinTableBaseTravelTimeFieldName(String fieldName) The field name for base travel time in the join table.
void	setJoinTableBaseTravelTimeUnits(int units) Base travel time units.
void	setJoinTableName(String joinTableName) The name of the join table between edges and profiles.
void	setJoinTableProfileIDFieldNamesByRef(IStringArray profileIDFields) The field names of the historic join table pointing to speed profiles.
void	setLastTimeSliceFieldName(String lastTimeSliceFieldName) The field name of the last time slice of the given period in the profile table.
void	setProfilesTableName(String profilesTableName) The name of the table containing profiles.
void	setTimeSliceDurationInMinutes(int timeSliceDurationInMinutes) The duration of time slice in minutes.

Method Detail

getProfilesTableName

String getProfilesTableName()
                            throws IOException,
                                   AutomationException

The name of the table containing profiles.

Product Availability

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

Returns:

The profilesTableName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProfilesTableName

void setProfilesTableName(String profilesTableName)
                          throws IOException,
                                 AutomationException

The name of the table containing profiles.

Product Availability

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

Parameters:

profilesTableName - The profilesTableName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeSliceDurationInMinutes

int getTimeSliceDurationInMinutes()
                                  throws IOException,
                                         AutomationException

The duration of time slice in minutes.

Product Availability

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

Returns:

The timeSliceDurationInMinutes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeSliceDurationInMinutes

void setTimeSliceDurationInMinutes(int timeSliceDurationInMinutes)
                                   throws IOException,
                                          AutomationException

The duration of time slice in minutes.

Product Availability

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

Parameters:

timeSliceDurationInMinutes - The timeSliceDurationInMinutes (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFirstTimeSliceStartTime

Date getFirstTimeSliceStartTime()
                                throws IOException,
                                       AutomationException

The start time of valid period of a day for traffic data.

Product Availability

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

Returns:

The firstTimeSliceStartTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFirstTimeSliceStartTime

void setFirstTimeSliceStartTime(Date firstTimeSliceStartTime)
                                throws IOException,
                                       AutomationException

The start time of valid period of a day for traffic data.

Product Availability

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

Parameters:

firstTimeSliceStartTime - The firstTimeSliceStartTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFirstTimeSliceFieldName

String getFirstTimeSliceFieldName()
                                  throws IOException,
                                         AutomationException

The field name of the first time slice of the given period in the profile table.

Product Availability

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

Returns:

The firstTimeSliceFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFirstTimeSliceFieldName

void setFirstTimeSliceFieldName(String firstTimeSliceFieldName)
                                throws IOException,
                                       AutomationException

The field name of the first time slice of the given period in the profile table.

Product Availability

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

Parameters:

firstTimeSliceFieldName - The firstTimeSliceFieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastTimeSliceFieldName

String getLastTimeSliceFieldName()
                                 throws IOException,
                                        AutomationException

The field name of the last time slice of the given period in the profile table.

Product Availability

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

Returns:

The lastTimeSliceFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLastTimeSliceFieldName

void setLastTimeSliceFieldName(String lastTimeSliceFieldName)
                               throws IOException,
                                      AutomationException

The field name of the last time slice of the given period in the profile table.

Product Availability

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

Parameters:

lastTimeSliceFieldName - The lastTimeSliceFieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJoinTableName

String getJoinTableName()
                        throws IOException,
                               AutomationException

The name of the join table between edges and profiles.

Product Availability

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

Returns:

The joinTableName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJoinTableName

void setJoinTableName(String joinTableName)
                      throws IOException,
                             AutomationException

The name of the join table between edges and profiles.

Product Availability

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

Parameters:

joinTableName - The joinTableName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJoinTableBaseTravelTimeFieldName

String getJoinTableBaseTravelTimeFieldName()
                                           throws IOException,
                                                  AutomationException

The field name for base travel time in the join table.

Product Availability

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

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJoinTableBaseTravelTimeFieldName

void setJoinTableBaseTravelTimeFieldName(String fieldName)
                                         throws IOException,
                                                AutomationException

The field name for base travel time in the join table.

Product Availability

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

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJoinTableBaseTravelTimeUnits

int getJoinTableBaseTravelTimeUnits()
                                    throws IOException,
                                           AutomationException

Base travel time units.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJoinTableBaseTravelTimeUnits

void setJoinTableBaseTravelTimeUnits(int units)
                                     throws IOException,
                                            AutomationException

Base travel time units.

Product Availability

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

Parameters:

units - A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJoinTableProfileIDFieldNames

IStringArray getJoinTableProfileIDFieldNames()
                                             throws IOException,
                                                    AutomationException

The field names of the historic join table pointing to speed profiles.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJoinTableProfileIDFieldNamesByRef

void setJoinTableProfileIDFieldNamesByRef(IStringArray profileIDFields)
                                          throws IOException,
                                                 AutomationException

The field names of the historic join table pointing to speed profiles.

Product Availability

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

Parameters:

profileIDFields - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.