org.opentrafficsim.core.car

Class LaneBasedTemplateCar.LaneBasedTemplateCarBuilder<ID>

java.lang.Object

org.opentrafficsim.core.car.LaneBasedTemplateCar.LaneBasedTemplateCarBuilder<ID>

Type Parameters:

ID - the ID type of the Car, e.g. String or Integer or Long.

Enclosing class:

LaneBasedTemplateCar<ID>

public static class LaneBasedTemplateCar.LaneBasedTemplateCarBuilder<ID>
extends Object

Build a template car and use easy setter methods to instantiate the car. Typical use looks like:

 LaneBasedTemplateCar<String> car = new LaneBasedTemplateCarBuilder<String>().setId("Car:"+nr)
    .setInitialSpeed(new DoubleScalar.Rel<SpeedUnit>(80.0, LengthUnit.KM_PER_HOUR))....build(); 
    
 or
 
 LaneBasedTemplateCarBuilder<String> carBuilder = new LaneBasedTemplateCarBuilder<String>();
 carBuilder.setId("Car:"+nr);
 carBuilder.setTemplateGtuType(TruckTemplate);
 carBuilder.setInitialSpeed(new DoubleScalar.Rel<SpeedUnit>(80.0, LengthUnit.KM_PER_HOUR));
 ...
 LaneBasedTemplateCar<String> car = carBuilder.build();
 

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

Version:

Feb 3, 2015

Author:

Alexander Verbraeck

Constructor Summary

Constructors

Constructor and Description
LaneBasedTemplateCarBuilder()

Method Summary

Modifier and Type	Method and Description
LaneBasedTemplateCar<ID>	build()
LaneBasedTemplateCar.LaneBasedTemplateCarBuilder<ID>	setAnimationClass(Class<? extends nl.tudelft.simulation.dsol.animation.D2.Renderable2D> animationClass)
LaneBasedTemplateCar.LaneBasedTemplateCarBuilder<ID>	setId(ID id)
LaneBasedTemplateCar.LaneBasedTemplateCarBuilder<ID>	setInitialLongitudinalPositions(Map<Lane,DoubleScalar.Rel<LengthUnit>> initialLongitudinalPositions)
LaneBasedTemplateCar.LaneBasedTemplateCarBuilder<ID>	setInitialSpeed(DoubleScalar.Abs<SpeedUnit> initialSpeed)
LaneBasedTemplateCar.LaneBasedTemplateCarBuilder<ID>	setRoute(Route route)
LaneBasedTemplateCar.LaneBasedTemplateCarBuilder<ID>	setTemplateGtuType(TemplateGTUType<?> templateGtuType)

Methods inherited from class java.lang.Object

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

Constructor Detail

LaneBasedTemplateCarBuilder

public LaneBasedTemplateCarBuilder()

Method Detail

setId

public final LaneBasedTemplateCar.LaneBasedTemplateCarBuilder<ID> setId(ID id)

Parameters:

id - set id

Returns:

the class itself for chaining the setters

setTemplateGtuType

public final LaneBasedTemplateCar.LaneBasedTemplateCarBuilder<ID> setTemplateGtuType(TemplateGTUType<?> templateGtuType)

Parameters:

templateGtuType - set the template for the gtuType

Returns:

the class itself for chaining the setters

setInitialLongitudinalPositions

public final LaneBasedTemplateCar.LaneBasedTemplateCarBuilder<ID> setInitialLongitudinalPositions(Map<Lane,DoubleScalar.Rel<LengthUnit>> initialLongitudinalPositions)

Parameters:

initialLongitudinalPositions - set initialLongitudinalPositions

Returns:

the class itself for chaining the setters

setInitialSpeed

public final LaneBasedTemplateCar.LaneBasedTemplateCarBuilder<ID> setInitialSpeed(DoubleScalar.Abs<SpeedUnit> initialSpeed)

Parameters:

initialSpeed - set initialSpeed

Returns:

the class itself for chaining the setters

setRoute

public final LaneBasedTemplateCar.LaneBasedTemplateCarBuilder<ID> setRoute(Route route)

Parameters:

route - Route; the route

Returns:

the class itself for chaing the setters

setAnimationClass

public final LaneBasedTemplateCar.LaneBasedTemplateCarBuilder<ID> setAnimationClass(Class<? extends nl.tudelft.simulation.dsol.animation.D2.Renderable2D> animationClass)

Parameters:

animationClass - set animation class

Returns:

the class itself for chaining the setters

build

public final LaneBasedTemplateCar<ID> build()
                                     throws RemoteException,
                                            NamingException,
                                            NetworkException,
                                            nl.tudelft.simulation.dsol.SimRuntimeException,
                                            GTUException

Returns:

the built Car with the set properties

Throws:

NamingException - if an error occurs when adding the animation handler

RemoteException - when the simulator cannot be reached

NetworkException - when the GTU cannot be placed on the given lane

nl.tudelft.simulation.dsol.SimRuntimeException - when the move method cannot be scheduled

GTUException - when gtuFollowingModel is null