SUMO - Simulation of Urban MObility
TraCIAPI::VehicleScope Class Reference

Scope for interaction with vehicles. More...

#include <TraCIAPI.h>

Inheritance diagram for TraCIAPI::VehicleScope:
Inheritance graph
Collaboration diagram for TraCIAPI::VehicleScope:
Collaboration graph

Data Structures

struct  NextTLSData
 

Public Member Functions

void add (const std::string &vehicleID, const std::string &routeID, const std::string &typeID="DEFAULT_VEHTYPE", std::string depart="-1", const std::string &departLane="first", const std::string &departPos="base", const std::string &departSpeed="0", const std::string &arrivalLane="current", const std::string &arrivalPos="max", const std::string &arrivalSpeed="current", const std::string &fromTaz="", const std::string &toTaz="", const std::string &line="", int personCapacity=0, int personNumber=0) const
 
void changeTarget (const std::string &vehicleID, const std::string &edgeID) const
 
double getAngle (const std::string &vehicleID) const
 
double getCO2Emission (const std::string &vehicleID) const
 
double getCOEmission (const std::string &vehicleID) const
 
TraCIColor getColor (const std::string &vehicleID) const
 
std::vector< std::string > getEdges (const std::string &vehicleID) const
 
double getElectricityConsumption (const std::string &vehicleID) const
 
std::string getEmissionClass (const std::string &vehicleID) const
 
double getFuelConsumption (const std::string &vehicleID) const
 
double getHCEmission (const std::string &vehicleID) const
 
int getIDCount () const
 
std::vector< std::string > getIDList () const
 
std::string getLaneID (const std::string &vehicleID) const
 
int getLaneIndex (const std::string &vehicleID) const
 
double getLanePosition (const std::string &vehicleID) const
 
double getLateralLanePosition (const std::string &vehicleID) const
 
std::string getLine (const std::string &vehicleID) const
 
double getMaxSpeed (const std::string &vehicleID) const
 
std::vector< NextTLSDatagetNextTLS (const std::string &vehID) const
 
double getNoiseEmission (const std::string &vehicleID) const
 
double getNOxEmission (const std::string &vehicleID) const
 
double getPMxEmission (const std::string &vehicleID) const
 
TraCIPosition getPosition (const std::string &vehicleID) const
 
std::string getRoadID (const std::string &vehicleID) const
 
std::string getRouteID (const std::string &vehicleID) const
 
int getRouteIndex (const std::string &vehicleID) const
 
std::string getShapeClass (const std::string &vehicleID) const
 
int getSignalStates (const std::string &vehicleID) const
 
double getSlope (const std::string &vehicleID) const
 
double getSpeed (const std::string &vehicleID) const
 
int getSpeedMode (const std::string &vehicleID) const
 
std::string getTypeID (const std::string &vehicleID) const
 
std::vector< std::string > getVia (const std::string &vehicleID) const
 
double getWaitingTime (const std::string &vehicleID) const
 
void moveTo (const std::string &vehicleID, const std::string &laneID, double position) const
 
void moveToXY (const std::string &vehicleID, const std::string &edgeID, const int lane, const double x, const double y, const double angle, const int keepRoute) const
 
void remove (const std::string &vehicleID, char reason=REMOVE_VAPORIZED) const
 
void setColor (const std::string &vehicleID, const TraCIColor &c) const
 
void setEmissionClass (const std::string &vehicleID, const std::string &clazz) const
 
void setLine (const std::string &vehicleID, const std::string &line) const
 
void setMaxSpeed (const std::string &vehicleID, double speed) const
 
void setShapeClass (const std::string &vehicleID, const std::string &clazz) const
 
void setSpeed (const std::string &vehicleID, double speed) const
 
void setVia (const std::string &vehicleID, const std::vector< std::string > &via) const
 
void slowDown (const std::string &vehicleID, double speed, int duration) const
 
 VehicleScope (TraCIAPI &parent)
 
virtual ~VehicleScope ()
 

Protected Attributes

TraCIAPImyParent
 The parent TraCI client which offers the connection. More...
 

Private Member Functions

VehicleScopeoperator= (const VehicleScope &src)
 invalidated assignment operator More...
 
 VehicleScope (const VehicleScope &src)
 invalidated copy constructor More...
 

Detailed Description

Scope for interaction with vehicles.

Definition at line 614 of file TraCIAPI.h.

Constructor & Destructor Documentation

◆ VehicleScope() [1/2]

TraCIAPI::VehicleScope::VehicleScope ( TraCIAPI parent)
inline

Definition at line 616 of file TraCIAPI.h.

◆ ~VehicleScope()

virtual TraCIAPI::VehicleScope::~VehicleScope ( )
inlinevirtual

Definition at line 617 of file TraCIAPI.h.

