com.azalient.api.b.parameters
Interface IRestriction

All Superinterfaces:

IActionable, IAssociate, IDescribed, IDraggable, IPastable, IRecord, RecordR, RecordRW, RecordW, SortableData, StoreRecordRW

public interface IRestriction
extends IDescribed, StoreRecordRW, IPastable

A restriction can be applied to a walkway or lane, or their connectors (turns, courses). A restriction can limit the use of a lane or walkway by specifying a set of types that can use it a set of types that cannot use it or a set of types that must use it

Field Summary

static IRestriction[]

ZERO A static zero-length array, created for convenience, and to save memory

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	allowed(IBehaviour behaviour) Is this behaviour allowed by this restriction (behaviour not in barred list )
boolean	allowed(IType type) Is this type allowed by this restriction (type not in barred list )
boolean	barred(IBehaviour behaviour) Is this behaviour barred by this restriction (behaviour in barred list )
boolean	barred(IType type) Is this type barred by this restriction (type in barred list )
NamedColour	colour() The graphics colour for drawing this restriction
Distance	endPocket() The end-pocket distance, applicable for lane restrictions only
int	index() an index, not necessarily sequential, always unique
boolean	mandatory(IBehaviour behaviour) Should the behaviour stick to lanes of this restriction
boolean	mandatory(IType type) Should the type stick to lanes of this restriction
boolean	surfaceModeCompatible(SurfaceMode sm) Can the restriction be applied to this surface mode?
ITerm	term() The term during which this restriction is active

Methods inherited from interface com.azalient.api.a.tables.IDescribed

description

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

finish, pickables

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.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 IRestriction[] ZERO

A static zero-length array, created for convenience, and to save memory

Method Detail

index

int index()

an index, not necessarily sequential, always unique

colour

NamedColour colour()

The graphics colour for drawing this restriction

barred

boolean barred(IType type)

Is this type barred by this restriction (type in barred list )

allowed

boolean allowed(IType type)

Is this type allowed by this restriction (type not in barred list )

mandatory

boolean mandatory(IType type)

Should the type stick to lanes of this restriction

barred

boolean barred(IBehaviour behaviour)

Is this behaviour barred by this restriction (behaviour in barred list )

allowed

boolean allowed(IBehaviour behaviour)

Is this behaviour allowed by this restriction (behaviour not in barred list )

mandatory

boolean mandatory(IBehaviour behaviour)

Should the behaviour stick to lanes of this restriction

term

ITerm term()

The term during which this restriction is active

surfaceModeCompatible

boolean surfaceModeCompatible(SurfaceMode sm)

Can the restriction be applied to this surface mode?

endPocket

Distance endPocket()

The end-pocket distance, applicable for lane restrictions only