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::SubscriptionResults &	getModifiableContextSubscriptionResults (const std::string &objID)
libsumo::SubscriptionResults &	getModifiableSubscriptionResults ()
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 parameter More...
std::pair< std::string, std::string >	getParameterWithKey (const std::string &objectID, const std::string &key) const
	retrieve generic parameter and return (key, value) tuple 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 Member Functions
int	getByte (int var, const std::string &id, tcpip::Storage *add=0) const
libsumo::TraCIColor	getCol (int var, const std::string &id, tcpip::Storage *add=0) const
double	getDouble (int var, const std::string &id, tcpip::Storage *add=0) const
std::vector< double >	getDoubleVector (int var, const std::string &id, tcpip::Storage *add=0) const
int	getInt (int var, const std::string &id, tcpip::Storage *add=0) const
libsumo::TraCIPositionVector	getPolygon (int var, const std::string &id, tcpip::Storage *add=0) const
libsumo::TraCIPosition	getPos (int var, const std::string &id, tcpip::Storage *add=0) const
libsumo::TraCIPosition	getPos3D (int var, const std::string &id, tcpip::Storage *add=0) const
std::string	getString (int var, const std::string &id, tcpip::Storage *add=0) const
std::vector< std::string >	getStringVector (int var, const std::string &id, tcpip::Storage *add=0) const
libsumo::TraCIStage	getTraCIStage (int var, const std::string &id, tcpip::Storage *add=0) const
int	getUnsignedByte (int var, const std::string &id, tcpip::Storage *add=0) const
void	setDouble (int var, const std::string &id, double value) const
void	setInt (int var, const std::string &id, int value) const
void	setString (int var, const std::string &id, const std::string &value) const
void	setStringVector (int var, const std::string &id, const std::vector< std::string > &value) const

Protected Attributes
TraCIAPI &	myParent
	The parent TraCI client which offers the connection. More...

Private Attributes
int	myCmdGetID
int	myCmdSetID
int	myContextSubscribeID
libsumo::ContextSubscriptionResults	myContextSubscriptionResults
int	mySubscribeID
libsumo::SubscriptionResults	mySubscriptionResults

Detailed Description

Scope for interaction with edges.

Definition at line 171 of file TraCIAPI.h.

Constructor & Destructor Documentation

EdgeScope()

TraCIAPI::EdgeScope::EdgeScope ( TraCIAPI &  parent )

inline

Definition at line 173 of file TraCIAPI.h.

~EdgeScope()

virtual TraCIAPI::EdgeScope::~EdgeScope ( )

inlinevirtual

Definition at line 174 of file TraCIAPI.h.

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

Definition at line 602 of file TraCIAPI.cpp.

References libsumo::CMD_SET_EDGE_VARIABLE, libsumo::TYPE_COMPOUND, libsumo::TYPE_DOUBLE, libsumo::VAR_EDGE_TRAVELTIME, tcpip::Storage::writeByte(), tcpip::Storage::writeDouble(), and tcpip::Storage::writeInt().

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

clearSubscriptionResults()

void TraCIAPI::TraCIScopeWrapper::clearSubscriptionResults ( )

inherited

Definition at line 3894 of file TraCIAPI.cpp.

getAdaptedTraveltime()

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

Definition at line 497 of file TraCIAPI.cpp.

References TraCIAPI::TraCIScopeWrapper::getDouble(), libsumo::TYPE_DOUBLE, libsumo::VAR_EDGE_TRAVELTIME, tcpip::Storage::writeByte(), and tcpip::Storage::writeDouble().

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

getAllContextSubscriptionResults()

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

inherited

Definition at line 3878 of file TraCIAPI.cpp.

getAllSubscriptionResults()

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

inherited

Definition at line 3862 of file TraCIAPI.cpp.

getByte()

int TraCIAPI::TraCIScopeWrapper::getByte ( int  var, const std::string &  id, tcpip::Storage *  add = 0  ) const

protectedinherited

Definition at line 3564 of file TraCIAPI.cpp.

References libsumo::INVALID_INT_VALUE, and libsumo::TYPE_BYTE.

getCO2Emission()

double TraCIAPI::EdgeScope::getCO2Emission

(

const std::string &

edgeID

)

const

Definition at line 513 of file TraCIAPI.cpp.

References libsumo::VAR_CO2EMISSION.

getCOEmission()

double TraCIAPI::EdgeScope::getCOEmission

(

const std::string &

edgeID

)

