org.opentrafficsim.road.gtu.lane

Class LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder

java.lang.Object

org.opentrafficsim.road.gtu.lane.LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder

All Implemented Interfaces:

Serializable

Enclosing class:

LaneBasedIndividualGTU

public static class LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder
extends Object
implements Serializable

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 Length(4.0, METER))....build(); 
    
 or
 
 LaneBasedIndividualCarBuilder<String> carBuilder = new LaneBasedIndividualCarBuilder<String>();
 carBuilder.setId("Car:"+nr);
 carBuilder.setLength(new Length(4.0, METER));
 carBuilder.setWidth(new Length(1.8, METER));
 ...
 LaneBasedIndividualCar<String> car = carBuilder.build();
 

Copyright (c) 2013-2017 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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LaneBasedIndividualCarBuilder()

Method Summary

Modifier and Type	Method and Description
LaneBasedIndividualGTU	build(LaneBasedStrategicalPlannerFactory<? extends LaneBasedStrategicalPlanner> laneBasedStrategicalPlannerFactory, org.opentrafficsim.core.network.route.Route route, org.opentrafficsim.core.network.Node origin, org.opentrafficsim.core.network.Node destination) Build one LaneBasedIndividualCar.
Class<? extends nl.tudelft.simulation.dsol.animation.D2.Renderable2D<? super LaneBasedIndividualGTU>>	getAnimationClass()
org.opentrafficsim.core.gtu.animation.GTUColorer	getGtuColorer()
org.opentrafficsim.core.gtu.GTUType	getGtuType()
String	getId()
Set<DirectedLanePosition>	getInitialLongitudinalPositions()
org.djunits.value.vdouble.scalar.Speed	getInitialSpeed()
org.djunits.value.vdouble.scalar.Length	getLength()
org.djunits.value.vdouble.scalar.Speed	getMaximumSpeed()
org.opentrafficsim.core.network.OTSNetwork	getNetwork()
org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface	getSimulator()
org.djunits.value.vdouble.scalar.Length	getWidth()
LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder	setAnimationClass(Class<? extends nl.tudelft.simulation.dsol.animation.D2.Renderable2D<? super LaneBasedIndividualGTU>> animationClass)
LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder	setFront(org.djunits.value.vdouble.scalar.Length front)
LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder	setGtuColorer(org.opentrafficsim.core.gtu.animation.GTUColorer gtuColorer)
LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder	setGtuType(org.opentrafficsim.core.gtu.GTUType gtuType)
LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder	setId(String id)
LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder	setInitialLongitudinalPositions(Set<DirectedLanePosition> initialLongitudinalPositions)
LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder	setInitialSpeed(org.djunits.value.vdouble.scalar.Speed initialSpeed)
LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder	setLength(org.djunits.value.vdouble.scalar.Length length)
LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder	setMaximumAcceleration(org.djunits.value.vdouble.scalar.Acceleration maximumAcceleration)
LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder	setMaximumDeceleration(org.djunits.value.vdouble.scalar.Acceleration maximumDeceleration)
LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder	setMaximumSpeed(org.djunits.value.vdouble.scalar.Speed maximumSpeed)
LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder	setNetwork(org.opentrafficsim.core.network.OTSNetwork network)
LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder	setSimulator(org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator)
LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder	setWidth(org.djunits.value.vdouble.scalar.Length width)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LaneBasedIndividualCarBuilder

public LaneBasedIndividualCarBuilder()

Method Detail

setId

public final LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder setId(String id)

Parameters:

id - set id

Returns:

the class itself for chaining the setters

setGtuType

public final LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder setGtuType(org.opentrafficsim.core.gtu.GTUType gtuType)

Parameters:

gtuType - set gtuType

Returns:

the class itself for chaining the setters

setInitialLongitudinalPositions

public final LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder setInitialLongitudinalPositions(Set<DirectedLanePosition> initialLongitudinalPositions)

Parameters:

initialLongitudinalPositions - set initialLongitudinalPositions

Returns:

the class itself for chaining the setters

