SUMO - Simulation of Urban MObility
SUMOVehicleParameter Class Reference

Structure representing possible vehicle parameter. More...

#include <SUMOVehicleParameter.h>

Inheritance diagram for SUMOVehicleParameter:
Inheritance graph
Collaboration diagram for SUMOVehicleParameter:
Collaboration graph

Data Structures

struct  Stop
 Definition of vehicle stop (position and duration) More...
 

Public Member Functions

void clearParameter ()
 Clears the parameter map. More...
 
bool defaultOptionOverrides (const OptionsCont &oc, const std::string &optionName) const
 Returns whether the defaults shall be used. More...
 
double getDouble (const std::string &key, const double defaultValue) const
 Returns the value for a given key converted to a double. More...
 
const std::string getParameter (const std::string &key, const std::string &defaultValue="") const
 Returns the value for a given key. More...
 
const std::map< std::string, std::string > & getParametersMap () const
 Returns the inner key/value map. More...
 
bool knowsParameter (const std::string &key) const
 Returns whether the parameter is known. More...
 
void setParameter (const std::string &key, const std::string &value)
 Sets a parameter. More...
 
 SUMOVehicleParameter ()
 Constructor. More...
 
void unsetParameter (const std::string &key)
 Removes a parameter. More...
 
void updateParameter (const std::map< std::string, std::string > &mapArg)
 Adds or updates all given parameters from the map. More...
 
bool wasSet (int what) const
 Returns whether the given parameter was set. More...
 
void write (OutputDevice &dev, const OptionsCont &oc, const SumoXMLTag tag=SUMO_TAG_VEHICLE, const std::string &typeID="") const
 Writes the parameters as a beginning element. More...
 
void writeParams (OutputDevice &device) const
 write Params in the given outputdevice More...
 
 ~SUMOVehicleParameter ()
 Destructor. More...
 

Static Public Member Functions

static double interpretEdgePos (double pos, double maximumValue, SumoXMLAttr attr, const std::string &id)
 Interprets negative edge positions and fits them onto a given edge. More...
 
Depart/arrival-attributes verification
static bool parseDepart (const std::string &val, const std::string &element, const std::string &id, SUMOTime &depart, DepartDefinition &dd, std::string &error)
 Validates a given depart value. More...
 
static bool parseDepartLane (const std::string &val, const std::string &element, const std::string &id, int &lane, DepartLaneDefinition &dld, std::string &error)
 Validates a given departLane value. More...
 
static bool parseDepartPos (const std::string &val, const std::string &element, const std::string &id, double &pos, DepartPosDefinition &dpd, std::string &error)
 Validates a given departPos value. More...
 
static bool parseDepartPosLat (const std::string &val, const std::string &element, const std::string &id, double &pos, DepartPosLatDefinition &dpd, std::string &error)
 Validates a given departPosLat value. More...
 
static bool parseDepartSpeed (const std::string &val, const std::string &element, const std::string &id, double &speed, DepartSpeedDefinition &dsd, std::string &error)
 Validates a given departSpeed value. More...
 
static bool parseArrivalLane (const std::string &val, const std::string &element, const std::string &id, int &lane, ArrivalLaneDefinition &ald, std::string &error)
 Validates a given arrivalLane value. More...
 
static bool parseArrivalPos (const std::string &val, const std::string &element, const std::string &id, double &pos, ArrivalPosDefinition &apd, std::string &error)
 Validates a given arrivalPos value. More...
 
static bool parseArrivalPosLat (const std::string &val, const std::string &element, const std::string &id, double &pos, ArrivalPosLatDefinition &apd, std::string &error)
 Validates a given arrivalPosLat value. More...
 
static bool parseArrivalSpeed (const std::string &val, const std::string &element, const std::string &id, double &speed, ArrivalSpeedDefinition &asd, std::string &error)
 Validates a given arrivalSpeed value. More...
 

Data Fields

RGBColor color
 The vehicle's color, TraCI may change this. More...
 
int containerNumber
 The static number of containers in the vehicle when it departs. More...
 
std::string fromTaz
 The vehicle's origin zone (district) More...
 
std::string id
 The vehicle's id. More...
 
std::string line
 The vehicle's line (mainly for public transport) More...
 
int parametersSet
 Information for the router which parameter were set, TraCI may modify this (whe changing color) More...
 
