org.opentrafficsim.core.car

Class LaneBasedIndividualCar.LaneBasedIndividualCarBuilder

java.lang.Object

org.opentrafficsim.core.car.LaneBasedIndividualCar.LaneBasedIndividualCarBuilder

Enclosing class:

LaneBasedIndividualCar

public static class LaneBasedIndividualCar.LaneBasedIndividualCarBuilder
extends Object

Build an individual car and use easy setter methods to instantiate the car. Typical use looks like:

 LaneBasedIndividualCar<String> car = new LaneBasedIndividualCarBuilder<String>().setId("Car:"+nr)
    .setLength(new DoubleScalar.Rel<LengthUnit>(4.0, LengthUnit.METER))....build(); 
    
 or
 
 LaneBasedIndividualCarBuilder<String> carBuilder = new LaneBasedIndividualCarBuilder<String>();
 carBuilder.setId("Car:"+nr);
 carBuilder.setLength(new DoubleScalar.Rel<LengthUnit>(4.0, LengthUnit.METER));
 carBuilder.setWidth(new DoubleScalar.Rel<LengthUnit>(1.8, LengthUnit.METER));
 ...
 LaneBasedIndividualCar<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: 1329 $, $LastChangedDate: 2015-08-30 00:16:51 +0200 (Sun, 30 Aug 2015) $, by $Author: averbraeck $, initial Feb 3, 2015

Author:

Alexander Verbraeck

Constructor Summary

Constructors

Constructor and Description
LaneBasedIndividualCarBuilder()

Method Summary

Modifier and Type	Method and Description
LaneBasedIndividualCar	build() Build one LaneBasedIndividualCar.
Class<? extends nl.tudelft.simulation.dsol.animation.D2.Renderable2D>	getAnimationClass()
GTUColorer	getGtuColorer()
GTUFollowingModel	getGtuFollowingModel()
GTUType	getGtuType()
String	getId()
Map<Lane,org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>>	getInitialLongitudinalPositions()
org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.SpeedUnit>	getInitialSpeed()
LaneChangeModel	getLaneChangeModel()
org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>	getLength()
org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.SpeedUnit>	getMaximumVelocity()
LaneBasedRouteGenerator	getRouteGenerator()
OTSDEVSSimulatorInterface	getSimulator()
org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>	getWidth()
LaneBasedIndividualCar.LaneBasedIndividualCarBuilder	setAnimationClass(Class<? extends nl.tudelft.simulation.dsol.animation.D2.Renderable2D> animationClass)
void	setGtuColorer(GTUColorer gtuColorer)
LaneBasedIndividualCar.LaneBasedIndividualCarBuilder	setGTUFollowingModel(GTUFollowingModel gtuFollowingModel)
LaneBasedIndividualCar.LaneBasedIndividualCarBuilder	setGtuType(GTUType gtuType)
LaneBasedIndividualCar.LaneBasedIndividualCarBuilder	setId(String id)
LaneBasedIndividualCar.LaneBasedIndividualCarBuilder	setInitialLongitudinalPositions(Map<Lane,org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>> initialLongitudinalPositions)
LaneBasedIndividualCar.LaneBasedIndividualCarBuilder	setInitialSpeed(org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.SpeedUnit> initialSpeed)
LaneBasedIndividualCar.LaneBasedIndividualCarBuilder	setLaneChangeModel(LaneChangeModel laneChangeModel)
LaneBasedIndividualCar.LaneBasedIndividualCarBuilder	setLength(org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> length)
LaneBasedIndividualCar.LaneBasedIndividualCarBuilder	setMaximumVelocity(org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.SpeedUnit> maximumVelocity)
LaneBasedIndividualCar.LaneBasedIndividualCarBuilder	setRouteGenerator(LaneBasedRouteGenerator routeGenerator)
LaneBasedIndividualCar.LaneBasedIndividualCarBuilder	setSimulator(OTSDEVSSimulatorInterface simulator)
LaneBasedIndividualCar.LaneBasedIndividualCarBuilder	setWidth(org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> width)

Methods inherited from class java.lang.Object

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

Constructor Detail

LaneBasedIndividualCarBuilder

public LaneBasedIndividualCarBuilder()

Method Detail

setId

public final LaneBasedIndividualCar.LaneBasedIndividualCarBuilder setId(String id)

Parameters:

id - set id

Returns:

the class itself for chaining the setters

setGtuType

public final LaneBasedIndividualCar.LaneBasedIndividualCarBuilder setGtuType(GTUType gtuType)

