Scope for interaction with vehicles. More...

#include <TraCIAPI.h>

Inheritance diagram for TraCIAPI::VehicleScope:

Collaboration diagram for TraCIAPI::VehicleScope:

Data Structures
struct	NextTLSData

Public Member Functions
void	add (const std::string &vehicleID, const std::string &routeID, const std::string &typeID="DEFAULT_VEHTYPE", std::string depart="-1", const std::string &departLane="first", const std::string &departPos="base", const std::string &departSpeed="0", const std::string &arrivalLane="current", const std::string &arrivalPos="max", const std::string &arrivalSpeed="current", const std::string &fromTaz="", const std::string &toTaz="", const std::string &line="", int personCapacity=0, int personNumber=0) const

SUMOReal	getAngle (const std::string &vehicleID) const

SUMOReal	getCO2Emission (const std::string &vehicleID) const

SUMOReal	getCOEmission (const std::string &vehicleID) const

TraCIColor	getColor (const std::string &vehicleID) const

std::vector< std::string >	getEdges (const std::string &vehicleID) const

SUMOReal	getElectricityConsumption (const std::string &vehicleID) const

std::string	getEmissionClass (const std::string &vehicleID) const

SUMOReal	getFuelConsumption (const std::string &vehicleID) const

SUMOReal	getHCEmission (const std::string &vehicleID) const

int	getIDCount () const

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

std::string	getLaneID (const std::string &vehicleID) const

int	getLaneIndex (const std::string &vehicleID) const

SUMOReal	getLanePosition (const std::string &vehicleID) const

std::string	getLine (const std::string &vehicleID) const

std::vector< NextTLSData >	getNextTLS (const std::string &vehID) const

SUMOReal	getNoiseEmission (const std::string &vehicleID) const

SUMOReal	getNOxEmission (const std::string &vehicleID) const

SUMOReal	getPMxEmission (const std::string &vehicleID) const

TraCIPosition	getPosition (const std::string &vehicleID) const

std::string	getRoadID (const std::string &vehicleID) const

std::string	getRouteID (const std::string &vehicleID) const

int	getRouteIndex (const std::string &vehicleID) const

std::string	getShapeClass (const std::string &vehicleID) const

int	getSignalStates (const std::string &vehicleID) const

SUMOReal	getSlope (const std::string &vehicleID) const

SUMOReal	getSpeed (const std::string &vehicleID) const

int	getSpeedMode (const std::string &vehicleID) const

std::string	getTypeID (const std::string &vehicleID) const

std::vector< std::string >	getVia (const std::string &vehicleID) const

SUMOReal	getWaitingTime (const std::string &vehicleID) const

void	moveTo (const std::string &vehicleID, const std::string &laneID, SUMOReal position) const

void	moveToXY (const std::string &vehicleID, const std::string &edgeID, const int lane, const SUMOReal x, const SUMOReal y, const SUMOReal angle, const int keepRoute) const

void	remove (const std::string &vehicleID, char reason=REMOVE_VAPORIZED) const

void	setColor (const std::string &vehicleID, const TraCIColor &c) const

void	setEmissionClass (const std::string &vehicleID, const std::string &clazz) const

void	setLine (const std::string &vehicleID, const std::string &line) const

void	setShapeClass (const std::string &vehicleID, const std::string &clazz) const

void	setSpeed (const std::string &vehicleID, SUMOReal speed) const

void	setVia (const std::string &vehicleID, const std::vector< std::string > &via) const

void	slowDown (const std::string &vehicleID, SUMOReal speed, int duration) const

	VehicleScope (TraCIAPI &parent)

virtual	~VehicleScope ()

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

Private Member Functions
VehicleScope &	operator= (const VehicleScope &src)
	invalidated assignment operator More...

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

Detailed Description

Scope for interaction with vehicles.

Definition at line 703 of file TraCIAPI.h.

Constructor & Destructor Documentation