setInitialSpeed

public final LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder setInitialSpeed(org.djunits.value.vdouble.scalar.Speed initialSpeed)

Parameters:

initialSpeed - set initialSpeed

Returns:

the class itself for chaining the setters

setLength

public final LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder setLength(org.djunits.value.vdouble.scalar.Length length)

Parameters:

length - set length

Returns:

the class itself for chaining the setters

setWidth

public final LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder setWidth(org.djunits.value.vdouble.scalar.Length width)

Parameters:

width - set width

Returns:

the class itself for chaining the setters

setMaximumSpeed

public final LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder setMaximumSpeed(org.djunits.value.vdouble.scalar.Speed maximumSpeed)

Parameters:

maximumSpeed - set maximumSpeed

Returns:

the class itself for chaining the setters

setMaximumAcceleration

public final LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder setMaximumAcceleration(org.djunits.value.vdouble.scalar.Acceleration maximumAcceleration)

Parameters:

maximumAcceleration - Acceleration; maximum acceleration

Returns:

the class itself for chaining the setters

setMaximumDeceleration

public final LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder setMaximumDeceleration(org.djunits.value.vdouble.scalar.Acceleration maximumDeceleration)

Parameters:

maximumDeceleration - Acceleration; maximum deceleration (a negative value)

Returns:

the class itself for chaining the setters

setSimulator

public final LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder setSimulator(org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator)

Parameters:

simulator - set simulator

Returns:

the class itself for chaining the setters

setFront

public final LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder setFront(org.djunits.value.vdouble.scalar.Length front)

Parameters:

front - distance of the front relative to the reference point

Returns:

the class itself for chaining the setters

setAnimationClass

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

Parameters:

animationClass - set animation class

Returns:

the class itself for chaining the setters

setGtuColorer

public final LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder setGtuColorer(org.opentrafficsim.core.gtu.animation.GTUColorer gtuColorer)

Parameters:

gtuColorer - set gtuColorer.

Returns:

the class itself for chaining the setters

setNetwork

public final LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder setNetwork(org.opentrafficsim.core.network.OTSNetwork network)

Parameters:

network - set network

Returns:

the class itself for chaining the setters

getId

public final String getId()

Returns:

id.

getGtuType

public final org.opentrafficsim.core.gtu.GTUType getGtuType()

Returns:

gtuType.

getInitialLongitudinalPositions

public final Set<DirectedLanePosition> getInitialLongitudinalPositions()

Returns:

initialLongitudinalPositions.

getInitialSpeed

public final org.djunits.value.vdouble.scalar.Speed getInitialSpeed()

Returns:

initialSpeed.

getLength

public final org.djunits.value.vdouble.scalar.Length getLength()

Returns:

length.

getWidth

public final org.djunits.value.vdouble.scalar.Length getWidth()

Returns:

width.

getMaximumSpeed

public final org.djunits.value.vdouble.scalar.Speed getMaximumSpeed()

Returns:

maximumSpeed.

getSimulator

public final org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface getSimulator()

Returns:

simulator.

getAnimationClass

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

Returns:

animationClass.

getGtuColorer

public final org.opentrafficsim.core.gtu.animation.GTUColorer getGtuColorer()

Returns:

gtuColorer.

getNetwork

public final org.opentrafficsim.core.network.OTSNetwork getNetwork()

Returns:

network

build

public final LaneBasedIndividualGTU build(LaneBasedStrategicalPlannerFactory<? extends LaneBasedStrategicalPlanner> laneBasedStrategicalPlannerFactory,
                                          org.opentrafficsim.core.network.route.Route route,
                                          org.opentrafficsim.core.network.Node origin,
                                          org.opentrafficsim.core.network.Node destination)
                                   throws Exception

Build one LaneBasedIndividualCar.

Parameters:

laneBasedStrategicalPlannerFactory - factory for the strategical planner

route - route

origin - origin

destination - destination

Returns:

the built Car with the set properties

Throws:

Exception - when not all required values have been set

toString

public final String toString()

Overrides:

toString in class Object