com.azalient.api.b.demand
Interface IVolume

All Superinterfaces:

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

public interface IVolume
extends StoreRecordRW, ISource, ITripSource

A specification of undirected demand from an array of origins, including

• A division: the set of agents to which this volume applies
• A profile: an array of weights over a time interval (specified as a start time and an end time)

Field Summary

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

DELETED, KEY_SEP, KEY_SEP_CHAR

Method Summary

double	demand(int originIndex) The demand for the given origin index [0..n-1]
void	demand(int originIndex, double newDemand) Set the demand for the given origin index [0..n-1]
double	demand(IPlace origin) The demand for the given origin
IDivision	division() The division for this volume, determining an array of types, their respective shares, and the travel mode for this volume, which determines the type of the IPlace
void	division(IDivision division)
TripMode	mode() The trip mode, PEOPLE or VEHICLE
IProfile	originProfile(int originIndex) A profile attached to the given origin place only
void	originProfile(int originIndex, IProfile profile) Set a profile attached to the given origin place only
IPlace[]	origins() The array of origins
void	origins(IPlace[] pa) Set the volume of origin places
IProfile	profile() A profile for the volume, which can be null.
void	profile(IProfile p) Set the profile for this volume
double	totalDemand() The total (sum) of the values in this volume
void	totalDemand(double newTotal) Set the total (sum) of the values in this volume
VolumeMode	volumeMode()

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.ISource

name, sourceType

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

generateTrips, generateTrips

Method Detail

division

IDivision division()

The division for this volume, determining an array of types, their respective shares, and the travel mode for this volume, which determines the type of the IPlace

division

void division(IDivision division)

profile

IProfile profile()

A profile for the volume, which can be null. If two origins use different profiles, then their demand should be specified in different volumes

mode

TripMode mode()

The trip mode, PEOPLE or VEHICLE

volumeMode

VolumeMode volumeMode()

origins

IPlace[] origins()

The array of origins

demand

double demand(IPlace origin)

The demand for the given origin

demand

double demand(int originIndex)

The demand for the given origin index [0..n-1]

demand

void demand(int originIndex,
            double newDemand)

Set the demand for the given origin index [0..n-1]

totalDemand

double totalDemand()

The total (sum) of the values in this volume

totalDemand

void totalDemand(double newTotal)

Set the total (sum) of the values in this volume

profile

void profile(IProfile p)

Set the profile for this volume

origins

void origins(IPlace[] pa)

Set the volume of origin places

originProfile

IProfile originProfile(int originIndex)

A profile attached to the given origin place only

originProfile

void originProfile(int originIndex,
                   IProfile profile)

Set a profile attached to the given origin place only