const

Definition at line 519 of file TraCIAPI.cpp.

References libsumo::VAR_COEMISSION.

getCol()

libsumo::TraCIColor TraCIAPI::TraCIScopeWrapper::getCol ( int  var, const std::string &  id, tcpip::Storage *  add = 0  ) const

protectedinherited

Definition at line 3680 of file TraCIAPI.cpp.

References libsumo::TraCIColor::a, libsumo::TraCIColor::b, libsumo::TraCIColor::g, libsumo::TraCIColor::r, and libsumo::TYPE_COLOR.

getContextSubscriptionResults()

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

inherited

Definition at line 3884 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

getDouble()

double TraCIAPI::TraCIScopeWrapper::getDouble ( int  var, const std::string &  id, tcpip::Storage *  add = 0  ) const

protectedinherited

Definition at line 3585 of file TraCIAPI.cpp.

References libsumo::INVALID_DOUBLE_VALUE, and libsumo::TYPE_DOUBLE.

Referenced by getAdaptedTraveltime().

Here is the caller graph for this function:

getDoubleVector()

std::vector< double > TraCIAPI::TraCIScopeWrapper::getDoubleVector ( int  var, const std::string &  id, tcpip::Storage *  add = 0  ) const

protectedinherited

Definition at line 3666 of file TraCIAPI.cpp.

References libsumo::TYPE_DOUBLELIST.

getEffort()

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

Definition at line 505 of file TraCIAPI.cpp.

References libsumo::TYPE_DOUBLE, libsumo::VAR_EDGE_EFFORT, tcpip::Storage::writeByte(), and tcpip::Storage::writeDouble().

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

getElectricityConsumption()

double TraCIAPI::EdgeScope::getElectricityConsumption

(

const std::string &

edgeID

)

const

Definition at line 549 of file TraCIAPI.cpp.

References libsumo::VAR_ELECTRICITYCONSUMPTION.

getFuelConsumption()

double TraCIAPI::EdgeScope::getFuelConsumption

(

const std::string &

edgeID

)

const

Definition at line 539 of file TraCIAPI.cpp.

References libsumo::VAR_FUELCONSUMPTION.

getHCEmission()

double TraCIAPI::EdgeScope::getHCEmission

(

const std::string &

edgeID

)

const

Definition at line 524 of file TraCIAPI.cpp.

References libsumo::VAR_HCEMISSION.

getIDCount()

int TraCIAPI::TraCIScopeWrapper::getIDCount ( ) const

inherited

Definition at line 3749 of file TraCIAPI.cpp.

References libsumo::ID_COUNT.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

getIDList()

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

inherited

Definition at line 3743 of file TraCIAPI.cpp.

References libsumo::TRACI_ID_LIST.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

getInt()

int TraCIAPI::TraCIScopeWrapper::getInt ( int  var, const std::string &  id, tcpip::Storage *  add = 0  ) const

protectedinherited

Definition at line 3575 of file TraCIAPI.cpp.

References libsumo::INVALID_INT_VALUE, and libsumo::TYPE_INTEGER.

getLaneNumber()

int TraCIAPI::EdgeScope::getLaneNumber

(

const std::string &

edgeID

)

const

Definition at line 590 of file TraCIAPI.cpp.

References libsumo::VAR_LANE_INDEX.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

getLastStepHaltingNumber()

double TraCIAPI::EdgeScope::getLastStepHaltingNumber

(

const std::string &

edgeID

)

const

Definition at line 579 of file TraCIAPI.cpp.

References libsumo::LAST_STEP_VEHICLE_HALTING_NUMBER.

getLastStepLength()

double TraCIAPI::EdgeScope::getLastStepLength

(

const std::string &

edgeID

)

const

Definition at line 564 of file TraCIAPI.cpp.

References libsumo::LAST_STEP_LENGTH.

getLastStepMeanSpeed()

double TraCIAPI::EdgeScope::getLastStepMeanSpeed

(

const std::string &

edgeID

)

const

Definition at line 554 of file TraCIAPI.cpp.

References libsumo::LAST_STEP_MEAN_SPEED.

getLastStepOccupancy()

double TraCIAPI::EdgeScope::getLastStepOccupancy

(

const std::string &

edgeID

)

const

Definition at line 559 of file TraCIAPI.cpp.

References libsumo::LAST_STEP_OCCUPANCY.

getLastStepVehicleIDs()

std::vector< std::string > TraCIAPI::EdgeScope::getLastStepVehicleIDs

