Vehicle

Object
- de.tudresden.sumo.cmd.Vehicle

```
public class Vehicle
extends Object
```
Author:

Mario Krumnow, Evamarie Wiessner

Constructor Summary

Constructors
Constructor and Description

Vehicle()

Constructors
Constructor and Description
`Vehicle()`

Method Summary

Methods
Modifier and Type	Method and Description
`static SumoCommand`	`add(String vehID, String typeID, String routeID, int depart, double pos, double speed, byte lane)` Add a new vehicle.
`static SumoCommand`	`changeLane(String vehID, byte laneIndex, int duration)` Forces a lane change to the lane with the given index; if successful, the lane will be chosen for the given amount of time.
`static SumoCommand`	`changeTarget(String vehID, String edgeID)` The vehicle's destination edge is set to the given.
`static SumoCommand`	`getAccel(String vehID)` Returns the acceleration of the named vehicle within the last step.
`static SumoCommand`	`getAdaptedTraveltime(String vehID, int time, String edgeID)` Returns the edge travel time for the given time as stored in the vehicle's internal container.
`static SumoCommand`	`getAllowedSpeed(String vehID)` Returns the maximum allowed speed on the current lane regarding speed factor in m/s for this vehicle.
`static SumoCommand`	`getAngle(String vehID)` Returns the angle of the named vehicle within the last time step.
`static SumoCommand`	`getBestLanes(String vehID)` getBestLanes
`static SumoCommand`	`getCO2Emission(String vehID)` Returns the CO2 emission in mg for the last time step.
`static SumoCommand`	`getCOEmission(String vehID)` Returns the CO emission in mg for the last time step.
`static SumoCommand`	`getColor(String vehID)` Returns the vehicle's color (RGBA).
`static SumoCommand`	`getDecel(String vehID)` Returns the deceleration of the named vehicle within the last time step.
`static SumoCommand`	`getDistance(String vehID)` Get the distance to the starting point acts as a odometer
`static SumoCommand`	`getDrivingDistance(String vehID, String edgeID, double pos, int laneID)` Returns the driving distance (in m) of the named vehicle within the last tine step.
`static SumoCommand`	`getDrivingDistance2D(String vehID, double x, double y)` getDrivingDistance2D
`static SumoCommand`	`getEffort(String vehID, int time, String edgeID)` Returns the edge effort for the given time as stored in the vehicle's internal container.
`static SumoCommand`	`getEmissionClass(String vehID)` Returns the emission class of the named vehicle.
`static SumoCommand`	`getFuelConsumption(String vehID)` Returns the fuel consumption in ml for the last time step.
`static SumoCommand`	`getHCEmission(String vehID)` Returns the HC emission (in mg) during the last time step.
`static SumoCommand`	`getIDCount()` Returns the number of all vehicles in the network.
`static SumoCommand`	`getIDList()` Returns a list of ids of all vehicles currently running within the scenario.
`static SumoCommand`	`getImperfection(String vehID)` getImperfection
`static SumoCommand`	`getLaneID(String vehID)` Returns the id of the lane the named vehicle was at within the last step.
`static SumoCommand`	`getLaneIndex(String vehID)` Returns the index of the lane the named vehicle was at within the last step.
`static SumoCommand`	`getLanePosition(String vehID)` Returns the position of the vehicle along the lane (in m).
`static SumoCommand`	`getLeader(String vehID, double dist)` Return the leading vehicle id together with the distance.
`static SumoCommand`	`getLength(String vehID)` Returns the length (in m) of the named vehicle.
`static SumoCommand`	`getMaxSpeed(String vehID)` Returns the maximum speed(in m/s) of the named vehicle.
`static SumoCommand`	`getMinGap(String vehID)` Returns the minimum gap (in m) between this vehicle and the vehicle before it.
`static SumoCommand`	`getNoiseEmission(String vehID)` Returns the noise emission (in db) generated by the vehicle during the last time step.
`static SumoCommand`	`getNOxEmission(String vehID)` Returns the NOx emissions (in mg) generated by the vehicle during the last time step.
`static SumoCommand`	`getPersonNumber(String vehID)` getPersonNumber
`static SumoCommand`	`getPMxEmission(String vehID)` Returns the particular matter emissions (in mg) generated by the vehicle during the last time step.
`static SumoCommand`	`getPosition(String vehID)` Returns the position of the named vehicle within the last step [m,m].
`static SumoCommand`	`getPosition3D(String vehID)` Returns the position of the named vehicle within the last step [m,m,m].
`static SumoCommand`	`getRoadID(String vehID)` Returns the id of the edge the named vehicle was at within the last step.
`static SumoCommand`	`getRoute(String vehID)` Returns the ids of the edges the vehicle's route is made of.
`static SumoCommand`	`getRouteID(String vehID)` Returns the id of the route of the named vehicle.
`static SumoCommand`	`getShapeClass(String vehID)` getShapeClass
`static SumoCommand`	`getSignals(String vehID)` getSignals
`static SumoCommand`	`getSpeed(String vehID)` Returns the speed (in m/s) of the named vehicle within the last step.
`static SumoCommand`	`getSpeedDeviation(String vehID)` Returns the standard deviation of the estimated maximum speed (see speed factor) divided by this speed.
`static SumoCommand`	`getSpeedFactor(String vehID)` Returns the factor by which the driver multiplies the speed read from street signs to estimate "real" maximum allowed speed.
`static SumoCommand`	`getSpeedWithoutTraCI(String vehID)` getSpeedWithoutTraCI
`static SumoCommand`	`getTau(String vehID)` getTau
`static SumoCommand`	`getTypeID(String vehID)` Returns the id of the type of the named vehicle.
`static SumoCommand`	`getVehicleClass(String vehID)` Returns the vehicle class.
`static SumoCommand`	`getWaitingTime(String vehID)` The waiting time of a vehicle is defined as the time (in seconds) spent with a speed below 0.1m/s since the last time it was faster than 0.1m/s.
`static SumoCommand`	`getWidth(String vehID)` Returns the vehicle's width (in m).
`static SumoCommand`	`isRouteValid(String vehID)` Returns whether the Route is valid.
`static SumoCommand`	`moveTo(String vehID, String laneID, double pos)` Moves the vehicle to a new position.
`static SumoCommand`	`moveToVTD(String vehID, String edgeID, int lane, double x, double y)` moveToVTD
`static SumoCommand`	`remove(String vehID, byte reason)` Removes vehicle with the given ID for the given reason.
`static SumoCommand`	`rerouteEffort(String vehID)` Computes a new route using the vehicle's internal and the global edge effort information.
`static SumoCommand`	`rerouteTraveltime(String vehID)` Computes a new route using the vehicle's internal and the global edge travel time information.
`static SumoCommand`	`Resume(String vehID)` Continue after a stop
`static SumoCommand`	`setAccel(String vehID, double accel)` Sets the acceleration of the named vehicle.
`static SumoCommand`	`setAdaptedTraveltime(String vehID, int begTime, int endTime, String edgeID, double time)` Sets the edge travel time of the named vehicle.
`static SumoCommand`	`setColor(String vehID, SumoColor color)` Sets the vehicle's color (RGBA).
`static SumoCommand`	`setDecel(String vehID, double decel)` Sets the deceleration of the named vehicle.
`static SumoCommand`	`setEffort(String vehID, int begTime, int endTime, String edgeID, double effort)` Sets the edge effort for the given time as stored in the vehicle's internal container.
`static SumoCommand`	`setEmissionClass(String vehID, String clazz)` Sets the emission class of the named vehicle.
`static SumoCommand`	`setImperfection(String vehID, double imperfection)` setImperfection
`static SumoCommand`	`setLaneChangeMode(String vehID, int lcm)` Sets the vehicle's lane change mode as a bitset.
`static SumoCommand`	`setLength(String vehID, double length)` Sets the length (in m) of the named vehicle.
`static SumoCommand`	`setMaxSpeed(String vehID, double speed)` Sets the maximum speed (in m/s) of the named vehicle.
`static SumoCommand`	`setMinGap(String vehID, double minGap)` Sets the minimum gap (in m) between this vehicle and the vehicle before it.
`static SumoCommand`	`setRoute(String vehID, SumoStringList edgeList)` Sets the IDs of the edges the vehicle's route is made of.
`static SumoCommand`	`setRouteID(String vehID, String routeID)` Sets the id of the route of the named vehicle.
`static SumoCommand`	`setShapeClass(String vehID, String clazz)` setShapeClass
`static SumoCommand`	`setSignals(String vehID, String signals)` setSignals
`static SumoCommand`	`setSpeed(String vehID, double speed)` Sets the speed (in m/s) of the named vehicle.
`static SumoCommand`	`setSpeedDeviation(String vehID, double deviation)` Sets the standard deviation of the estimated maximum speed.
`static SumoCommand`	`setSpeedFactor(String vehID, double factor)` Sets the factor by which the driver multiplies the speed read from street signs to estimate "real" maximum allowed speed.
`static SumoCommand`	`setspeedMode(String vehID, int sm)` Sets the vehicle's speed mode as a bitset.
`static SumoCommand`	`setStop(String vehID, String edgeID, double pos, byte laneIndex, int duration, byte stopType)` Lets the vehicle stop at the given edge, at the given position and lane.
`static SumoCommand`	`setTau(String vehID, double tau)` setTau
`static SumoCommand`	`setType(String vehID, String typeID)` Sets the id of the type for the named vehicle.
`static SumoCommand`	`setVehicleClass(String vehID, String clazz)` Sets the vehicle class.
`static SumoCommand`	`setWidth(String vehID, double width)` Sets the vehicle's width (in m).
`static SumoCommand`	`slowDown(String vehID, double speed, int duration)` Reduces the speed to the given for the given amount of time.

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- Vehicle
```
public Vehicle()
```

