SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
TraCIAPI::EdgeScope Class Reference

Scope for interaction with edges. More...

#include <TraCIAPI.h>

Inheritance diagram for TraCIAPI::EdgeScope:
Inheritance graph
Collaboration diagram for TraCIAPI::EdgeScope:
Collaboration graph

Public Member Functions

void adaptTraveltime (const std::string &edgeID, SUMOReal time, SUMOTime begin=0, SUMOTime end=SUMOTime_MAX) const
 
 EdgeScope (TraCIAPI &parent)
 
SUMOReal getAdaptedTraveltime (const std::string &edgeID, SUMOTime time) const
 
SUMOReal getCO2Emission (const std::string &edgeID) const
 
SUMOReal getCOEmission (const std::string &edgeID) const
 
SUMOReal getEffort (const std::string &edgeID, SUMOTime time) const
 
SUMOReal getElectricityConsumption (const std::string &edgeID) const
 
SUMOReal getFuelConsumption (const std::string &edgeID) const
 
SUMOReal getHCEmission (const std::string &edgeID) const
 
int getIDCount () const
 
std::vector< std::string > getIDList () const
 
SUMOReal getLastStepHaltingNumber (const std::string &edgeID) const
 
SUMOReal getLastStepLength (const std::string &edgeID) const
 
SUMOReal getLastStepMeanSpeed (const std::string &edgeID) const
 
SUMOReal getLastStepOccupancy (const std::string &edgeID) const
 
std::vector< std::string > getLastStepVehicleIDs (const std::string &edgeID) const
 
int getLastStepVehicleNumber (const std::string &edgeID) const
 
SUMOReal getNoiseEmission (const std::string &edgeID) const
 
SUMOReal getNOxEmission (const std::string &edgeID) const
 
SUMOReal getPMxEmission (const std::string &edgeID) const
 
SUMOReal getTraveltime (const std::string &edgeID) const
 
void setEffort (const std::string &edgeID, SUMOReal effort, SUMOTime begin=0, SUMOTime end=SUMOTime_MAX) const
 
void setMaxSpeed (const std::string &edgeID, SUMOReal speed) const
 
virtual ~EdgeScope ()
 

Protected Attributes

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

Private Member Functions

 EdgeScope (const EdgeScope &src)
 invalidated copy constructor More...
 
EdgeScopeoperator= (const EdgeScope &src)
 invalidated assignment operator More...
 

Detailed Description

Scope for interaction with edges.

Definition at line 227 of file TraCIAPI.h.

Constructor & Destructor Documentation

TraCIAPI::EdgeScope::EdgeScope ( TraCIAPI parent)
inline

Definition at line 229 of file TraCIAPI.h.

virtual TraCIAPI::EdgeScope::~EdgeScope ( )
inlinevirtual

Definition at line 230 of file TraCIAPI.h.

TraCIAPI::EdgeScope::EdgeScope ( const EdgeScope src)
private

invalidated copy constructor

Member Function Documentation

void TraCIAPI::EdgeScope::adaptTraveltime ( const std::string &  edgeID,
SUMOReal  time,
SUMOTime  begin = 0,
SUMOTime  end = SUMOTime_MAX 
) const
SUMOReal TraCIAPI::EdgeScope::getAdaptedTraveltime ( const std::string &  edgeID,
SUMOTime  time 
) const
SUMOReal TraCIAPI::EdgeScope::getCO2Emission ( const std::string &  edgeID) const

Definition at line 570 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, and VAR_CO2EMISSION.

SUMOReal TraCIAPI::EdgeScope::getCOEmission ( const std::string &  edgeID) const

Definition at line 576 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, and VAR_COEMISSION.

SUMOReal TraCIAPI::EdgeScope::getEffort ( const std::string &  edgeID,
SUMOTime  time 
) const
SUMOReal TraCIAPI::EdgeScope::getElectricityConsumption ( const std::string &  edgeID) const

Definition at line 606 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, and VAR_ELECTRICITYCONSUMPTION.

SUMOReal TraCIAPI::EdgeScope::getFuelConsumption ( const std::string &  edgeID) const

Definition at line 596 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, and VAR_FUELCONSUMPTION.

SUMOReal TraCIAPI::EdgeScope::getHCEmission ( const std::string &  edgeID) const

Definition at line 581 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, and VAR_HCEMISSION.

int TraCIAPI::EdgeScope::getIDCount ( ) const

Definition at line 549 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, and ID_COUNT.

Referenced by TraCITestClient::testAPI().

std::vector< std::string > TraCIAPI::EdgeScope::getIDList ( ) const
SUMOReal TraCIAPI::EdgeScope::getLastStepHaltingNumber ( const std::string &  edgeID) const

Definition at line 636 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, and LAST_STEP_VEHICLE_HALTING_NUMBER.

SUMOReal TraCIAPI::EdgeScope::getLastStepLength ( const std::string &  edgeID) const

Definition at line 621 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, and LAST_STEP_LENGTH.

SUMOReal TraCIAPI::EdgeScope::getLastStepMeanSpeed ( const std::string &  edgeID) const

Definition at line 611 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, and LAST_STEP_MEAN_SPEED.

SUMOReal TraCIAPI::EdgeScope::getLastStepOccupancy ( const std::string &  edgeID) const

Definition at line 616 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, and LAST_STEP_OCCUPANCY.

std::vector< std::string > TraCIAPI::EdgeScope::getLastStepVehicleIDs ( const std::string &  edgeID) const

Definition at line 641 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, and LAST_STEP_VEHICLE_ID_LIST.

int TraCIAPI::EdgeScope::getLastStepVehicleNumber ( const std::string &  edgeID) const

Definition at line 631 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, and LAST_STEP_VEHICLE_NUMBER.

SUMOReal TraCIAPI::EdgeScope::getNoiseEmission ( const std::string &  edgeID) const

Definition at line 601 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, and VAR_NOISEEMISSION.

SUMOReal TraCIAPI::EdgeScope::getNOxEmission ( const std::string &  edgeID) const

Definition at line 591 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, and VAR_NOXEMISSION.

SUMOReal TraCIAPI::EdgeScope::getPMxEmission ( const std::string &  edgeID) const

Definition at line 586 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, and VAR_PMXEMISSION.

SUMOReal TraCIAPI::EdgeScope::getTraveltime ( const std::string &  edgeID) const

Definition at line 626 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, and VAR_CURRENT_TRAVELTIME.

Referenced by TraCITestClient::testAPI().

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

invalidated assignment operator

void TraCIAPI::EdgeScope::setEffort ( const std::string &  edgeID,
SUMOReal  effort,
SUMOTime  begin = 0,
SUMOTime  end = SUMOTime_MAX 
) const
void TraCIAPI::EdgeScope::setMaxSpeed ( const std::string &  edgeID,
SUMOReal  speed 
) const

Definition at line 680 of file TraCIAPI.cpp.

References CMD_SET_EDGE_VARIABLE, VAR_MAXSPEED, and tcpip::Storage::writeDouble().

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 getIDList().


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