org.opentrafficsim.core.car

Class LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<ID>

java.lang.Object

org.opentrafficsim.core.car.LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<ID>

Type Parameters:

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

Enclosing class:

LaneBasedIndividualCar<ID>

public static class LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<ID>
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-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
LaneBasedIndividualCarBuilder()

Method Summary

Modifier and Type	Method and Description
LaneBasedIndividualCar<ID>	build() Build one LaneBasedIndividualCar.
Class<? extends nl.tudelft.simulation.dsol.animation.D2.Renderable2D>	getAnimationClass()
GTUColorer	getGtuColorer()
GTUFollowingModel	getGtuFollowingModel()
GTUType<ID>	getGtuType()
ID	getId()
Map<Lane,DoubleScalar.Rel<LengthUnit>>	getInitialLongitudinalPositions()
DoubleScalar.Abs<SpeedUnit>	getInitialSpeed()
LaneChangeModel	getLaneChangeModel()
DoubleScalar.Rel<LengthUnit>	getLength()
DoubleScalar.Abs<SpeedUnit>	getMaximumVelocity()
Route	getRoute()
OTSDEVSSimulatorInterface	getSimulator()
DoubleScalar.Rel<LengthUnit>	getWidth()
LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<ID>	setAnimationClass(Class<? extends nl.tudelft.simulation.dsol.animation.D2.Renderable2D> animationClass)
void	setGtuColorer(GTUColorer gtuColorer)
LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<ID>	setGTUFollowingModel(GTUFollowingModel gtuFollowingModel)
LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<ID>	setGtuType(GTUType<ID> gtuType)
LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<ID>	setId(ID id)
LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<ID>	setInitialLongitudinalPositions(Map<Lane,DoubleScalar.Rel<LengthUnit>> initialLongitudinalPositions)
LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<ID>	setInitialSpeed(DoubleScalar.Abs<SpeedUnit> initialSpeed)
LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<ID>	setLaneChangeModel(LaneChangeModel laneChangeModel)
LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<ID>	setLength(DoubleScalar.Rel<LengthUnit> length)
LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<ID>	setMaximumVelocity(DoubleScalar.Abs<SpeedUnit> maximumVelocity)
LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<ID>	setRoute(Route route)
LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<ID>	setSimulator(OTSDEVSSimulatorInterface simulator)
LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<ID>	setWidth(DoubleScalar.Rel<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<ID> setId(ID id)

Parameters:

id - set id

Returns:

the class itself for chaining the setters

setGtuType

public final LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<ID> setGtuType(GTUType<ID> gtuType)

Parameters:

gtuType - set gtuType

Returns:

the class itself for chaining the setters

setGTUFollowingModel

public final LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<ID> 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<ID> setLaneChangeModel(LaneChangeModel laneChangeModel)

Parameters:

laneChangeModel - AbstractLaneChangeModel; the lane change model

Returns:

the class itself for chaining the setters

setInitialLongitudinalPositions

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

Parameters:

initialLongitudinalPositions - set initialLongitudinalPositions

Returns:

the class itself for chaining the setters

setInitialSpeed

public final LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<ID> setInitialSpeed(DoubleScalar.Abs<SpeedUnit> initialSpeed)

Parameters:

initialSpeed - set initialSpeed

Returns:

the class itself for chaining the setters

setLength

public final LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<ID> setLength(DoubleScalar.Rel<LengthUnit> length)

Parameters:

length - set length

Returns:

the class itself for chaining the setters

setWidth

public final LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<ID> setWidth(DoubleScalar.Rel<LengthUnit> width)

Parameters:

width - set width

Returns:

the class itself for chaining the setters

setMaximumVelocity

public final LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<ID> setMaximumVelocity(DoubleScalar.Abs<SpeedUnit> maximumVelocity)

Parameters:

maximumVelocity - set maximumVelocity

Returns:

the class itself for chaining the setters

setSimulator

public final LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<ID> setSimulator(OTSDEVSSimulatorInterface simulator)

Parameters:

simulator - set simulator

Returns:

the class itself for chaining the setters

setAnimationClass

public final LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<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

setRoute

public final LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<ID> setRoute(Route route)

Parameters:

route - set route.

Returns:

the class itself for chaining the setters

getId

public final ID getId()

Returns:

id.

getRoute

public final Route getRoute()

Returns:

route.

getGtuType

public final GTUType<ID> getGtuType()

Returns:

gtuType.

getInitialLongitudinalPositions

public final Map<Lane,DoubleScalar.Rel<LengthUnit>> getInitialLongitudinalPositions()

Returns:

initialLongitudinalPositions.

getInitialSpeed

public final DoubleScalar.Abs<SpeedUnit> getInitialSpeed()

Returns:

initialSpeed.

getGtuFollowingModel

public final GTUFollowingModel getGtuFollowingModel()

Returns:

gtuFollowingModel.

getLaneChangeModel

public final LaneChangeModel getLaneChangeModel()

Returns:

laneChangeModel.

getLength

public final DoubleScalar.Rel<LengthUnit> getLength()

Returns:

length.

getWidth

public final DoubleScalar.Rel<LengthUnit> getWidth()

Returns:

width.

getMaximumVelocity

public final DoubleScalar.Abs<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<ID> build()
                                       throws Exception

Build one LaneBasedIndividualCar.

Returns:

the built Car with the set properties

Throws:

Exception - when not all required values have been set