◆ VehicleScope() [2/2]

TraCIAPI::VehicleScope::VehicleScope ( const VehicleScope src)
private

invalidated copy constructor

Member Function Documentation

◆ add()

void TraCIAPI::VehicleScope::add ( const std::string &  vehicleID,
const std::string &  routeID,
const std::string &  typeID = "DEFAULT_VEHTYPE",
std::string  depart = "-1",
const std::string &  departLane = "first",
const std::string &  departPos = "base",
const std::string &  departSpeed = "0",
const std::string &  arrivalLane = "current",
const std::string &  arrivalPos = "max",
const std::string &  arrivalSpeed = "current",
const std::string &  fromTaz = "",
const std::string &  toTaz = "",
const std::string &  line = "",
int  personCapacity = 0,
int  personNumber = 0 
) const

◆ changeTarget()

void TraCIAPI::VehicleScope::changeTarget ( const std::string &  vehicleID,
const std::string &  edgeID 
) const

◆ getAngle()

double TraCIAPI::VehicleScope::getAngle ( const std::string &  vehicleID) const

Definition at line 1977 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_ANGLE.

◆ getCO2Emission()

double TraCIAPI::VehicleScope::getCO2Emission ( const std::string &  vehicleID) const

Definition at line 2032 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_CO2EMISSION.

◆ getCOEmission()

double TraCIAPI::VehicleScope::getCOEmission ( const std::string &  vehicleID) const

Definition at line 2037 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_COEMISSION.

◆ getColor()

TraCIColor TraCIAPI::VehicleScope::getColor ( const std::string &  vehicleID) const

Definition at line 2017 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_COLOR.

Referenced by TraCITestClient::testAPI().

◆ getEdges()

std::vector< std::string > TraCIAPI::VehicleScope::getEdges ( const std::string &  vehicleID) const

Definition at line 2012 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_EDGES.

Referenced by TraCITestClient::testAPI().

◆ getElectricityConsumption()

double TraCIAPI::VehicleScope::getElectricityConsumption ( const std::string &  vehicleID) const

Definition at line 2067 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_ELECTRICITYCONSUMPTION.

◆ getEmissionClass()

std::string TraCIAPI::VehicleScope::getEmissionClass ( const std::string &  vehicleID) const

Definition at line 2100 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_EMISSIONCLASS.

◆ getFuelConsumption()

double TraCIAPI::VehicleScope::getFuelConsumption ( const std::string &  vehicleID) const

Definition at line 2057 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_FUELCONSUMPTION.

◆ getHCEmission()

double TraCIAPI::VehicleScope::getHCEmission ( const std::string &  vehicleID) const

Definition at line 2042 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_HCEMISSION.

◆ getIDCount()

int TraCIAPI::VehicleScope::getIDCount ( ) const

Definition at line 1957 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and ID_COUNT.

Referenced by TraCITestClient::testAPI().

◆ getIDList()

std::vector< std::string > TraCIAPI::VehicleScope::getIDList ( ) const

Definition at line 1952 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and ID_LIST.

Referenced by TraCITestClient::testAPI().

◆ getLaneID()

std::string TraCIAPI::VehicleScope::getLaneID ( const std::string &  vehicleID) const

Definition at line 1987 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_LANE_ID.

Referenced by TraCITestClient::testAPI().

◆ getLaneIndex()

int TraCIAPI::VehicleScope::getLaneIndex ( const std::string &  vehicleID) const

Definition at line 1992 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_LANE_INDEX.

◆ getLanePosition()

double TraCIAPI::VehicleScope::getLanePosition ( const std::string &  vehicleID) const

Definition at line 2022 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_LANEPOSITION.

Referenced by TraCITestClient::testAPI().

◆ getLateralLanePosition()

double TraCIAPI::VehicleScope::getLateralLanePosition ( const std::string &  vehicleID) const

Definition at line 2027 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_LANEPOSITION_LAT.

Referenced by TraCITestClient::testAPI().

◆ getLine()

std::string TraCIAPI::VehicleScope::getLine ( const std::string &  vehicleID) const

Definition at line 2090 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_LINE.

Referenced by TraCITestClient::testAPI().

◆ getMaxSpeed()

double TraCIAPI::VehicleScope::getMaxSpeed ( const std::string &  vehicleID) const

Definition at line 1967 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_MAXSPEED.

Referenced by TraCITestClient::testAPI().

◆ getNextTLS()

◆ getNoiseEmission()

double TraCIAPI::VehicleScope::getNoiseEmission ( const std::string &  vehicleID) const

Definition at line 2062 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_NOISEEMISSION.

◆ getNOxEmission()

double TraCIAPI::VehicleScope::getNOxEmission ( const std::string &  vehicleID) const

Definition at line 2052 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_NOXEMISSION.

