Eclipse SUMO - Simulation of Urban MObility
SUMOVehicleParameter.h File Reference
#include <config.h>
#include <string>
#include <utils/common/Parameterised.h>
#include <utils/common/RGBColor.h>
#include <utils/common/SUMOTime.h>
#include <utils/common/SUMOVehicleClass.h>
Include dependency graph for SUMOVehicleParameter.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

class  SUMOVehicleParameter
 Structure representing possible vehicle parameter. More...
 
struct  SUMOVehicleParameter::Stop
 Definition of vehicle stop (position and duration) More...
 

Enumerations

enum class  ArrivalLaneDefinition {
  DEFAULT = 0 , CURRENT = 1 , GIVEN = 2 , RANDOM = 3 ,
  FIRST_ALLOWED = 4
}
 Possible ways to choose the arrival lane. More...
 
enum class  ArrivalPosDefinition {
  DEFAULT , GIVEN , RANDOM , CENTER ,
  MAX
}
 Possible ways to choose the arrival position. More...
 
enum class  ArrivalPosLatDefinition {
  DEFAULT , GIVEN , RIGHT , CENTER ,
  LEFT
}
 Possible ways to choose the lateral arrival position. More...
 
enum class  ArrivalSpeedDefinition { DEFAULT , GIVEN , CURRENT }
 Possible ways to choose the arrival speed. More...
 
enum class  DepartDefinition {
  GIVEN , TRIGGERED , CONTAINER_TRIGGERED , NOW ,
  SPLIT , BEGIN , DEF_MAX
}
 Possible ways to depart. More...
 
enum class  DepartLaneDefinition {
  DEFAULT , GIVEN , RANDOM , FREE ,
  ALLOWED_FREE , BEST_FREE , FIRST_ALLOWED
}
 Possible ways to choose a lane on depart. More...
 
enum class  DepartPosDefinition {
  DEFAULT , GIVEN , GIVEN_VEHROUTE , RANDOM ,
  FREE , BASE , LAST , RANDOM_FREE ,
  RANDOM_LOCATION , SPLIT_FRONT , STOP
}
 Possible ways to choose the departure position. More...
 
enum class  DepartPosLatDefinition {
  DEFAULT , GIVEN , GIVEN_VEHROUTE , RIGHT ,
  CENTER , LEFT , RANDOM , FREE ,
  RANDOM_FREE
}
 Possible ways to choose the lateral departure position. More...
 
enum class  DepartSpeedDefinition {
  DEFAULT , GIVEN , GIVEN_VEHROUTE , RANDOM ,
  MAX , DESIRED , LIMIT , LAST ,
  AVG
}
 Possible ways to choose the departure speed. More...
 
enum class  RouteIndexDefinition { DEFAULT , GIVEN , RANDOM }
 Possible ways to choose the departure and arrival edge. More...
 

Variables

const double MIN_STOP_LENGTH = 2 * POSITION_EPS
 
const int STOP_ARRIVAL_SET = 2 << 14
 
const int STOP_CONTAINER_TRIGGER_SET = 2 << 7
 
const int STOP_DURATION_SET = 2 << 1
 
const int STOP_END_SET = 2
 
const int STOP_ENDED_SET = 2 << 16
 
const int STOP_EXPECTED_CONTAINERS_SET = 2 << 8
 
const int STOP_EXPECTED_SET = 2 << 6
 
const int STOP_EXTENSION_SET = 2 << 3
 
const int STOP_INDEX_END = -1
 
const int STOP_INDEX_FIT = -2
 
const int STOP_JOIN_SET = 2 << 13
 
const int STOP_JUMP_SET = 2 << 20
 
const int STOP_LINE_SET = 2 << 10
 
const int STOP_ONDEMAND_SET = 2 << 19
 
const int STOP_PARKING_SET = 2 << 5
 
const int STOP_PERMITTED_SET = 2 << 15
 
const int STOP_POSLAT_SET = 2 << 18
 
const int STOP_SPEED_SET = 2 << 11
 
