org.opentrafficsim.trafficcontrol.trafcod

Class TrafCOD

java.lang.Object

nl.tudelft.simulation.event.EventProducer

org.opentrafficsim.trafficcontrol.trafcod.TrafCOD

All Implemented Interfaces:

Serializable, EventListener, EventListenerInterface, EventProducerInterface, Identifiable, InvisibleObjectInterface, TrafficController

public class TrafCOD
extends EventProducer
implements TrafficController, EventListenerInterface

TrafCOD evaluator. TrafCOD is a language for writing traffic control programs. A TrafCOD program consists of a set of rules that must be evaluated repeatedly (until no more changes occurr) every time step. The time step size is 0.1 seconds.

Copyright (c) 2013-2018 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 Oct 5, 2016

Author:

Wouter Schakel

See Also:

Serialized Form

Field Summary

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
TrafCOD(String controllerName, URL trafCodURL, Set<TrafficLight> trafficLights, Set<TrafficLightSensor> sensors, DEVSSimulator<Time,Duration,SimTimeDoubleUnit> simulator, Container display) Construct a new TrafCOD traffic light controller.

Method Summary

Modifier and Type	Method and Description
void	checkConsistency() Check the consistency of the traffic control program.
InvisibleObjectInterface	clone(SimulatorInterface.TimeDoubleUnit newSimulator, Network newNetwork)
String	getFullId()
String	getId() Retrieve the Id of the traffic light controller.
SimulatorInterface<Time,Duration,SimTimeDoubleUnit>	getSimulator() Retrieve the simulator.
int	getStructureNumber() Retrieve the structure number.
void	notify(EventInterface event)
void	traceVariable(String variableName, int stream, boolean trace) Switch tracing of one variable on or off.
void	traceVariablesOfStream(int stream, boolean trace) Switch tracing of all variables of a particular traffic stream, or all variables that do not have an associated traffic stream on or off.
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

Constructor Detail

TrafCOD

public TrafCOD(String controllerName,
               URL trafCodURL,
               Set<TrafficLight> trafficLights,
               Set<TrafficLightSensor> sensors,
               DEVSSimulator<Time,Duration,SimTimeDoubleUnit> simulator,
               Container display)
        throws TrafficControlException,
               SimRuntimeException

Construct a new TrafCOD traffic light controller.

Parameters:

controllerName - String; name of this TrafCOD traffic light controller

trafCodURL - URL; the URL of the TrafCOD rules

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

display - Container; if non-null, a controller display is constructed and shown in the supplied container

Throws:

TrafficControlException - when a rule cannot be parsed

SimRuntimeException - when scheduling the first evaluation event fails

Method Detail

checkConsistency

public void checkConsistency()

Check the consistency of the traffic control program.

getSimulator

public SimulatorInterface<Time,Duration,SimTimeDoubleUnit> getSimulator()

Retrieve the simulator.

Returns:

SimulatorInterface<Time, Duration, SimTimeDoubleUnit>

getStructureNumber

public int getStructureNumber()

Retrieve the structure number.

Returns:

int; the structureNumber

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;

traceVariablesOfStream

public void traceVariablesOfStream(int stream,
                                   boolean trace)

Switch tracing of all variables of a particular traffic stream, or all variables that do not have an associated traffic stream on or off.

Parameters:

stream - int; the traffic stream number, or TrafCOD.NO_STREAM to affect all variables that do not have an associated traffic stream

trace - boolean; if true; switch on tracing; if false; switch off tracing

traceVariable

public void traceVariable(String variableName,
                          int stream,
                          boolean trace)

Switch tracing of one variable on or off.

Parameters:

variableName - String; name of the variable

stream - int; traffic stream of the variable, or TrafCOD.NO_STREAM to select a variable that does not have an associated traffic stream

trace - boolean; if true; switch on tracing; if false; switch off tracing

notify

public void notify(EventInterface event)
            throws RemoteException

Specified by:

notify in interface EventListenerInterface

Throws:

RemoteException

getId

public String getId()

Retrieve the Id of the traffic light controller.

Specified by:

getId in interface 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 InvisibleObjectInterface

clone

public final InvisibleObjectInterface clone(SimulatorInterface.TimeDoubleUnit newSimulator,
                                            Network newNetwork)
                                     throws NetworkException

Specified by:

clone in interface InvisibleObjectInterface

Throws:

NetworkException