Scope for interaction with the simulation. More...

#include <TraCIAPI.h>

Inheritance diagram for TraCIAPI::SimulationScope:

Collaboration diagram for TraCIAPI::SimulationScope:

Public Member Functions
void	clearSubscriptionResults ()

libsumo::TraCIPosition	convert2D (const std::string &edgeID, double pos, int laneIndex=0, bool toGeo=false) const

libsumo::TraCIPosition	convert3D (const std::string &edgeID, double pos, int laneIndex=0, bool toGeo=false) const

libsumo::TraCIPosition	convertGeo (double x, double y, bool fromGeo=false) const

libsumo::TraCIRoadPosition	convertRoad (double x, double y, bool isGeo=false, const std::string &vClass="ignoring") const

libsumo::TraCIStage	findRoute (const std::string &fromEdge, const std::string &toEdge, const std::string &vType="", double pos=-1., int routingMode=0) const

const libsumo::ContextSubscriptionResults	getAllContextSubscriptionResults () const

const libsumo::SubscriptionResults	getAllSubscriptionResults () const

std::vector< std::string >	getArrivedIDList () const

int	getArrivedNumber () const

std::vector< std::string >	getArrivedPersonIDList () const

int	getArrivedPersonNumber () const

int	getBusStopWaiting (const std::string &stopID) const

std::vector< std::string >	getBusStopWaitingIDList (const std::string &stopID) const

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

int	getCurrentTime () const

double	getDeltaT () const

std::vector< std::string >	getDepartedIDList () const

int	getDepartedNumber () const

std::vector< std::string >	getDepartedPersonIDList () const

int	getDepartedPersonNumber () const

double	getDistance2D (double x1, double y1, double x2, double y2, bool isGeo=false, bool isDriving=false)

double	getDistanceRoad (const std::string &edgeID1, double pos1, const std::string &edgeID2, double pos2, bool isDriving=false)

std::vector< std::string >	getEndingTeleportIDList () const

int	getEndingTeleportNumber () const

int	getIDCount () const

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

std::vector< std::string >	getLoadedIDList () const

int	getLoadedNumber () const

int	getMinExpectedNumber () const

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

libsumo::SubscriptionResults &	getModifiableSubscriptionResults ()

libsumo::TraCIPositionVector	getNetBoundary () const

std::string	getOption (const std::string &option) const

std::string	getParameter (const std::string &objectID, const std::string &key) const
	retrieve generic parameter

std::pair< std::string, std::string >	getParameterWithKey (const std::string &objectID, const std::string &key) const
	retrieve generic parameter and return (key, value) tuple

std::vector< std::string >	getStartingTeleportIDList () const

int	getStartingTeleportNumber () const

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

double	getTime () const

void	loadState (const std::string &path) const

void	saveState (const std::string &destination) const

void	setParameter (const std::string &objectID, const std::string &key, const std::string &value) const
	set generic paramter

	SimulationScope (TraCIAPI &parent)

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

void	writeMessage (const std::string msg)

virtual	~SimulationScope ()

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.

Private Attributes
int	myCmdGetID

int	myCmdSetID

int	myContextSubscribeID

libsumo::ContextSubscriptionResults	myContextSubscriptionResults

int	mySubscribeID

libsumo::SubscriptionResults	mySubscriptionResults

Detailed Description

Scope for interaction with the simulation.

Definition at line 419 of file TraCIAPI.h.

Constructor & Destructor Documentation

◆ SimulationScope()

TraCIAPI::SimulationScope::SimulationScope ( TraCIAPI & parent )

inline

Definition at line 421 of file TraCIAPI.h.

◆ ~SimulationScope()

virtual TraCIAPI::SimulationScope::~SimulationScope ( )

inlinevirtual

Definition at line 422 of file TraCIAPI.h.

Member Function Documentation

◆ clearSubscriptionResults()

void TraCIAPI::TraCIScopeWrapper::clearSubscriptionResults ( )

inherited

Definition at line 3894 of file TraCIAPI.cpp.

◆ convert2D()

libsumo::TraCIPosition TraCIAPI::SimulationScope::convert2D	(	const std::string &	edgeID,
		double	pos,
		int	laneIndex = `0`,
		bool	toGeo = `false`
	)		const

Definition at line 1463 of file TraCIAPI.cpp.

