TrafficLight (AnyLogic 8 Engine API)

java.lang.Object
- com.anylogic.engine.markup.TrafficLight<T>

All Implemented Interfaces:

java.io.Serializable
```
public class TrafficLight<T extends ISignalable>
extends java.lang.Object
implements java.io.Serializable
```
Traffic light controls cars movement using stop lines or lane connectors. Let's call them lines.
Each line stays in one available signal: RED, GREEN, YELLOW or GRAY (not working).
Phase of traffic light is period of time when all traffic light's lines don't change its signal.
So traffic light visually can be presented as table where rows is the signals of one line and columns is the signals of one phase:

stopLine1 | R | G | G
stopLine2 | G | R | G
----------------------
duration | 1 | 2 | 3

stop lines: stopLine1, stopLine2
phase durations: 1, 2, 3
phase signals: (R, G, G), (G, R, G)

Author:

AnyLogic North America, LLC https://anylogic.com

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`TrafficLight(T[] signalElements, double[] phaseDurationsInSeconds, TrafficLightSignal[][] phaseSignals)` Creates a new traffic light to control traffic using stop lines or lane connectors

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`calcPhaseDurationInSeconds(int index)` This method is internal and shouldn't be called by user. it may be removed/renamed in future.
`double`	`getCurrentPhaseDuration()` Returns duration of the current phase in model time units, or -1 if the traffic light is off
`double`	`getCurrentPhaseDuration(TimeUnits units)` Returns duration of the current phase in specified time units, or -1 if the traffic light is off
`double`	`getCurrentPhaseElapsedTime()` Returns time elapsed from beginning of the current phase in model time units or -1 if the traffic light is off
`double`	`getCurrentPhaseElapsedTime(TimeUnits units)` Returns time elapsed from beginning of the current phase in specified time units or -1 if the traffic light is off
`int`	`getCurrentPhaseIndex()` Returns 0-based index of the current phase, or -1 if the traffic light is off
`double`	`getCurrentPhaseRemainingTime()` Returns time remaining to the end of the current phase in model time units or -1 if the traffic light is off
`double`	`getCurrentPhaseRemainingTime(TimeUnits units)` Returns time remaining to the end of the current phase in specified time units or -1 if the traffic light is off
`TrafficLightSignal`	`getCurrentSignal(ISignalable signalElement)` Returns current signal for the specified stop line or lane connector.
`double`	`getPhaseDuration(int index)` Returns duration of the phase in model time units by index
`double`	`getPhaseDuration(int index, TimeUnits units)` Returns duration of the phase in the given time units by index
`java.util.List<java.util.List<TrafficLightSignal>>`	`getPhaseSignals()` Returns two-dimensional list of signals where rows is the signals of one line and columns is the signals of one phase
`int`	`getPhasesNumber()` Returns number of phases
`RoadNetwork`	`getRoadNetwork()` Return roadNetwork specified for this traffic light
`java.util.List<T>`	`getSignalElements()` Returns list of controlled stop lines or lane connectors
`TrafficLightType`	`getType()` This method is internal and shouldn't be called by user. it may be removed/renamed in future.
`boolean`	`isOn()` Returns `true` if the traffic light is on, `false` otherwise
`void`	`onPhaseChanged(int currentPhaseIndex)`
`void`	`setCurrentPhaseIndex(int currentPhaseIndex)` This method should not be called by user.
`void`	`setDelegate(TrafficLightDelegate delegate)`
`void`	`switchToNextPhase()` Switches traffic light to next phase.
`java.lang.String`	`toString()`
`void`	`turnOff()` Turns off traffic light
`void`	`turnOn()` Turns on traffic light
`void`	`turnOn(double offset)` Turns on traffic light with offset in model time units
`void`	`turnOn(double offset, TimeUnits units)` Turns on traffic light with offset in the specified time units

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TrafficLight
```
public TrafficLight(T[] signalElements,
                    double[] phaseDurationsInSeconds,
                    TrafficLightSignal[][] phaseSignals)
```
    Creates a new traffic light to control traffic using stop lines or lane connectors
    
    Parameters:
    
    signalElements - Controlled stop lines or lane connectors
    
    phaseDurationsInSeconds - Durations of phases in seconds. Length of array is a number of phases.
    
    phaseSignals - Two-dimensional array of signals where rows are the signals of one stop line/lane connector and columns are the signals of one phase. That is phaseSignals.length == signalElements.length and phaseSignals.[i].length == phaseDurations.length.
- Method Detail
  - getRoadNetwork
```
public RoadNetwork getRoadNetwork()
```
    Return roadNetwork specified for this traffic light
    
    Returns:
    
    roadNetwork specified for this traffic light
  - getType
```
@AnyLogicInternalAPI
public TrafficLightType getType()
```
    This method is internal and shouldn't be called by user.
    it may be removed/renamed in future.
  - getSignalElements
```
public java.util.List<T> getSignalElements()
```
    Returns list of controlled stop lines or lane connectors
    
    Returns:
    
    list of controlled stop lines or lane connectors
  - getPhaseSignals
```
public java.util.List<java.util.List<TrafficLightSignal>> getPhaseSignals()
```
    Returns two-dimensional list of signals where rows is the signals of one line and columns is the signals of one phase
    
    Returns:
    
    two-dimensional list of signals where rows is the signals of one line and columns is the signals of one phase
  - getPhasesNumber
