org.opentrafficsim.trafficcontrol.trafcod

Class TrafCOD

java.lang.Object

nl.tudelft.simulation.event.EventProducer

org.opentrafficsim.trafficcontrol.trafcod.TrafCOD

All Implemented Interfaces:

Serializable, EventListener, nl.tudelft.simulation.event.EventListenerInterface, nl.tudelft.simulation.event.EventProducerInterface, TrafficController

public class TrafCOD
extends nl.tudelft.simulation.event.EventProducer
implements TrafficController, nl.tudelft.simulation.event.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-2016 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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	TrafCOD.ParserState States of the rule parser.
(package private) static class	TrafCOD.Token Types of TrafCOD tokens.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static String	COMMENT_PREFIX Comment starter in TrafCOD.
(package private) String	controllerName Name of this TrafCod controller.
(package private) Map<String,Variable>	detectors The detectors.
(package private) static org.djunits.value.vdouble.scalar.Duration	EVALUATION_INTERVAL The evaluation interval of TrafCOD.
(package private) int	numberOfConflictGroups Number of conflict groups in the control program.
(package private) List<Object[]>	tokenisedRules The tokenized rules.
(package private) static int	TRAFCOD_VERSION Version of the supported TrafCOD files.
(package private) List<String>	trafcodRules The original rules.
(package private) Map<String,Variable>	variables The TrafCOD variables.
(package private) List<Variable>	variablesInDefinitionOrder The TrafCOD variables in order of definition.

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

listeners

Fields inherited from interface org.opentrafficsim.trafficcontrol.TrafficController

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<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, 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.
(package private) void	fireTrafCODEvent(nl.tudelft.simulation.event.EventType eventType, Object[] payload) Fire an event on behalf of this TrafCOD engine (used for tracing variable changes).
String	getId() Retrieve the Id of the traffic light controller.
nl.tudelft.simulation.dsol.simulators.SimulatorInterface<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,org.opentrafficsim.core.dsol.OTSSimTimeDouble>	getSimulator() Retrieve the simulator.
int	getStructureNumber() Retrieve the structure number.
void	notify(nl.tudelft.simulation.event.EventInterface event)
(package private) static String	printRule(Object[] tokens, boolean printValues) Print a tokenized rule.
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

Field Detail

controllerName

final String controllerName

Name of this TrafCod controller.

TRAFCOD_VERSION

static final int TRAFCOD_VERSION

Version of the supported TrafCOD files.

See Also:

Constant Field Values

EVALUATION_INTERVAL

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

The evaluation interval of TrafCOD.

trafcodRules

final List<String> trafcodRules

The original rules.

tokenisedRules

final List<Object[]> tokenisedRules

The tokenized rules.

variables

final Map<String,Variable> variables

The TrafCOD variables.

variablesInDefinitionOrder

final List<Variable> variablesInDefinitionOrder

The TrafCOD variables in order of definition.

detectors

final Map<String,Variable> detectors

The detectors.

COMMENT_PREFIX

static final String COMMENT_PREFIX

Comment starter in TrafCOD.

See Also:

Constant Field Values

numberOfConflictGroups

int numberOfConflictGroups

Number of conflict groups in the control program.

Constructor Detail

TrafCOD

public TrafCOD(String controllerName,
               URL trafCodURL,
               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,
               Container display)
        throws TrafficControlException,
               nl.tudelft.simulation.dsol.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, OTSSimTimeDouble>; 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

nl.tudelft.simulation.dsol.SimRuntimeException - when scheduling the first evaluation event fails

Method Detail

checkConsistency

public void checkConsistency()

Check the consistency of the traffic control program.

printRule

static String printRule(Object[] tokens,
                        boolean printValues)
                 throws TrafficControlException

Print a tokenized rule.

Parameters:

tokens - Object[]; the tokens

printValues - boolean; if true; print the values of all encountered variable; if false; do not print the values of all encountered variable

Returns:

String; a textual approximation of the original rule

Throws:

TrafficControlException - when tokens does not match the expected grammar

getSimulator

public nl.tudelft.simulation.dsol.simulators.SimulatorInterface<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,org.opentrafficsim.core.dsol.OTSSimTimeDouble> getSimulator()

Retrieve the simulator.

Returns:

SimulatorInterface<Time, Duration, OTSSimTimeDouble>

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

Specified by:

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

Throws:

RemoteException

fireTrafCODEvent

void fireTrafCODEvent(nl.tudelft.simulation.event.EventType eventType,
                      Object[] payload)

Fire an event on behalf of this TrafCOD engine (used for tracing variable changes).

Parameters:

eventType - EventType; the type of the event

payload - Object[]; the payload of the event

getId

public String getId()

Retrieve the Id of the traffic light controller.

Specified by:

getId in interface TrafficController

Returns:

String; the id of the traffic light controller