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 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

TraCIAPI &	myParent
	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...

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

Detailed Description

Scope for interaction with edges.

Definition at line 169 of file TraCIAPI.h.

Constructor & Destructor Documentation

◆ EdgeScope() [1/2]

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

inline

Definition at line 171 of file TraCIAPI.h.

◆ ~EdgeScope()

virtual TraCIAPI::EdgeScope::~EdgeScope ( )

inlinevirtual

Definition at line 172 of file TraCIAPI.h.

◆ 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

Definition at line 778 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().

◆ clearSubscriptionResults()

void TraCIAPI::TraCIScopeWrapper::clearSubscriptionResults ( )

inherited

Definition at line 3707 of file TraCIAPI.cpp.

◆ getAdaptedTraveltime()

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

Definition at line 673 of file TraCIAPI.cpp.

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

Referenced by TraCITestClient::testAPI().

◆ getAllContextSubscriptionResults()

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

inherited

Definition at line 3691 of file TraCIAPI.cpp.

◆ getAllSubscriptionResults()

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

inherited

Definition at line 3675 of file TraCIAPI.cpp.

◆ getCO2Emission()

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

Definition at line 689 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 695 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

Definition at line 3697 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI().

◆ getEffort()

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

Definition at line 681 of file TraCIAPI.cpp.

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

Referenced by TraCITestClient::testAPI().

◆ getElectricityConsumption()

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

Definition at line 725 of file TraCIAPI.cpp.

References libsumo::CMD_GET_EDGE_VARIABLE, and libsumo::VAR_ELECTRICITYCONSUMPTION.

◆ getFuelConsumption()

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

Definition at line 715 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 700 of file TraCIAPI.cpp.

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

◆ getIDCount()

int TraCIAPI::EdgeScope::getIDCount ( ) const

Definition at line 668 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 663 of file TraCIAPI.cpp.

References libsumo::CMD_GET_EDGE_VARIABLE, TraCIAPI::getStringVector(), TraCIAPI::TraCIScopeWrapper::myParent, and libsumo::TRACI_ID_LIST.

Referenced by TraCITestClient::testAPI().

◆ getLaneNumber()

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

Definition at line 766 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

Definition at line 755 of file TraCIAPI.cpp.

References libsumo::CMD_GET_EDGE_VARIABLE, and libsumo::LAST_STEP_VEHICLE_HALTING_NUMBER.

◆ getLastStepLength()

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

Definition at line 740 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 730 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 735 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

Definition at line 760 of file TraCIAPI.cpp.

References libsumo::CMD_GET_EDGE_VARIABLE, and libsumo::LAST_STEP_VEHICLE_ID_LIST.

◆ getLastStepVehicleNumber()

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

Definition at line 750 of file TraCIAPI.cpp.

References libsumo::CMD_GET_EDGE_VARIABLE, and libsumo::LAST_STEP_VEHICLE_NUMBER.

◆ getModifiableContextSubscriptionResults()

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

inherited

Definition at line 3720 of file TraCIAPI.cpp.

◆ getModifiableSubscriptionResults()

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

inherited

Definition at line 3714 of file TraCIAPI.cpp.

◆ getNoiseEmission()

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

Definition at line 720 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 710 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

retrieve generic paramter

Definition at line 3630 of file TraCIAPI.cpp.

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

Referenced by TraCITestClient::testAPI().

◆ getPMxEmission()

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

Definition at line 705 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 772 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

Definition at line 3681 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI().

◆ getTraveltime()

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

Definition at line 745 of file TraCIAPI.cpp.

References libsumo::CMD_GET_EDGE_VARIABLE, and libsumo::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,
		double	effort,
		double	beginSeconds = `0.`,
		double	endSeconds = `std::numeric_limits<double>::max()`
	)		const

Definition at line 798 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().

◆ setMaxSpeed()

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

Definition at line 817 of file TraCIAPI.cpp.

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

Referenced by TraCITestClient::testAPI().

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

◆ subscribe()

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

inherited

Definition at line 3653 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI().

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

Referenced by TraCITestClient::testAPI().

Field Documentation

◆ myCmdGetID

int TraCIAPI::TraCIScopeWrapper::myCmdGetID

protectedinherited

Definition at line 145 of file TraCIAPI.h.

◆ myCmdSetID

int TraCIAPI::TraCIScopeWrapper::myCmdSetID

protectedinherited

Definition at line 146 of file TraCIAPI.h.

◆ myContextSubscribeID

int TraCIAPI::TraCIScopeWrapper::myContextSubscribeID

protectedinherited

Definition at line 148 of file TraCIAPI.h.

◆ myContextSubscriptionResults

libsumo::ContextSubscriptionResults TraCIAPI::TraCIScopeWrapper::myContextSubscriptionResults

protectedinherited

Definition at line 150 of file TraCIAPI.h.

◆ myParent

TraCIAPI& TraCIAPI::TraCIScopeWrapper::myParent

protectedinherited

The parent TraCI client which offers the connection.

Definition at line 144 of file TraCIAPI.h.

Referenced by getIDList().

◆ mySubscribeID

int TraCIAPI::TraCIScopeWrapper::mySubscribeID

protectedinherited

Definition at line 147 of file TraCIAPI.h.

◆ mySubscriptionResults

libsumo::SubscriptionResults TraCIAPI::TraCIScopeWrapper::mySubscriptionResults

protectedinherited

Definition at line 149 of file TraCIAPI.h.

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

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ EdgeScope() [1/2]

◆ ~EdgeScope()

◆ EdgeScope() [2/2]

Member Function Documentation

◆ adaptTraveltime()

◆ clearSubscriptionResults()

◆ getAdaptedTraveltime()

◆ getAllContextSubscriptionResults()

◆ getAllSubscriptionResults()

◆ getCO2Emission()

◆ getCOEmission()

◆ getContextSubscriptionResults()

◆ getEffort()

◆ getElectricityConsumption()

◆ getFuelConsumption()

◆ getHCEmission()

◆ getIDCount()

◆ getIDList()

◆ getLaneNumber()

◆ getLastStepHaltingNumber()

◆ getLastStepLength()

◆ getLastStepMeanSpeed()

◆ getLastStepOccupancy()

◆ getLastStepVehicleIDs()

◆ getLastStepVehicleNumber()

◆ getModifiableContextSubscriptionResults()

◆ getModifiableSubscriptionResults()

◆ getNoiseEmission()

◆ getNOxEmission()

◆ getParameter()

◆ getPMxEmission()

◆ getStreetName()

◆ getSubscriptionResults()

◆ getTraveltime()

◆ operator=()

◆ setEffort()

◆ setMaxSpeed()

◆ setParameter()

◆ subscribe()

◆ subscribeContext()

Field Documentation

◆ myCmdGetID

◆ myCmdSetID

◆ myContextSubscribeID

◆ myContextSubscriptionResults

◆ myParent

◆ mySubscribeID

◆ mySubscriptionResults