com.azalient.api.b.trips
Interface ITrip

All Superinterfaces:

Comparable<ITrip>, IRecord, IRouteFinder, RecordR, RecordRW, RecordW, SortableData, StoreRecordRW

All Known Subinterfaces:

IPersonTrip, ITransportTrip, IVehicleTrip

public interface ITrip
extends IRouteFinder, StoreRecordRW, Comparable<ITrip>

Field Summary

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

DELETED, KEY_SEP, KEY_SEP_CHAR

Method Summary

IAgent	agent()
void	agent(IAgent agent)
UTime	arrival()
IBehaviour	behaviour()
UTime	departure()
IPlace	destination() The destination, which might be null
void	destination(IPlace place) Change the destination for this trip
double	dna(Strand strand) Return either a uniform-distribution or gaussian-distribution random variable.
void	generateDNA()
int	immediateTargetIndex() [0, nT-1] index of next "target", where a target may be a gateway or a destination place and nT = nZ + nG
int	matrix() The index (1 ..
TripMode	mode()
IPlace	origin() The origin area or zone
int	originPlaceIndex() [0, nP-1] index of origin place
void	replaceBehaviour(IBehaviour b)
void	replaceDNA(ITrip trip)
void	resetTypeGroupIndex()
void	restoreTypeBehaviour()
void	rewind()
int	tableIndex()
int	travellers() The number of travellers represented by this (person) trip.
IType	type()
int	ultimateDestinationIndex() [0, nP-1] index of ultimate destination, or -1 if no destination set

Methods inherited from interface com.azalient.api.sim.agents.IRouteFinder

arrivesHere, routeExitIndex

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 java.lang.Comparable

compareTo

Method Detail

departure

UTime departure()

arrival

UTime arrival()

type

IType type()

mode

TripMode mode()

origin

IPlace origin()

The origin area or zone

originPlaceIndex

int originPlaceIndex()

[0, nP-1] index of origin place

destination

IPlace destination()

The destination, which might be null

destination

void destination(IPlace place)

Change the destination for this trip

ultimateDestinationIndex

int ultimateDestinationIndex()

[0, nP-1] index of ultimate destination, or -1 if no destination set

immediateTargetIndex

int immediateTargetIndex()

[0, nT-1] index of next "target", where a target may be a gateway or a destination place and nT = nZ + nG

matrix

int matrix()

The index (1 .. N) of the matrix that generated the trip

dna

double dna(Strand strand)

Return either a uniform-distribution or gaussian-distribution random variable. Uniform distribution is between 0 1nd 1, gaussian has mean 0, and std.dev 1.0

tableIndex

int tableIndex()

resetTypeGroupIndex

void resetTypeGroupIndex()

rewind

void rewind()

agent

void agent(IAgent agent)

agent

IAgent agent()

generateDNA

void generateDNA()

behaviour

IBehaviour behaviour()

replaceDNA

void replaceDNA(ITrip trip)

replaceBehaviour

void replaceBehaviour(IBehaviour b)

restoreTypeBehaviour

void restoreTypeBehaviour()

travellers

int travellers()

The number of travellers represented by this (person) trip. If this is not a person trip, then this returns 1