References libsumo::CMD_GET_SIM_VARIABLE, libsumo::POSITION_2D, libsumo::POSITION_CONVERSION, libsumo::POSITION_LON_LAT, libsumo::POSITION_ROADMAP, libsumo::TYPE_COMPOUND, libsumo::TYPE_UBYTE, tcpip::Storage::writeByte(), tcpip::Storage::writeDouble(), tcpip::Storage::writeInt(), tcpip::Storage::writeString(), libsumo::TraCIPosition::x, and libsumo::TraCIPosition::y.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ convert3D()

libsumo::TraCIPosition TraCIAPI::SimulationScope::convert3D	(	const std::string &	edgeID,
		double	pos,
		int	laneIndex = `0`,
		bool	toGeo = `false`
	)		const

Definition at line 1485 of file TraCIAPI.cpp.

References libsumo::CMD_GET_SIM_VARIABLE, libsumo::POSITION_3D, libsumo::POSITION_CONVERSION, libsumo::POSITION_LON_LAT_ALT, libsumo::POSITION_ROADMAP, libsumo::TYPE_COMPOUND, libsumo::TYPE_UBYTE, tcpip::Storage::writeByte(), tcpip::Storage::writeDouble(), tcpip::Storage::writeInt(), tcpip::Storage::writeString(), libsumo::TraCIPosition::x, libsumo::TraCIPosition::y, and libsumo::TraCIPosition::z.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ convertGeo()

libsumo::TraCIPosition TraCIAPI::SimulationScope::convertGeo	(	double	x,
		double	y,
		bool	fromGeo = `false`
	)		const

Definition at line 1531 of file TraCIAPI.cpp.

References libsumo::CMD_GET_SIM_VARIABLE, libsumo::POSITION_2D, libsumo::POSITION_CONVERSION, libsumo::POSITION_LON_LAT, libsumo::TYPE_COMPOUND, libsumo::TYPE_UBYTE, tcpip::Storage::writeByte(), tcpip::Storage::writeDouble(), tcpip::Storage::writeInt(), libsumo::TraCIPosition::x, and libsumo::TraCIPosition::y.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ convertRoad()

libsumo::TraCIRoadPosition TraCIAPI::SimulationScope::convertRoad	(	double	x,
		double	y,
		bool	isGeo = `false`,
		const std::string &	vClass = `"ignoring"`
	)		const

Definition at line 1508 of file TraCIAPI.cpp.

References libsumo::CMD_GET_SIM_VARIABLE, libsumo::TraCIRoadPosition::edgeID, libsumo::TraCIRoadPosition::laneIndex, libsumo::TraCIRoadPosition::pos, libsumo::POSITION_2D, libsumo::POSITION_CONVERSION, libsumo::POSITION_LON_LAT, libsumo::POSITION_ROADMAP, libsumo::TYPE_COMPOUND, libsumo::TYPE_STRING, libsumo::TYPE_UBYTE, tcpip::Storage::writeByte(), tcpip::Storage::writeDouble(), tcpip::Storage::writeInt(), and tcpip::Storage::writeString().

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ findRoute()

libsumo::TraCIStage TraCIAPI::SimulationScope::findRoute	(	const std::string &	fromEdge,
		const std::string &	toEdge,
		const std::string &	vType = `""`,
		double	pos = `-1.`,
		int	routingMode = `0`
	)		const

Definition at line 1594 of file TraCIAPI.cpp.

References libsumo::FIND_ROUTE, libsumo::TYPE_COMPOUND, libsumo::TYPE_DOUBLE, libsumo::TYPE_INTEGER, libsumo::TYPE_STRING, tcpip::Storage::writeByte(), tcpip::Storage::writeDouble(), tcpip::Storage::writeInt(), tcpip::Storage::writeString(), and tcpip::Storage::writeUnsignedByte().

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.

◆ getArrivedIDList()

std::vector< std::string > TraCIAPI::SimulationScope::getArrivedIDList ( ) const

Definition at line 1386 of file TraCIAPI.cpp.

References libsumo::VAR_ARRIVED_VEHICLES_IDS.

◆ getArrivedNumber()

int TraCIAPI::SimulationScope::getArrivedNumber ( ) const

Definition at line 1381 of file TraCIAPI.cpp.

References libsumo::VAR_ARRIVED_VEHICLES_NUMBER.

◆ getArrivedPersonIDList()

std::vector< std::string > TraCIAPI::SimulationScope::getArrivedPersonIDList ( ) const

Definition at line 1426 of file TraCIAPI.cpp.

References libsumo::VAR_ARRIVED_PERSONS_IDS.

◆ getArrivedPersonNumber()

int TraCIAPI::SimulationScope::getArrivedPersonNumber ( ) const