const int STOP_SPLIT_SET = 2 << 12
 
const int STOP_START_SET = 1
 
const int STOP_STARTED_SET = 2 << 17
 
const int STOP_TRIGGER_SET = 2 << 4
 
const int STOP_TRIP_ID_SET = 2 << 9
 
const int STOP_UNTIL_SET = 2 << 2
 
const int VEHPARS_ARRIVALEDGE_SET = 2 << 26
 
const int VEHPARS_ARRIVALLANE_SET = 2 << 11
 
const int VEHPARS_ARRIVALPOS_SET = 2 << 12
 
const int VEHPARS_ARRIVALPOSLAT_SET = 2 << 22
 
const int VEHPARS_ARRIVALSPEED_SET = 2 << 13
 
const int VEHPARS_CALIBRATORSPEED_SET = 2 << 27
 
const int VEHPARS_CFMODEL_PARAMS_SET = 2 << 29
 
const int VEHPARS_COLOR_SET = 1
 
const int VEHPARS_CONTAINER_NUMBER_SET = 2 << 20
 
const int VEHPARS_DEPARTEDGE_SET = 2 << 25
 
const int VEHPARS_DEPARTLANE_SET = 2 << 1
 
const int VEHPARS_DEPARTPOS_SET = 2 << 2
 
const int VEHPARS_DEPARTPOSLAT_SET = 2 << 21
 
const int VEHPARS_DEPARTSPEED_SET = 2 << 3
 
const int VEHPARS_END_SET = 2 << 4
 
const int VEHPARS_FORCE_REROUTE = 2 << 17
 
const int VEHPARS_FROM_TAZ_SET = 2 << 15
 
const int VEHPARS_JUNCTIONMODEL_PARAMS_SET = 2 << 28
 
const int VEHPARS_LINE_SET = 2 << 14
 
const int VEHPARS_NUMBER_SET = 2 << 5
 
const int VEHPARS_PARKING_BADGES_SET = 2 << 30
 
const int VEHPARS_PERIOD_SET = 2 << 6
 
const int VEHPARS_PERSON_CAPACITY_SET = 2 << 18
 
const int VEHPARS_PERSON_NUMBER_SET = 2 << 19
 
const int VEHPARS_POISSON_SET = 2 << 9
 
const int VEHPARS_PROB_SET = 2 << 8
 
const int VEHPARS_ROUTE_SET = 2 << 10
 
const int VEHPARS_SPEEDFACTOR_SET = 2 << 24
 
const int VEHPARS_TO_TAZ_SET = 2 << 16
 
const int VEHPARS_VIA_SET = 2 << 23
 
const int VEHPARS_VPH_SET = 2 << 7
 
const int VEHPARS_VTYPE_SET = 2
 

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Axel Wegener
Michael Behrisch
Date
2006-01-24

Definition in file SUMOVehicleParameter.h.

Enumeration Type Documentation

◆ ArrivalLaneDefinition

enum ArrivalLaneDefinition
strong

Possible ways to choose the arrival lane.

Enumerator
DEFAULT 

No information given; use default.

CURRENT 

The current lane shall be used.

GIVEN 

The arrival lane is given.

RANDOM 

The lane is chosen randomly.

FIRST_ALLOWED 

The rightmost lane the vehicle may use.

Definition at line 252 of file SUMOVehicleParameter.h.

◆ ArrivalPosDefinition

enum ArrivalPosDefinition
strong

Possible ways to choose the arrival position.

Enumerator
DEFAULT 

No information given; use default.

GIVEN 

The arrival position is given.

RANDOM 

The arrival position is chosen randomly.

CENTER 

Half the road length.

MAX 

The maximum arrival position is used.

Definition at line 270 of file SUMOVehicleParameter.h.

◆ ArrivalPosLatDefinition

Possible ways to choose the lateral arrival position.

Enumerator
DEFAULT 

No information given; use default.

GIVEN 

The position is given.

RIGHT 

At the rightmost side of the lane.

CENTER 

At the center of the lane.