(

const std::string &

edgeID

)

const

Definition at line 584 of file TraCIAPI.cpp.

References libsumo::LAST_STEP_VEHICLE_ID_LIST.

getLastStepVehicleNumber()

int TraCIAPI::EdgeScope::getLastStepVehicleNumber

(

const std::string &

edgeID

)

const

Definition at line 574 of file TraCIAPI.cpp.

References libsumo::LAST_STEP_VEHICLE_NUMBER.

getModifiableContextSubscriptionResults()

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

inherited

Definition at line 3907 of file TraCIAPI.cpp.

getModifiableSubscriptionResults()

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

inherited

Definition at line 3901 of file TraCIAPI.cpp.

getNoiseEmission()

double TraCIAPI::EdgeScope::getNoiseEmission

(

const std::string &

edgeID

)

const

Definition at line 544 of file TraCIAPI.cpp.

References libsumo::VAR_NOISEEMISSION.

getNOxEmission()

double TraCIAPI::EdgeScope::getNOxEmission

(

const std::string &

edgeID

)

const

Definition at line 534 of file TraCIAPI.cpp.

References libsumo::VAR_NOXEMISSION.

getParameter()

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

inherited

retrieve generic parameter

Definition at line 3755 of file TraCIAPI.cpp.

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

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

getParameterWithKey()

std::pair< std::string, std::string > TraCIAPI::TraCIScopeWrapper::getParameterWithKey ( const std::string &  objectID, const std::string &  key  ) const

inherited

retrieve generic parameter and return (key, value) tuple

Definition at line 3764 of file TraCIAPI.cpp.

References libsumo::TYPE_COMPOUND, libsumo::TYPE_STRING, libsumo::VAR_PARAMETER_WITH_KEY, tcpip::Storage::writeString(), and tcpip::Storage::writeUnsignedByte().

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

getPMxEmission()

double TraCIAPI::EdgeScope::getPMxEmission

(

const std::string &

edgeID

)

const

Definition at line 529 of file TraCIAPI.cpp.

References libsumo::VAR_PMXEMISSION.

getPolygon()

libsumo::TraCIPositionVector TraCIAPI::TraCIScopeWrapper::getPolygon ( int  var, const std::string &  id, tcpip::Storage *  add = 0  ) const

protectedinherited

Definition at line 3595 of file TraCIAPI.cpp.

References libsumo::TYPE_POLYGON, libsumo::TraCIPositionVector::value, libsumo::TraCIPosition::x, libsumo::TraCIPosition::y, and libsumo::TraCIPosition::z.

getPos()

libsumo::TraCIPosition TraCIAPI::TraCIScopeWrapper::getPos ( int  var, const std::string &  id, tcpip::Storage *  add = 0  ) const

protectedinherited

Definition at line 3616 of file TraCIAPI.cpp.

References libsumo::POSITION_2D, libsumo::TraCIPosition::x, libsumo::TraCIPosition::y, and libsumo::TraCIPosition::z.

getPos3D()

libsumo::TraCIPosition TraCIAPI::TraCIScopeWrapper::getPos3D ( int  var, const std::string &  id, tcpip::Storage *  add = 0  ) const

protectedinherited

Definition at line 3629 of file TraCIAPI.cpp.

References libsumo::POSITION_3D, libsumo::TraCIPosition::x, libsumo::TraCIPosition::y, and libsumo::TraCIPosition::z.

getStreetName()

std::string TraCIAPI::EdgeScope::getStreetName

(

const std::string &

id

)

const

Definition at line 596 of file TraCIAPI.cpp.

References libsumo::VAR_NAME.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

getString()

std::string TraCIAPI::TraCIScopeWrapper::getString ( int  var, const std::string &  id, tcpip::Storage *  add = 0  ) const

protectedinherited

Definition at line 3642 of file TraCIAPI.cpp.

References libsumo::TYPE_STRING.

getStringVector()

std::vector< std::string > TraCIAPI::TraCIScopeWrapper::getStringVector ( int  var, const std::string &  id, tcpip::Storage *  add = 0  ) const

protectedinherited

Definition at line 3652 of file TraCIAPI.cpp.

References libsumo::TYPE_STRINGLIST.

getSubscriptionResults()

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

inherited

Definition at line 3868 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

getTraCIStage()

libsumo::TraCIStage TraCIAPI::TraCIScopeWrapper::getTraCIStage ( int  var, const std::string &  id, tcpip::Storage *  add = 0  ) const

