Package org.opentrafficsim.trafficcontrol.ccol

Class Ccol

java.lang.Object

org.djutils.event.LocalEventProducer

org.opentrafficsim.trafficcontrol.ccol.Ccol

All Implemented Interfaces:

Serializable, Remote, EventListener, org.djutils.event.EventListener, org.djutils.event.EventProducer, org.opentrafficsim.base.Identifiable, org.opentrafficsim.core.animation.Drawable, org.opentrafficsim.core.object.NonLocatedObject, ActuatedTrafficController, TrafficController

public class Ccol
extends org.djutils.event.LocalEventProducer
implements ActuatedTrafficController

Communication link with a CCOL traffic control program.

Copyright (c) 2013-2023 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

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final Duration	EVALUATION_INTERVAL	The evaluation interval of a CCOL controller.

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, org.opentrafficsim.core.dsol.OtsSimulator simulator)	Construct a new CCOL communication link.

Method Summary

Modifier and Type	Method	Description
(package private) Socket	getClientSocket()	Retrieve the client socket for shutdown.
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(org.djutils.event.Event event)
(package private) void	setClientSocket(Socket socket)	Set the client socket (called from the accept thread).
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

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

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

Field Details

EVALUATION_INTERVAL

static final Duration EVALUATION_INTERVAL

The evaluation interval of a CCOL controller.

Constructor Details

Ccol

public Ccol(String id,
 String controlProgram,
 Set<TrafficLight> trafficLights,
 Set<TrafficLightDetector> sensors,
 org.opentrafficsim.core.dsol.OtsSimulator simulator)
     throws TrafficControlException,
SimRuntimeException

Construct a new CCOL communication link.

Parameters:

id - String; id of the traffic controller

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

trafficLights - Set<TrafficLight>; 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 - Set<TrafficLightSensor>; 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 - DEVSSimulator<Time, Duration, SimTimeDoubleUnit>; the simulation engine

Throws:

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

SimRuntimeException - on failure to schedule the first evaluation event

Method Details

setClientSocket

void setClientSocket(Socket socket)

Set the client socket (called from the accept thread).

Parameters:

socket - Socket; the socket returned by accept

getClientSocket

Socket getClientSocket()

Retrieve the client socket for shutdown.

Returns:

Socket; the socket for communication with the CCOL client

notify

public void notify(org.djutils.event.Event event)
            throws RemoteException

Specified by:

notify in interface org.djutils.event.EventListener

Throws:

RemoteException

getId

public String getId()

Retrieve the Id of the traffic light controller.

Specified by:

getId in interface org.opentrafficsim.base.Identifiable

Specified by:

getId in interface TrafficController

Returns:

String; the id of the traffic light controller

getFullId

public String getFullId()

Specified by:

getFullId in interface org.opentrafficsim.core.object.NonLocatedObject

updateDetector

public void updateDetector(String detectorId,
 boolean detectingGTU)

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

Specified by:

updateDetector in interface ActuatedTrafficController

Parameters:

detectorId - String; id of the detector

detectingGTU - boolean;

getDisplayContainer

public Container getDisplayContainer()

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

Specified by:

getDisplayContainer in interface ActuatedTrafficController

Returns:

Container; the display of the current state; may return null!