Method Detail

getAccel
```
public static SumoCommand getAccel(String vehID)
```
Returns the acceleration of the named vehicle within the last step.

getIDCount
```
public static SumoCommand getIDCount()
```
Returns the number of all vehicles in the network.

getAdaptedTraveltime

public static SumoCommand getAdaptedTraveltime(String vehID,
                               int time,
                               String edgeID)

Returns the edge travel time for the given time as stored in the vehicle's internal container.

getAngle
```
public static SumoCommand getAngle(String vehID)
```
Returns the angle of the named vehicle within the last time step.

getAllowedSpeed
```
public static SumoCommand getAllowedSpeed(String vehID)
```
Returns the maximum allowed speed on the current lane regarding speed factor in m/s for this vehicle.

getLeader
```
public static SumoCommand getLeader(String vehID,
                    double dist)
```
Return the leading vehicle id together with the distance. The dist parameter defines the maximum lookahead, 0 calculates a lookahead from the brake gap.

getPersonNumber

public static SumoCommand getPersonNumber(String vehID)

getPersonNumber

getBestLanes

public static SumoCommand getBestLanes(String vehID)

getBestLanes

getCO2Emission
```
public static SumoCommand getCO2Emission(String vehID)
```
Returns the CO2 emission in mg for the last time step.