int personNumber
 The static number of persons in the vehicle when it departs (not including boarding persons) More...
 
std::string routeid
 The vehicle's route id. More...
 
std::vector< Stopstops
 List of the stops the vehicle will make, TraCI may add entries here. More...
 
std::string toTaz
 The vehicle's destination zone (district) More...
 
std::vector< std::string > via
 List of the via-edges the vehicle must visit. More...
 
std::string vtypeid
 The vehicle's type id. More...
 
Departure definition
SUMOTime depart
 The vehicle's departure time. More...
 
DepartDefinition departProcedure
 Information how the vehicle shall choose the depart time. More...
 
int departLane
 (optional) The lane the vehicle shall depart from (index in edge) More...
 
DepartLaneDefinition departLaneProcedure
 Information how the vehicle shall choose the lane to depart from. More...
 
double departPos
 (optional) The position the vehicle shall depart from More...
 
DepartPosDefinition departPosProcedure
 Information how the vehicle shall choose the departure position. More...
 
double departPosLat
 (optional) The lateral position the vehicle shall depart from More...
 
DepartPosLatDefinition departPosLatProcedure
 Information how the vehicle shall choose the lateral departure position. More...
 
double departSpeed
 (optional) The initial speed of the vehicle More...
 
DepartSpeedDefinition departSpeedProcedure
 Information how the vehicle's initial speed shall be chosen. More...
 
Arrival definition
int arrivalLane
 (optional) The lane the vehicle shall arrive on (not used yet) More...
 
ArrivalLaneDefinition arrivalLaneProcedure
 Information how the vehicle shall choose the lane to arrive on. More...
 
double arrivalPos
 (optional) The position the vehicle shall arrive on More...
 
ArrivalPosDefinition arrivalPosProcedure
 Information how the vehicle shall choose the arrival position. More...
 
double arrivalPosLat
 (optional) The lateral position the vehicle shall arrive on More...
 
ArrivalPosLatDefinition arrivalPosLatProcedure
 Information how the vehicle shall choose the lateral arrival position. More...
 
double arrivalSpeed
 (optional) The final speed of the vehicle (not used yet) More...
 
ArrivalSpeedDefinition arrivalSpeedProcedure
 Information how the vehicle's end speed shall be chosen. More...
 
Repetition definition
int repetitionNumber
 The number of times the vehicle shall be repeatedly inserted. More...
 
int repetitionsDone
 The number of times the vehicle was already inserted. More...
 
SUMOTime repetitionOffset
 The time offset between vehicle reinsertions. More...
 
double repetitionProbability
 The probability for emitting a vehicle per second. More...
 
SUMOTime repetitionEnd
 The time at which the flow ends (only needed when using repetitionProbability) More...
 

Detailed Description

Structure representing possible vehicle parameter.

When used within a vehicle, parameter are usually const except for selected items adaptable via TraCI which are flagged as mutable below The fields yielding with "Procedure" describe whether the according value shall be used or another procedure is used to choose the value.

See also
DepartLaneDefinition
DepartPosDefinition
DepartSpeedDefinition

Definition at line 280 of file SUMOVehicleParameter.h.

Constructor & Destructor Documentation

◆ SUMOVehicleParameter()

SUMOVehicleParameter::SUMOVehicleParameter ( )

Constructor.

Initialises the structure with default values

Definition at line 37 of file SUMOVehicleParameter.cpp.

◆ ~SUMOVehicleParameter()

SUMOVehicleParameter::~SUMOVehicleParameter ( )

Destructor.

Definition at line 52 of file SUMOVehicleParameter.cpp.

Member Function Documentation

◆ clearParameter()

◆ defaultOptionOverrides()

bool SUMOVehicleParameter::defaultOptionOverrides ( const OptionsCont oc,
const std::string &  optionName 
) const

Returns whether the defaults shall be used.

Parameters
[in]ocThe options to get the options from
[in]optionNameThe name of the option to determine whether its value shall be used
Returns
Whether the option is set and –defaults-override was set

Definition at line 56 of file SUMOVehicleParameter.cpp.

References OptionsCont::exists(), OptionsCont::getBool(), and OptionsCont::isSet().

Referenced by wasSet(), and write().

◆ getDouble()

◆ getParameter()

