com.azalient.api.b.demand
Interface IMatrixDescription

All Superinterfaces:

IRecord, ITripSource, RecordR, RecordRW, RecordW, SortableData, StoreRecordRW

public interface IMatrixDescription
extends StoreRecordRW, ITripSource

A reference to the metadata object describing a matrix. 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.

Field Summary

Fields inherited from interface com.azalient.api.a.tables.IRecord

DELETED, KEY_SEP, KEY_SEP_CHAR

Method Summary

IDivision	division() Returns a division specifying the proportions, by type, from this demand matrix.
TripMode	mode() Returns the trip mode: people or vehicles
IProfile	profile() Returns a time profile describing how demand will be released over the term.

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

canRename, rename, store

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

extraSet, finished, isApplicable, isEditable, set

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

name

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

extraCols, extraGet, extraGetB, extraGetD, extraGetI, extraGetS, extraGetT, get, isVolatile

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

generateTrips, generateTrips

Method Detail

mode

TripMode mode()

Returns the trip mode: people or vehicles

division

IDivision division()

Returns a division specifying the proportions, by type, from this demand matrix. For example 90% cars, 10% trucks.

profile

IProfile profile()

Returns a time profile describing how demand will be released over the term. Commonly the profile rises to a maximum then falls again as a reflection of peak hour demand.