com.azalient.api.b.network
Interface IWalkway

All Superinterfaces:

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

All Known Subinterfaces:

IChannel, ICrossing, IPhaseCrossing

public interface IWalkway
extends IWay, StoreRecordRW

A walkway is a place where people can walk. It has a centre line and a width, but the width is only a guide, unless the walkway is walled.

Nested Class Summary

static class

IWalkway.WalkwayType The set of all possible walkway types

Field Summary

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

DELETED, KEY_SEP, KEY_SEP_CHAR

Method Summary

void	addConnection(boolean isTatD, IWalkway that, boolean isUatC) Add a connection to that walkway, specifying which way round the connection should be added
ICourse	addConnectionNearest(IWalkway that) Add a connection between the nearest ends of this walkway and that
IArea	area() Returns an area if this walkway is connected to an area by being partially inside it.
int	capacity() Returns the maximum number of people that can use the walkway at any one time, or zero if there is no limit
ICourse[]	coursesC() An array of courses (connections) at the C end of the walkway.
ICourse[]	coursesD() An array of courses (connections) at the D end of the walkway.
void	deleteConnection(IWalkway that) Delete a connection
void	draw(IDrawing drw) Draw this walkway
boolean	isPrivate() Returns true if private, which means that it can be used by only one person (or person group) at a time.
int	population() Returns the number of people currently on the walkway, which must be less than the capacity() if it is set.
boolean	selected() True if this is selected in GUI
void	selected(boolean v) Set to true to highlight this as selected in GUI
boolean	shared() Returns true if this is a shared walkway: look out for cyclists!
Speed	speedCD() The speed in the CD direction for this walkway
double	stepHeight() For a stepped walkway, this will return a finite positive value, in metres
double	stepLength() For a stepped walkway, this will return a finite positive value, in metres
IUserTwig	twigCD() The routing branch for the CD direction
IUserTwig	twigDC() The routing branch for the DC direction
IWalkway.WalkwayType	walkwayType() Returns the type of the walkway, either a type of crossing or a channel
boolean	walled() Returns true if this walkway is walled - a person can not walk outside the width of a walled walkway

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

Method Detail

walkwayType

IWalkway.WalkwayType walkwayType()

Returns the type of the walkway, either a type of crossing or a channel

area

IArea area()

Returns an area if this walkway is connected to an area by being partially inside it. Otherwise returns null

twigCD

IUserTwig twigCD()

The routing branch for the CD direction

twigDC

IUserTwig twigDC()

The routing branch for the DC direction

speedCD

Speed speedCD()

The speed in the CD direction for this walkway

deleteConnection

void deleteConnection(IWalkway that)

Delete a connection

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

addConnection

void addConnection(boolean isTatD,
                   IWalkway that,
                   boolean isUatC)

Add a connection to that walkway, specifying which way round the connection should be added

addConnectionNearest

ICourse addConnectionNearest(IWalkway that)

Add a connection between the nearest ends of this walkway and that

coursesC

ICourse[] coursesC()

An array of courses (connections) at the C end of the walkway. Each course can be connected at either its T or its U end to C.

coursesD

ICourse[] coursesD()

An array of courses (connections) at the D end of the walkway. Each course can be connected at either its T or its U end to D.

draw

void draw(IDrawing drw)

Draw this walkway

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

selected

boolean selected()

True if this is selected in GUI

selected

void selected(boolean v)

Set to true to highlight this as selected in GUI

shared

boolean shared()

Returns true if this is a shared walkway: look out for cyclists!

walled

boolean walled()

Returns true if this walkway is walled - a person can not walk outside the width of a walled walkway

isPrivate

boolean isPrivate()

Returns true if private, which means that it can be used by only one person (or person group) at a time.

capacity

int capacity()

Returns the maximum number of people that can use the walkway at any one time, or zero if there is no limit

population

int population()

Returns the number of people currently on the walkway, which must be less than the capacity() if it is set.

stepLength

double stepLength()

For a stepped walkway, this will return a finite positive value, in metres

stepHeight

double stepHeight()

For a stepped walkway, this will return a finite positive value, in metres