com.azalient.api.a
Interface IModel

public interface IModel

Start Here: this is the top-level interface for the data that defines a commuter model. There is a direct mapping between the objects available from this interface and the component pages in the model data file.

Method Summary

IAssignment	assignment() Returns a handle to the currently loaded assignment page.
IControl	control() Returns a handle to the currently loaded control page - traffic control objects, such as phases and plans
IDemand	demand() Returns a handle to the currently loaded demand page.
IDisplay	display() Returns a handle to the currently loaded display page - annotation, symbols, hyperlinks, views, 3-D shapes, etc
IScenario	firstActiveScenario() The (first) active scenario.
INetwork	network() Returns a handle to the currently loaded network page - links, lanes, walkways, zones, areas etc.
IParameters	parameters() Returns a handle to the currently loaded parameters page - terms, restrictions, agent types, divisions etc
IPlugins	plugins() Returns a handle to the currently loaded plugins page
void	renewResults() Create a new set of results
IReporting	reporting() Returns a handle to the currently loaded reporting page
IResults	results() Returns a handle to the results book
IStore<IScenario>	scenarios() Returns a handle to the store of scenarios.
ISettings	settings() Returns a handle to the settings.
ITrips	trips() Returns a handle to the currently loaded trips page - directed and undirected trips for person and vehicle agents
IValidation	validation() Returns a handle to the currently loaded validation page

Method Detail

assignment

IAssignment assignment()

Returns a handle to the currently loaded assignment page. Functions in this page assign agents to routes within the network.

control

IControl control()

Returns a handle to the currently loaded control page - traffic control objects, such as phases and plans

demand

IDemand demand()

Returns a handle to the currently loaded demand page. Demand is specified as matrices or volumes, or as a timetable for public transport.

display

IDisplay display()

Returns a handle to the currently loaded display page - annotation, symbols, hyperlinks, views, 3-D shapes, etc

network

INetwork network()

Returns a handle to the currently loaded network page - links, lanes, walkways, zones, areas etc.

parameters

IParameters parameters()

Returns a handle to the currently loaded parameters page - terms, restrictions, agent types, divisions etc

plugins

IPlugins plugins()

Returns a handle to the currently loaded plugins page

validation

IValidation validation()

Returns a handle to the currently loaded validation page

reporting

IReporting reporting()

Returns a handle to the currently loaded reporting page

trips

ITrips trips()

Returns a handle to the currently loaded trips page - directed and undirected trips for person and vehicle agents

results

IResults results()

Returns a handle to the results book

settings

ISettings settings()

Returns a handle to the settings. These are global settings, such as file name and path

scenarios

IStore<IScenario> scenarios()

Returns a handle to the store of scenarios. A scenario specifies a set of active pages

firstActiveScenario

IScenario firstActiveScenario()

The (first) active scenario. There may be more than one active scenario, or none. Consequently, this may return null.

renewResults

void renewResults()

Create a new set of results