RoadSimulationModelIMB (The code to link ots-road to IMB 0.12.00 API)

java.lang.Object
- org.opentrafficsim.imb.demo.RoadSimulationModelIMB

All Implemented Interfaces:

Serializable, nl.tudelft.simulation.dsol.DSOLModel<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,org.opentrafficsim.core.dsol.OTSSimTimeDouble>, org.djunits.unit.UNITS, org.opentrafficsim.core.dsol.OTSModelInterface
```
class RoadSimulationModelIMB
extends Object
implements org.opentrafficsim.core.dsol.OTSModelInterface, org.djunits.unit.UNITS
```
Simulate traffic on a circular, two-lane road.
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.
$LastChangedDate: 2016-08-24 13:50:36 +0200 (Wed, 24 Aug 2016) $, @version $Revision: 2144 $, by $Author: pknoppers $, initial version 1 nov. 2014

Author:

Peter Knoppers

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RoadSimulationModelIMB.SimpleSilentSensor
Simple sensor that does not provide output, but is drawn on the Lanes.
- Nested classes/interfaces inherited from interface nl.tudelft.simulation.dsol.DSOLModel
  nl.tudelft.simulation.dsol.DSOLModel.CalendarDouble, nl.tudelft.simulation.dsol.DSOLModel.CalendarFloat, nl.tudelft.simulation.dsol.DSOLModel.CalendarLong, nl.tudelft.simulation.dsol.DSOLModel.TimeDouble, nl.tudelft.simulation.dsol.DSOLModel.TimeDoubleUnit, nl.tudelft.simulation.dsol.DSOLModel.TimeFloat, nl.tudelft.simulation.dsol.DSOLModel.TimeFloatUnit, nl.tudelft.simulation.dsol.DSOLModel.TimeLong, nl.tudelft.simulation.dsol.DSOLModel.TimeLongUnit

Nested Classes
Modifier and Type	Class and Description
`static class`	`RoadSimulationModelIMB.SimpleSilentSensor` Simple sensor that does not provide output, but is drawn on the Lanes.

Field Summary

Fields
Modifier and Type Field and Description