const std::string Parameterised::getParameter ( const std::string &  key,
const std::string &  defaultValue = "" 
) const
inherited

Returns the value for a given key.

Parameters
[in]keyThe key to ask for
[in]defaultValueThe default value to return if no value is stored under the key
Returns
The value stored under the key

Definition at line 71 of file Parameterised.cpp.

References Parameterised::myMap.

Referenced by MSTLLogicControl::WAUTSwitchProcedure_Stretch::adaptLogic(), NBEdge::addRestrictedLane(), MSDevice_Battery::buildVehicleDevices(), MSDevice_Bluelight::buildVehicleDevices(), MSDevice_Example::buildVehicleDevices(), MSDevice::equippedByParameter(), libsumo::Simulation::findIntermodalRoute(), MSDevice::getBoolParam(), NBRailwayTopologyAnalyzer::getBrokenRailNodes(), GNELane::getColorValue(), GUILane::getColorValue(), MSSOTLTrafficLightLogic::getDecayConstant(), MSDevice_SSM::getDetectionRange(), MSDevice_SSM::getExtraTime(), MSDevice::getFloatParam(), MSTLLogicControl::WAUTSwitchProcedure::getGSPValue(), MSSOTLTrafficLightLogic::getInputSensorsLength(), MSDevice_SSM::getMeasuresAndThresholds(), MSSOTLRequestPolicy::getMinDecisionalPhaseDuration(), MSSOTLTrafficLightLogic::getMode(), MSDevice_ToC::getOutputFilename(), MSDevice_SSM::getOutputFilename(), MSSOTLTrafficLightLogic::getOutputSensorsLength(), libsumo::Polygon::getParameter(), libsumo::Route::getParameter(), libsumo::POI::getParameter(), libsumo::Person::getParameter(), libsumo::TrafficLight::getParameter(), libsumo::Edge::getParameter(), libsumo::Lane::getParameter(), libsumo::VehicleType::getParameter(), libsumo::Vehicle::getParameter(), MSSOTLTrafficLightLogic::getSpeedThreshold(), MSTLLogicControl::WAUTSwitchProcedure_Stretch::getStretchAreaNo(), MSTLLogicControl::WAUTSwitchProcedure_Stretch::getStretchBereichDef(), MSDevice::getStringParam(), MSSOTLTrafficLightLogic::getThreshold(), MSTriggeredRerouter::getWeight(), PushButtonLogic::init(), MSSOTLPhasePolicy::init(), SigmoidLogic::init(), MSSOTLTrafficLightLogic::init(), MSSwarmTrafficLightLogic::init(), NIImporter_OpenStreetMap::insertEdge(), MSSOTLTrafficLightLogic::isDecayThresholdActivated(), MSSOTLTrafficLightLogic::isPushButtonPressed(), libsumo::Helper::moveToXYMap(), MSActuatedTrafficLightLogic::MSActuatedTrafficLightLogic(), MSDelayBasedTrafficLightLogic::MSDelayBasedTrafficLightLogic(), MSSOTLPolicy::MSSOTLPolicy(), MSSOTLPolicy5DFamilyStimulus::MSSOTLPolicy5DFamilyStimulus(), MSSwarmTrafficLightLogic::MSSwarmTrafficLightLogic(), MSTriggeredRerouter::notifyEnter(), MSDevice_SSM::requestsTrajectories(), NBEdgeCont::splitAt(), MSTLLogicControl::WAUTSwitchProcedure_Stretch::stretchLogic(), MSDevice_SSM::useGeoCoords(), and NWWriter_DlrNavteq::writeLinksUnsplitted().

◆ getParametersMap()

◆ interpretEdgePos()

double SUMOVehicleParameter::interpretEdgePos ( double  pos,
double  maximumValue,
SumoXMLAttr  attr,
const std::string &  id 
)
static

Interprets negative edge positions and fits them onto a given edge.

Parameters
[in]posThe position to be interpreted
[in]maximumValueThe maximum allowed value (edge length)
[in]attrThe attribute from which the value originated
[in]idThe id of the object to which this attribute belongs
Returns
Whether the interpreted position

Definition at line 588 of file SUMOVehicleParameter.cpp.

References toString(), and WRITE_WARNING.

