com.esri.arcgis.datasourcesfile
Interface ISMRouterFactory

All Superinterfaces:

Serializable

All Known Implementing Classes:

SMRouterFactory

public interface ISMRouterFactory
extends Serializable

Provides access to members for creating SMRouter objects.

Description

Allows creation of SMRouter objects.

Product Availability

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

Method Summary

ISMRouter	createRouter(String routingFilePath) Creates a SMRouter object based on information in the input routing initialization file.
ISMRouter	createRouterCfg(String routingFilePath, String configPath) Creates a SMRouter object based on additional information in the alternate routing configuration file.

Method Detail

createRouter

ISMRouter createRouter(String routingFilePath)
                       throws IOException,
                              AutomationException

Creates a SMRouter object based on information in the input routing initialization file.

Description

The method creates a SMRouter object reading necessary information from the routing initialization file that is passed in.

Remarks

The method returns an instance of the SMRouter object if successful. Otherwise it returns Nothing.

A routing initialization file, for example routing.ini or routing.rs, contains the definition of the routing service based on the specific information about routing data source.

Product Availability

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

Parameters:

routingFilePath - The routingFilePath (in)

Returns:

A reference to a com.esri.arcgis.datasourcesfile.ISMRouter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createRouterCfg

ISMRouter createRouterCfg(String routingFilePath,
                          String configPath)
                          throws IOException,
                                 AutomationException

Creates a SMRouter object based on additional information in the alternate routing configuration file.

Description

The method creates SMRouter object using the alternate configuration file along with the main routing initialization file.

Remarks

The method returns an instance of the SMRouter object if successful. Otherwise it returns Nothing.

A routing initialization file, for example routing.ini or routing.rs, contains the definition of the routing service based on the specific information about routing data source.

A routing configuration file, for example routing.cfg, contains application specific information such as driving directions patterns, texts of directions parts, distance, time formats, and so on.

Product Availability

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

Parameters:

routingFilePath - The routingFilePath (in)

configPath - The configPath (in)

Returns:

A reference to a com.esri.arcgis.datasourcesfile.ISMRouter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.