com.esri.arcgis.networkanalyst
Interface INATimeAwareSolverSettings

All Superinterfaces:

Serializable

All Known Implementing Classes:

NAClosestFacilitySolver, NALocationAllocationSolver, NAODCostMatrixSolver, NAServerClosestFacilityParams, NAServerLocationAllocationParams, NAServerODCostMatrixParams, NAServerServiceAreaParams, NAServiceAreaSolver

public interface INATimeAwareSolverSettings
extends Serializable

Provides access to settings common to all time-aware solvers.

Product Availability

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

Method Summary

Date	getTimeOfDay() The date-time value used in time-aware solvers.
int	getTimeOfDayUsage() The usage type for the TimeOfDay property.
void	setTimeOfDay(Date timeOfDay) The date-time value used in time-aware solvers.
void	setTimeOfDayUsage(int timeOfDayUsage) The usage type for the TimeOfDay property.

Method Detail

getTimeOfDay

Date getTimeOfDay()
                  throws IOException,
                         AutomationException

The date-time value used in time-aware solvers.

Product Availability

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

Returns:

The timeOfDay

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeOfDay

void setTimeOfDay(Date timeOfDay)
                  throws IOException,
                         AutomationException

The date-time value used in time-aware solvers.

Remarks

TimeOfDay, in conjunction with TimeOfDayUsage, provides the time input to time-aware solvers. The time value is considered local time.

Product Availability

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

Parameters:

timeOfDay - The timeOfDay (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeOfDayUsage

int getTimeOfDayUsage()
                      throws IOException,
                             AutomationException

The usage type for the TimeOfDay property.

Product Availability

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

Returns:

A com.esri.arcgis.networkanalyst.esriNATimeOfDayUsage constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeOfDayUsage

void setTimeOfDayUsage(int timeOfDayUsage)
                       throws IOException,
                              AutomationException

The usage type for the TimeOfDay property.

Remarks

TimeOfDayUsage specifies how TimeOfDay is used by the solver. Please see esriNATimeOfDayUsage for a description of the possible usage types.

Product Availability

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

Parameters:

timeOfDayUsage - A com.esri.arcgis.networkanalyst.esriNATimeOfDayUsage constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.