◆ getPMxEmission()

double TraCIAPI::VehicleScope::getPMxEmission ( const std::string &  vehicleID) const

Definition at line 2047 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_PMXEMISSION.

◆ getPosition()

TraCIPosition TraCIAPI::VehicleScope::getPosition ( const std::string &  vehicleID) const

Definition at line 1972 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_POSITION.

◆ getRoadID()

std::string TraCIAPI::VehicleScope::getRoadID ( const std::string &  vehicleID) const

Definition at line 1982 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_ROAD_ID.

Referenced by TraCITestClient::testAPI().

◆ getRouteID()

std::string TraCIAPI::VehicleScope::getRouteID ( const std::string &  vehicleID) const

Definition at line 2002 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_ROAD_ID.

◆ getRouteIndex()

int TraCIAPI::VehicleScope::getRouteIndex ( const std::string &  vehicleID) const

Definition at line 2007 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_ROUTE_INDEX.

◆ getShapeClass()

std::string TraCIAPI::VehicleScope::getShapeClass ( const std::string &  vehicleID) const

Definition at line 2105 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_SHAPECLASS.

Referenced by TraCITestClient::testAPI().

◆ getSignalStates()

int TraCIAPI::VehicleScope::getSignalStates ( const std::string &  vehicleID) const

◆ getSlope()

double TraCIAPI::VehicleScope::getSlope ( const std::string &  vehicleID) const

Definition at line 2084 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_SLOPE.

Referenced by TraCITestClient::testAPI().

◆ getSpeed()

double TraCIAPI::VehicleScope::getSpeed ( const std::string &  vehicleID) const

Definition at line 1962 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_SPEED.

◆ getSpeedMode()

int TraCIAPI::VehicleScope::getSpeedMode ( const std::string &  vehicleID) const

Definition at line 2078 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_SPEEDSETMODE.

Referenced by TraCITestClient::testAPI().

◆ getTypeID()

std::string TraCIAPI::VehicleScope::getTypeID ( const std::string &  vehicleID) const

Definition at line 1997 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_TYPE.

◆ getVia()

std::vector< std::string > TraCIAPI::VehicleScope::getVia ( const std::string &  vehicleID) const

Definition at line 2095 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_VIA.

Referenced by TraCITestClient::testAPI().

◆ getWaitingTime()

double TraCIAPI::VehicleScope::getWaitingTime ( const std::string &  vehicleID) const

Definition at line 2072 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_WAITING_TIME.

Referenced by TraCITestClient::testAPI().

◆ moveTo()

void TraCIAPI::VehicleScope::moveTo ( const std::string &  vehicleID,
const std::string &  laneID,
double  position 
) const

◆ moveToXY()

void TraCIAPI::VehicleScope::moveToXY ( const std::string &  vehicleID,
const std::string &  edgeID,
const int  lane,
const double  x,
const double  y,
const double  angle,
const int  keepRoute 
) const

Definition at line 2236 of file TraCIAPI.cpp.

References CMD_SET_VEHICLE_VARIABLE.

Referenced by TraCITestClient::testAPI().

◆ operator=()

VehicleScope& TraCIAPI::VehicleScope::operator= ( const VehicleScope src)
private

invalidated assignment operator

◆ remove()

void TraCIAPI::VehicleScope::remove ( const std::string &  vehicleID,
char  reason = REMOVE_VAPORIZED 
) const

◆ setColor()

void TraCIAPI::VehicleScope::setColor ( const std::string &  vehicleID,
const TraCIColor c 
) const

◆ setEmissionClass()

void TraCIAPI::VehicleScope::setEmissionClass ( const std::string &  vehicleID,
const std::string &  clazz 
) const

◆ setLine()

void TraCIAPI::VehicleScope::setLine ( const std::string &  vehicleID,
const std::string &  line 
) const

◆ setMaxSpeed()

void TraCIAPI::VehicleScope::setMaxSpeed ( const std::string &  vehicleID,
double  speed 
) const

◆ setShapeClass()

void TraCIAPI::VehicleScope::setShapeClass ( const std::string &  vehicleID,
const std::string &  clazz 
) const

◆ setSpeed()

void TraCIAPI::VehicleScope::setSpeed ( const std::string &  vehicleID,
double  speed 
) const

◆ setVia()

void TraCIAPI::VehicleScope::setVia ( const std::string &  vehicleID,
const std::vector< std::string > &  via 
) const

◆ slowDown()

void TraCIAPI::VehicleScope::slowDown ( const std::string &  vehicleID,
double  speed,
int  duration 
) const

Field Documentation

◆ myParent

TraCIAPI& TraCIAPI::TraCIScopeWrapper::myParent
protectedinherited

The parent TraCI client which offers the connection.

Definition at line 131 of file TraCIAPI.h.


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