LEFT 

At the leftmost side of the lane.

Definition at line 288 of file SUMOVehicleParameter.h.

◆ ArrivalSpeedDefinition

Possible ways to choose the arrival speed.

Enumerator
DEFAULT 

No information given; use default.

GIVEN 

The speed is given.

CURRENT 

The current speed is used.

Definition at line 306 of file SUMOVehicleParameter.h.

◆ DepartDefinition

enum DepartDefinition
strong

Possible ways to depart.

Enumerator
GIVEN 

The time is given.

TRIGGERED 

The departure is person triggered.

CONTAINER_TRIGGERED 

The departure is container triggered.

NOW 

The vehicle is discarded if emission fails (not fully implemented yet)

SPLIT 

The departure is triggered by a train split.

BEGIN 

The departure is at simulation start.

DEF_MAX 

Tag for the last element in the enum for safe int casting.

Definition at line 112 of file SUMOVehicleParameter.h.

◆ DepartLaneDefinition

enum DepartLaneDefinition
strong

Possible ways to choose a lane on depart.

Enumerator
DEFAULT 

No information given; use default.

GIVEN 

The lane is given.

RANDOM 

The lane is chosen randomly.

FREE 

The least occupied lane is used.

ALLOWED_FREE 

The least occupied lane from lanes which allow the continuation.

BEST_FREE 

The least occupied lane from best lanes.

FIRST_ALLOWED 

The rightmost lane the vehicle may use.

Definition at line 134 of file SUMOVehicleParameter.h.

◆ DepartPosDefinition

enum DepartPosDefinition
strong

Possible ways to choose the departure position.

Enumerator
DEFAULT 

No information given; use default.

GIVEN 

The position is given.

GIVEN_VEHROUTE 

The position is set by the vehroute device.

RANDOM 

A random position is chosen.

FREE 

A free position is chosen.

BASE 

Back-at-zero position.

LAST 

Insert behind the last vehicle as close as possible to still allow the specified departSpeed. Fallback to DepartPosDefinition::BASE if there is no vehicle on the departLane yet.

RANDOM_FREE 

If a fixed number of random choices fails, a free position is chosen.

RANDOM_LOCATION 

The position may be chosen freely in a polygon defined by a taz.

SPLIT_FRONT 

depart position for a split vehicle is in front of the continuing vehicle

STOP 

depart position is endPos of first stop

Definition at line 156 of file SUMOVehicleParameter.h.

◆ DepartPosLatDefinition

Possible ways to choose the lateral departure position.

Enumerator
DEFAULT 

No information given; use default.

GIVEN 

The position is given.

GIVEN_VEHROUTE 

The position is set by the vehroute device.

RIGHT 

At the rightmost side of the lane.

CENTER 

At the center of the lane.

LEFT 

At the leftmost side of the lane.

RANDOM 

The lateral position is chosen randomly.

FREE 

A free lateral position is chosen.

RANDOM_FREE 

If a fixed number of random choices fails, a free lateral position is chosen.

Definition at line 186 of file SUMOVehicleParameter.h.

◆ DepartSpeedDefinition

enum DepartSpeedDefinition
strong

Possible ways to choose the departure speed.

Enumerator
DEFAULT 

No information given; use default.

GIVEN 

The speed is given.

GIVEN_VEHROUTE 

The speed is set by the vehroute device.

RANDOM 

The speed is chosen randomly.

MAX 

The maximum safe speed is used.

DESIRED 

The maximum lane speed is used (speedLimit * speedFactor)

LIMIT 

The maximum lane speed is used (speedLimit)

LAST 

The speed of the last vehicle. Fallback to DepartSpeedDefinition::DESIRED if there is no vehicle on the departLane yet.

AVG 

The average speed on the lane. Fallback to DepartSpeedDefinition::DESIRED if there is no vehicle on the departLane yet.

Definition at line 212 of file SUMOVehicleParameter.h.

◆ RouteIndexDefinition

enum RouteIndexDefinition
strong

Possible ways to choose the departure and arrival edge.