Referenced by MSContainer::MSContainerStage_Tranship::MSContainerStage_Tranship(), MSPerson::MSPersonStage_Walking::MSPersonStage_Walking(), SUMOVehicleParserHelper::parseWalkPos(), and wasSet().

◆ knowsParameter()

◆ parseArrivalLane()

bool SUMOVehicleParameter::parseArrivalLane ( const std::string &  val,
const std::string &  element,
const std::string &  id,
int &  lane,
ArrivalLaneDefinition ald,
std::string &  error 
)
static

Validates a given arrivalLane value.

Parameters
[in]valThe arrivalLane value to parse
[in]elementThe name of the type of the parsed element, for building the error message
[in]idThe id of the parsed element, for building the error message
[out]laneThe parsed lane, if given
[out]aldThe parsed arrivalLane definition
[out]errorError message, if an error occures
Returns
Whether the given value is a valid arrivalLane definition

Definition at line 490 of file SUMOVehicleParameter.cpp.

References ARRIVAL_LANE_CURRENT, ARRIVAL_LANE_GIVEN, and StringUtils::toInt().

Referenced by libsumo::Vehicle::add(), ROJTRFrame::checkOptions(), RODUAFrame::checkOptions(), checkOptions(), SUMOVehicleParserHelper::parseCommonAttributes(), and wasSet().

◆ parseArrivalPos()

bool SUMOVehicleParameter::parseArrivalPos ( const std::string &  val,
const std::string &  element,
const std::string &  id,
double &  pos,
ArrivalPosDefinition apd,
std::string &  error 
)
static

Validates a given arrivalPos value.

Parameters
[in]valThe arrivalPos value to parse
[in]elementThe name of the type of the parsed element, for building the error message
[in]idThe id of the parsed element, for building the error message
[out]posThe parsed position, if given
[out]apdThe parsed arrivalPos definition
[out]errorError message, if an error occures
Returns
Whether the given value is a valid arrivalPos definition

Definition at line 514 of file SUMOVehicleParameter.cpp.

References ARRIVAL_POS_CENTER, ARRIVAL_POS_GIVEN, ARRIVAL_POS_MAX, ARRIVAL_POS_RANDOM, and StringUtils::toDouble().

Referenced by libsumo::Vehicle::add(), ROJTRFrame::checkOptions(), RODUAFrame::checkOptions(), checkOptions(), SUMOVehicleParserHelper::parseCommonAttributes(), SUMOVehicleParserHelper::parseWalkPos(), and wasSet().

◆ parseArrivalPosLat()

bool SUMOVehicleParameter::parseArrivalPosLat ( const std::string &  val,
const std::string &  element,
const std::string &  id,
double &  pos,
ArrivalPosLatDefinition apd,
std::string &  error 
)
static

Validates a given arrivalPosLat value.

Parameters
[in]valThe arrivalPosLat value to parse
[in]elementThe name of the type of the parsed element, for building the error message
[in]idThe id of the parsed element, for building the error message
[out]posThe parsed position, if given
[out]apdThe parsed arrivalPos definition
[out]errorError message, if an error occures
Returns
Whether the given value is a valid arrivalPos definition

Definition at line 539 of file SUMOVehicleParameter.cpp.

References ARRIVAL_POSLAT_CENTER, ARRIVAL_POSLAT_GIVEN, ARRIVAL_POSLAT_LEFT, ARRIVAL_POSLAT_RIGHT, and StringUtils::toDouble().

Referenced by SUMOVehicleParserHelper::parseCommonAttributes(), and wasSet().

◆ parseArrivalSpeed()

bool SUMOVehicleParameter::parseArrivalSpeed ( const std::string &  val,
const std::string &  element,
const std::string &  id,
double &  speed,
ArrivalSpeedDefinition asd,
std::string &  error 
)
static

Validates a given arrivalSpeed value.

Parameters
[in]valThe arrivalSpeed value to parse
[in]elementThe name of the type of the parsed element, for building the error message
[in]idThe id of the parsed element, for building the error message
[out]speedThe parsed speed, if given
[out]asdThe parsed arrivalSpeed definition
[out]errorError message, if an error occures
Returns
Whether the given value is a valid arrivalSpeed definition

Definition at line 564 of file SUMOVehicleParameter.cpp.

References ARRIVAL_SPEED_CURRENT, ARRIVAL_SPEED_GIVEN, and StringUtils::toDouble().

