org.opentrafficsim.road.gtu.generator

Class Platoons

java.lang.Object

org.opentrafficsim.road.gtu.generator.Platoons

public class Platoons
extends Object

Connects with a lane-based GTU generator to disable it over some time and generate a platoon instead. Platoons are added as: new Platoons(...).addPlatoon(...).addGtu(...).addGtu(...).addPlatoon(...).addGtu(...).addGtu(...).start();. Method addGtu(...) may only determine a generation time if other info is set by fixInfo(...).

This class bay be used with a LaneBasedGTUCharacteristicsGenerator or GTUCharacteristicsGeneratorOD. In the former case the origin and destination nodes as well as the OD category can be null.

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 14 sep. 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Constructor Summary

Constructors

Constructor and Description
Platoons(LaneBasedGTUGenerator generator, GTUCharacteristicsGeneratorOD characteristics, DEVSSimulatorInterface.TimeDoubleUnit simulator, StreamInterface stream, Set<DirectedLanePosition> position) Constructor.
Platoons(LaneBasedGTUGenerator generator, LaneBasedGTUCharacteristicsGenerator characteristics, DEVSSimulatorInterface.TimeDoubleUnit simulator, Set<DirectedLanePosition> position) Constructor.

Method Summary

Modifier and Type	Method and Description
Platoons	addGtu(Time time) Add GTU to the current platoon.
Platoons	addGtu(Time time, Node origin, Node destination, Category category, Speed speed) Add GTU to the current platoon.
Platoons	addPlatoon(Time start, Time end) Add a platoon.
Platoons	fixInfo(Node origin, Node destination, Category category, Speed speed) Fix all info except time for GTU's added hereafter.
void	start() Starts the events.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Platoons

public Platoons(LaneBasedGTUGenerator generator,
                LaneBasedGTUCharacteristicsGenerator characteristics,
                DEVSSimulatorInterface.TimeDoubleUnit simulator,
                Set<DirectedLanePosition> position)

Constructor.

Parameters:

generator - LaneBasedGTUGenerator; GTU generator

characteristics - LaneBasedGTUCharacteristicsGenerator; characteristics generator

simulator - DEVSSimulatorInterface.TimeDoubleUnit; simulator

position - Set<DirectedLanePosition>; position

Platoons

public Platoons(LaneBasedGTUGenerator generator,
                GTUCharacteristicsGeneratorOD characteristics,
                DEVSSimulatorInterface.TimeDoubleUnit simulator,
                StreamInterface stream,
                Set<DirectedLanePosition> position)

Constructor.

Parameters:

generator - LaneBasedGTUGenerator; GTU generator

characteristics - GTUCharacteristicsGeneratorOD; characteristics generator

simulator - DEVSSimulatorInterface.TimeDoubleUnit; simulator

stream - StreamInterface; random number stream

position - Set<DirectedLanePosition>; position

Method Detail

addPlatoon

public Platoons addPlatoon(Time start,
                           Time end)
                    throws SimRuntimeException

Add a platoon. The generator is disabled during the provided time frame. Individual GTU's should be added using addGtu.

Parameters:

start - Time; start time

end - Time; end time

Returns:

Platoons; for method chaining

Throws:

SimRuntimeException - on exception

fixInfo

public Platoons fixInfo(Node origin,
                        Node destination,
                        Category category,
                        Speed speed)

Fix all info except time for GTU's added hereafter.

Parameters:

origin - Node; origin

destination - Node; destination

category - Category; category

speed - Speed; generation speed

Returns:

Platoons; for method chaining

addGtu

public Platoons addGtu(Time time)

Add GTU to the current platoon. Per platoon, GTU may be given in any order. This method uses info set with fixInfo.

Parameters:

time - Time; time of generation

Returns:

Platoons; for method chaining

Throws:

IllegalStateException - if no fixed info was set using fixInfo

addGtu

public Platoons addGtu(Time time,
                       Node origin,
                       Node destination,
                       Category category,
                       Speed speed)

Add GTU to the current platoon. Per platoon, GTU may be given in any order.

Parameters:

time - Time; time of generation

origin - Node; origin

destination - Node; destination

category - Category; category

speed - Speed; generation speed

Returns:

Platoons; for method chaining

Throws:

IllegalStateException - if no platoon was started or time is outside of the platoon time range

start

public void start()
           throws SimRuntimeException

Starts the events.

Throws:

SimRuntimeException - if start of first platoon is in the past