6. API documentation

6.1. Project Module

Project

AequilibraE project class

6.1.2. Project components

About

Provides an interface for querying and editing the about table of an AequilibraE project

FieldEditor

Allows user to edit the project data tables

Log

API entry point to the log file contents

Matrices

Gateway into the matrices available/recorded in the model

Network

Network class.

Zoning

Access to the API resources to manipulate the zones table in the project

6.1.3. Project objects

Zone

Single zone object that can be queried and manipulated in memory

6.1.3.2. Network data

Modes

Access to the API resources to manipulate the modes table in the network

LinkTypes

Access to the API resources to manipulate the link_types table in the network

Links

Access to the API resources to manipulate the links table in the network

Nodes

Access to the API resources to manipulate the links table in the network

6.1.3.3. Network items

Mode

A mode object represents a single record in the modes table

LinkType

A link_type object represents a single record in the link_types table

Link

A Link object represents a single record in the links table

Node

A Node object represents a single record in the nodes table

6.2. Parameters Module

Parameters

Global parameters module

6.3. Distribution Module

Ipf

Iterative proportional fitting procedure

GravityApplication

Applies a synthetic gravity model

GravityCalibration

Calibrate a traditional gravity model

SyntheticGravityModel

Simple class object to represent synthetic gravity models

6.4. Matrix Module

AequilibraeMatrix

Matrix class

AequilibraeData

AequilibraE dataset

6.5. Paths Module

Graph

Graph class

AssignmentResults

Assignment result holder for a single TrafficClass with multiple user classes

SkimResults

Network skimming result holder

PathResults

Path computation result holder

VDF

Volume-Delay function

TrafficClass

Traffic class for equilibrium traffic assignment

TrafficAssignment

Traffic assignment class

6.7. Use examples