Definition at line 1421 of file TraCIAPI.cpp.

References libsumo::VAR_ARRIVED_PERSONS_NUMBER.

◆ getBusStopWaiting()

int TraCIAPI::SimulationScope::getBusStopWaiting ( const std::string & stopID ) const

Definition at line 1452 of file TraCIAPI.cpp.

References libsumo::VAR_BUS_STOP_WAITING.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getBusStopWaitingIDList()

std::vector< std::string > TraCIAPI::SimulationScope::getBusStopWaitingIDList ( const std::string & stopID ) const

Definition at line 1457 of file TraCIAPI.cpp.

References libsumo::VAR_BUS_STOP_WAITING_IDS.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

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

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

◆ getCurrentTime()

int TraCIAPI::SimulationScope::getCurrentTime ( ) const

Definition at line 1351 of file TraCIAPI.cpp.

References libsumo::VAR_TIME_STEP.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getDeltaT()

double TraCIAPI::SimulationScope::getDeltaT ( ) const

Definition at line 1431 of file TraCIAPI.cpp.

References libsumo::VAR_DELTA_T.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getDepartedIDList()

std::vector< std::string > TraCIAPI::SimulationScope::getDepartedIDList ( ) const

Definition at line 1376 of file TraCIAPI.cpp.

References libsumo::VAR_DEPARTED_VEHICLES_IDS.

◆ getDepartedNumber()

int TraCIAPI::SimulationScope::getDepartedNumber ( ) const

Definition at line 1371 of file TraCIAPI.cpp.

References libsumo::VAR_DEPARTED_VEHICLES_NUMBER.

◆ getDepartedPersonIDList()

std::vector< std::string > TraCIAPI::SimulationScope::getDepartedPersonIDList ( ) const

Definition at line 1416 of file TraCIAPI.cpp.

References libsumo::VAR_DEPARTED_PERSONS_IDS.

◆ getDepartedPersonNumber()

int TraCIAPI::SimulationScope::getDepartedPersonNumber ( ) const

Definition at line 1411 of file TraCIAPI.cpp.

References libsumo::VAR_DEPARTED_PERSONS_NUMBER.

◆ getDistance2D()

double TraCIAPI::SimulationScope::getDistance2D	(	double	x1,
		double	y1,
		double	x2,
		double	y2,
		bool	isGeo = `false`,
		bool	isDriving = `false`
	)

Definition at line 1552 of file TraCIAPI.cpp.

References libsumo::CMD_GET_SIM_VARIABLE, libsumo::DISTANCE_REQUEST, libsumo::POSITION_2D, libsumo::POSITION_LON_LAT, libsumo::REQUEST_AIRDIST, libsumo::REQUEST_DRIVINGDIST, libsumo::TYPE_COMPOUND, libsumo::TYPE_DOUBLE, tcpip::Storage::writeByte(), tcpip::Storage::writeDouble(), and tcpip::Storage::writeInt().

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getDistanceRoad()

double TraCIAPI::SimulationScope::getDistanceRoad	(	const std::string &	edgeID1,
		double	pos1,
		const std::string &	edgeID2,
		double	pos2,
		bool	isDriving = `false`
	)

Definition at line 1572 of file TraCIAPI.cpp.

References libsumo::CMD_GET_SIM_VARIABLE, libsumo::DISTANCE_REQUEST, libsumo::POSITION_ROADMAP, libsumo::REQUEST_AIRDIST, libsumo::REQUEST_DRIVINGDIST, libsumo::TYPE_COMPOUND, libsumo::TYPE_DOUBLE, tcpip::Storage::writeByte(), tcpip::Storage::writeDouble(), tcpip::Storage::writeInt(), and tcpip::Storage::writeString().

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 TraCIAPI::EdgeScope::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.

◆ getEndingTeleportIDList()

std::vector< std::string > TraCIAPI::SimulationScope::getEndingTeleportIDList ( ) const

Definition at line 1406 of file TraCIAPI.cpp.

References libsumo::VAR_TELEPORT_ENDING_VEHICLES_IDS.

◆ getEndingTeleportNumber()

int TraCIAPI::SimulationScope::getEndingTeleportNumber ( ) const

Definition at line 1401 of file TraCIAPI.cpp.

References libsumo::VAR_TELEPORT_ENDING_VEHICLES_NUMBER.

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

◆ getLoadedIDList()

std::vector< std::string > TraCIAPI::SimulationScope::getLoadedIDList ( ) const

Definition at line 1366 of file TraCIAPI.cpp.