getCOEmission
```
public static SumoCommand getCOEmission(String vehID)
```
Returns the CO emission in mg for the last time step.

getColor

public static SumoCommand getColor(String vehID)

Returns the vehicle's color (RGBA).

getDecel
```
public static SumoCommand getDecel(String vehID)
```
Returns the deceleration of the named vehicle within the last time step.

getDrivingDistance

public static SumoCommand getDrivingDistance(String vehID,
                             String edgeID,
                             double pos,
                             int laneID)

Returns the driving distance (in m) of the named vehicle within the last tine step.

getDrivingDistance2D

public static SumoCommand getDrivingDistance2D(String vehID,
                               double x,
                               double y)

getDrivingDistance2D

getDistance
```
public static SumoCommand getDistance(String vehID)
```
Get the distance to the starting point acts as a odometer

getEffort

public static SumoCommand getEffort(String vehID,
                    int time,
                    String edgeID)

Returns the edge effort for the given time as stored in the vehicle's internal container.

getEmissionClass
```
public static SumoCommand getEmissionClass(String vehID)
```
Returns the emission class of the named vehicle.

getFuelConsumption
```
public static SumoCommand getFuelConsumption(String vehID)
```
Returns the fuel consumption in ml for the last time step.

getHCEmission
```
public static SumoCommand getHCEmission(String vehID)
```
Returns the HC emission (in mg) during the last time step.

getIDList
```
public static SumoCommand getIDList()
```
Returns a list of ids of all vehicles currently running within the scenario.

getImperfection

public static SumoCommand getImperfection(String vehID)

getImperfection

getLaneID
```
public static SumoCommand getLaneID(String vehID)
```
Returns the id of the lane the named vehicle was at within the last step.

getLaneIndex
```
public static SumoCommand getLaneIndex(String vehID)
```
Returns the index of the lane the named vehicle was at within the last step.

getLanePosition
```
public static SumoCommand getLanePosition(String vehID)
```
Returns the position of the vehicle along the lane (in m).

getLength

public static SumoCommand getLength(String vehID)

Returns the length (in m) of the named vehicle.

getMaxSpeed
```
public static SumoCommand getMaxSpeed(String vehID)
```
Returns the maximum speed(in m/s) of the named vehicle.

getMinGap
```
public static SumoCommand getMinGap(String vehID)
```
Returns the minimum gap (in m) between this vehicle and the vehicle before it.