Parameters:

gtuType - set gtuType

Returns:

the class itself for chaining the setters

setGTUFollowingModel

public final LaneBasedIndividualCar.LaneBasedIndividualCarBuilder setGTUFollowingModel(GTUFollowingModel gtuFollowingModel)

Parameters:

gtuFollowingModel - GTUFollowingModel; the GTU following model used by the built cars

Returns:

the class itself for chaining the setters

setLaneChangeModel

public final LaneBasedIndividualCar.LaneBasedIndividualCarBuilder setLaneChangeModel(LaneChangeModel laneChangeModel)

Parameters:

laneChangeModel - AbstractLaneChangeModel; the lane change model

Returns:

the class itself for chaining the setters

setInitialLongitudinalPositions

public final LaneBasedIndividualCar.LaneBasedIndividualCarBuilder setInitialLongitudinalPositions(Map<Lane,org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>> initialLongitudinalPositions)

Parameters:

initialLongitudinalPositions - set initialLongitudinalPositions

Returns:

the class itself for chaining the setters

setInitialSpeed

public final LaneBasedIndividualCar.LaneBasedIndividualCarBuilder setInitialSpeed(org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.SpeedUnit> initialSpeed)

Parameters:

initialSpeed - set initialSpeed

Returns:

the class itself for chaining the setters

setLength

public final LaneBasedIndividualCar.LaneBasedIndividualCarBuilder setLength(org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> length)

Parameters:

length - set length

Returns:

the class itself for chaining the setters

setWidth

public final LaneBasedIndividualCar.LaneBasedIndividualCarBuilder setWidth(org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> width)

Parameters:

width - set width

Returns:

the class itself for chaining the setters

setMaximumVelocity

public final LaneBasedIndividualCar.LaneBasedIndividualCarBuilder setMaximumVelocity(org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.SpeedUnit> maximumVelocity)

Parameters:

maximumVelocity - set maximumVelocity

Returns:

the class itself for chaining the setters

setSimulator

public final LaneBasedIndividualCar.LaneBasedIndividualCarBuilder setSimulator(OTSDEVSSimulatorInterface simulator)

Parameters:

simulator - set simulator

Returns:

the class itself for chaining the setters

setAnimationClass

public final LaneBasedIndividualCar.LaneBasedIndividualCarBuilder setAnimationClass(Class<? extends nl.tudelft.simulation.dsol.animation.D2.Renderable2D> animationClass)

Parameters:

animationClass - set animation class

Returns:

the class itself for chaining the setters

setRouteGenerator

public final LaneBasedIndividualCar.LaneBasedIndividualCarBuilder setRouteGenerator(LaneBasedRouteGenerator routeGenerator)

Parameters:

routeGenerator - set route generator.

Returns:

the class itself for chaining the setters

getId

public final String getId()

Returns:

id.

getRouteGenerator

public final LaneBasedRouteGenerator getRouteGenerator()

Returns:

route generator.

getGtuType

public final GTUType getGtuType()

Returns:

gtuType.

getInitialLongitudinalPositions

public final Map<Lane,org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>> getInitialLongitudinalPositions()

Returns:

initialLongitudinalPositions.

getInitialSpeed

public final org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.SpeedUnit> getInitialSpeed()

Returns:

initialSpeed.

getGtuFollowingModel

public final GTUFollowingModel getGtuFollowingModel()

Returns:

gtuFollowingModel.

getLaneChangeModel

public final LaneChangeModel getLaneChangeModel()

Returns:

laneChangeModel.

getLength

public final org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> getLength()

Returns:

length.

getWidth

public final org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> getWidth()

Returns:

width.

getMaximumVelocity

public final org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.SpeedUnit> getMaximumVelocity()

Returns:

maximumVelocity.

getSimulator

public final OTSDEVSSimulatorInterface getSimulator()

Returns:

simulator.

getAnimationClass

public final Class<? extends nl.tudelft.simulation.dsol.animation.D2.Renderable2D> getAnimationClass()

Returns:

animationClass.

getGtuColorer

public final GTUColorer getGtuColorer()

Returns:

gtuColorer.

setGtuColorer

public final void setGtuColorer(GTUColorer gtuColorer)

Parameters:

gtuColorer - set gtuColorer.

build

public final LaneBasedIndividualCar build()
                                   throws Exception

Build one LaneBasedIndividualCar.

Returns:

the built Car with the set properties

Throws:

Exception - when not all required values have been set