SUMO - Simulation of Urban MObility
Public Member Functions | Protected Attributes | Private Member Functions
TraCIAPI::LaneScope Class Reference

Scope for interaction with lanes. More...

#include <TraCIAPI.h>

Inheritance diagram for TraCIAPI::LaneScope:
Inheritance graph
Collaboration diagram for TraCIAPI::LaneScope:
Collaboration graph

Public Member Functions

void clearSubscriptionResults ()
 
const libsumo::ContextSubscriptionResults getAllContextSubscriptionResults () const
 
std::vector< std::string > getAllowed (const std::string &laneID) const
 
const libsumo::SubscriptionResults getAllSubscriptionResults () const
 
double getCO2Emission (const std::string &laneID) const
 
double getCOEmission (const std::string &laneID) const
 
const libsumo::SubscriptionResults getContextSubscriptionResults (const std::string &objID) const
 
std::vector< std::string > getDisallowed (const std::string &laneID) const
 
std::string getEdgeID (const std::string &laneID) const
 
double getElectricityConsumption (const std::string &laneID) const
 
std::vector< std::string > getFoes (const std::string &laneID, const std::string &toLaneID) const
 
double getFuelConsumption (const std::string &laneID) const
 
double getHCEmission (const std::string &laneID) const
 
int getIDCount () const
 
std::vector< std::string > getIDList () const
 
std::vector< std::string > getInternalFoes (const std::string &laneID) const
 
int getLastStepHaltingNumber (const std::string &laneID) const
 
double getLastStepLength (const std::string &laneID) const
 
double getLastStepMeanSpeed (const std::string &laneID) const
 
double getLastStepOccupancy (const std::string &laneID) const
 
std::vector< std::string > getLastStepVehicleIDs (const std::string &laneID) const
 
int getLastStepVehicleNumber (const std::string &laneID) const
 
double getLength (const std::string &laneID) const
 
int getLinkNumber (const std::string &laneID) const
 
std::vector< libsumo::TraCIConnection > getLinks (const std::string &laneID) const
 
double getMaxSpeed (const std::string &laneID) const
 
libsumo::SubscriptionResults & getModifiableContextSubscriptionResults (const std::string &objID)
 
libsumo::SubscriptionResults & getModifiableSubscriptionResults ()
 
double getNoiseEmission (const std::string &laneID) const
 
double getNOxEmission (const std::string &laneID) const
 
std::string getParameter (const std::string &objectID, const std::string &key) const
 retrieve generic paramter More...
 
double getPMxEmission (const std::string &laneID) const
 
libsumo::TraCIPositionVector getShape (const std::string &laneID) const
 
const libsumo::TraCIResults getSubscriptionResults (const std::string &objID) const
 
double getTraveltime (const std::string &laneID) const
 
double getWidth (const std::string &laneID) const
 
 LaneScope (TraCIAPI &parent)
 
void setAllowed (const std::string &laneID, const std::vector< std::string > &allowedClasses) const
 
void setDisallowed (const std::string &laneID, const std::vector< std::string > &disallowedClasses) const
 
void setLength (const std::string &laneID, double length) const
 