Referenced by libsumo::Vehicle::add(), ROJTRFrame::checkOptions(), RODUAFrame::checkOptions(), checkOptions(), SUMOVehicleParserHelper::parseCommonAttributes(), and wasSet().

◆ parseDepart()

bool SUMOVehicleParameter::parseDepart ( const std::string &  val,
const std::string &  element,
const std::string &  id,
SUMOTime depart,
DepartDefinition dd,
std::string &  error 
)
static

Validates a given depart value.

Parameters
[in]valThe depart value to parse
[in]elementThe name of the type of the parsed element, for building the error message
[in]idThe id of the parsed element, for building the error message
[out]departThe parsed depart time, if given
[out]ddThe parsed departProcedure definition
[out]errorError message, if an error occures
Returns
Whether the given value is a valid depart definition

Definition at line 345 of file SUMOVehicleParameter.cpp.

References DEPART_CONTAINER_TRIGGERED, DEPART_GIVEN, DEPART_NOW, DEPART_TRIGGERED, and string2time().

Referenced by libsumo::Vehicle::add(), SUMOVehicleParserHelper::parseVehicleAttributes(), and wasSet().

◆ parseDepartLane()

bool SUMOVehicleParameter::parseDepartLane ( const std::string &  val,
const std::string &  element,
const std::string &  id,
int &  lane,
DepartLaneDefinition dld,
std::string &  error 
)
static

Validates a given departLane value.

Parameters
[in]valThe departLane value to parse
[in]elementThe name of the type of the parsed element, for building the error message
[in]idThe id of the parsed element, for building the error message
[out]laneThe parsed lane, if given
[out]dldThe parsed departLane definition
[out]errorError message, if an error occures
Returns
Whether the given value is a valid departLane definition

Definition at line 372 of file SUMOVehicleParameter.cpp.

References DEPART_LANE_ALLOWED_FREE, DEPART_LANE_BEST_FREE, DEPART_LANE_FIRST_ALLOWED, DEPART_LANE_FREE, DEPART_LANE_GIVEN, DEPART_LANE_RANDOM, and StringUtils::toInt().

Referenced by libsumo::Vehicle::add(), ROJTRFrame::checkOptions(), RODUAFrame::checkOptions(), checkOptions(), SUMOVehicleParserHelper::parseCommonAttributes(), and wasSet().

◆ parseDepartPos()

bool SUMOVehicleParameter::parseDepartPos ( const std::string &  val,
const std::string &  element,
const std::string &  id,
double &  pos,
DepartPosDefinition dpd,
std::string &  error 
)
static

Validates a given departPos value.

Parameters
[in]valThe departPos value to parse
[in]elementThe name of the type of the parsed element, for building the error message
[in]idThe id of the parsed element, for building the error message
[out]posThe parsed position, if given
[out]dpdThe parsed departPos definition
[out]errorError message, if an error occures
Returns
Whether the given value is a valid departPos definition

Definition at line 404 of file SUMOVehicleParameter.cpp.

References DEPART_POS_BASE, DEPART_POS_FREE, DEPART_POS_GIVEN, DEPART_POS_LAST, DEPART_POS_RANDOM, DEPART_POS_RANDOM_FREE, and StringUtils::toDouble().

Referenced by libsumo::Vehicle::add(), ROJTRFrame::checkOptions(), RODUAFrame::checkOptions(), checkOptions(), SUMOVehicleParserHelper::parseCommonAttributes(), and wasSet().

◆ parseDepartPosLat()

bool SUMOVehicleParameter::parseDepartPosLat ( const std::string &  val,
const std::string &  element,
const std::string &  id,
double &  pos,
DepartPosLatDefinition dpd,
std::string &  error 
)
static

Validates a given departPosLat value.

Parameters
[in]valThe departPosLat value to parse
[in]elementThe name of the type of the parsed element, for building the error message
[in]idThe id of the parsed element, for building the error message
[out]posThe parsed position, if given
[out]dpdThe parsed departPos definition
[out]errorError message, if an error occures
Returns
Whether the given value is a valid departPos definition

Definition at line 433 of file SUMOVehicleParameter.cpp.

References DEPART_POSLAT_CENTER, DEPART_POSLAT_FREE, DEPART_POSLAT_GIVEN, DEPART_POSLAT_LEFT, DEPART_POSLAT_RANDOM, DEPART_POSLAT_RANDOM_FREE, DEPART_POSLAT_RIGHT, and StringUtils::toDouble().

