Eclipse SUMO - Simulation of Urban MObility
TraCIAPI::EdgeScope Class Reference

Scope for interaction with edges. More...

#include <TraCIAPI.h>

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

Public Member Functions

void adaptTraveltime (const std::string &edgeID, double time, double beginSeconds=0., double endSeconds=std::numeric_limits< double >::max()) const
 
void clearSubscriptionResults ()
 
 EdgeScope (TraCIAPI &parent)
 
double getAdaptedTraveltime (const std::string &edgeID, double time) const
 
const libsumo::ContextSubscriptionResults getAllContextSubscriptionResults () const
 
const libsumo::SubscriptionResults getAllSubscriptionResults () const
 
double getCO2Emission (const std::string &edgeID) const
 
double getCOEmission (const std::string &edgeID) const
 
const libsumo::SubscriptionResults getContextSubscriptionResults (const std::string &objID) const
 
double getEffort (const std::string &edgeID, double time) const
 
double getElectricityConsumption (const std::string &edgeID) const
 
double getFuelConsumption (const std::string &edgeID) const
 
double getHCEmission (const std::string &edgeID) const
 
int getIDCount () const
 
std::vector< std::string > getIDList () const
 
int getLaneNumber (const std::string &edgeID) const
 
double getLastStepHaltingNumber (const std::string &edgeID) const
 
double getLastStepLength (const std::string &edgeID) const
 
double getLastStepMeanSpeed (const std::string &edgeID) const
 
double getLastStepOccupancy (const std::string &edgeID) const
 
std::vector< std::string > getLastStepVehicleIDs (const std::string &edgeID) const
 
int getLastStepVehicleNumber (const std::string &edgeID) const
 
libsumo::SubscriptionResultsgetModifiableContextSubscriptionResults (const std::string &objID)
 
libsumo::SubscriptionResultsgetModifiableSubscriptionResults ()
 
double getNoiseEmission (const std::string &edgeID) const
 
double getNOxEmission (const std::string &edgeID) const
 
std::string getParameter (const std::string &objectID, const std::string &key) const
 retrieve generic paramter More...
 
double getPMxEmission (const std::string &edgeID) const
 
std::string getStreetName (const std::string &id) const
 
const libsumo::TraCIResults getSubscriptionResults (const std::string &objID) const
 
double getTraveltime (const std::string &edgeID) const
 
void setEffort (const std::string &edgeID, double effort, double beginSeconds=0., double endSeconds=std::numeric_limits< double >::max()) const
 
void setMaxSpeed (const std::string &edgeID, double speed) const
 
void setParameter (const std::string &objectID, const std::string &key, const std::string &value) const
 set generic paramter More...
 
void subscribe (const std::string &objID, const std::vector< int > &vars, double beginTime, double endTime) const
 
void subscribeContext (const std::string &objID, int domain, double range, const std::vector< int > &vars, double beginTime, double endTime) const
 
virtual ~EdgeScope ()
 

Protected Attributes

int myCmdGetID
 
int myCmdSetID
 
int myContextSubscribeID
 
libsumo::ContextSubscriptionResults myContextSubscriptionResults
 
TraCIAPImyParent
 The parent TraCI client which offers the connection. More...
 
int mySubscribeID
 
libsumo::SubscriptionResults mySubscriptionResults
 

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 170 of file TraCIAPI.h.

Constructor & Destructor Documentation

◆ EdgeScope() [1/2]

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

Definition at line 172 of file TraCIAPI.h.

◆ ~EdgeScope()

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

Definition at line 173 of file TraCIAPI.h.

References TraCIAPI::TraCIScopeWrapper::operator=().

◆ 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,
double  time,
double  beginSeconds = 0.,
double  endSeconds = std::numeric_limits<double>::max() 
) const

◆ clearSubscriptionResults()

void TraCIAPI::TraCIScopeWrapper::clearSubscriptionResults ( )
inherited

Definition at line 3667 of file TraCIAPI.cpp.

Referenced by TraCIAPI::TraCIScopeWrapper::~TraCIScopeWrapper().

◆ getAdaptedTraveltime()

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

◆ getAllContextSubscriptionResults()

const libsumo::ContextSubscriptionResults TraCIAPI::TraCIScopeWrapper::getAllContextSubscriptionResults ( ) const
inherited

Definition at line 3651 of file TraCIAPI.cpp.

Referenced by TraCIAPI::TraCIScopeWrapper::~TraCIScopeWrapper().

◆ getAllSubscriptionResults()

const libsumo::SubscriptionResults TraCIAPI::TraCIScopeWrapper::getAllSubscriptionResults ( ) const
inherited

Definition at line 3635 of file TraCIAPI.cpp.

Referenced by TraCIAPI::TraCIScopeWrapper::~TraCIScopeWrapper().

◆ getCO2Emission()

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

Definition at line 690 of file TraCIAPI.cpp.

References libsumo::CMD_GET_EDGE_VARIABLE, and libsumo::VAR_CO2EMISSION.

◆ getCOEmission()

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

Definition at line 696 of file TraCIAPI.cpp.

References libsumo::CMD_GET_EDGE_VARIABLE, and libsumo::VAR_COEMISSION.

◆ getContextSubscriptionResults()

const libsumo::SubscriptionResults TraCIAPI::TraCIScopeWrapper::getContextSubscriptionResults ( const std::string &  objID) const
inherited

◆ getEffort()

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

◆ getElectricityConsumption()

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

◆ getFuelConsumption()

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

Definition at line 716 of file TraCIAPI.cpp.

References libsumo::CMD_GET_EDGE_VARIABLE, and libsumo::VAR_FUELCONSUMPTION.

◆ getHCEmission()

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

Definition at line 701 of file TraCIAPI.cpp.

References libsumo::CMD_GET_EDGE_VARIABLE, and libsumo::VAR_HCEMISSION.

◆ getIDCount()

int TraCIAPI::EdgeScope::getIDCount ( ) const

Definition at line 669 of file TraCIAPI.cpp.

References libsumo::CMD_GET_EDGE_VARIABLE, and libsumo::ID_COUNT.

Referenced by TraCITestClient::testAPI().

◆ getIDList()

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

Definition at line 664 of file TraCIAPI.cpp.

References libsumo::CMD_GET_EDGE_VARIABLE, and libsumo::TRACI_ID_LIST.

Referenced by TraCITestClient::testAPI().

◆ getLaneNumber()

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

Definition at line 767 of file TraCIAPI.cpp.

References libsumo::CMD_GET_EDGE_VARIABLE, and libsumo::VAR_LANE_INDEX.

Referenced by TraCITestClient::testAPI().

◆ getLastStepHaltingNumber()

double TraCIAPI::EdgeScope::getLastStepHaltingNumber ( const std::string &  edgeID) const

◆ getLastStepLength()

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

Definition at line 741 of file TraCIAPI.cpp.

References libsumo::CMD_GET_EDGE_VARIABLE, and libsumo::LAST_STEP_LENGTH.

◆ getLastStepMeanSpeed()

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

Definition at line 731 of file TraCIAPI.cpp.

References libsumo::CMD_GET_EDGE_VARIABLE, and libsumo::LAST_STEP_MEAN_SPEED.

◆ getLastStepOccupancy()

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

Definition at line 736 of file TraCIAPI.cpp.

References libsumo::CMD_GET_EDGE_VARIABLE, and libsumo::LAST_STEP_OCCUPANCY.

◆ getLastStepVehicleIDs()

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

◆ getLastStepVehicleNumber()

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

◆ getModifiableContextSubscriptionResults()

libsumo::SubscriptionResults & TraCIAPI::TraCIScopeWrapper::getModifiableContextSubscriptionResults ( const std::string &  objID)
inherited

Definition at line 3680 of file TraCIAPI.cpp.

Referenced by TraCIAPI::TraCIScopeWrapper::~TraCIScopeWrapper().

◆ getModifiableSubscriptionResults()