void setMaxSpeed (const std::string &laneID, 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 ~LaneScope ()
 

Protected Attributes

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

Private Member Functions

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

Detailed Description

Scope for interaction with lanes.

Definition at line 306 of file TraCIAPI.h.

Constructor & Destructor Documentation

◆ LaneScope() [1/2]

TraCIAPI::LaneScope::LaneScope ( TraCIAPI &  parent)
inline

Definition at line 308 of file TraCIAPI.h.

◆ ~LaneScope()

virtual TraCIAPI::LaneScope::~LaneScope ( )
inlinevirtual

Definition at line 309 of file TraCIAPI.h.

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

◆ LaneScope() [2/2]

TraCIAPI::LaneScope::LaneScope ( const LaneScope &  src)
private

invalidated copy constructor

Member Function Documentation

◆ clearSubscriptionResults()

void TraCIAPI::TraCIScopeWrapper::clearSubscriptionResults ( )
inherited

Definition at line 3208 of file TraCIAPI.cpp.

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

◆ getAllContextSubscriptionResults()

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

Definition at line 3192 of file TraCIAPI.cpp.

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

◆ getAllowed()

std::vector< std::string > TraCIAPI::LaneScope::getAllowed ( const std::string &  laneID) const

Definition at line 1001 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and LANE_ALLOWED.

◆ getAllSubscriptionResults()

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

Definition at line 3176 of file TraCIAPI.cpp.

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

◆ getCO2Emission()

double TraCIAPI::LaneScope::getCO2Emission ( const std::string &  laneID) const

Definition at line 1076 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and VAR_CO2EMISSION.

◆ getCOEmission()

double TraCIAPI::LaneScope::getCOEmission ( const std::string &  laneID) const

Definition at line 1081 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and VAR_COEMISSION.

◆ getContextSubscriptionResults()

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

Definition at line 3198 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI(), and TraCIAPI::TraCIScopeWrapper::~TraCIScopeWrapper().

◆ getDisallowed()

std::vector< std::string > TraCIAPI::LaneScope::getDisallowed ( const std::string &  laneID) const

Definition at line 1006 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and LANE_DISALLOWED.

◆ getEdgeID()

std::string TraCIAPI::LaneScope::getEdgeID ( const std::string &  laneID) const

Definition at line 1071 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and LANE_EDGE_ID.

◆ getElectricityConsumption()

double TraCIAPI::LaneScope::getElectricityConsumption ( const std::string &  laneID) const

Definition at line 1111 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and VAR_ELECTRICITYCONSUMPTION.

◆ getFoes()

std::vector< std::string > TraCIAPI::LaneScope::getFoes ( const std::string &  laneID,
const std::string &  toLaneID 
) const

Definition at line 1152 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, tcpip::Storage::readInt(), tcpip::Storage::readString(), TYPE_STRING, TYPE_STRINGLIST, VAR_FOES, tcpip::Storage::writeString(), and tcpip::Storage::writeUnsignedByte().

Referenced by TraCITestClient::testAPI().

◆ getFuelConsumption()

double TraCIAPI::LaneScope::getFuelConsumption ( const std::string &  laneID) const

Definition at line 1101 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and VAR_FUELCONSUMPTION.

◆ getHCEmission()

double TraCIAPI::LaneScope::getHCEmission ( const std::string &  laneID) const

Definition at line 1086 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and VAR_HCEMISSION.

◆ getIDCount()

int TraCIAPI::LaneScope::getIDCount ( ) const

Definition at line 981 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and ID_COUNT.

Referenced by TraCITestClient::testAPI().

◆ getIDList()

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

Definition at line 976 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and ID_LIST.

Referenced by TraCITestClient::testAPI().

◆ getInternalFoes()

std::vector< std::string > TraCIAPI::LaneScope::getInternalFoes ( const std::string &  laneID) const

Definition at line 1168 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI().

◆ getLastStepHaltingNumber()

int TraCIAPI::LaneScope::getLastStepHaltingNumber ( const std::string &  laneID) const

Definition at line 1141 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and LAST_STEP_VEHICLE_HALTING_NUMBER.

◆ getLastStepLength()

double TraCIAPI::LaneScope::getLastStepLength ( const std::string &  laneID) const

Definition at line 1126 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and LAST_STEP_LENGTH.

◆ getLastStepMeanSpeed()

double TraCIAPI::LaneScope::getLastStepMeanSpeed ( const std::string &  laneID) const

Definition at line 1116 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and LAST_STEP_MEAN_SPEED.

◆ getLastStepOccupancy()

double TraCIAPI::LaneScope::getLastStepOccupancy ( const std::string &  laneID) const

Definition at line 1121 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and LAST_STEP_OCCUPANCY.

◆ getLastStepVehicleIDs()

std::vector< std::string > TraCIAPI::LaneScope::getLastStepVehicleIDs ( const std::string &  laneID) const

Definition at line 1146 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and LAST_STEP_VEHICLE_ID_LIST.

◆ getLastStepVehicleNumber()

int TraCIAPI::LaneScope::getLastStepVehicleNumber ( const std::string &  laneID) const

Definition at line 1136 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and LAST_STEP_VEHICLE_NUMBER.

◆ getLength()

double TraCIAPI::LaneScope::getLength ( const std::string &  laneID) const

Definition at line 986 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and VAR_LENGTH.

◆ getLinkNumber()

int TraCIAPI::LaneScope::getLinkNumber ( const std::string &  laneID) const

Definition at line 1011 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and LANE_LINK_NUMBER.

Referenced by TraCITestClient::testAPI().

◆ getLinks()

std::vector< libsumo::TraCIConnection > TraCIAPI::LaneScope::getLinks ( const std::string &  laneID) const

Definition at line 1016 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, LANE_LINKS, tcpip::Storage::readDouble(), tcpip::Storage::readInt(), tcpip::Storage::readString(), tcpip::Storage::readUnsignedByte(), and TYPE_COMPOUND.

Referenced by TraCITestClient::testAPI().

◆ getMaxSpeed()

double TraCIAPI::LaneScope::getMaxSpeed ( const std::string &  laneID) const

Definition at line 991 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and VAR_MAXSPEED.

◆ getModifiableContextSubscriptionResults()

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

Definition at line 3221 of file TraCIAPI.cpp.

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

◆ getModifiableSubscriptionResults()

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

Definition at line 3215 of file TraCIAPI.cpp.

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

◆ getNoiseEmission()

double TraCIAPI::LaneScope::getNoiseEmission ( const std::string &  laneID) const

Definition at line 1106 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and VAR_NOISEEMISSION.

◆ getNOxEmission()

double TraCIAPI::LaneScope::getNOxEmission ( const std::string &  laneID) const

Definition at line 1096 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and VAR_NOXEMISSION.

◆ getParameter()

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

retrieve generic paramter

Definition at line 3130 of file TraCIAPI.cpp.

References TYPE_STRING, VAR_PARAMETER, tcpip::Storage::writeByte(), and tcpip::Storage::writeString().

Referenced by TraCITestClient::testAPI(), and TraCIAPI::TraCIScopeWrapper::~TraCIScopeWrapper().

◆ getPMxEmission()

double TraCIAPI::LaneScope::getPMxEmission ( const std::string &  laneID) const

Definition at line 1091 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and VAR_PMXEMISSION.

◆ getShape()

libsumo::TraCIPositionVector TraCIAPI::LaneScope::getShape ( const std::string &  laneID) const

Definition at line 1066 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and VAR_SHAPE.

◆ getSubscriptionResults()

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

Definition at line 3182 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI(), and TraCIAPI::TraCIScopeWrapper::~TraCIScopeWrapper().

◆ getTraveltime()

double TraCIAPI::LaneScope::getTraveltime ( const std::string &  laneID) const

Definition at line 1131 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and VAR_CURRENT_TRAVELTIME.

◆ getWidth()

double TraCIAPI::LaneScope::getWidth ( const std::string &  laneID) const

Definition at line 996 of file TraCIAPI.cpp.

References CMD_GET_LANE_VARIABLE, and VAR_WIDTH.

◆ operator=()

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

invalidated assignment operator

◆ setAllowed()

void TraCIAPI::LaneScope::setAllowed ( const std::string &  laneID,
const std::vector< std::string > &  allowedClasses 
) const

Definition at line 1174 of file TraCIAPI.cpp.

References CMD_SET_LANE_VARIABLE, LANE_ALLOWED, TYPE_STRINGLIST, tcpip::Storage::writeInt(), tcpip::Storage::writeString(), and tcpip::Storage::writeUnsignedByte().

◆ setDisallowed()

void TraCIAPI::LaneScope::setDisallowed ( const std::string &  laneID,
const std::vector< std::string > &  disallowedClasses 
) const

Definition at line 1187 of file TraCIAPI.cpp.

References CMD_SET_LANE_VARIABLE, LANE_DISALLOWED, TYPE_STRINGLIST, tcpip::Storage::writeInt(), tcpip::Storage::writeString(), and tcpip::Storage::writeUnsignedByte().

◆ setLength()

void TraCIAPI::LaneScope::setLength ( const std::string &  laneID,
double  length 
) const

Definition at line 1210 of file TraCIAPI.cpp.

References CMD_SET_LANE_VARIABLE, TYPE_DOUBLE, VAR_LENGTH, tcpip::Storage::writeDouble(), and tcpip::Storage::writeUnsignedByte().

◆ setMaxSpeed()

void TraCIAPI::LaneScope::setMaxSpeed ( const std::string &  laneID,
double  speed 
) const

Definition at line 1200 of file TraCIAPI.cpp.

References CMD_SET_LANE_VARIABLE, TYPE_DOUBLE, VAR_MAXSPEED, tcpip::Storage::writeDouble(), and tcpip::Storage::writeUnsignedByte().

◆ setParameter()

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

set generic paramter

Definition at line 3139 of file TraCIAPI.cpp.

References TYPE_COMPOUND, TYPE_STRING, VAR_PARAMETER, tcpip::Storage::writeInt(), tcpip::Storage::writeString(), and tcpip::Storage::writeUnsignedByte().

Referenced by TraCITestClient::testAPI(), and TraCIAPI::TraCIScopeWrapper::~TraCIScopeWrapper().

◆ subscribe()

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

Definition at line 3154 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI(), and TraCIAPI::TraCIScopeWrapper::~TraCIScopeWrapper().

◆ subscribeContext()

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

Definition at line 3166 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI(), and TraCIAPI::TraCIScopeWrapper::~TraCIScopeWrapper().

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: