com.azalient.api.b.control
Interface IGapOutData

public interface IGapOutData

The playback controller can contain some hard-coded rules at each intersection, that allow certain phases to "gap out" or terminate under certain conditions. This interface defines the parameters that are used in those special rules.

Method Summary

void	addLoop(ILoop loop)
void	delLoop(ILoop loop)
int	gap() The minimum gap time, in seconds, required on ALL loops to fire the rule.
void	gap(int seconds) Set the minimum gap time, in seconds, required on ALL loops to fire the rule.
ILoop[]	loops() The array of loops used by this gap-out test.
int	min() The minimum time, in seconds for which this phase MUST run.
void	min(int seconds) Set the minimum time, in seconds for which this phase MUST run.
IPhase	phase() The phase to which this gap-out rule applies

Method Detail

addLoop

void addLoop(ILoop loop)

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

Add a loop to this gap-out object

delLoop

void delLoop(ILoop loop)

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

Remove a loop from this gap-out object

loops

ILoop[] loops()

The array of loops used by this gap-out test.
Often the test is the AND of all loops in the array.

For example if loop1 is empty AND loop2 is empty AND loop3 is empty

phase

IPhase phase()

The phase to which this gap-out rule applies

min

int min()

The minimum time, in seconds for which this phase MUST run.

gap

int gap()

The minimum gap time, in seconds, required on ALL loops to fire the rule.

min

void min(int seconds)

Set the minimum time, in seconds for which this phase MUST run.

gap

void gap(int seconds)

Set the minimum gap time, in seconds, required on ALL loops to fire the rule.