TraCIAPI::VehicleScope::VehicleScope ( TraCIAPI & parent )

inline

Definition at line 705 of file TraCIAPI.h.

virtual TraCIAPI::VehicleScope::~VehicleScope ( )

inlinevirtual

Definition at line 706 of file TraCIAPI.h.

TraCIAPI::VehicleScope::VehicleScope ( const VehicleScope & src )

private

invalidated copy constructor

Member Function Documentation

void TraCIAPI::VehicleScope::add	(	const std::string &	vehicleID,
		const std::string &	routeID,
		const std::string &	typeID = `"DEFAULT_VEHTYPE"`,
		std::string	depart = `"-1"`,
		const std::string &	departLane = `"first"`,
		const std::string &	departPos = `"base"`,
		const std::string &	departSpeed = `"0"`,
		const std::string &	arrivalLane = `"current"`,
		const std::string &	arrivalPos = `"max"`,
		const std::string &	arrivalSpeed = `"current"`,
		const std::string &	fromTaz = `""`,
		const std::string &	toTaz = `""`,
		const std::string &	line = `""`,
		int	personCapacity = `0`,
		int	personNumber = `0`
	)		const

Definition at line 2061 of file TraCIAPI.cpp.

References ADD_FULL, CMD_SET_VEHICLE_VARIABLE, TraCIAPI::toString(), TYPE_COMPOUND, TYPE_INTEGER, TYPE_STRING, tcpip::Storage::writeInt(), tcpip::Storage::writeString(), and tcpip::Storage::writeUnsignedByte().

Referenced by TraCITestClient::testAPI().

SUMOReal TraCIAPI::VehicleScope::getAngle ( const std::string & vehicleID ) const

Definition at line 1903 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_ANGLE.

SUMOReal TraCIAPI::VehicleScope::getCO2Emission ( const std::string & vehicleID ) const

Definition at line 1953 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, SUMOReal, and VAR_CO2EMISSION.

SUMOReal TraCIAPI::VehicleScope::getCOEmission ( const std::string & vehicleID ) const

Definition at line 1958 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, SUMOReal, and VAR_COEMISSION.

TraCIAPI::TraCIColor TraCIAPI::VehicleScope::getColor ( const std::string & vehicleID ) const

Definition at line 1943 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, SUMOReal, and VAR_COLOR.

Referenced by TraCITestClient::testAPI().

std::vector< std::string > TraCIAPI::VehicleScope::getEdges ( const std::string & vehicleID ) const

Definition at line 1938 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_EDGES.

SUMOReal TraCIAPI::VehicleScope::getElectricityConsumption ( const std::string & vehicleID ) const

Definition at line 1988 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, SUMOReal, and VAR_ELECTRICITYCONSUMPTION.

std::string TraCIAPI::VehicleScope::getEmissionClass ( const std::string & vehicleID ) const

Definition at line 2021 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_EMISSIONCLASS.

SUMOReal TraCIAPI::VehicleScope::getFuelConsumption ( const std::string & vehicleID ) const

Definition at line 1978 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, SUMOReal, and VAR_FUELCONSUMPTION.

SUMOReal TraCIAPI::VehicleScope::getHCEmission ( const std::string & vehicleID ) const

Definition at line 1963 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, SUMOReal, and VAR_HCEMISSION.

int TraCIAPI::VehicleScope::getIDCount ( ) const

Definition at line 1888 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, ID_COUNT, and SUMOReal.

Referenced by TraCITestClient::testAPI().

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

Definition at line 1883 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and ID_LIST.

Referenced by TraCITestClient::testAPI().

std::string TraCIAPI::VehicleScope::getLaneID ( const std::string & vehicleID ) const

Definition at line 1913 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_LANE_ID.

Referenced by TraCITestClient::testAPI().

int TraCIAPI::VehicleScope::getLaneIndex ( const std::string & vehicleID ) const