libsumo::SubscriptionResults & TraCIAPI::TraCIScopeWrapper::getModifiableSubscriptionResults ( )
inherited

Definition at line 3674 of file TraCIAPI.cpp.

Referenced by TraCIAPI::TraCIScopeWrapper::~TraCIScopeWrapper().

◆ getNoiseEmission()

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

Definition at line 721 of file TraCIAPI.cpp.

References libsumo::CMD_GET_EDGE_VARIABLE, and libsumo::VAR_NOISEEMISSION.

◆ getNOxEmission()

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

Definition at line 711 of file TraCIAPI.cpp.

References libsumo::CMD_GET_EDGE_VARIABLE, and libsumo::VAR_NOXEMISSION.

◆ getParameter()

std::string TraCIAPI::TraCIScopeWrapper::getParameter ( const std::string &  objectID,
const std::string &  key 
) const
inherited

◆ getPMxEmission()

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

Definition at line 706 of file TraCIAPI.cpp.

References libsumo::CMD_GET_EDGE_VARIABLE, and libsumo::VAR_PMXEMISSION.

◆ getStreetName()

std::string TraCIAPI::EdgeScope::getStreetName ( const std::string &  id) const

Definition at line 773 of file TraCIAPI.cpp.

References libsumo::CMD_GET_EDGE_VARIABLE, and libsumo::VAR_NAME.

Referenced by TraCITestClient::testAPI().

◆ getSubscriptionResults()

const libsumo::TraCIResults TraCIAPI::TraCIScopeWrapper::getSubscriptionResults ( const std::string &  objID) const
inherited

◆ getTraveltime()

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

◆ operator=()

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

invalidated assignment operator

◆ setEffort()

void TraCIAPI::EdgeScope::setEffort ( const std::string &  edgeID,
double  effort,
double  beginSeconds = 0.,
double  endSeconds = std::numeric_limits<double>::max() 
) const

◆ setMaxSpeed()

void TraCIAPI::EdgeScope::setMaxSpeed ( const std::string &  edgeID,
double  speed 
) const

◆ setParameter()

void TraCIAPI::TraCIScopeWrapper::setParameter ( const std::string &  objectID,
const std::string &  key,
const std::string &  value 
) const
inherited

◆ subscribe()

void TraCIAPI::TraCIScopeWrapper::subscribe ( const std::string &  objID,
const std::vector< int > &  vars,
double  beginTime,
double  endTime 
) const
inherited

◆ subscribeContext()

void TraCIAPI::TraCIScopeWrapper::subscribeContext ( const std::string &  objID,
int  domain,
double  range,
const std::vector< int > &  vars,
double  beginTime,
double  endTime 
) const
inherited

Field Documentation

◆ myCmdGetID

int TraCIAPI::TraCIScopeWrapper::myCmdGetID
protectedinherited

Definition at line 146 of file TraCIAPI.h.

◆ myCmdSetID

int TraCIAPI::TraCIScopeWrapper::myCmdSetID
protectedinherited

Definition at line 147 of file TraCIAPI.h.

◆ myContextSubscribeID

int TraCIAPI::TraCIScopeWrapper::myContextSubscribeID
protectedinherited

Definition at line 149 of file TraCIAPI.h.

◆ myContextSubscriptionResults

libsumo::ContextSubscriptionResults TraCIAPI::TraCIScopeWrapper::myContextSubscriptionResults
protectedinherited

Definition at line 151 of file TraCIAPI.h.

◆ myParent

TraCIAPI& TraCIAPI::TraCIScopeWrapper::myParent
protectedinherited

The parent TraCI client which offers the connection.

Definition at line 145 of file TraCIAPI.h.

◆ mySubscribeID

int TraCIAPI::TraCIScopeWrapper::mySubscribeID
protectedinherited

Definition at line 148 of file TraCIAPI.h.

◆ mySubscriptionResults

libsumo::SubscriptionResults TraCIAPI::TraCIScopeWrapper::mySubscriptionResults
protectedinherited

Definition at line 150 of file TraCIAPI.h.


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