TraCIAPI::VehicleScope Class Reference

Scope for interaction with vehicles. More...

#include <TraCIAPI.h>

Inheritance diagram for TraCIAPI::VehicleScope:

Collaboration diagram for TraCIAPI::VehicleScope:

Public Member Functions
SUMOReal	getAccel (const std::string &typeID) const
SUMOReal	getAngle (const std::string &typeID) const
unsigned int	getBestLanes (const std::string &typeID) const
SUMOReal	getCO2Emissions (const std::string &typeID) const
SUMOReal	getCOEmissions (const std::string &typeID) const
TraCIColor	getColor (const std::string &typeID) const
SUMOReal	getDecel (const std::string &typeID) const
std::vector< std::string >	getEdges (const std::string &typeID) const
std::string	getEmissionClass (const std::string &typeID) const
SUMOReal	getFuelConsumption (const std::string &typeID) const
SUMOReal	getHCEmissions (const std::string &typeID) const
unsigned int	getIDCount () const
std::vector< std::string >	getIDList () const
SUMOReal	getImperfection (const std::string &typeID) const
std::string	getLaneID (const std::string &typeID) const
unsigned int	getLaneIndex (const std::string &typeID) const
SUMOReal	getLanePosition (const std::string &typeID) const
SUMOReal	getLength (const std::string &typeID) const
SUMOReal	getMaxSpeed (const std::string &typeID) const
SUMOReal	getMinGap (const std::string &typeID) const
SUMOReal	getNoiseEmission (const std::string &typeID) const
SUMOReal	getNOxEmissions (const std::string &typeID) const
SUMOReal	getPMxEmissions (const std::string &typeID) const
TraCIPosition	getPosition (const std::string &typeID) const
std::string	getRoadID (const std::string &typeID) const
std::string	getRouteID (const std::string &typeID) const
unsigned int	getRouteIndex (const std::string &typeID) const
std::string	getShapeClass (const std::string &typeID) const
unsigned int	getSignalStates (const std::string &typeID) const
SUMOReal	getSpeed (const std::string &typeID) const
SUMOReal	getSpeedDeviation (const std::string &typeID) const
SUMOReal	getSpeedFactor (const std::string &typeID) const
unsigned int	getStopState (const std::string &typeID) const
SUMOReal	getTau (const std::string &typeID) const
std::string	getTypeID (const std::string &typeID) const
std::string	getVClass (const std::string &typeID) const
SUMOReal	getWaitingTime (const std::string &typeID) const
SUMOReal	getWidth (const std::string &typeID) const
void	moveTo (const std::string &typeID, const std::string &laneID, SUMOReal position) const
void	setSpeed (const std::string &typeID, SUMOReal speed) const
void	slowDown (const std::string &typeID, 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 670 of file TraCIAPI.h.

Constructor & Destructor Documentation

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

inline

Definition at line 672 of file TraCIAPI.h.

virtual TraCIAPI::VehicleScope::~VehicleScope ( )

inlinevirtual

Definition at line 673 of file TraCIAPI.h.

References TraCIAPI::getColor(), TraCIAPI::getPosition(), and SUMOReal.

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

private

invalidated copy constructor

Member Function Documentation

SUMOReal TraCIAPI::VehicleScope::getAccel

(

const std::string &

typeID

)

const

SUMOReal TraCIAPI::VehicleScope::getAngle

(

const std::string &

typeID

)

const

Definition at line 1680 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_ANGLE.

unsigned int TraCIAPI::VehicleScope::getBestLanes

(

const std::string &

typeID

)

const

SUMOReal TraCIAPI::VehicleScope::getCO2Emissions

(

const std::string &

typeID

)

const

SUMOReal TraCIAPI::VehicleScope::getCOEmissions

(

const std::string &

typeID

)

const

TraCIAPI::TraCIColor TraCIAPI::VehicleScope::getColor

(

const std::string &

typeID

)

const

Definition at line 1720 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, SUMOReal, and VAR_COLOR.

SUMOReal TraCIAPI::VehicleScope::getDecel

(

const std::string &

typeID

)

const

std::vector< std::string > TraCIAPI::VehicleScope::getEdges

(

const std::string &

typeID

)

const

Definition at line 1715 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_EDGES.

std::string TraCIAPI::VehicleScope::getEmissionClass

(

const std::string &

typeID

)

const

SUMOReal TraCIAPI::VehicleScope::getFuelConsumption

(

const std::string &

typeID

)

const

SUMOReal TraCIAPI::VehicleScope::getHCEmissions

(

const std::string &

typeID

)

const

unsigned int TraCIAPI::VehicleScope::getIDCount

(

)

const

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

References CMD_GET_VEHICLE_VARIABLE, and ID_LIST.

Referenced by TraCITestClient::testAPI().

SUMOReal TraCIAPI::VehicleScope::getImperfection

(

const std::string &

typeID

)

const

std::string TraCIAPI::VehicleScope::getLaneID

(

const std::string &

typeID

)

const

Definition at line 1690 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_LANE_ID.

unsigned int TraCIAPI::VehicleScope::getLaneIndex

(

const std::string &

typeID

)

const

Definition at line 1695 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_LANE_INDEX.

SUMOReal TraCIAPI::VehicleScope::getLanePosition

(

const std::string &

typeID

)

const

Definition at line 1725 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_LANEPOSITION.

SUMOReal TraCIAPI::VehicleScope::getLength

(

const std::string &

typeID

)

const

SUMOReal TraCIAPI::VehicleScope::getMaxSpeed

(

const std::string &

typeID

)

const

SUMOReal TraCIAPI::VehicleScope::getMinGap

(

const std::string &

typeID

)

const

SUMOReal TraCIAPI::VehicleScope::getNoiseEmission

(

const std::string &

typeID

)

const

SUMOReal TraCIAPI::VehicleScope::getNOxEmissions

(

const std::string &

typeID

)

const

SUMOReal TraCIAPI::VehicleScope::getPMxEmissions

(

const std::string &

typeID

)

const

TraCIAPI::TraCIPosition TraCIAPI::VehicleScope::getPosition

(

const std::string &

typeID

)

const

Definition at line 1675 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, SUMOReal, and VAR_POSITION.

std::string TraCIAPI::VehicleScope::getRoadID

(

const std::string &

typeID

)

const

Definition at line 1685 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_ROAD_ID.

std::string TraCIAPI::VehicleScope::getRouteID

(

const std::string &

typeID

)

const

Definition at line 1705 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_ROAD_ID.

unsigned int TraCIAPI::VehicleScope::getRouteIndex

(

const std::string &

typeID

)

const

Definition at line 1710 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_ROUTE_INDEX.

std::string TraCIAPI::VehicleScope::getShapeClass

(

const std::string &

typeID

)

const

unsigned int TraCIAPI::VehicleScope::getSignalStates

(

const std::string &

typeID

)

const

SUMOReal TraCIAPI::VehicleScope::getSpeed

(

const std::string &

typeID

)

const

Definition at line 1670 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_SPEED.

SUMOReal TraCIAPI::VehicleScope::getSpeedDeviation

(

const std::string &

typeID

)

const

SUMOReal TraCIAPI::VehicleScope::getSpeedFactor

(

const std::string &

typeID

)

const

unsigned int TraCIAPI::VehicleScope::getStopState

(

const std::string &

typeID

)

const

SUMOReal TraCIAPI::VehicleScope::getTau

(

const std::string &

typeID

)

const

std::string TraCIAPI::VehicleScope::getTypeID

(

const std::string &

typeID

)

const

Definition at line 1700 of file TraCIAPI.cpp.

References CMD_GET_VEHICLE_VARIABLE, and VAR_TYPE.

std::string TraCIAPI::VehicleScope::getVClass

(

const std::string &

typeID

)

const

SUMOReal TraCIAPI::VehicleScope::getWaitingTime

(

const std::string &

typeID

)

const

SUMOReal TraCIAPI::VehicleScope::getWidth

(

const std::string &

typeID

)

const

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

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

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

private

invalidated assignment operator

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

Definition at line 1761 of file TraCIAPI.cpp.

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

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

Definition at line 1747 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 192 of file TraCIAPI.h.

---

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

• TraCIAPI.h
• TraCIAPI.cpp