getNOxEmission
```
public static SumoCommand getNOxEmission(String vehID)
```
Returns the NOx emissions (in mg) generated by the vehicle during the last time step.

getNoiseEmission
```
public static SumoCommand getNoiseEmission(String vehID)
```
Returns the noise emission (in db) generated by the vehicle during the last time step.

getPMxEmission
```
public static SumoCommand getPMxEmission(String vehID)
```
Returns the particular matter emissions (in mg) generated by the vehicle during the last time step.

getPosition
```
public static SumoCommand getPosition(String vehID)
```
Returns the position of the named vehicle within the last step [m,m].

getPosition3D
```
public static SumoCommand getPosition3D(String vehID)
```
Returns the position of the named vehicle within the last step [m,m,m].

getRoadID
```
public static SumoCommand getRoadID(String vehID)
```
Returns the id of the edge the named vehicle was at within the last step.

getRoute
```
public static SumoCommand getRoute(String vehID)
```
Returns the ids of the edges the vehicle's route is made of.

getRouteID
```
public static SumoCommand getRouteID(String vehID)
```
Returns the id of the route of the named vehicle.

getShapeClass

public static SumoCommand getShapeClass(String vehID)

getShapeClass

getSignals

public static SumoCommand getSignals(String vehID)

getSignals

getSpeed
```
public static SumoCommand getSpeed(String vehID)
```
Returns the speed (in m/s) of the named vehicle within the last step.

getSpeedDeviation
```
public static SumoCommand getSpeedDeviation(String vehID)
```
Returns the standard deviation of the estimated maximum speed (see speed factor) divided by this speed.

getSpeedFactor
```
public static SumoCommand getSpeedFactor(String vehID)
```
Returns the factor by which the driver multiplies the speed read from street signs to estimate "real" maximum allowed speed.

getSpeedWithoutTraCI

public static SumoCommand getSpeedWithoutTraCI(String vehID)

getSpeedWithoutTraCI

getTau

public static SumoCommand getTau(String vehID)

getTau

getWaitingTime
```
public static SumoCommand getWaitingTime(String vehID)
```
The waiting time of a vehicle is defined as the time (in seconds) spent with a speed below 0.1m/s since the last time it was faster than 0.1m/s. (basically, the waiting time of a vehicle is reset to 0 every time it moves).

getTypeID
```
public static SumoCommand getTypeID(String vehID)
```
Returns the id of the type of the named vehicle.

getVehicleClass

public static SumoCommand getVehicleClass(String vehID)

Returns the vehicle class.

getWidth

public static SumoCommand getWidth(String vehID)

Returns the vehicle's width (in m).

isRouteValid

public static SumoCommand isRouteValid(String vehID)

Returns whether the Route is valid.

slowDown

public static SumoCommand slowDown(String vehID,
                   double speed,
                   int duration)

Reduces the speed to the given for the given amount of time.

add

public static SumoCommand add(String vehID,
              String typeID,
              String routeID,
              int depart,
              double pos,
              double speed,
              byte lane)

Add a new vehicle.

changeLane
```
public static SumoCommand changeLane(String vehID,
                     byte laneIndex,
                     int duration)
```
Forces a lane change to the lane with the given index; if successful, the lane will be chosen for the given amount of time.

changeTarget

public static SumoCommand changeTarget(String vehID,
                       String edgeID)

The vehicle's destination edge is set to the given. The route is rebuilt.

moveTo

public static SumoCommand moveTo(String vehID,
                 String laneID,
                 double pos)

Moves the vehicle to a new position.

moveToVTD

public static SumoCommand moveToVTD(String vehID,
                    String edgeID,
                    int lane,
                    double x,
                    double y)

moveToVTD

remove
```
public static SumoCommand remove(String vehID,
                 byte reason)
```
Removes vehicle with the given ID for the given reason. Reasons are defined in module constants and start with REMOVE_

rerouteEffort
```
public static SumoCommand rerouteEffort(String vehID)
```
Computes a new route using the vehicle's internal and the global edge effort information.

rerouteTraveltime
```
public static SumoCommand rerouteTraveltime(String vehID)
```
Computes a new route using the vehicle's internal and the global edge travel time information.

setAccel

public static SumoCommand setAccel(String vehID,
                   double accel)

Sets the acceleration of the named vehicle.

setAdaptedTraveltime

public static SumoCommand setAdaptedTraveltime(String vehID,
                               int begTime,
                               int endTime,
                               String edgeID,
                               double time)

Sets the edge travel time of the named vehicle.