Enumerator
DEFAULT 

No information given; use default.

GIVEN 

The edge index is given.

RANDOM 

The edge is chosen randomly.

Definition at line 238 of file SUMOVehicleParameter.h.

Variable Documentation

◆ MIN_STOP_LENGTH

const double MIN_STOP_LENGTH = 2 * POSITION_EPS

Definition at line 102 of file SUMOVehicleParameter.h.

Referenced by MSRouteHandler::addStop().

◆ STOP_ARRIVAL_SET

◆ STOP_CONTAINER_TRIGGER_SET

const int STOP_CONTAINER_TRIGGER_SET = 2 << 7

◆ STOP_DURATION_SET

◆ STOP_END_SET

◆ STOP_ENDED_SET

◆ STOP_EXPECTED_CONTAINERS_SET

◆ STOP_EXPECTED_SET

◆ STOP_EXTENSION_SET

◆ STOP_INDEX_END

◆ STOP_INDEX_FIT

◆ STOP_JOIN_SET

◆ STOP_JUMP_SET

◆ STOP_LINE_SET

◆ STOP_ONDEMAND_SET

◆ STOP_PARKING_SET

◆ STOP_PERMITTED_SET

◆ STOP_POSLAT_SET

◆ STOP_SPEED_SET

◆ STOP_SPLIT_SET

◆ STOP_START_SET

◆ STOP_STARTED_SET

◆ STOP_TRIGGER_SET

◆ STOP_TRIP_ID_SET

◆ STOP_UNTIL_SET

◆ VEHPARS_ARRIVALEDGE_SET

const int VEHPARS_ARRIVALEDGE_SET = 2 << 26

◆ VEHPARS_ARRIVALLANE_SET

◆ VEHPARS_ARRIVALPOS_SET

◆ VEHPARS_ARRIVALPOSLAT_SET

◆ VEHPARS_ARRIVALSPEED_SET

◆ VEHPARS_CALIBRATORSPEED_SET

◆ VEHPARS_CFMODEL_PARAMS_SET

const int VEHPARS_CFMODEL_PARAMS_SET = 2 << 29

◆ VEHPARS_COLOR_SET

◆ VEHPARS_CONTAINER_NUMBER_SET

◆ VEHPARS_DEPARTEDGE_SET

const int VEHPARS_DEPARTEDGE_SET = 2 << 25

◆ VEHPARS_DEPARTLANE_SET

◆ VEHPARS_DEPARTPOS_SET

◆ VEHPARS_DEPARTPOSLAT_SET

◆ VEHPARS_DEPARTSPEED_SET

◆ VEHPARS_END_SET

◆ VEHPARS_FORCE_REROUTE

◆ VEHPARS_FROM_TAZ_SET

◆ VEHPARS_JUNCTIONMODEL_PARAMS_SET

const int VEHPARS_JUNCTIONMODEL_PARAMS_SET = 2 << 28

◆ VEHPARS_LINE_SET

◆ VEHPARS_NUMBER_SET

◆ VEHPARS_PARKING_BADGES_SET

const int VEHPARS_PARKING_BADGES_SET = 2 << 30

◆ VEHPARS_PERIOD_SET

◆ VEHPARS_PERSON_CAPACITY_SET

const int VEHPARS_PERSON_CAPACITY_SET = 2 << 18

Definition at line 62 of file SUMOVehicleParameter.h.

◆ VEHPARS_PERSON_NUMBER_SET

◆ VEHPARS_POISSON_SET

◆ VEHPARS_PROB_SET

◆ VEHPARS_ROUTE_SET

◆ VEHPARS_SPEEDFACTOR_SET

◆ VEHPARS_TO_TAZ_SET

◆ VEHPARS_VIA_SET

const int VEHPARS_VIA_SET = 2 << 23

Definition at line 67 of file SUMOVehicleParameter.h.

Referenced by GNEVehicle::setAttribute().

◆ VEHPARS_VPH_SET

◆ VEHPARS_VTYPE_SET