Definition at line 1918 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_LANE_INDEX.

SUMOReal TraCIAPI::VehicleScope::getLanePosition ( const std::string & vehicleID ) const

Definition at line 1948 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, SUMOReal, and VAR_LANEPOSITION.

std::string TraCIAPI::VehicleScope::getLine ( const std::string & vehicleID ) const

Definition at line 2011 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_LINE.

Referenced by TraCITestClient::testAPI().

std::vector< TraCIAPI::VehicleScope::NextTLSData > TraCIAPI::VehicleScope::getNextTLS ( const std::string & vehID ) const

Definition at line 2031 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, TraCIAPI::VehicleScope::NextTLSData::dist, TraCIAPI::VehicleScope::NextTLSData::id, tcpip::Storage::readByte(), tcpip::Storage::readDouble(), tcpip::Storage::readInt(), tcpip::Storage::readString(), tcpip::Storage::readUnsignedByte(), TraCIAPI::VehicleScope::NextTLSData::state, TraCIAPI::VehicleScope::NextTLSData::tlIndex, TYPE_COMPOUND, and VAR_NEXT_TLS.

Referenced by TraCITestClient::testAPI().

SUMOReal TraCIAPI::VehicleScope::getNoiseEmission ( const std::string & vehicleID ) const

Definition at line 1983 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, SUMOReal, and VAR_NOISEEMISSION.

SUMOReal TraCIAPI::VehicleScope::getNOxEmission ( const std::string & vehicleID ) const

Definition at line 1973 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, SUMOReal, and VAR_NOXEMISSION.

SUMOReal TraCIAPI::VehicleScope::getPMxEmission ( const std::string & vehicleID ) const

Definition at line 1968 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, SUMOReal, and VAR_PMXEMISSION.

TraCIAPI::TraCIPosition TraCIAPI::VehicleScope::getPosition ( const std::string & vehicleID ) const

Definition at line 1898 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, SUMOReal, and VAR_POSITION.

std::string TraCIAPI::VehicleScope::getRoadID ( const std::string & vehicleID ) const

Definition at line 1908 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_ROAD_ID.

Referenced by TraCITestClient::testAPI().

std::string TraCIAPI::VehicleScope::getRouteID ( const std::string & vehicleID ) const

Definition at line 1928 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_ROAD_ID.

int TraCIAPI::VehicleScope::getRouteIndex ( const std::string & vehicleID ) const

Definition at line 1933 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_ROUTE_INDEX.

std::string TraCIAPI::VehicleScope::getShapeClass ( const std::string & vehicleID ) const

Definition at line 2026 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_SHAPECLASS.

Referenced by TraCITestClient::testAPI().

int TraCIAPI::VehicleScope::getSignalStates ( const std::string & vehicleID ) const

SUMOReal TraCIAPI::VehicleScope::getSlope ( const std::string & vehicleID ) const

Definition at line 2005 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_SLOPE.

Referenced by TraCITestClient::testAPI().

SUMOReal TraCIAPI::VehicleScope::getSpeed ( const std::string & vehicleID ) const

Definition at line 1893 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_SPEED.

int TraCIAPI::VehicleScope::getSpeedMode ( const std::string & vehicleID ) const

Definition at line 1999 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, SUMOReal, and VAR_SPEEDSETMODE.

Referenced by TraCITestClient::testAPI().

std::string TraCIAPI::VehicleScope::getTypeID ( const std::string & vehicleID ) const

Definition at line 1923 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_TYPE.

std::vector< std::string > TraCIAPI::VehicleScope::getVia ( const std::string & vehicleID ) const

Definition at line 2016 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_VIA.

Referenced by TraCITestClient::testAPI().

SUMOReal TraCIAPI::VehicleScope::getWaitingTime ( const std::string & vehicleID ) const

Definition at line 1993 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_WAITING_TIME.

Referenced by TraCITestClient::testAPI().