setColor

public static SumoCommand setColor(String vehID,
                   SumoColor color)

Sets the vehicle's color (RGBA).

setDecel

public static SumoCommand setDecel(String vehID,
                   double decel)

Sets the deceleration of the named vehicle.

setLaneChangeMode

public static SumoCommand setLaneChangeMode(String vehID,
                            int lcm)

Sets the vehicle's lane change mode as a bitset.

setRoute

public static SumoCommand setRoute(String vehID,
                   SumoStringList edgeList)

Sets the IDs of the edges the vehicle's route is made of.

setType

public static SumoCommand setType(String vehID,
                  String typeID)

Sets the id of the type for the named vehicle.

setEffort

public static SumoCommand setEffort(String vehID,
                    int begTime,
                    int endTime,
                    String edgeID,
                    double effort)

Sets the edge effort for the given time as stored in the vehicle's internal container.

setEmissionClass

public static SumoCommand setEmissionClass(String vehID,
                           String clazz)

Sets the emission class of the named vehicle.

setImperfection

public static SumoCommand setImperfection(String vehID,
                          double imperfection)

setImperfection

setLength

public static SumoCommand setLength(String vehID,
                    double length)

Sets the length (in m) of the named vehicle.

setMaxSpeed

public static SumoCommand setMaxSpeed(String vehID,
                      double speed)

Sets the maximum speed (in m/s) of the named vehicle.

setMinGap

public static SumoCommand setMinGap(String vehID,
                    double minGap)

Sets the minimum gap (in m) between this vehicle and the vehicle before it.

setRouteID

public static SumoCommand setRouteID(String vehID,
                     String routeID)

Sets the id of the route of the named vehicle.

setShapeClass

public static SumoCommand setShapeClass(String vehID,
                        String clazz)

setShapeClass

setSignals

public static SumoCommand setSignals(String vehID,
                     String signals)

setSignals

setSpeed

public static SumoCommand setSpeed(String vehID,
                   double speed)

Sets the speed (in m/s) of the named vehicle.

setSpeedDeviation

public static SumoCommand setSpeedDeviation(String vehID,
                            double deviation)

Sets the standard deviation of the estimated maximum speed.

setSpeedFactor
```
public static SumoCommand setSpeedFactor(String vehID,
                         double factor)
```
Sets the factor by which the driver multiplies the speed read from street signs to estimate "real" maximum allowed speed.

setspeedMode

public static SumoCommand setspeedMode(String vehID,
                       int sm)

Sets the vehicle's speed mode as a bitset.

setStop

public static SumoCommand setStop(String vehID,
                  String edgeID,
                  double pos,
                  byte laneIndex,
                  int duration,
                  byte stopType)

Lets the vehicle stop at the given edge, at the given position and lane. The vehicle will stop for the given duration. Re-issuing a stop command with the same lane and position allows changing the duration.

Resume

public static SumoCommand Resume(String vehID)

Continue after a stop

setTau

public static SumoCommand setTau(String vehID,
                 double tau)

setTau

setVehicleClass

public static SumoCommand setVehicleClass(String vehID,
                          String clazz)

Sets the vehicle class.

setWidth

public static SumoCommand setWidth(String vehID,
                   double width)

Sets the vehicle's width (in m).

Class Vehicle

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

Vehicle

Method Detail

getAccel

getIDCount

getAdaptedTraveltime

getAngle

getAllowedSpeed

getLeader

getPersonNumber

getBestLanes

getCO2Emission

getCOEmission

getColor

getDecel

getDrivingDistance

getDrivingDistance2D

getDistance

getEffort

getEmissionClass

getFuelConsumption

getHCEmission

getIDList

getImperfection

getLaneID

getLaneIndex

getLanePosition

getLength

getMaxSpeed

getMinGap

getNOxEmission

getNoiseEmission

getPMxEmission

getPosition

getPosition3D

getRoadID

getRoute

getRouteID

getShapeClass

getSignals

getSpeed

getSpeedDeviation

getSpeedFactor

getSpeedWithoutTraCI

getTau

getWaitingTime

getTypeID

getVehicleClass

getWidth

isRouteValid

slowDown

add

changeLane

changeTarget

moveTo

moveToVTD

remove

rerouteEffort

rerouteTraveltime

setAccel

setAdaptedTraveltime

setColor

setDecel

setLaneChangeMode

setRoute

setType

setEffort

setEmissionClass

setImperfection

setLength

setMaxSpeed

setMinGap

setRouteID

setShapeClass

setSignals

setSpeed