com.azalient.api.b.demand
Interface IMatrix

All Superinterfaces:

ISource, ITable, ITableType, Table, TableR, TableRW, TableW

public interface IMatrix
extends ISource, TableRW

This class represents an origin-destination demand matrix

Method Summary

double	demand(int origin, int destination) Return the demand for the given OD pair, where indices are (0..N-1)
void	demand(int origin, int destination, double value) Set the demand for the given OD pair, where indices are (0..N-1)
double	destinationDemand(int destination) Sum of demand to given destination
void	destinationDemand(int destination, double value) Set sum of demand to given destination
IPlace[]	destinations() The array of destinations
IDivision	division() Returns the division for this matrix, defining an array of types, and their respective shares of the demand
void	division(IDivision division) Sets the division for this matrix, defining an array of types, and their respective shares of the demand
boolean	generateTrips() Return true if this matrix is currently switched on to generate trips
void	generateTrips(boolean b) Set trip generation from this matrix, on by default
int	index() An integer index that should be unique, used for rule matching
IMatrixDescription	matrixDescription() A reference to the metadata.
TripMode	mode() The transport mode for the matrix, PEOPLE or VEHICLE
String	name() A unique name for the matrix
double	originDemand(int origin) Sum of demand from given origin
void	originDemand(int origin, double value) Set sum of demand from given origin
IProfile	originProfile(int originIndex) Get any origin profile for the given origin.
void	originProfile(int originIndex, IProfile profile) Set a profile attached to the given origin place only
IPlace[]	origins() The array of origins
IProfile	profile() A profile applied to the whole matrix.
void	profile(IProfile p) Set the profile for this matrix
void	rename(String newName) change the name of the matrix, the new name must be unique amongst all matrices
double	totalDemand() The total of all demand across the matrix
void	totalDemand(double doubleValue) Set the total matrix demand, apportion over all cells

Methods inherited from interface com.azalient.api.b.demand.ISource

sourceType

Methods inherited from interface com.azalient.api.file.TableR

columnNameObject, finishedR, invalidate, notFound, open, open, row, rowExists

Methods inherited from interface com.azalient.api.file.TableW

columnName, finishedW, format, newPage, recordArray, save, save, width

Methods inherited from interface com.azalient.api.file.Table

destroy, headerRows, keyTypes

Methods inherited from interface com.azalient.api.a.tables.ITable

page, pageName

Methods inherited from interface com.azalient.api.a.tables.ITableType

colNameObjects, pageType, tableName

Method Detail

name

String name()

A unique name for the matrix

Specified by:

name in interface ISource

matrixDescription

IMatrixDescription matrixDescription()

A reference to the metadata. It is usually not necessary to refer to this object, as there are convenience methods on the matrix to get handles to the relevant objects within the description.

rename

void rename(String newName)

change the name of the matrix, the new name must be unique amongst all matrices

index

int index()

An integer index that should be unique, used for rule matching

mode

TripMode mode()

The transport mode for the matrix, PEOPLE or VEHICLE

division

IDivision division()

Returns the division for this matrix, defining an array of types, and their respective shares of the demand

division

void division(IDivision division)

Sets the division for this matrix, defining an array of types, and their respective shares of the demand

profile

IProfile profile()

A profile applied to the whole matrix.

originProfile

IProfile originProfile(int originIndex)

Get any origin profile for the given origin. Can return null;

origins

IPlace[] origins()

The array of origins

destinations

IPlace[] destinations()

The array of destinations

demand

double demand(int origin,
              int destination)

Return the demand for the given OD pair, where indices are (0..N-1)

originDemand

double originDemand(int origin)

Sum of demand from given origin

originDemand

void originDemand(int origin,
                  double value)

Set sum of demand from given origin

destinationDemand

double destinationDemand(int destination)

Sum of demand to given destination

destinationDemand

void destinationDemand(int destination,
                       double value)

Set sum of demand to given destination

profile

void profile(IProfile p)

Set the profile for this matrix

demand

void demand(int origin,
            int destination,
            double value)

Set the demand for the given OD pair, where indices are (0..N-1)

totalDemand

double totalDemand()

The total of all demand across the matrix

totalDemand

void totalDemand(double doubleValue)

Set the total matrix demand, apportion over all cells

originProfile

void originProfile(int originIndex,
                   IProfile profile)

Set a profile attached to the given origin place only

generateTrips

boolean generateTrips()

Return true if this matrix is currently switched on to generate trips

generateTrips

void generateTrips(boolean b)

Set trip generation from this matrix, on by default