void TraCIAPI::VehicleScope::moveTo	(	const std::string &	vehicleID,
		const std::string &	laneID,
		SUMOReal	position
	)		const

Definition at line 2134 of file TraCIAPI.cpp.

References CMD_SET_VEHICLE_VARIABLE, TYPE_COMPOUND, TYPE_DOUBLE, TYPE_STRING, VAR_MOVE_TO, tcpip::Storage::writeDouble(), tcpip::Storage::writeInt(), tcpip::Storage::writeString(), and tcpip::Storage::writeUnsignedByte().

void TraCIAPI::VehicleScope::moveToXY	(	const std::string &	vehicleID,
		const std::string &	edgeID,
		const int	lane,
		const SUMOReal	x,
		const SUMOReal	y,
		const SUMOReal	angle,
		const int	keepRoute
	)		const

Definition at line 2148 of file TraCIAPI.cpp.

References CMD_SET_VEHICLE_VARIABLE.

Referenced by TraCITestClient::testAPI().

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

private

invalidated assignment operator

void TraCIAPI::VehicleScope::remove	(	const std::string &	vehicleID,
		char	reason = `REMOVE_VAPORIZED`
	)		const

Definition at line 2122 of file TraCIAPI.cpp.

References CMD_SET_VEHICLE_VARIABLE, REMOVE, TYPE_BYTE, and tcpip::Storage::writeUnsignedByte().

Referenced by TraCITestClient::testAPI().

void TraCIAPI::VehicleScope::setColor	(	const std::string &	vehicleID,
		const TraCIColor &	c
	)		const

Definition at line 2180 of file TraCIAPI.cpp.

References TraCIAPI::TraCIColor::a, TraCIAPI::TraCIColor::b, CMD_SET_VEHICLE_VARIABLE, TraCIAPI::TraCIColor::g, TraCIAPI::TraCIColor::r, TYPE_COLOR, VAR_COLOR, and tcpip::Storage::writeUnsignedByte().

Referenced by TraCITestClient::testAPI().

void TraCIAPI::VehicleScope::setEmissionClass	(	const std::string &	vehicleID,
		const std::string &	clazz
	)		const

Definition at line 2228 of file TraCIAPI.cpp.

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

void TraCIAPI::VehicleScope::setLine	(	const std::string &	vehicleID,
		const std::string &	line
	)		const

Definition at line 2193 of file TraCIAPI.cpp.

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

Referenced by TraCITestClient::testAPI().

void TraCIAPI::VehicleScope::setShapeClass	(	const std::string &	vehicleID,
		const std::string &	clazz
	)		const

Definition at line 2217 of file TraCIAPI.cpp.

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

Referenced by TraCITestClient::testAPI().

void TraCIAPI::VehicleScope::setSpeed	(	const std::string &	vehicleID,
		SUMOReal	speed
	)		const

Definition at line 2170 of file TraCIAPI.cpp.

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

void TraCIAPI::VehicleScope::setVia	(	const std::string &	vehicleID,
		const std::vector< std::string > &	via
	)		const

Definition at line 2203 of file TraCIAPI.cpp.

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

Referenced by TraCITestClient::testAPI().

void TraCIAPI::VehicleScope::slowDown	(	const std::string &	vehicleID,
		SUMOReal	speed,
		int	duration
	)		const

Definition at line 2156 of file TraCIAPI.cpp.

References CMD_SET_VEHICLE_VARIABLE, CMD_SLOWDOWN, TYPE_COMPOUND, TYPE_DOUBLE, TYPE_INTEGER, tcpip::Storage::writeDouble(), tcpip::Storage::writeInt(), and tcpip::Storage::writeUnsignedByte().

Field Documentation

TraCIAPI& TraCIAPI::TraCIScopeWrapper::myParent

protectedinherited

The parent TraCI client which offers the connection.

Definition at line 208 of file TraCIAPI.h.

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

Data Structures

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation