SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
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
 
SUMOReal getAngle (const std::string &vehicleID) const
 
SUMOReal getCO2Emission (const std::string &vehicleID) const
 
SUMOReal getCOEmission (const std::string &vehicleID) const
 
TraCIColor getColor (const std::string &vehicleID) const
 
std::vector< std::string > getEdges (const std::string &vehicleID) const
 
SUMOReal getElectricityConsumption (const std::string &vehicleID) const
 
SUMOReal getFuelConsumption (const std::string &vehicleID) const
 
SUMOReal 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
 
SUMOReal getLanePosition (const std::string &vehicleID) const
 
std::vector< NextTLSDatagetNextTLS (const std::string &vehID) const
 
SUMOReal getNoiseEmission (const std::string &vehicleID) const
 
SUMOReal getNOxEmission (const std::string &vehicleID) const
 
SUMOReal 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
 
int getSignalStates (const std::string &vehicleID) const
 
SUMOReal getSlope (const std::string &vehicleID) const
 
SUMOReal getSpeed (const std::string &vehicleID) const
 
int getSpeedMode (const std::string &vehicleID) const
 
std::string getTypeID (const std::string &vehicleID) const
 
SUMOReal getWaitingTime (const std::string &vehicleID) const
 
void moveTo (const std::string &vehicleID, const std::string &laneID, SUMOReal position) const
 
void moveToXY (const std::string &vehicleID, const std::string &edgeID, const int lane, const SUMOReal x, const SUMOReal y, const SUMOReal 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 setSpeed (const std::string &vehicleID, SUMOReal speed) const
 
void slowDown (const std::string &vehicleID, SUMOReal 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 703 of file TraCIAPI.h.

Constructor & Destructor Documentation

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

Definition at line 705 of file TraCIAPI.h.

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

Definition at line 706 of file TraCIAPI.h.

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

invalidated copy constructor

Member Function Documentation

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
SUMOReal TraCIAPI::VehicleScope::getAngle ( const std::string &  vehicleID) const

Definition at line 1871 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_ANGLE.

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

Definition at line 1921 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_CO2EMISSION.

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

Definition at line 1926 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_COEMISSION.

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

Definition at line 1911 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_COLOR.

Referenced by TraCITestClient::testAPI().

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

Definition at line 1906 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_EDGES.

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

Definition at line 1956 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_ELECTRICITYCONSUMPTION.

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

Definition at line 1946 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_FUELCONSUMPTION.

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

Definition at line 1931 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_HCEMISSION.

int TraCIAPI::VehicleScope::getIDCount ( ) const

Definition at line 1856 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and ID_COUNT.

Referenced by TraCITestClient::testAPI().

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

Definition at line 1851 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and ID_LIST.

Referenced by TraCITestClient::testAPI().

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

Definition at line 1881 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_LANE_ID.

Referenced by TraCITestClient::testAPI().

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

Definition at line 1886 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_LANE_INDEX.

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

Definition at line 1916 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_LANEPOSITION.

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

Definition at line 1951 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_NOISEEMISSION.

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

Definition at line 1941 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_NOXEMISSION.

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

Definition at line 1936 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_PMXEMISSION.

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

Definition at line 1866 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_POSITION.

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

Definition at line 1876 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_ROAD_ID.

Referenced by TraCITestClient::testAPI().

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

Definition at line 1896 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_ROAD_ID.

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

Definition at line 1901 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_ROUTE_INDEX.

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

Definition at line 1973 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_SLOPE.

Referenced by TraCITestClient::testAPI().

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

Definition at line 1861 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_SPEED.

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

Definition at line 1967 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_SPEEDSETMODE.

Referenced by TraCITestClient::testAPI().

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

Definition at line 1891 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_TYPE.

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

Definition at line 1961 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_WAITING_TIME.

Referenced by TraCITestClient::testAPI().

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

Definition at line 2096 of file TraCIAPI.cpp.

References CMD_SET_VEHICLE_VARIABLE.

Referenced by TraCITestClient::testAPI().

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

invalidated assignment operator

void TraCIAPI::VehicleScope::remove ( const std::string &  vehicleID,
char  reason = REMOVE_VAPORIZED 
) const
void TraCIAPI::VehicleScope::setColor ( const std::string &  vehicleID,
const TraCIColor c 
) const
void TraCIAPI::VehicleScope::setSpeed ( const std::string &  vehicleID,
SUMOReal  speed 
) const
void TraCIAPI::VehicleScope::slowDown ( const std::string &  vehicleID,
SUMOReal  speed,
int  duration 
) const

Field Documentation

TraCIAPI& TraCIAPI::TraCIScopeWrapper::myParent
protectedinherited

The parent TraCI client which offers the connection.

Definition at line 208 of file TraCIAPI.h.

Referenced by TraCIAPI::EdgeScope::getIDList().


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