```
public int getPhasesNumber()
```
    Returns number of phases
    
    Returns:
    
    number of phases
  - getPhaseDuration
```
public double getPhaseDuration(int index)
```
    Returns duration of the phase in model time units by index
    
    Parameters:
    
    index - phase index (0, 1, 2, ...)
    
    Returns:
    
    duration of the phase in model time units by index
  - getPhaseDuration
```
public double getPhaseDuration(int index,
                               TimeUnits units)
```
    Returns duration of the phase in the given time units by index
    
    Parameters:
    
    index - phase index (0, 1, 2, ...)
    
    units - time units
    
    Returns:
    
    duration of the phase in the given time units by index
  - calcPhaseDurationInSeconds
```
@AnyLogicInternalAPI
public double calcPhaseDurationInSeconds(int index)
```
    This method is internal and shouldn't be called by user.
    it may be removed/renamed in future. Please use getPhaseDuration(int, TimeUnits) instead.
  - setDelegate
```
@AnyLogicInternalAPI
public void setDelegate(TrafficLightDelegate delegate)
```
  - turnOn
```
public void turnOn()
```
    Turns on traffic light
  - turnOn
```
public void turnOn(double offset)
```
    Turns on traffic light with offset in model time units
    
    Parameters:
    
    offset - offset in model time units
  - turnOn
```
public void turnOn(double offset,
                   TimeUnits units)
```
    Turns on traffic light with offset in the specified time units
    
    Parameters:
    
    offset - offset in the specified time units
    
    units - the time units
  - turnOff
```
public void turnOff()
```
    Turns off traffic light
  - isOn
```
public boolean isOn()
```
    Returns true if the traffic light is on, false otherwise
    
    Returns:
    
    true if the traffic light is on, false otherwise
  - switchToNextPhase
```
public void switchToNextPhase()
```
    Switches traffic light to next phase. Typical use case: current phase has infinite duration and should be switched
  - getCurrentPhaseIndex
```
public int getCurrentPhaseIndex()
```
    Returns 0-based index of the current phase, or -1 if the traffic light is off
    
    Returns:
    
    0-based index of the current phase, or -1 if the traffic light is off
  - getCurrentPhaseDuration
```
public double getCurrentPhaseDuration()
```
    Returns duration of the current phase in model time units, or -1 if the traffic light is off
    
    Returns:
    
    duration of the current phase in model time units, or -1 if the traffic light is off
  - getCurrentPhaseDuration
```
public double getCurrentPhaseDuration(TimeUnits units)
```
    Returns duration of the current phase in specified time units, or -1 if the traffic light is off
    
    Parameters:
    
    units - the time units
    
    Returns:
    
    duration of the current phase in specified time units, or -1 if the traffic light is off
  - getCurrentPhaseElapsedTime
```
public double getCurrentPhaseElapsedTime()
```
    Returns time elapsed from beginning of the current phase in model time units or -1 if the traffic light is off
    
    Returns:
    
    time elapsed from beginning of the current phase in model time units or -1 if the traffic light is off
  - getCurrentPhaseElapsedTime
```
public double getCurrentPhaseElapsedTime(TimeUnits units)
```
    Returns time elapsed from beginning of the current phase in specified time units or -1 if the traffic light is off
    
    Parameters:
    
    units - the time units
    
    Returns:
    
    time elapsed from beginning of the current phase in specified time units or -1 if the traffic light is off
  - getCurrentPhaseRemainingTime
```
public double getCurrentPhaseRemainingTime()
```
    Returns time remaining to the end of the current phase in model time units or -1 if the traffic light is off
    
    Returns:
    
    time remaining to the end of the current phase in model time units or -1 if the traffic light is off
  - getCurrentPhaseRemainingTime
```
public double getCurrentPhaseRemainingTime(TimeUnits units)
```
    Returns time remaining to the end of the current phase in specified time units or -1 if the traffic light is off
    
    Parameters:
    
    units - the time units
    
    Returns:
    
    time remaining to the end of the current phase in specified time units or -1 if the traffic light is off
  - getCurrentSignal
```
public TrafficLightSignal getCurrentSignal(ISignalable signalElement)
```
    Returns current signal for the specified stop line or lane connector. If traffic light is off, or the stop line/or lane connector is not controlled by the traffic light, returns null
    
    Parameters:
    
    signalElement - specified stop line or lane connector.
  - setCurrentPhaseIndex
```
@AnyLogicInternalAPI
public void setCurrentPhaseIndex(int currentPhaseIndex)
```
    This method should not be called by user. The method is called by internal CarTrafficLight_xjal object when phase changes event is fired.
    
    Parameters:
    
    currentPhaseIndex - Index of the phase.
  - onPhaseChanged
```
@AnyLogicInternalCodegenAPI
public void onPhaseChanged(int currentPhaseIndex)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class TrafficLight<T extends ISignalable>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TrafficLight

Method Detail

getRoadNetwork

getType

getSignalElements

getPhaseSignals

getPhasesNumber

getPhaseDuration

getPhaseDuration

calcPhaseDurationInSeconds

setDelegate

turnOn

turnOn

turnOn

turnOff

isOn

switchToNextPhase

getCurrentPhaseIndex

getCurrentPhaseDuration

getCurrentPhaseDuration

getCurrentPhaseElapsedTime

getCurrentPhaseElapsedTime

getCurrentPhaseRemainingTime

getCurrentPhaseRemainingTime

getCurrentSignal

setCurrentPhaseIndex

onPhaseChanged

toString