References libsumo::VAR_LOADED_VEHICLES_IDS.

◆ getLoadedNumber()

int TraCIAPI::SimulationScope::getLoadedNumber ( ) const

Definition at line 1361 of file TraCIAPI.cpp.

References libsumo::VAR_LOADED_VEHICLES_NUMBER.

◆ getMinExpectedNumber()

int TraCIAPI::SimulationScope::getMinExpectedNumber ( ) const

Definition at line 1442 of file TraCIAPI.cpp.

References libsumo::VAR_MIN_EXPECTED_VEHICLES.

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

◆ getNetBoundary()

libsumo::TraCIPositionVector TraCIAPI::SimulationScope::getNetBoundary ( ) const

Definition at line 1436 of file TraCIAPI.cpp.

References libsumo::VAR_NET_BOUNDING_BOX.

◆ getOption()

std::string TraCIAPI::SimulationScope::getOption ( const std::string & option ) const

Definition at line 1447 of file TraCIAPI.cpp.

References libsumo::VAR_OPTION.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

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

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

◆ getStartingTeleportIDList()

std::vector< std::string > TraCIAPI::SimulationScope::getStartingTeleportIDList ( ) const

Definition at line 1396 of file TraCIAPI.cpp.

References libsumo::VAR_TELEPORT_STARTING_VEHICLES_IDS.

◆ getStartingTeleportNumber()

int TraCIAPI::SimulationScope::getStartingTeleportNumber ( ) const

Definition at line 1391 of file TraCIAPI.cpp.

References libsumo::VAR_TELEPORT_STARTING_VEHICLES_NUMBER.

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

◆ getTime()

double TraCIAPI::SimulationScope::getTime ( ) const

Definition at line 1356 of file TraCIAPI.cpp.

References libsumo::VAR_TIME.

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

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

◆ loadState()

void TraCIAPI::SimulationScope::loadState ( const std::string & path ) const

Definition at line 1612 of file TraCIAPI.cpp.

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

◆ saveState()

void TraCIAPI::SimulationScope::saveState ( const std::string & destination ) const

Definition at line 1621 of file TraCIAPI.cpp.

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

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

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

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

◆ writeMessage()

void TraCIAPI::SimulationScope::writeMessage ( const std::string msg )

Definition at line 1630 of file TraCIAPI.cpp.

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

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:

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SimulationScope()

◆ ~SimulationScope()

Member Function Documentation

◆ clearSubscriptionResults()

◆ convert2D()

◆ convert3D()

◆ convertGeo()

◆ convertRoad()

◆ findRoute()

◆ getAllContextSubscriptionResults()

◆ getAllSubscriptionResults()

◆ getArrivedIDList()

◆ getArrivedNumber()

◆ getArrivedPersonIDList()

◆ getArrivedPersonNumber()

◆ getBusStopWaiting()

◆ getBusStopWaitingIDList()

◆ getByte()

◆ getCol()

◆ getContextSubscriptionResults()

◆ getCurrentTime()

◆ getDeltaT()

◆ getDepartedIDList()

◆ getDepartedNumber()

◆ getDepartedPersonIDList()

◆ getDepartedPersonNumber()

◆ getDistance2D()

◆ getDistanceRoad()

◆ getDouble()

◆ getDoubleVector()

◆ getEndingTeleportIDList()

◆ getEndingTeleportNumber()

◆ getIDCount()

◆ getIDList()

◆ getInt()

◆ getLoadedIDList()

◆ getLoadedNumber()

◆ getMinExpectedNumber()

◆ getModifiableContextSubscriptionResults()

◆ getModifiableSubscriptionResults()

◆ getNetBoundary()

◆ getOption()

◆ getParameter()

◆ getParameterWithKey()

◆ getPolygon()

◆ getPos()

◆ getPos3D()

◆ getStartingTeleportIDList()

◆ getStartingTeleportNumber()

◆ getString()

◆ getStringVector()

◆ getSubscriptionResults()

◆ getTime()

◆ getTraCIStage()

◆ getUnsignedByte()

◆ loadState()

◆ saveState()

◆ setDouble()

◆ setInt()

◆ setParameter()

◆ setString()

◆ setStringVector()

◆ subscribe()

◆ subscribeContext()

◆ writeMessage()

Field Documentation

◆ myCmdGetID

◆ myCmdSetID

◆ myContextSubscribeID

◆ myContextSubscriptionResults

◆ myParent

◆ mySubscribeID

◆ mySubscriptionResults