(package private) OTSIMBConnector imbConnector
Connector to the IMB hub.
- Fields inherited from interface org.djunits.unit.UNITS
  ABAMPERE, ABCOULOMB, ABVOLT, ACRE, AMPERE, ARCMINUTE, ARCSECOND, ARE, ATMOSPHERE_STANDARD, ATMOSPHERE_TECHNICAL, ATOMIC_UNIT, BAR, BARYE, BTU_ISO, BTU_IT, CALORIE_IT, CENTESIMAL_ARCMINUTE, CENTESIMAL_ARCSECOND, CENTIMETER, CENTIMETER_MERCURY, COULOMB, CUBIC_CENTIMETER, CUBIC_DECIMETER, CUBIC_FEET_PER_MINUTE, CUBIC_FEET_PER_SECOND, CUBIC_FOOT, CUBIC_INCH, CUBIC_INCH_PER_MINUTE, CUBIC_INCH_PER_SECOND, CUBIC_KM, CUBIC_METER, CUBIC_METER_PER_DAY, CUBIC_METER_PER_HOUR, CUBIC_METER_PER_MINUTE, CUBIC_METER_PER_SECOND, CUBIC_MILE, CUBIC_YARD, DALTON, DAY, DECIMETER, DEGREE, DEGREE_CELSIUS, DEGREE_FAHRENHEIT, DEGREE_RANKINE, DEGREE_REAUMUR, DEKAMETER, DYNE, ELECTRONVOLT, EMU, ERG, ERG_PER_SECOND, ESU, EXA_ELECTRONVOLT, FARADAY, FOOT, FOOT_MERCURY, FOOT_PER_SECOND, FOOT_PER_SECOND_2, FOOT_POUND_FORCE, FOOT_POUND_FORCE_PER_HOUR, FOOT_POUND_FORCE_PER_MINUTE, FOOT_POUND_FORCE_PER_SECOND, FRANKLIN, GAL, GALLON_IMP, GALLON_PER_DAY, GALLON_PER_HOUR, GALLON_PER_MINUTE, GALLON_PER_SECOND, GALLON_US_FLUID, GIGA_ELECTRONVOLT, GIGAHERTZ, GIGAWATT, GIGAWATT_HOUR, GRAD, GRAM, GRAM_PER_CENTIMETER_3, HECTARE, HECTOMETER, HECTOPASCAL, HERTZ, HORSEPOWER_METRIC, HOUR, INCH, INCH_MERCURY, INCH_PER_SECOND_2, INCH_POUND_FORCE, JOULE, KELVIN, KG_PER_METER_3, KGF_PER_SQUARE_MM, KILO_ELECTRONVOLT, KILOAMPERE, KILOCALORIE, KILOGRAM, KILOGRAM_FORCE, KILOGRAM_PER_SECOND, KILOHERTZ, KILOMETER, KILOOHM, KILOPASCAL, KILOVOLT, KILOWATT, KILOWATT_HOUR, KM_PER_HOUR, KM_PER_HOUR_2, KNOT, KNOT_PER_SECOND, LITER, LITER_PER_DAY, LITER_PER_HOUR, LITER_PER_MINUTE, LITER_PER_SECOND, MEGA_ELECTRONVOLT, MEGAHERTZ, MEGAOHM, MEGAVOLT, MEGAWATT, MEGAWATT_HOUR, METER, METER_KILOGRAM_FORCE, METER_PER_SECOND, METER_PER_SECOND_2, MICROAMPERE, MICROVOLT, MICROWATT_HOUR, MILE, MILE_PER_HOUR, MILE_PER_HOUR_2, MILE_PER_HOUR_PER_SECOND, MILLI_ELECTRONVOLT, MILLIAMPERE, MILLIAMPERE_HOUR, MILLIBAR, MILLIMETER, MILLIMETER_MERCURY, MILLIOHM, MILLISECOND, MILLIVOLT, MILLIWATT_HOUR, MINUTE, NANOAMPERE, NAUTICAL_MILE, NEWTON, NEWTON_METER, OHM, OUNCE, OUNCE_FORCE, OUNCE_IMP_FLUID, OUNCE_US_FLUID, PASCAL, PER_CENTIMETER, PER_DAY, PER_DECIMETER, PER_DEKAMETER, PER_FOOT, PER_HECTOMETER, PER_HOUR, PER_INCH, PER_KILOMETER, PER_METER, PER_MILE, PER_MILLIMETER, PER_MILLISECOND, PER_MINUTE, PER_NAUTICAL_MILE, PER_SECOND, PER_WEEK, PER_YARD, PETA_ELECTRONVOLT, PIEZE, PINT_IMP, PINT_US_FLUID, POUND, POUND_FOOT, POUND_FORCE, POUND_INCH, POUND_PER_SECOND, POUND_PER_SQUARE_FOOT, POUND_PER_SQUARE_INCH, QUART_IMP, QUART_US_FLUID, RADIAN, RPM, SECOND, SQUARE_CENTIMETER, SQUARE_DEGREE, SQUARE_FOOT, SQUARE_INCH, SQUARE_METER, SQUARE_MILE, SQUARE_MILLIMETER, SQUARE_YARD, STANDARD_GRAVITY, STATAMPERE, STATCOULOMB, STATVOLT, STERADIAN, STHENE, STHENE_METER, STHENE_METER_PER_SECOND, TERA_ELECTRONVOLT, TERAHERTZ, TERAWATT_HOUR, TON_FORCE, TON_LONG, TON_METRIC, TON_SHORT, TONNE, TORR, VOLT, WATT, WATT_HOUR, WEEK, YARD

Fields
Modifier and Type	Field and Description
`(package private) OTSIMBConnector`	`imbConnector` Connector to the IMB hub.

Constructor Summary