Referenced by SUMOVehicleParserHelper::parseCommonAttributes(), and wasSet().

◆ parseDepartSpeed()

bool SUMOVehicleParameter::parseDepartSpeed ( const std::string &  val,
const std::string &  element,
const std::string &  id,
double &  speed,
DepartSpeedDefinition dsd,
std::string &  error 
)
static

Validates a given departSpeed value.

Parameters
[in]valThe departSpeed value to parse
[in]elementThe name of the type of the parsed element, for building the error message
[in]idThe id of the parsed element, for building the error message
[out]speedThe parsed speed, if given
[out]dsdThe parsed departSpeed definition
[out]errorError message, if an error occures
Returns
Whether the given value is a valid departSpeed definition

Definition at line 464 of file SUMOVehicleParameter.cpp.

References DEPART_SPEED_GIVEN, DEPART_SPEED_MAX, DEPART_SPEED_RANDOM, and StringUtils::toDouble().

Referenced by libsumo::Vehicle::add(), ROJTRFrame::checkOptions(), RODUAFrame::checkOptions(), checkOptions(), SUMOVehicleParserHelper::parseCommonAttributes(), and wasSet().

◆ setParameter()

◆ unsetParameter()

void Parameterised::unsetParameter ( const std::string &  key)
inherited

Removes a parameter.

Parameters
[in]keyThe parameter's name

Definition at line 51 of file Parameterised.cpp.

References Parameterised::myMap.

◆ updateParameter()

void Parameterised::updateParameter ( const std::map< std::string, std::string > &  mapArg)
inherited

◆ wasSet()

◆ write()

void SUMOVehicleParameter::write ( OutputDevice dev,
const OptionsCont oc,
const SumoXMLTag  tag = SUMO_TAG_VEHICLE,
const std::string &  typeID = "" 
) const

Writes the parameters as a beginning element.

Parameters
[in,out]devThe device to write into
[in]ocThe options to get defaults from
[in]tagThe "root" tag to write (defaults to vehicle)
[in]tagThe typeID to write (defaults to member vtypeid)
Exceptions
IOErrornot yet implemented

Definition at line 62 of file SUMOVehicleParameter.cpp.