protectedinherited

Definition at line 3694 of file TraCIAPI.cpp.

References libsumo::TraCIStage::arrivalPos, libsumo::TraCIStage::cost, libsumo::TraCIStage::depart, libsumo::TraCIStage::departPos, libsumo::TraCIStage::description, libsumo::TraCIStage::destStop, libsumo::TraCIStage::edges, libsumo::TraCIStage::intended, libsumo::TraCIStage::length, libsumo::TraCIStage::line, libsumo::TraCIStage::travelTime, libsumo::TraCIStage::type, libsumo::TYPE_COMPOUND, and libsumo::TraCIStage::vType.

getTraveltime()

double TraCIAPI::EdgeScope::getTraveltime

(

const std::string &

edgeID

)

const

Definition at line 569 of file TraCIAPI.cpp.

References libsumo::VAR_CURRENT_TRAVELTIME.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

getUnsignedByte()

int TraCIAPI::TraCIScopeWrapper::getUnsignedByte ( int  var, const std::string &  id, tcpip::Storage *  add = 0  ) const

protectedinherited

Definition at line 3554 of file TraCIAPI.cpp.

References libsumo::INVALID_INT_VALUE, and libsumo::TYPE_UBYTE.

setDouble()

void TraCIAPI::TraCIScopeWrapper::setDouble ( int  var, const std::string &  id, double  value  ) const

protectedinherited

Definition at line 3807 of file TraCIAPI.cpp.

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

setEffort()

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

Definition at line 622 of file TraCIAPI.cpp.

References libsumo::CMD_SET_EDGE_VARIABLE, libsumo::TYPE_COMPOUND, libsumo::TYPE_DOUBLE, libsumo::VAR_EDGE_EFFORT, tcpip::Storage::writeByte(), tcpip::Storage::writeDouble(), and tcpip::Storage::writeInt().

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

setInt()

void TraCIAPI::TraCIScopeWrapper::setInt ( int  var, const std::string &  id, int  value  ) const

protectedinherited

Definition at line 3797 of file TraCIAPI.cpp.

References libsumo::TYPE_INTEGER, tcpip::Storage::writeInt(), and tcpip::Storage::writeUnsignedByte().

setMaxSpeed()

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

Definition at line 641 of file TraCIAPI.cpp.

References libsumo::VAR_MAXSPEED.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

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 3783 of file TraCIAPI.cpp.

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

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

setString()

void TraCIAPI::TraCIScopeWrapper::setString ( int  var, const std::string &  id, const std::string &  value  ) const

protectedinherited

Definition at line 3817 of file TraCIAPI.cpp.

References libsumo::TYPE_STRING, tcpip::Storage::writeString(), and tcpip::Storage::writeUnsignedByte().

setStringVector()

void TraCIAPI::TraCIScopeWrapper::setStringVector ( int  var, const std::string &  id, const std::vector< std::string > &  value  ) const

protectedinherited

Definition at line 3827 of file TraCIAPI.cpp.

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

subscribe()

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

inherited

Definition at line 3840 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

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 3852 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

Field Documentation

myCmdGetID

int TraCIAPI::TraCIScopeWrapper::myCmdGetID

privateinherited

Definition at line 154 of file TraCIAPI.h.

myCmdSetID

int TraCIAPI::TraCIScopeWrapper::myCmdSetID

privateinherited

Definition at line 155 of file TraCIAPI.h.

myContextSubscribeID

int TraCIAPI::TraCIScopeWrapper::myContextSubscribeID

privateinherited

Definition at line 157 of file TraCIAPI.h.

myContextSubscriptionResults

libsumo::ContextSubscriptionResults TraCIAPI::TraCIScopeWrapper::myContextSubscriptionResults

privateinherited

Definition at line 159 of file TraCIAPI.h.

myParent

TraCIAPI& TraCIAPI::TraCIScopeWrapper::myParent

protectedinherited

The parent TraCI client which offers the connection.

Definition at line 151 of file TraCIAPI.h.

mySubscribeID

int TraCIAPI::TraCIScopeWrapper::mySubscribeID

privateinherited

Definition at line 156 of file TraCIAPI.h.

mySubscriptionResults

libsumo::SubscriptionResults TraCIAPI::TraCIScopeWrapper::mySubscriptionResults

privateinherited

Definition at line 158 of file TraCIAPI.h.

---

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

• TraCIAPI.h
• TraCIAPI.cpp