An abstract interface for accessing type-dependent values. More...

#include <TraCIAPI.h>

Inheritance diagram for TraCIAPI::TraCIScopeWrapper:

Collaboration diagram for TraCIAPI::TraCIScopeWrapper:

Public Member Functions
void	clearSubscriptionResults ()

const libsumo::ContextSubscriptionResults	getAllContextSubscriptionResults () const

const libsumo::SubscriptionResults	getAllSubscriptionResults () const

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

int	getIDCount () const

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

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

libsumo::SubscriptionResults &	getModifiableSubscriptionResults ()

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

const libsumo::TraCIResults	getSubscriptionResults (const std::string &objID) 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

	TraCIScopeWrapper (TraCIAPI &parent, int cmdGetID, int cmdSetID, int subscribeID, int contextSubscribeID)
	Constructor. More...

virtual	~TraCIScopeWrapper ()
	Destructor. More...

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 Member Functions
TraCIScopeWrapper &	operator= (const TraCIScopeWrapper &src)=delete
	invalidated assignment operator More...

Private Attributes
int	myCmdGetID

int	myCmdSetID

int	myContextSubscribeID

libsumo::ContextSubscriptionResults	myContextSubscriptionResults

int	mySubscribeID

libsumo::SubscriptionResults	mySubscriptionResults

Detailed Description

An abstract interface for accessing type-dependent values.

Must be derived by interfaces which implement access methods to certain object types

Definition at line 88 of file TraCIAPI.h.

Constructor & Destructor Documentation

◆ TraCIScopeWrapper()

TraCIAPI::TraCIScopeWrapper::TraCIScopeWrapper	(	TraCIAPI &	parent,
		int	cmdGetID,
		int	cmdSetID,
		int	subscribeID,
		int	contextSubscribeID
	)

inline

Constructor.

Parameters

[in] parent The parent TraCI client which offers the connection

Definition at line 93 of file TraCIAPI.h.

◆ ~TraCIScopeWrapper()

virtual TraCIAPI::TraCIScopeWrapper::~TraCIScopeWrapper ( )

inlinevirtual

Destructor.

Definition at line 102 of file TraCIAPI.h.

Member Function Documentation

◆ clearSubscriptionResults()

void TraCIAPI::TraCIScopeWrapper::clearSubscriptionResults ( )

Definition at line 3894 of file TraCIAPI.cpp.

◆ getAllContextSubscriptionResults()

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

Definition at line 3878 of file TraCIAPI.cpp.

◆ getAllSubscriptionResults()

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

Definition at line 3862 of file TraCIAPI.cpp.

◆ getByte()

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

protected

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

protected

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

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

protected

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

protected

Definition at line 3666 of file TraCIAPI.cpp.

References libsumo::TYPE_DOUBLELIST.

◆ getIDCount()

int TraCIAPI::TraCIScopeWrapper::getIDCount ( ) const

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

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

protected

Definition at line 3575 of file TraCIAPI.cpp.

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

◆ getModifiableContextSubscriptionResults()

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

Definition at line 3907 of file TraCIAPI.cpp.

◆ getModifiableSubscriptionResults()

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

Definition at line 3901 of file TraCIAPI.cpp.

◆ getParameter()

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

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

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

protected

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

protected

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

protected

Definition at line 3629 of file TraCIAPI.cpp.

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

◆ getString()

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

protected

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

protected

Definition at line 3652 of file TraCIAPI.cpp.

References libsumo::TYPE_STRINGLIST.

◆ getSubscriptionResults()

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

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

protected

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

protected

Definition at line 3554 of file TraCIAPI.cpp.

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

◆ operator=()

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

privatedelete

invalidated assignment operator

◆ setDouble()

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

protected

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

protected

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

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

protected

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

protected

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

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

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

private

Definition at line 154 of file TraCIAPI.h.

◆ myCmdSetID

int TraCIAPI::TraCIScopeWrapper::myCmdSetID

private

Definition at line 155 of file TraCIAPI.h.

◆ myContextSubscribeID

int TraCIAPI::TraCIScopeWrapper::myContextSubscribeID

private

Definition at line 157 of file TraCIAPI.h.

◆ myContextSubscriptionResults

libsumo::ContextSubscriptionResults TraCIAPI::TraCIScopeWrapper::myContextSubscriptionResults

private

Definition at line 159 of file TraCIAPI.h.

◆ myParent

TraCIAPI& TraCIAPI::TraCIScopeWrapper::myParent

protected

The parent TraCI client which offers the connection.

Definition at line 151 of file TraCIAPI.h.

◆ mySubscribeID

int TraCIAPI::TraCIScopeWrapper::mySubscribeID

private

Definition at line 156 of file TraCIAPI.h.

◆ mySubscriptionResults

libsumo::SubscriptionResults TraCIAPI::TraCIScopeWrapper::mySubscriptionResults

private

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

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TraCIScopeWrapper()

◆ ~TraCIScopeWrapper()

Member Function Documentation

◆ clearSubscriptionResults()

◆ getAllContextSubscriptionResults()

◆ getAllSubscriptionResults()

◆ getByte()

◆ getCol()

◆ getContextSubscriptionResults()

◆ getDouble()

◆ getDoubleVector()

◆ getIDCount()

◆ getIDList()

◆ getInt()

◆ getModifiableContextSubscriptionResults()

◆ getModifiableSubscriptionResults()

◆ getParameter()

◆ getParameterWithKey()

◆ getPolygon()

◆ getPos()

◆ getPos3D()

◆ getString()

◆ getStringVector()

◆ getSubscriptionResults()

◆ getTraCIStage()

◆ getUnsignedByte()

◆ operator=()

◆ setDouble()

◆ setInt()

◆ setParameter()

◆ setString()

◆ setStringVector()

◆ subscribe()

◆ subscribeContext()

Field Documentation

◆ myCmdGetID

◆ myCmdSetID

◆ myContextSubscribeID

◆ myContextSubscriptionResults

◆ myParent

◆ mySubscribeID

◆ mySubscriptionResults