References ARRIVAL_LANE_CURRENT, ARRIVAL_LANE_DEFAULT, ARRIVAL_LANE_GIVEN, ARRIVAL_POS_CENTER, ARRIVAL_POS_DEFAULT, ARRIVAL_POS_GIVEN, ARRIVAL_POS_MAX, ARRIVAL_POS_RANDOM, ARRIVAL_POSLAT_CENTER, ARRIVAL_POSLAT_DEFAULT, ARRIVAL_POSLAT_GIVEN, ARRIVAL_POSLAT_LEFT, ARRIVAL_POSLAT_RIGHT, ARRIVAL_SPEED_CURRENT, ARRIVAL_SPEED_DEFAULT, ARRIVAL_SPEED_GIVEN, arrivalLane, arrivalLaneProcedure, arrivalPos, arrivalPosLatProcedure, arrivalPosProcedure, arrivalSpeed, arrivalSpeedProcedure, color, containerNumber, defaultOptionOverrides(), depart, DEPART_CONTAINER_TRIGGERED, DEPART_LANE_ALLOWED_FREE, DEPART_LANE_BEST_FREE, DEPART_LANE_DEFAULT, DEPART_LANE_FIRST_ALLOWED, DEPART_LANE_FREE, DEPART_LANE_GIVEN, DEPART_LANE_RANDOM, DEPART_POS_BASE, DEPART_POS_DEFAULT, DEPART_POS_FREE, DEPART_POS_GIVEN, DEPART_POS_LAST, DEPART_POS_RANDOM, DEPART_POS_RANDOM_FREE, DEPART_POSLAT_CENTER, DEPART_POSLAT_DEFAULT, DEPART_POSLAT_FREE, DEPART_POSLAT_GIVEN, DEPART_POSLAT_LEFT, DEPART_POSLAT_RANDOM, DEPART_POSLAT_RANDOM_FREE, DEPART_POSLAT_RIGHT, DEPART_SPEED_DEFAULT, DEPART_SPEED_GIVEN, DEPART_SPEED_MAX, DEPART_SPEED_RANDOM, DEPART_TRIGGERED, departLane, departLaneProcedure, departPos, departPosLatProcedure, departPosProcedure, departProcedure, departSpeed, departSpeedProcedure, OptionsCont::exists(), fromTaz, OptionsCont::getString(), OptionsCont::isSet(), line, OutputDevice::openTag(), personNumber, SUMO_ATTR_ARRIVALLANE, SUMO_ATTR_ARRIVALPOS, SUMO_ATTR_ARRIVALPOS_LAT, SUMO_ATTR_ARRIVALSPEED, SUMO_ATTR_COLOR, SUMO_ATTR_CONTAINER_NUMBER, SUMO_ATTR_DEPART, SUMO_ATTR_DEPARTLANE, SUMO_ATTR_DEPARTPOS, SUMO_ATTR_DEPARTPOS_LAT, SUMO_ATTR_DEPARTSPEED, SUMO_ATTR_FROM_TAZ, SUMO_ATTR_ID, SUMO_ATTR_LINE, SUMO_ATTR_PERSON_NUMBER, SUMO_ATTR_TO_TAZ, SUMO_ATTR_TYPE, time2string(), toString(), toTaz, VEHPARS_ARRIVALLANE_SET, VEHPARS_ARRIVALPOS_SET, VEHPARS_ARRIVALPOSLAT_SET, VEHPARS_ARRIVALSPEED_SET, VEHPARS_COLOR_SET, VEHPARS_CONTAINER_NUMBER_SET, VEHPARS_DEPARTLANE_SET, VEHPARS_DEPARTPOS_SET, VEHPARS_DEPARTPOSLAT_SET, VEHPARS_DEPARTSPEED_SET, VEHPARS_FROM_TAZ_SET, VEHPARS_LINE_SET, VEHPARS_PERSON_NUMBER_SET, VEHPARS_TO_TAZ_SET, VEHPARS_VTYPE_SET, vtypeid, wasSet(), OutputDevice::writeAttr(), and OutputDevice::writeNonEmptyAttr().

Referenced by MSPerson::routeOutput(), ROVehicle::saveAsXML(), ROPerson::saveAsXML(), MSBaseVehicle::saveState(), and wasSet().

◆ writeParams()

Field Documentation

◆ arrivalLane

int SUMOVehicleParameter::arrivalLane

◆ arrivalLaneProcedure

◆ arrivalPos

◆ arrivalPosLat

double SUMOVehicleParameter::arrivalPosLat

(optional) The lateral position the vehicle shall arrive on

Definition at line 498 of file SUMOVehicleParameter.h.

Referenced by MSLCM_SL2015::_wantsChangeSublane(), and SUMOVehicleParserHelper::parseCommonAttributes().

◆ arrivalPosLatProcedure

ArrivalPosLatDefinition SUMOVehicleParameter::arrivalPosLatProcedure

Information how the vehicle shall choose the lateral arrival position.

Definition at line 500 of file SUMOVehicleParameter.h.

Referenced by MSLCM_SL2015::_wantsChangeSublane(), SUMOVehicleParserHelper::parseCommonAttributes(), and write().

◆ arrivalPosProcedure

◆ arrivalSpeed

◆ arrivalSpeedProcedure

◆ color

◆ containerNumber

int SUMOVehicleParameter::containerNumber

The static number of containers in the vehicle when it departs.

Definition at line 590 of file SUMOVehicleParameter.h.

Referenced by MSBaseVehicle::getContainerNumber(), SUMOVehicleParserHelper::parseCommonAttributes(), and write().

◆ depart

SUMOTime SUMOVehicleParameter::depart

◆ departLane

int SUMOVehicleParameter::departLane

◆ departLaneProcedure

◆ departPos

◆ departPosLat

double SUMOVehicleParameter::departPosLat

(optional) The lateral position the vehicle shall depart from

Definition at line 476 of file SUMOVehicleParameter.h.

Referenced by MSLane::getDepartPosLat(), and SUMOVehicleParserHelper::parseCommonAttributes().

◆ departPosLatProcedure

DepartPosLatDefinition SUMOVehicleParameter::departPosLatProcedure

Information how the vehicle shall choose the lateral departure position.