Constructors
Constructor and Description
`RoadSimulationModelIMB(List<org.opentrafficsim.base.modelproperties.Property<?>> properties, org.opentrafficsim.core.gtu.animation.GTUColorer gtuColorer, org.opentrafficsim.core.network.OTSNetwork network)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`constructModel(nl.tudelft.simulation.dsol.simulators.SimulatorInterface<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,org.opentrafficsim.core.dsol.OTSSimTimeDouble> theSimulator)`
`protected void`	`drawGraphs()` Notify the contour plots that the underlying data has changed.
`protected void`	`generateCar(org.djunits.value.vdouble.scalar.Length initialPosition, org.opentrafficsim.road.network.lane.Lane lane, org.opentrafficsim.core.gtu.GTUType gtuType)` Generate cars at a fixed rate (implemented by re-scheduling this method).
`org.djunits.value.vdouble.scalar.Length`	`getMinimumDistance()`
`org.opentrafficsim.core.network.Network`	`getNetwork()` Retrieve the Network.
`List<org.opentrafficsim.road.network.lane.Lane>`	`getPath(int index)`
`List<org.opentrafficsim.graphs.LaneBasedGTUSampler>`	`getPlots()`
`nl.tudelft.simulation.dsol.simulators.SimulatorInterface<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,org.opentrafficsim.core.dsol.OTSSimTimeDouble>`	`getSimulator()`
`void`	`stopSimulator(org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface theSimulator, String errorMessage)` Stop simulation and throw an Error.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- imbConnector
```
OTSIMBConnector imbConnector
```
  Connector to the IMB hub.

Constructor Detail

RoadSimulationModelIMB

RoadSimulationModelIMB(List<org.opentrafficsim.base.modelproperties.Property<?>> properties,
                       org.opentrafficsim.core.gtu.animation.GTUColorer gtuColorer,
                       org.opentrafficsim.core.network.OTSNetwork network)

Parameters:: properties - ArrayList<AbstractProperty<?>>; the properties; gtuColorer - the default and initial GTUColorer, e.g. a DefaultSwitchableTUColorer.; network - Network; the network

Method Detail

getNetwork

public org.opentrafficsim.core.network.Network getNetwork()

Retrieve the Network.

Returns:: Network; the network

getPath
```
public List<org.opentrafficsim.road.network.lane.Lane> getPath(int index)
```
Parameters:

index - int; the rank number of the path

Returns:

List<Lane>; the set of lanes for the specified index

constructModel

public void constructModel(nl.tudelft.simulation.dsol.simulators.SimulatorInterface<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,org.opentrafficsim.core.dsol.OTSSimTimeDouble> theSimulator)
                    throws nl.tudelft.simulation.dsol.SimRuntimeException,
                           RemoteException

Specified by:: constructModel in interface nl.tudelft.simulation.dsol.DSOLModel<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,org.opentrafficsim.core.dsol.OTSSimTimeDouble>
Throws:: nl.tudelft.simulation.dsol.SimRuntimeException; RemoteException

drawGraphs
```
protected final void drawGraphs()
```
Notify the contour plots that the underlying data has changed.

generateCar
```
protected final void generateCar(org.djunits.value.vdouble.scalar.Length initialPosition,
                                 org.opentrafficsim.road.network.lane.Lane lane,
                                 org.opentrafficsim.core.gtu.GTUType gtuType)
                          throws NamingException,
                                 org.opentrafficsim.core.network.NetworkException,
                                 nl.tudelft.simulation.dsol.SimRuntimeException,
                                 org.opentrafficsim.core.gtu.GTUException,
                                 org.opentrafficsim.core.geometry.OTSGeometryException
```
Generate cars at a fixed rate (implemented by re-scheduling this method).

Parameters:

initialPosition - Length; the initial position of the new cars

lane - Lane; the lane on which the new cars are placed

gtuType - GTUType<String>; the type of the new cars

Throws:

NamingException - on ???

nl.tudelft.simulation.dsol.SimRuntimeException - cannot happen

org.opentrafficsim.core.network.NetworkException - on network inconsistency

org.opentrafficsim.core.gtu.GTUException - when something goes wrong during construction of the car

org.opentrafficsim.core.geometry.OTSGeometryException - when the initial position is outside the center line of the lane

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()
                                                                                                                                                                                                     throws RemoteException

Specified by:: getSimulator in interface nl.tudelft.simulation.dsol.DSOLModel<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,org.opentrafficsim.core.dsol.OTSSimTimeDouble>
Throws:: RemoteException

getPlots

public final List<org.opentrafficsim.graphs.LaneBasedGTUSampler> getPlots()

Returns:: plots

getMinimumDistance

public final org.djunits.value.vdouble.scalar.Length getMinimumDistance()

Returns:: minimumDistance

stopSimulator

public void stopSimulator(org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface theSimulator,
                          String errorMessage)

Stop simulation and throw an Error.

Parameters:: theSimulator - OTSDEVSSimulatorInterface; the simulator; errorMessage - String; the error message

Class RoadSimulationModelIMB

Nested Class Summary

Nested classes/interfaces inherited from interface nl.tudelft.simulation.dsol.DSOLModel

Field Summary

Fields inherited from interface org.djunits.unit.UNITS

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

imbConnector

Constructor Detail

RoadSimulationModelIMB

Method Detail

getNetwork

getPath

constructModel

drawGraphs

generateCar

getSimulator

getPlots

getMinimumDistance

stopSimulator