Package org.opentrafficsim.trafficcontrol.ccol

Class Ccol

java.lang.Object

org.djutils.event.LocalEventProducer

org.opentrafficsim.trafficcontrol.ccol.Ccol

All Implemented Interfaces:

EventListener, Identifiable, EventListener, EventProducer, NonLocatedObject, ActuatedTrafficController, TrafficController

public class Ccol
extends LocalEventProducer
implements ActuatedTrafficController

Communication link with a CCOL traffic control program.

Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Field Summary

Fields inherited from interface org.djutils.event.EventProducer

FIRST_POSITION, LAST_POSITION

Fields inherited from interface org.opentrafficsim.trafficcontrol.TrafficController

BEING_CLONED, NO_STREAM, OFF, RUNNING, SHUTTING_DOWN, STARTING_UP, TRAFFIC_LIGHT_CHANGED, TRAFFICCONTROL_CONFLICT_GROUP_CHANGED, TRAFFICCONTROL_CONTROLLER_CREATED, TRAFFICCONTROL_CONTROLLER_EVALUATING, TRAFFICCONTROL_CONTROLLER_WARNING, TRAFFICCONTROL_SET_TRACING, TRAFFICCONTROL_STATE_CHANGED, TRAFFICCONTROL_TRACED_VARIABLE_UPDATED, TRAFFICCONTROL_VARIABLE_CREATED

Constructor Summary

Constructors

Constructor	Description
Ccol(String id, String controlProgram, Set<TrafficLight> trafficLights, Set<TrafficLightDetector> sensors, OtsSimulator simulator)	Construct a new CCOL communication link.

Method Summary

Modifier and Type	Method	Description
Optional<Container>	getDisplayContainer()	Retrieve the Swing (for now) container in which the controller displays its current state.
String	getFullId()
String	getId()	Retrieve the Id of the traffic light controller.
void	notify(Event event)
void	updateDetector(String detectorId, boolean detectingGTU)	Tell the traffic controller that the state of a detector has changed.

Methods inherited from class org.djutils.event.LocalEventProducer

getEventListenerMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.djutils.event.EventProducer

addListener, addListener, addListener, addListener, fireEvent, fireEvent, fireEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, getEventListenerMap, getEventTypesWithListeners, getListenerReferences, hasListeners, numberOfListeners, removeAllListeners, removeAllListeners, removeListener

Constructor Details

Ccol

public Ccol(String id,
 String controlProgram,
 Set<TrafficLight> trafficLights,
 Set<TrafficLightDetector> sensors,
 OtsSimulator simulator)
     throws TrafficControlException,
nl.tudelft.simulation.dsol.SimRuntimeException

Construct a new CCOL communication link.

Parameters:

id - id of the traffic controller

controlProgram - name of the CCOL program that this CCOL link must communicate with

trafficLights - the traffic lights. The ids of the traffic lights must end with two digits that match the stream numbers as used in the traffic control program

sensors - the traffic sensors. The ids of the traffic sensors must end with three digits; the first two of those must match the stream and sensor numbers used in the traffic control program

simulator - the simulation engine

Throws:

TrafficControlException - on failure to initialize the connection to the external CCOL program

nl.tudelft.simulation.dsol.SimRuntimeException - on failure to schedule the first evaluation event

Method Details

notify

public void notify(Event event)

Specified by:

notify in interface EventListener

getId

public String getId()

Description copied from interface: TrafficController

Retrieve the Id of the traffic light controller.

Specified by:

getId in interface Identifiable

Specified by:

getId in interface TrafficController

Returns:

the id of the traffic light controller

getFullId

public String getFullId()

Specified by:

getFullId in interface NonLocatedObject

updateDetector

public void updateDetector(String detectorId,
 boolean detectingGTU)

Description copied from interface: ActuatedTrafficController

Tell the traffic controller that the state of a detector has changed.

Specified by:

updateDetector in interface ActuatedTrafficController

Parameters:

detectorId - id of the detector

detectingGTU - detecting GTU

getDisplayContainer

public Optional<Container> getDisplayContainer()

Description copied from interface: ActuatedTrafficController

Retrieve the Swing (for now) container in which the controller displays its current state.

Specified by:

getDisplayContainer in interface ActuatedTrafficController

Returns:

the display of the current state; may return empty