com.azalient.api.b.control
Interface ISignalRule

All Superinterfaces:

IActionable, IAssociate, IClippable, IDeletable, IDraggable, IPastable, IRecord, RecordR, RecordRW, RecordW, SortableData, StoreRecordRW

public interface ISignalRule
extends IClippable, IPastable, IAssociate, IDeletable, StoreRecordRW

This interface allows access to a Signal Rule object. Signal rules can be defined for a signalised intersection to modify the timing of the traffic signals based on the volume of traffic detected on loops near the intersection.

Field Summary

static String	SEPARATOR
static ISignalRule[]	ZERO

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

scratch

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

DELETED, KEY_SEP, KEY_SEP_CHAR

Method Summary

SignalRuleAction	action() The action that will be applied if the test for this rule returns true.
String	description() A wordy description of this rule
boolean	enabled() Returns true if this rule is currently enabled
void	enabled(boolean b) Set this to true to enable this rule
IExpression	expression() A reference to the expression, once it has been read and understood by the expression parser.
String	expressionInternal()
String	expressionString() The expression defining the test that will be applied to decide if the rule should be applied.
int	index() The index number of this rule.
IIntersection	intersection() The intersection to which this rule applies
IPhase	phase() The running phase to which this rule applies
IPhase	phaseOther() The other "balancing" phase which will give or take time from the running phase.
int	planIndex() The index of the plan for which this rule is used.

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

children, getAlt, references, tableName

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

delete, deleted, name

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, isVolatile

Field Detail

ZERO

static final ISignalRule[] ZERO

SEPARATOR

static final String SEPARATOR

See Also:

Constant Field Values

Method Detail

description

String description()

A wordy description of this rule

index

int index()

The index number of this rule. This will be unique on this intersection

intersection

IIntersection intersection()

The intersection to which this rule applies

phase

IPhase phase()

The running phase to which this rule applies

phaseOther

IPhase phaseOther()

The other "balancing" phase which will give or take time from the running phase. The "other" phase might be null, in which case the changes will not be balanced, and the cycle time at the intersection will change.

planIndex

int planIndex()

The index of the plan for which this rule is used. If this returns zero, then the rule will be used for all plans.

expressionString

String expressionString()

The expression defining the test that will be applied to decide if the rule should be applied.

expressionInternal

String expressionInternal()

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

expression

IExpression expression()

A reference to the expression, once it has been read and understood by the expression parser.

action

SignalRuleAction action()

The action that will be applied if the test for this rule returns true.

enabled

void enabled(boolean b)

Set this to true to enable this rule

enabled

boolean enabled()

Returns true if this rule is currently enabled