Definition at line 478 of file SUMOVehicleParameter.h.

Referenced by MSLane::getDepartPosLat(), MSLane::insertVehicle(), SUMOVehicleParserHelper::parseCommonAttributes(), and write().

◆ departPosProcedure

◆ departProcedure

◆ departSpeed

◆ departSpeedProcedure

◆ fromTaz

◆ id

std::string SUMOVehicleParameter::id

The vehicle's id.

Definition at line 451 of file SUMOVehicleParameter.h.

Referenced by libsumo::Person::add(), MSTransportableControl::add(), libsumo::Vehicle::add(), MSInsertionControl::addFlow(), RONet::addFlow(), MSRouteHandler::addPersonTrip(), RORouteHandler::addPersonTrip(), IntermodalNetwork< E, L, N, V >::addSchedule(), MSRouteHandler::addStop(), RORouteHandler::addStop(), MSVehicle::addStop(), ROPerson::addTrip(), MSRouteHandler::addWalk(), RORouteHandler::addWalk(), MSTransportableControl::boardAnyWaiting(), RONet::checkFlows(), SUMORouteHandler::checkLastDepart(), MSRouteHandler::closeContainer(), RORouteHandler::closeContainer(), MSRouteHandler::closeFlow(), RORouteHandler::closeFlow(), MSRouteHandler::closePerson(), RORouteHandler::closePerson(), MSRouteHandler::closeRoute(), RORouteHandler::closeRoute(), MSStateHandler::closeVehicle(), MSRouteHandler::closeVehicle(), RORouteHandler::closeVehicle(), MSInsertionControl::determineCandidates(), METriggeredCalibrator::execute(), MSCalibrator::execute(), MSBaseVehicle::getID(), RORoutable::getID(), MSTransportable::getID(), MSEdge::insertVehicle(), MSTransportableControl::loadAnyWaiting(), MEVehicle::MEVehicle(), MSBaseVehicle::MSBaseVehicle(), MSVehicle::MSVehicle(), ROMARouteHandler::myEndElement(), MSStateHandler::myStartElement(), MSRouteHandler::myStartElement(), RORouteHandler::myStartElement(), SUMORouteHandler::myStartElement(), MSRouteHandler::openRoute(), RORouteHandler::openRoute(), MSRouteHandler::openRouteDistribution(), RORouteHandler::openRouteDistribution(), SUMOVehicleParserHelper::parseCommonAttributes(), MSRouteHandler::parseFromViaTo(), RORouteHandler::parseFromViaTo(), SUMOVehicleParserHelper::parseVehicleAttributes(), and MSVehicle::replaceParkingArea().

◆ line

◆ parametersSet

◆ personNumber

int SUMOVehicleParameter::personNumber

The static number of persons in the vehicle when it departs (not including boarding persons)

Definition at line 587 of file SUMOVehicleParameter.h.

Referenced by libsumo::Vehicle::add(), MSBaseVehicle::getPersonNumber(), SUMOVehicleParserHelper::parseCommonAttributes(), and write().

◆ repetitionEnd

SUMOTime SUMOVehicleParameter::repetitionEnd

The time at which the flow ends (only needed when using repetitionProbability)

Definition at line 520 of file SUMOVehicleParameter.h.

Referenced by RONet::checkFlows(), and MSInsertionControl::determineCandidates().

◆ repetitionNumber

◆ repetitionOffset

◆ repetitionProbability

double SUMOVehicleParameter::repetitionProbability

The probability for emitting a vehicle per second.

Definition at line 518 of file SUMOVehicleParameter.h.

Referenced by RONet::checkFlows(), MSRouteHandler::closeFlow(), and MSInsertionControl::determineCandidates().

◆ repetitionsDone

int SUMOVehicleParameter::repetitionsDone

The number of times the vehicle was already inserted.

Definition at line 514 of file SUMOVehicleParameter.h.

Referenced by MSBaseVehicle::addStops(), RONet::checkFlows(), MSRouteHandler::closeFlow(), RORouteHandler::closeFlow(), and MSInsertionControl::determineCandidates().

◆ routeid

◆ stops

std::vector<Stop> SUMOVehicleParameter::stops
mutable

◆ toTaz

◆ via

std::vector<std::string> SUMOVehicleParameter::via
mutable

◆ vtypeid


The documentation for this class was generated from the following files: