com.azalient.api
Interface ICommuter

public interface ICommuter

The top level interface handle to an instance of commuter, retrieved from CommuterAPI.startCommuter(String[]) or CommuterAPI.commuter()

See Also:

CommuterAPI

Method Summary

void	exportQP(String path) export the current network as QP format
void	importNetwork(String path, String saveAs) import the given VS/MDB/etc network
void	importQP(String path, String saveAs) import the given QP network
void	importSG(String filename) Import from S-graphics
IModel	model() Return a handle to the model part of the interface.
void	open(String path) open the given network
void	openNew() open a new network, with a default location
IRouting	routing() Return a handle to the routing part of the interface.
ISimulator	simulator() Return a handle to the simulator part of the interface.
IUtility	utility() Return a handle to the utility part of the interface.
IWindow	window() Return a handle to the window part of the interface.

Method Detail

model

IModel model()

Return a handle to the model part of the interface. This allows read and write access to the structured network data

routing

IRouting routing()

Return a handle to the routing part of the interface. This allows you to access information on route costs for individual turns or the lowest cost from a location to a destination

simulator

ISimulator simulator()

Return a handle to the simulator part of the interface. This allows you to access the objects in the simulation, such as the agents and the simulation time. This part also has listeners, allowing you to register for simulation events

utility

IUtility utility()

Return a handle to the utility part of the interface. This part allows you to display warning messages through the application's popup windows, query the license, perform dimension conversions, etc

window

IWindow window()

Return a handle to the window part of the interface. This allows you to modify the user interface, change the viewpoint, access the editing actions, etc.

openNew

void openNew()

open a new network, with a default location

open

void open(String path)

open the given network

importQP

void importQP(String path,
              String saveAs)

import the given QP network

importNetwork

void importNetwork(String path,
                   String saveAs)

import the given VS/MDB/etc network

exportQP

void exportQP(String path)

export the current network as QP format

importSG

void importSG(String filename)

Import from S-graphics