com.azalient.api.b.network
Interface ICourse

All Superinterfaces:

IActionable, IAssociate, IDecisionOption, IDraggable, IJoiner, IRecord, IRestrictable, RecordR, RecordRW, RecordW, SortableData, StoreRecordRW

public interface ICourse
extends IJoiner, IDecisionOption, IRestrictable, StoreRecordRW

A course connects two walkways, where a walkway may be a channel or a crossing.

A course is referred to as a "connection" in the Commuter documentation.

The two ends of a course are labelled T and U.

Field Summary

static ICourse[]

ZERO

Fields inherited from interface com.azalient.api.ui.clipboard.IAssociate

scratch

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

DELETED, KEY_SEP, KEY_SEP_CHAR

Method Summary

boolean	allows(IBehaviour b) Is this behaviour allowed on this course (is there a restriction)
int	capacity() The maximum capacity on this course
boolean	isTatC() Is T end of this course connected to C end of walkT? The two ends of a course are labelled T and U.
boolean	isTatD() Is T end of this course connected to D end of walkT? The two ends of a course are labelled T and U.
boolean	isUatC() Is U end of this course connected to C end of walkT? The two ends of a course are labelled T and U.
boolean	isUatD() Is U end of this course connected to D end of walkT? The two ends of a course are labelled T and U.
IParkingLane	laneU() Returns a reference to a parking lane, if this is a connection between a channel and a parking lane
int	population() The current population on this course
int	standDoor() If this is a connection to a stand, this method returns the index of the door on the stand to which this course is connected.
IStand	standU() Returns a reference to a stand, if this is a connection between a channel and a stand
IWalkway	walkT() Returns a reference to the walkway at the T end of this course.
IWalkway	walkU() Returns a reference to the walkway at the U end of this course.

Methods inherited from interface com.azalient.api.a.position.IJoiner

centreline

Methods inherited from interface com.azalient.api.ui.clipboard.IAssociate

clip, name, proxy, selected

Methods inherited from interface com.azalient.api.ui.clipboard.IDraggable

selected, selectedForDraggingDraw

Methods inherited from interface com.azalient.api.ui.clipboard.IActionable

action

Methods inherited from interface com.azalient.api.b.assignment.IDecisionOption

openFrom

Methods inherited from interface com.azalient.api.b.network.IRestrictable

allows, allows, closed, closed, multipleRestrictions, multipleRestrictions, name, restriction, restriction, restrictionIndex

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

Field Detail

ZERO

static final ICourse[] ZERO

Method Detail

walkT

IWalkway walkT()

Returns a reference to the walkway at the T end of this course. This always returns a non-null value

walkU

IWalkway walkU()

Returns a reference to the walkway at the U end of this course. This will return null if the course is connected to a stand or to a parking lane

standU

IStand standU()

Returns a reference to a stand, if this is a connection between a channel and a stand

standDoor

int standDoor()

If this is a connection to a stand, this method returns the index of the door on the stand to which this course is connected.

laneU

IParkingLane laneU()

Returns a reference to a parking lane, if this is a connection between a channel and a parking lane

isTatC

boolean isTatC()

Is T end of this course connected to C end of walkT?
The two ends of a course are labelled T and U.
The two ends of a walkway are labelled C and D.

isTatD

boolean isTatD()

Is T end of this course connected to D end of walkT?
The two ends of a course are labelled T and U.
The two ends of a walkway are labelled C and D.

isUatC

boolean isUatC()

Is U end of this course connected to C end of walkT?
The two ends of a course are labelled T and U.
The two ends of a walkway are labelled C and D.

isUatD

boolean isUatD()

Is U end of this course connected to D end of walkT?
The two ends of a course are labelled T and U.
The two ends of a walkway are labelled C and D.

capacity

int capacity()

The maximum capacity on this course

population

int population()

The current population on this course

allows

boolean allows(IBehaviour b)

Is this behaviour allowed on this course (is there a restriction)