SUMO - Simulation of Urban MObility
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

§ EdgeScope() [1/2]

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

Definition at line 229 of file TraCIAPI.h.

§ ~EdgeScope()

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

Definition at line 230 of file TraCIAPI.h.

References SUMOReal, and SUMOTime_MAX.

§ EdgeScope() [2/2]

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

invalidated copy constructor

Member Function Documentation

§ adaptTraveltime()

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

§ getAdaptedTraveltime()

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

§ getCO2Emission()

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

Definition at line 570 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, SUMOReal, and VAR_CO2EMISSION.

§ getCOEmission()

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

Definition at line 576 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, SUMOReal, and VAR_COEMISSION.

§ getEffort()

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

§ getElectricityConsumption()

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

Definition at line 606 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, SUMOReal, and VAR_ELECTRICITYCONSUMPTION.

§ getFuelConsumption()

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

Definition at line 596 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, SUMOReal, and VAR_FUELCONSUMPTION.

§ getHCEmission()

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

Definition at line 581 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, SUMOReal, and VAR_HCEMISSION.

§ getIDCount()

int TraCIAPI::EdgeScope::getIDCount ( ) const

Definition at line 549 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, ID_COUNT, and SUMOReal.

Referenced by TraCITestClient::testAPI().

§ getIDList()

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

Definition at line 544 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, and ID_LIST.

Referenced by TraCITestClient::testAPI().

§ getLastStepHaltingNumber()

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.

§ getLastStepLength()

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

Definition at line 621 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, LAST_STEP_LENGTH, and SUMOReal.

§ getLastStepMeanSpeed()

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

Definition at line 611 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, LAST_STEP_MEAN_SPEED, and SUMOReal.

§ getLastStepOccupancy()

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

Definition at line 616 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, LAST_STEP_OCCUPANCY, and SUMOReal.

§ getLastStepVehicleIDs()

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.

§ getLastStepVehicleNumber()

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

Definition at line 631 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, LAST_STEP_VEHICLE_NUMBER, and SUMOReal.

§ getNoiseEmission()

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

Definition at line 601 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, SUMOReal, and VAR_NOISEEMISSION.

§ getNOxEmission()

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

Definition at line 591 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, SUMOReal, and VAR_NOXEMISSION.

§ getPMxEmission()

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

Definition at line 586 of file TraCIAPI.cpp.

References CMD_GET_EDGE_VARIABLE, SUMOReal, and VAR_PMXEMISSION.

§ getTraveltime()

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

§ operator=()

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

invalidated assignment operator

§ setEffort()

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

§ setMaxSpeed()

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

§ myParent

TraCIAPI& TraCIAPI::TraCIScopeWrapper::myParent
protectedinherited

The parent TraCI client which offers the connection.

Definition at line 208 of file TraCIAPI.h.


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