org.opentrafficsim.road.car

Class LaneBasedTemplateCar.LaneBasedTemplateCarBuilder

java.lang.Object

org.opentrafficsim.road.car.LaneBasedTemplateCar.LaneBasedTemplateCarBuilder

Enclosing class:

LaneBasedTemplateCar

public static class LaneBasedTemplateCar.LaneBasedTemplateCarBuilder
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, 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, KM_PER_HOUR));
 ...
 LaneBasedTemplateCar<String> car = carBuilder.build();
 

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

Version:

$Revision: 1401 $, $LastChangedDate: 2015-09-14 01:33:02 +0200 (Mon, 14 Sep 2015) $, by $Author: averbraeck $, initial Feb 3, 2015

Author:

Alexander Verbraeck

Constructor Summary

Constructors

Constructor and Description
LaneBasedTemplateCarBuilder()

Method Summary

Modifier and Type	Method and Description
LaneBasedTemplateCar	build()
LaneBasedTemplateCar.LaneBasedTemplateCarBuilder	setAnimationClass(Class<? extends nl.tudelft.simulation.dsol.animation.D2.Renderable2D> animationClass)
LaneBasedTemplateCar.LaneBasedTemplateCarBuilder	setId(String id)
LaneBasedTemplateCar.LaneBasedTemplateCarBuilder	setInitialLongitudinalPositions(Map<Lane,org.djunits.value.vdouble.scalar.Length.Rel> initialLongitudinalPositions)
LaneBasedTemplateCar.LaneBasedTemplateCarBuilder	setInitialSpeed(org.djunits.value.vdouble.scalar.Speed initialSpeed)
LaneBasedTemplateCar.LaneBasedTemplateCarBuilder	setRouteNavigator(CompleteLaneBasedRouteNavigator routeNavigator)
LaneBasedTemplateCar.LaneBasedTemplateCarBuilder	setTemplateGtuType(org.opentrafficsim.core.gtu.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 setId(String id)

Parameters:

id - set id

Returns:

the class itself for chaining the setters

setTemplateGtuType

public final LaneBasedTemplateCar.LaneBasedTemplateCarBuilder setTemplateGtuType(org.opentrafficsim.core.gtu.TemplateGTUType templateGtuType)

Parameters:

templateGtuType - set the template for the gtuType

Returns:

the class itself for chaining the setters

setInitialLongitudinalPositions

public final LaneBasedTemplateCar.LaneBasedTemplateCarBuilder setInitialLongitudinalPositions(Map<Lane,org.djunits.value.vdouble.scalar.Length.Rel> initialLongitudinalPositions)

Parameters:

initialLongitudinalPositions - set initialLongitudinalPositions

Returns:

the class itself for chaining the setters

setInitialSpeed

public final LaneBasedTemplateCar.LaneBasedTemplateCarBuilder setInitialSpeed(org.djunits.value.vdouble.scalar.Speed initialSpeed)

Parameters:

initialSpeed - set initialSpeed

Returns:

the class itself for chaining the setters

setRouteNavigator

public final LaneBasedTemplateCar.LaneBasedTemplateCarBuilder setRouteNavigator(CompleteLaneBasedRouteNavigator routeNavigator)

Parameters:

routeNavigator - RouteNavigator; the route

Returns:

the class itself for chaining the setters

setAnimationClass

public final LaneBasedTemplateCar.LaneBasedTemplateCarBuilder 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 build()
                                 throws NamingException,
                                        org.opentrafficsim.core.network.NetworkException,
                                        nl.tudelft.simulation.dsol.SimRuntimeException,
                                        org.opentrafficsim.core.gtu.GTUException

Returns:

the built Car with the set properties

Throws:

NamingException - if an error occurs when adding the animation handler

org.opentrafficsim.core.network.NetworkException - when the GTU cannot be placed on the given lane

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

org.opentrafficsim.core.gtu.GTUException - when gtuFollowingModel is null