ccol

Class CCOL

java.lang.Object

nl.tudelft.simulation.event.EventProducer

ccol.CCOL

All Implemented Interfaces:

Serializable, EventListener, nl.tudelft.simulation.event.EventListenerInterface, nl.tudelft.simulation.event.EventProducerInterface, org.opentrafficsim.base.Identifyable, org.opentrafficsim.core.object.InvisibleObjectInterface, TrafficController

public class CCOL
extends nl.tudelft.simulation.event.EventProducer
implements TrafficController

Communication link with a CCOL traffic control program.

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

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version Jan 23, 2017

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Thread	acceptThread Thread that blocks until accept returns.
(package private) static org.djunits.value.vdouble.scalar.Duration	EVALUATION_INTERVAL The evaluation interval of a CCOL controller.
(package private) String	id Name of this CCOL traffic controller.
(package private) static int	PORT TCP port for incoming connection.
(package private) ServerSocket	serverSocket Socket used to listen for the incoming connection from the CCOL controller.
(package private) nl.tudelft.simulation.dsol.simulators.DEVSSimulator<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,org.opentrafficsim.core.dsol.OTSSimTimeDouble>	simulator The simulator.

Fields inherited from class nl.tudelft.simulation.event.EventProducer

listeners

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

Fields inherited from interface nl.tudelft.simulation.event.EventProducerInterface

FIRST_POSITION, LAST_POSITION

Constructor Summary

Constructors

Constructor and Description

CCOL(String id, String controlProgram, Set<org.opentrafficsim.road.network.lane.object.trafficlight.TrafficLight> trafficLights, Set<org.opentrafficsim.road.network.lane.object.sensor.TrafficLightSensor> sensors, nl.tudelft.simulation.dsol.simulators.DEVSSimulator<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,org.opentrafficsim.core.dsol.OTSSimTimeDouble> simulator) Construct a new CCOL communication link.

Method Summary

Modifier and Type	Method and Description
org.opentrafficsim.core.object.InvisibleObjectInterface	clone(org.opentrafficsim.core.dsol.OTSSimulatorInterface newSimulator, org.opentrafficsim.core.network.Network newNetwork)
(package private) Socket	getClientSocket() Retrieve the client socket for shutdown.
String	getId() Retrieve the Id of the traffic light controller.
void	notify(nl.tudelft.simulation.event.EventInterface 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 nl.tudelft.simulation.event.EventProducer

addListener, addListener, addListener, addListener, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, 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 nl.tudelft.simulation.event.EventProducerInterface

addListener, addListener, addListener, addListener, removeListener

Field Detail

id

final String id

Name of this CCOL traffic controller.

simulator

final nl.tudelft.simulation.dsol.simulators.DEVSSimulator<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,org.opentrafficsim.core.dsol.OTSSimTimeDouble> simulator

The simulator.

PORT

static int PORT

TCP port for incoming connection.

EVALUATION_INTERVAL

static final org.djunits.value.vdouble.scalar.Duration EVALUATION_INTERVAL

The evaluation interval of a CCOL controller.

serverSocket

ServerSocket serverSocket

Socket used to listen for the incoming connection from the CCOL controller.

acceptThread

Thread acceptThread

Thread that blocks until accept returns.

Constructor Detail

CCOL

public CCOL(String id,
            String controlProgram,
            Set<org.opentrafficsim.road.network.lane.object.trafficlight.TrafficLight> trafficLights,
            Set<org.opentrafficsim.road.network.lane.object.sensor.TrafficLightSensor> sensors,
            nl.tudelft.simulation.dsol.simulators.DEVSSimulator<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,org.opentrafficsim.core.dsol.OTSSimTimeDouble> simulator)
     throws TrafficControlException,
            nl.tudelft.simulation.dsol.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, OTSSimTimeDouble>; 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 Detail

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(nl.tudelft.simulation.event.EventInterface event)
            throws RemoteException

Specified by:

notify in interface nl.tudelft.simulation.event.EventListenerInterface

Throws:

RemoteException

getId

public String getId()

Retrieve the Id of the traffic light controller.

Specified by:

getId in interface org.opentrafficsim.base.Identifyable

Specified by:

getId in interface TrafficController

Returns:

String; the id of the traffic light controller

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 TrafficController

Parameters:

detectorId - String; id of the detector

detectingGTU - boolean;

clone

public org.opentrafficsim.core.object.InvisibleObjectInterface clone(org.opentrafficsim.core.dsol.OTSSimulatorInterface newSimulator,
                                                                     org.opentrafficsim.core.network.Network newNetwork)
                                                              throws org.opentrafficsim.core.network.NetworkException

Specified by:

clone in interface org.opentrafficsim.core.object.InvisibleObjectInterface

Throws:

org.opentrafficsim.core.network.NetworkException