com.azalient.api.b.control
Interface IGroup

All Superinterfaces:

IRecord, RecordR, RecordRW, RecordW, SortableData, StoreRecordRW

public interface IGroup
extends StoreRecordRW

A signal group. This is used to identify one or more Turns (traffic movements) or Walks (pedestrian movements) that are controlled by a single traffic signal command. Each group has an index number, which is unique on the intersection. On many intersections, group numbers start at 1 and are sequential but neither of these conditions are guaranteed at any locations. In general pedestrian group numbers are all higher numbers than all traffic movement groups, but this also cannot be guaranteed.

For example, at a 4-way intersection aligned with the compass, Group 1 might be for E-W and W-E traffic, Group 2 might be for E-N and W-S traffic, and Group 8 might be for the pedestrian walks on both E and W approaches

Field Summary

static String	IX_GROUP_SEP
static IGroup[]	ZERO

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

DELETED, KEY_SEP, KEY_SEP_CHAR

Method Summary

void	addTurn(ITurn turn) Add the given turn to the array of turns for this group
boolean	canGoOff() Returns true if this group can go to the OFF state.
void	canGoOff(boolean v) Set to true if this group can go to the OFF state
IController	controller() The controller to which this group belongs
boolean	delete(IUndoStack us)
void	delTurn(ITurn turn) Delete the given turn from this group
boolean	flash() Deprecated. use signalFlashing()
int	index() The index of this group, a positive number.
void	index(int i) Set the index of this group, a positive number
Signal	initialSignal() The initial signal state on this group
void	initialSignal(Signal signal) Set the initial signal state on this group
IIntersection	intersection() The intersection on which this group operates
boolean	isSelected() Deprecated. use logging
void	isSelected(boolean b) Deprecated. use logging
boolean	logging() Returns true if group has been selected for logging
void	logging(boolean v) Set to true to log information for this group
Signal	priInitial() Deprecated. use initialSignal()
void	priInitial(Signal signal) Deprecated. use initialSignal()
boolean	scramble() Returns true if this is an all-walks or "scramble" phase, where no traffic is moving, and all pedestrian walks are at green.
void	scramble(boolean b) Set this to true to make this pedestrian group a "scramble" phase, where no traffic is moving, and all pedestrian walks are at green.
boolean	selected() Returns true if this group is selected in the user interface
void	selected(boolean b) Select this group for highlight in the user interface
Signal	signal() The currently active signal state for this group (Red, Green, Off, etc)
void	signal(Signal p) Set all streams in this group to the given priority, but note that a stream may be contained in more than one group, so if you are using this method, make sure the group going to Red is set before the group going to Green
void	signal(Signal p, SignalColour colour, boolean flashing)
SignalColour	signalColour()
boolean	signalFlashing() Returns true if the signal currently active for the group is flashing.
ITurn[]	turns() An array of turns for this group, including those that have this group as a filter (secondary)
int	walkID() The walk ID number, valid only if this is a pedestrian group.
void	walkID(int i) Set the walk ID number, valid only if this is a pedestrian group.

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 IGroup[] ZERO

IX_GROUP_SEP

static final String IX_GROUP_SEP

See Also:

Constant Field Values

Method Detail

index

int index()

The index of this group, a positive number.

index

void index(int i)

Set the index of this group, a positive number

intersection

IIntersection intersection()

The intersection on which this group operates

controller

IController controller()

The controller to which this group belongs

turns

ITurn[] turns()

An array of turns for this group, including those that have this group as a filter (secondary)

signal

Signal signal()

The currently active signal state for this group (Red, Green, Off, etc)

signal

void signal(Signal p)

Set all streams in this group to the given priority, but note that a stream may be contained in more than one group, so if you are using this method, make sure the group going to Red is set before the group going to Green

signal

void signal(Signal p,
            SignalColour colour,
            boolean flashing)

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

Used in connection with SCATS SP38 interface

signalColour

SignalColour signalColour()

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

Used in connection with SCATS SP38 interface

signalFlashing

boolean signalFlashing()

Returns true if the signal currently active for the group is flashing.

logging

boolean logging()

Returns true if group has been selected for logging

logging

void logging(boolean v)

Set to true to log information for this group

isSelected

boolean isSelected()

Deprecated. use logging

isSelected

void isSelected(boolean b)

Deprecated. use logging

addTurn

void addTurn(ITurn turn)

Add the given turn to the array of turns for this group

delTurn

void delTurn(ITurn turn)

Delete the given turn from this group

canGoOff

boolean canGoOff()

Returns true if this group can go to the OFF state. Not all signal groups can go off, normally this is confined to filter arrow signals.

canGoOff

void canGoOff(boolean v)

Set to true if this group can go to the OFF state

flash

boolean flash()

Deprecated. use signalFlashing()

scramble

boolean scramble()

Returns true if this is an all-walks or "scramble" phase, where no traffic is moving, and all pedestrian walks are at green.

scramble

void scramble(boolean b)

Set this to true to make this pedestrian group a "scramble" phase, where no traffic is moving, and all pedestrian walks are at green.

walkID

int walkID()

The walk ID number, valid only if this is a pedestrian group. A valid value is in the range 1 to 255. A value of 0 means not set.

walkID

void walkID(int i)

Set the walk ID number, valid only if this is a pedestrian group. A valid value is in the range 1 to 255. A value of 0 means not set.

priInitial

Signal priInitial()

Deprecated. use initialSignal()

priInitial

void priInitial(Signal signal)

Deprecated. use initialSignal()

initialSignal

Signal initialSignal()

The initial signal state on this group

initialSignal

void initialSignal(Signal signal)

Set the initial signal state on this group

delete

boolean delete(IUndoStack us)

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

delete this group from the intersection

selected

boolean selected()

Returns true if this group is selected in the user interface

selected

void selected(boolean b)

Select this group for highlight in the user interface