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

const libsumo::ContextSubscriptionResults	getAllContextSubscriptionResults () const

const libsumo::SubscriptionResults	getAllSubscriptionResults () const

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

int	getArrivedNumber () 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

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

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	getParameter (const std::string &objectID, const std::string &key) const
	retrieve generic paramter More...

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

int	getStartingTeleportNumber () const

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

double	getTime () const

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

	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

virtual	~SimulationScope ()

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
SimulationScope &	operator= (const SimulationScope &src)
	invalidated assignment operator More...

	SimulationScope (const SimulationScope &src)
	invalidated copy constructor More...

Detailed Description

Scope for interaction with the simulation.

Definition at line 492 of file TraCIAPI.h.

Constructor & Destructor Documentation

◆ SimulationScope() [1/2]

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

inline

Definition at line 494 of file TraCIAPI.h.

◆ ~SimulationScope()

virtual TraCIAPI::SimulationScope::~SimulationScope ( )

inlinevirtual

Definition at line 495 of file TraCIAPI.h.

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

◆ SimulationScope() [2/2]

TraCIAPI::SimulationScope::SimulationScope ( const SimulationScope & 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().

◆ getAllSubscriptionResults()

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

inherited

Definition at line 3176 of file TraCIAPI.cpp.

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

◆ getArrivedIDList()

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

Definition at line 1523 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_ARRIVED_VEHICLES_IDS.

◆ getArrivedNumber()

int TraCIAPI::SimulationScope::getArrivedNumber ( ) const

Definition at line 1518 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_ARRIVED_VEHICLES_NUMBER.

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

◆ getCurrentTime()

int TraCIAPI::SimulationScope::getCurrentTime ( ) const

Definition at line 1488 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_TIME_STEP.

Referenced by TraCITestClient::testAPI().

◆ getDeltaT()

double TraCIAPI::SimulationScope::getDeltaT ( ) const

Definition at line 1548 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_DELTA_T.

Referenced by TraCITestClient::testAPI().

◆ getDepartedIDList()

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

Definition at line 1513 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_DEPARTED_VEHICLES_IDS.

◆ getDepartedNumber()

int TraCIAPI::SimulationScope::getDepartedNumber ( ) const

Definition at line 1508 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_DEPARTED_VEHICLES_NUMBER.

◆ getDistance2D()

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

Definition at line 1565 of file TraCIAPI.cpp.

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

Referenced by TraCITestClient::testAPI().

◆ getDistanceRoad()

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

Definition at line 1584 of file TraCIAPI.cpp.

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

Referenced by TraCITestClient::testAPI().

◆ getEndingTeleportIDList()

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

Definition at line 1543 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_TELEPORT_ENDING_VEHICLES_IDS.

◆ getEndingTeleportNumber()

int TraCIAPI::SimulationScope::getEndingTeleportNumber ( ) const

Definition at line 1538 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_TELEPORT_ENDING_VEHICLES_NUMBER.

◆ getLoadedIDList()

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

Definition at line 1503 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_LOADED_VEHICLES_IDS.

◆ getLoadedNumber()

int TraCIAPI::SimulationScope::getLoadedNumber ( ) const

Definition at line 1498 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_LOADED_VEHICLES_NUMBER.

◆ getMinExpectedNumber()

int TraCIAPI::SimulationScope::getMinExpectedNumber ( ) const

Definition at line 1559 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_MIN_EXPECTED_VEHICLES.

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

◆ getNetBoundary()

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

Definition at line 1553 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_NET_BOUNDING_BOX.

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

◆ getStartingTeleportIDList()

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

Definition at line 1533 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_TELEPORT_STARTING_VEHICLES_IDS.

◆ getStartingTeleportNumber()

int TraCIAPI::SimulationScope::getStartingTeleportNumber ( ) const

Definition at line 1528 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_TELEPORT_STARTING_VEHICLES_NUMBER.

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

◆ getTime()

double TraCIAPI::SimulationScope::getTime ( ) const

Definition at line 1493 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_TIME.

◆ operator=()

SimulationScope& TraCIAPI::SimulationScope::operator= ( const SimulationScope & src )

private

invalidated assignment operator

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

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SimulationScope() [1/2]

◆ ~SimulationScope()

◆ SimulationScope() [2/2]

Member Function Documentation

◆ clearSubscriptionResults()

◆ getAllContextSubscriptionResults()

◆ getAllSubscriptionResults()

◆ getArrivedIDList()

◆ getArrivedNumber()

◆ getContextSubscriptionResults()

◆ getCurrentTime()

◆ getDeltaT()

◆ getDepartedIDList()

◆ getDepartedNumber()

◆ getDistance2D()

◆ getDistanceRoad()

◆ getEndingTeleportIDList()

◆ getEndingTeleportNumber()

◆ getLoadedIDList()

◆ getLoadedNumber()

◆ getMinExpectedNumber()

◆ getModifiableContextSubscriptionResults()

◆ getModifiableSubscriptionResults()

◆ getNetBoundary()

◆ getParameter()

◆ getStartingTeleportIDList()

◆ getStartingTeleportNumber()

◆ getSubscriptionResults()

◆ getTime()

◆ operator=()

◆ setParameter()

◆ subscribe()

◆ subscribeContext()

Field Documentation

◆ myCmdGetID

◆ myCmdSetID

◆ myContextSubscribeID

◆ myContextSubscriptionResults

◆ myParent

◆ mySubscribeID

◆ mySubscriptionResults