com.azalient.api.b.network
Interface IChannel

All Superinterfaces:

IRecord, IRestrictable, IWalkway, IWay, RecordR, RecordRW, RecordW, SortableData, StoreRecordRW

public interface IChannel
extends IWalkway

IChannel is a walkway that does not cross a road. In the manuals and other documentation, a channel is referred to as a walkway, but in the API, walkway is used for the base interface, and ICrossing and IChannel extend IWalkway

See Also:

IWalkway, ICrossing

Nested Class Summary

Nested classes/interfaces inherited from interface com.azalient.api.b.network.IWalkway

IWalkway.WalkwayType

Field Summary

static String

PREFIX

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

DELETED, KEY_SEP, KEY_SEP_CHAR

Method Summary

boolean	addConnection(ILane lane, Boolean thisSide) Add a connection from this channel to a (parking) lane and align the channel to the lane
boolean	addConnection(ILane lane, boolean align, Boolean thisSide) Add a connection from this channel to a (parking) lane
boolean	addConnection(IStand s)
void	addParking(IParkingLane p) Add the given parkingLane object to the set held by this channel
void	alignToSideOfRoad(ILane lane, Boolean thisSide) Align the channel to the given lane
boolean	canArriveHere() Returns true if a person can finish a trip here
boolean	canDepartHere() Returns true if a person can start a trip here
boolean	connectedToParking() Returns true if this channel is connected to any parking lane.
void	deleteConnection(ILane lane) Delete the connection between this channel and the given parking lane
void	deleteConnection(IStand s)
double	releaseRate() Returns the release rate value for this channel in the range [0.0, 1.0].
void	releaseRate(Double rate) Sets the release rate value for this channel in the range [0.0, 1.0].
void	removeParking(IParkingLane p) Remove the given parkingLane object from the set held by this channel

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

addConnection, addConnectionNearest, area, capacity, coursesC, coursesD, deleteConnection, draw, isPrivate, population, selected, selected, shared, speedCD, stepHeight, stepLength, twigCD, twigDC, walkwayType, walled

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

centreline, halfWidth, halfWidthE, halfWidthS, kerb, median, width, widthE, widthS

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

PREFIX

static final String PREFIX

See Also:

Constant Field Values

Method Detail

canArriveHere

boolean canArriveHere()

Returns true if a person can finish a trip here

canDepartHere

boolean canDepartHere()

Returns true if a person can start a trip here

addConnection

boolean addConnection(IStand s)

Internal - Not recommended for use. Public as a side-effect of implementation method

Add a connection between this walkway and a stand

deleteConnection

void deleteConnection(IStand s)

Internal - Not recommended for use. Public as a side-effect of implementation method

Delete a connection between this walkway and a stand

addConnection

boolean addConnection(ILane lane,
                      boolean align,
                      Boolean thisSide)

Add a connection from this channel to a (parking) lane

Parameters:

lane - a parking lane to which a connection will be made

align - true if the channel should be aligned to the side of the lane

thisSide - Boolean.TRUE if the lane should be aligned to the kerb side of the same side of the road as the lane, or Boolean.FALSE if it shoudl be aligned to the other side (either the median side for a one-way road, or the kerb side of the opposite direction). If it is set to null, then a pop-up dialog will ask the user what to do in this regard

addConnection

boolean addConnection(ILane lane,
                      Boolean thisSide)

Add a connection from this channel to a (parking) lane and align the channel to the lane

Parameters:

lane - a parking lane to which a connection will be made

thisSide - Boolean.TRUE if the lane should be aligned to the kerb side of the same side of the road as the lane, or Boolean.FALSE if it shoudl be aligned to the other side (either the median side for a one-way road, or the kerb side of the opposite direction). If it is set to null, then a pop-up dialog will ask the user what to do in this regard

deleteConnection

void deleteConnection(ILane lane)

Delete the connection between this channel and the given parking lane

alignToSideOfRoad

void alignToSideOfRoad(ILane lane,
                       Boolean thisSide)

Align the channel to the given lane

Parameters:

lane - a parking lane to which this channel will be aligned

thisSide - Boolean.TRUE if the lane should be aligned to the kerb side of the same side of the road as the lane, or Boolean.FALSE if it shoudl be aligned to the other side (either the median side for a one-way road, or the kerb side of the opposite direction). If it is set to null, then a pop-up dialog will ask the user what to do in this regard

addParking

void addParking(IParkingLane p)

Add the given parkingLane object to the set held by this channel

Internal - Not recommended for use. Public as a side-effect of implementation method

removeParking

void removeParking(IParkingLane p)

Remove the given parkingLane object from the set held by this channel

Internal - Not recommended for use. Public as a side-effect of implementation method

connectedToParking

boolean connectedToParking()

Returns true if this channel is connected to any parking lane. A channel can be connected to any number of parking lanes, but more commonly, if connected, it will be either one (on one side) or two (one on either side)

releaseRate

double releaseRate()

Returns the release rate value for this channel in the range [0.0, 1.0]. If there are two or more channels in an area, this will control how many people are generated ("released") on this channel. Release rates for all channels in an area should add up to 1.0

releaseRate

void releaseRate(Double rate)

Sets the release rate value for this channel in the range [0.0, 1.0]. If there are two or more channels in an area, this will control how many people are generated ("released") on this channel. Release rates for all channels in an area should add up to 1.0