Scope for interaction with vehicles. More...

#include <TraCIAPI.h>

Inheritance diagram for TraCIAPI::VehicleScope:

Collaboration diagram for TraCIAPI::VehicleScope:

Public Types
enum	VehicleSignal { SIGNAL_BLINKER_RIGHT = 1 , SIGNAL_BLINKER_LEFT = 2 , SIGNAL_BLINKER_EMERGENCY = 4 , SIGNAL_BRAKELIGHT = 8 , SIGNAL_FRONTLIGHT = 16 , SIGNAL_FOGLIGHT = 32 , SIGNAL_HIGHBEAM = 64 , SIGNAL_BACKDRIVE = 128 , SIGNAL_WIPER = 256 , SIGNAL_DOOR_OPEN_LEFT = 512 , SIGNAL_DOOR_OPEN_RIGHT = 1024 , SIGNAL_EMERGENCY_BLUE = 2048 , SIGNAL_EMERGENCY_RED = 4096 , SIGNAL_EMERGENCY_YELLOW = 8192 , SIGNAL_RESET = -1 }

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

	VehicleScope (TraCIAPI &parent)

virtual	~VehicleScope ()

vehicle value retrieval
double	getSpeed (const std::string &vehicleID) const

double	getLateralSpeed (const std::string &vehicleID) const

double	getAcceleration (const std::string &vehicleID) const

double	getFollowSpeed (const std::string &vehicleID, double speed, double gap, double leaderSpeed, double leaderMaxDecel, const std::string &leaderID="") const

double	getSecureGap (const std::string &vehicleID, double speed, double leaderSpeed, double leaderMaxDecel, const std::string &leaderID="") const

double	getStopSpeed (const std::string &vehicleID, double speed, double gap) const

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

libsumo::TraCIPosition	getPosition3D (const std::string &vehicleID) const

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

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

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

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

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

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

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

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

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

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

double	getDistance (const std::string &vehicleID) const

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

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

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

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

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

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

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

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

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

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

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

double	getAccumulatedWaitingTime (const std::string &vehicleID) const

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

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

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

double	getAllowedSpeed (const std::string &vehicleID) const

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

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

double	getSpeedWithoutTraCI (const std::string &vehicleID) const

bool	isRouteValid (const std::string &vehicleID) const

double	getLateralLanePosition (const std::string &vehicleID) const

double	getSpeedFactor (const std::string &vehicleID) const

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

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

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

std::vector< libsumo::TraCIBestLanesData >	getBestLanes (const std::string &vehicleID) const

std::pair< std::string, double >	getLeader (const std::string &vehicleID, double dist) const

std::pair< std::string, double >	getFollower (const std::string &vehicleID, double dist) const

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

double	getStopDelay (const std::string &vehicleID) const

double	getStopArrivalDelay (const std::string &vehicleID) const

std::pair< int, int >	getLaneChangeState (const std::string &vehicleID, int direction) const

vehicle type value retrieval shortcuts
double	getLength (const std::string &vehicleID) const

double	getMaxSpeed (const std::string &vehicleID) const

double	getAccel (const std::string &vehicleID) const

double	getDecel (const std::string &vehicleID) const

double	getEmergencyDecel (const std::string &vehicleID) const

double	getApparentDecel (const std::string &vehicleID) const

double	getTau (const std::string &vehicleID) const

double	getImperfection (const std::string &vehicleID) const

double	getSpeedDeviation (const std::string &vehicleID) const

double	getMinGap (const std::string &vehicleID) const

double	getWidth (const std::string &vehicleID) const

double	getHeight (const std::string &veihcleID) const

double	getMaxSpeedLat (const std::string &vehicleID) const

double	getMinGapLat (const std::string &vehicleID) const

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

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

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

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

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

vehicle state changing
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

void	changeTarget (const std::string &vehicleID, const std::string &edgeID) const

void	changeLane (const std::string &vehicleID, int laneIndex, double duration) const

void	changeLaneRelative (const std::string &vehicleID, int laneChange, double duration) const

void	changeSublane (const std::string &vehicleID, double latDist) const

void	setRouteID (const std::string &vehicleID, const std::string &routeID) const

void	setRoute (const std::string &vehicleID, const std::vector< std::string > &edge) const

void	rerouteTraveltime (const std::string &vehicleID, bool currentTravelTimes=true) const

void	moveTo (const std::string &vehicleID, const std::string &laneID, double position, int reason=libsumo::MOVE_TELEPORT) const

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

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

void	openGap (const std::string &vehicleID, double newTau, double duration, double changeRate, double maxDecel) const

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

void	setAcceleration (const std::string &vehicleID, double accel, double duration) const

void	setPreviousSpeed (const std::string &vehicleID, double prevSpeed, double prevAcceleration=std::numeric_limits< int >::min()) const

void	setLaneChangeMode (const std::string &vehicleID, int mode) const

void	setSpeedMode (const std::string &vehicleID, int mode) const

void	setStop (const std::string vehicleID, const std::string edgeID, const double endPos=1., const int laneIndex=0, const double duration=std::numeric_limits< double >::max(), const int flags=0, const double startPos=std::numeric_limits< int >::min(), const double until=-1) const

void	setType (const std::string &vehicleID, const std::string &typeID) const

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

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

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

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

void	setSignals (const std::string &vehicleID, int signals) const

void	setRoutingMode (const std::string &vehicleID, int routingMode) const

vehicle type attribute changing shortcuts
void	setShapeClass (const std::string &vehicleID, const std::string &clazz) const

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

void	setSpeedFactor (const std::string &vehicleID, double factor) const

void	setMinGap (const std::string &vehicleID, double minGap) const

void	setMaxSpeed (const std::string &vehicleID, double speed) const

subscription filtering
void	addSubscriptionFilterLanes (const std::vector< int > &lanes, bool noOpposite=false, double downstreamDist=-1, double upstreamDist=-1) const

void	addSubscriptionFilterNoOpposite () const

void	addSubscriptionFilterDownstreamDistance (double dist) const

void	addSubscriptionFilterUpstreamDistance (double dist) const

void	addSubscriptionFilterCFManeuver (double downstreamDist=-1, double upstreamDist=-1) const

void	addSubscriptionFilterLCManeuver (int direction, bool noOpposite=false, double downstreamDist=-1, double upstreamDist=-1) const

void	addSubscriptionFilterLeadFollow (const std::vector< int > &lanes) const

void	addSubscriptionFilterTurn (double downstreamDist=-1, double upstreamDist=-1) const

void	addSubscriptionFilterVClass (const std::vector< std::string > &vClasses) const

void	addSubscriptionFilterVType (const std::vector< std::string > &vTypes) const

void	addSubscriptionFilterFieldOfVision (double angle) const

void	addSubscriptionFilterLateralDistance (double lateralDist, double downstreamDist=-1, double foeDistToJunction=-1) const

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
void	addSubscriptionFilterByteList (int filterType, const std::vector< int > &vals) const

void	addSubscriptionFilterEmpty (int filterType) const

void	addSubscriptionFilterFloat (int filterType, double val) const

void	addSubscriptionFilterStringList (int filterType, const std::vector< std::string > &vals) const

Private Attributes
int	myCmdGetID

int	myCmdSetID

int	myContextSubscribeID

libsumo::ContextSubscriptionResults	myContextSubscriptionResults

int	mySubscribeID

libsumo::SubscriptionResults	mySubscriptionResults

Detailed Description

Scope for interaction with vehicles.

Definition at line 556 of file TraCIAPI.h.

Member Enumeration Documentation

◆ VehicleSignal

enum TraCIAPI::VehicleScope::VehicleSignal

Enumerator
SIGNAL_BLINKER_RIGHT
SIGNAL_BLINKER_LEFT
SIGNAL_BLINKER_EMERGENCY
SIGNAL_BRAKELIGHT
SIGNAL_FRONTLIGHT
SIGNAL_FOGLIGHT
SIGNAL_HIGHBEAM
SIGNAL_BACKDRIVE
SIGNAL_WIPER
SIGNAL_DOOR_OPEN_LEFT
SIGNAL_DOOR_OPEN_RIGHT
SIGNAL_EMERGENCY_BLUE
SIGNAL_EMERGENCY_RED
SIGNAL_EMERGENCY_YELLOW
SIGNAL_RESET

Definition at line 561 of file TraCIAPI.h.

Constructor & Destructor Documentation

◆ VehicleScope()

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

inline

Definition at line 558 of file TraCIAPI.h.

◆ ~VehicleScope()

virtual TraCIAPI::VehicleScope::~VehicleScope ( )

inlinevirtual

Definition at line 559 of file TraCIAPI.h.

Member Function Documentation

◆ add()

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 2643 of file TraCIAPI.cpp.

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

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ addSubscriptionFilterByteList()

void TraCIAPI::VehicleScope::addSubscriptionFilterByteList	(	int	filterType,
		const std::vector< int > &	vals
	)		const

private

Definition at line 3190 of file TraCIAPI.cpp.

References libsumo::CMD_ADD_SUBSCRIPTION_FILTER, tcpip::Storage::writeByte(), and tcpip::Storage::writeUnsignedByte().

◆ addSubscriptionFilterCFManeuver()

void TraCIAPI::VehicleScope::addSubscriptionFilterCFManeuver	(	double	downstreamDist = `-1`,
		double	upstreamDist = `-1`
	)		const

Definition at line 3092 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ addSubscriptionFilterDownstreamDistance()

void TraCIAPI::VehicleScope::addSubscriptionFilterDownstreamDistance ( double dist ) const

Definition at line 3081 of file TraCIAPI.cpp.

References libsumo::FILTER_TYPE_DOWNSTREAM_DIST.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ addSubscriptionFilterEmpty()

void TraCIAPI::VehicleScope::addSubscriptionFilterEmpty ( int filterType ) const

private

Definition at line 3164 of file TraCIAPI.cpp.

References libsumo::CMD_ADD_SUBSCRIPTION_FILTER.

◆ addSubscriptionFilterFieldOfVision()

void TraCIAPI::VehicleScope::addSubscriptionFilterFieldOfVision ( double angle ) const

Definition at line 3148 of file TraCIAPI.cpp.

References libsumo::FILTER_TYPE_FIELD_OF_VISION.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ addSubscriptionFilterFloat()

void TraCIAPI::VehicleScope::addSubscriptionFilterFloat	(	int	filterType,
		double	val
	)		const

private

Definition at line 3170 of file TraCIAPI.cpp.

References libsumo::CMD_ADD_SUBSCRIPTION_FILTER, libsumo::TYPE_DOUBLE, tcpip::Storage::writeDouble(), and tcpip::Storage::writeUnsignedByte().

◆ addSubscriptionFilterLanes()

void TraCIAPI::VehicleScope::addSubscriptionFilterLanes	(	const std::vector< int > &	lanes,
		bool	noOpposite = `false`,
		double	downstreamDist = `-1`,
		double	upstreamDist = `-1`
	)		const

Definition at line 3060 of file TraCIAPI.cpp.

References libsumo::FILTER_TYPE_LANES.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ addSubscriptionFilterLateralDistance()

void TraCIAPI::VehicleScope::addSubscriptionFilterLateralDistance	(	double	lateralDist,
		double	downstreamDist = `-1`,
		double	foeDistToJunction = `-1`
	)		const

Definition at line 3153 of file TraCIAPI.cpp.

References libsumo::FILTER_TYPE_LATERAL_DIST.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ addSubscriptionFilterLCManeuver()

void TraCIAPI::VehicleScope::addSubscriptionFilterLCManeuver	(	int	direction,
		bool	noOpposite = `false`,
		double	downstreamDist = `-1`,
		double	upstreamDist = `-1`
	)		const

Definition at line 3103 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ addSubscriptionFilterLeadFollow()

void TraCIAPI::VehicleScope::addSubscriptionFilterLeadFollow ( const std::vector< int > & lanes ) const

Definition at line 3121 of file TraCIAPI.cpp.

References libsumo::FILTER_TYPE_LANES, and libsumo::FILTER_TYPE_LEAD_FOLLOW.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ addSubscriptionFilterNoOpposite()

void TraCIAPI::VehicleScope::addSubscriptionFilterNoOpposite ( ) const

Definition at line 3076 of file TraCIAPI.cpp.

References libsumo::FILTER_TYPE_NOOPPOSITE.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ addSubscriptionFilterStringList()

void TraCIAPI::VehicleScope::addSubscriptionFilterStringList	(	int	filterType,
		const std::vector< std::string > &	vals
	)		const

private

Definition at line 3180 of file TraCIAPI.cpp.

References libsumo::CMD_ADD_SUBSCRIPTION_FILTER, libsumo::TYPE_STRINGLIST, tcpip::Storage::writeStringList(), and tcpip::Storage::writeUnsignedByte().

◆ addSubscriptionFilterTurn()

void TraCIAPI::VehicleScope::addSubscriptionFilterTurn	(	double	downstreamDist = `-1`,
		double	upstreamDist = `-1`
	)		const

Definition at line 3127 of file TraCIAPI.cpp.

References libsumo::FILTER_TYPE_TURN.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ addSubscriptionFilterUpstreamDistance()

void TraCIAPI::VehicleScope::addSubscriptionFilterUpstreamDistance ( double dist ) const

Definition at line 3086 of file TraCIAPI.cpp.

References libsumo::FILTER_TYPE_UPSTREAM_DIST.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ addSubscriptionFilterVClass()

void TraCIAPI::VehicleScope::addSubscriptionFilterVClass ( const std::vector< std::string > & vClasses ) const

Definition at line 3136 of file TraCIAPI.cpp.

References libsumo::FILTER_TYPE_VCLASS.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ addSubscriptionFilterVType()

void TraCIAPI::VehicleScope::addSubscriptionFilterVType ( const std::vector< std::string > & vTypes ) const

Definition at line 3142 of file TraCIAPI.cpp.

References libsumo::FILTER_TYPE_VTYPE.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ changeLane()

void TraCIAPI::VehicleScope::changeLane	(	const std::string &	vehicleID,
		int	laneIndex,
		double	duration
	)		const

Definition at line 2724 of file TraCIAPI.cpp.

References libsumo::CMD_CHANGELANE, libsumo::CMD_SET_VEHICLE_VARIABLE, libsumo::TYPE_BYTE, libsumo::TYPE_COMPOUND, libsumo::TYPE_DOUBLE, tcpip::Storage::writeByte(), tcpip::Storage::writeDouble(), tcpip::Storage::writeInt(), and tcpip::Storage::writeUnsignedByte().

◆ changeLaneRelative()

void TraCIAPI::VehicleScope::changeLaneRelative	(	const std::string &	vehicleID,
		int	laneChange,
		double	duration
	)		const

Definition at line 2738 of file TraCIAPI.cpp.

References libsumo::CMD_CHANGELANE, libsumo::CMD_SET_VEHICLE_VARIABLE, libsumo::TYPE_BYTE, libsumo::TYPE_COMPOUND, libsumo::TYPE_DOUBLE, tcpip::Storage::writeByte(), tcpip::Storage::writeDouble(), tcpip::Storage::writeInt(), and tcpip::Storage::writeUnsignedByte().

◆ changeSublane()

void TraCIAPI::VehicleScope::changeSublane	(	const std::string &	vehicleID,
		double	latDist
	)		const

Definition at line 2754 of file TraCIAPI.cpp.

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

◆ changeTarget()

void TraCIAPI::VehicleScope::changeTarget	(	const std::string &	vehicleID,
		const std::string &	edgeID
	)		const

Definition at line 2714 of file TraCIAPI.cpp.

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

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ clearSubscriptionResults()

void TraCIAPI::TraCIScopeWrapper::clearSubscriptionResults ( )

inherited

Definition at line 3894 of file TraCIAPI.cpp.

◆ getAccel()

double TraCIAPI::VehicleScope::getAccel ( const std::string & vehicleID ) const

Definition at line 2538 of file TraCIAPI.cpp.

References libsumo::VAR_ACCEL.

◆ getAcceleration()

double TraCIAPI::VehicleScope::getAcceleration ( const std::string & vehicleID ) const

Definition at line 2178 of file TraCIAPI.cpp.

References libsumo::VAR_ACCELERATION.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getAccumulatedWaitingTime()

double TraCIAPI::VehicleScope::getAccumulatedWaitingTime ( const std::string & vehicleID ) const

Definition at line 2593 of file TraCIAPI.cpp.

References libsumo::VAR_ACCUMULATED_WAITING_TIME.

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.

◆ getAllowedSpeed()

double TraCIAPI::VehicleScope::getAllowedSpeed ( const std::string & vehicleID ) const

Definition at line 2598 of file TraCIAPI.cpp.

References libsumo::VAR_ALLOWED_SPEED.

◆ getAllSubscriptionResults()

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

inherited

Definition at line 3862 of file TraCIAPI.cpp.

◆ getAngle()

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

Definition at line 2246 of file TraCIAPI.cpp.

References libsumo::VAR_ANGLE.

◆ getApparentDecel()

double TraCIAPI::VehicleScope::getApparentDecel ( const std::string & vehicleID ) const

◆ getBestLanes()

std::vector< libsumo::TraCIBestLanesData > TraCIAPI::VehicleScope::getBestLanes ( const std::string & vehicleID ) const

Definition at line 2424 of file TraCIAPI.cpp.

References libsumo::TraCIBestLanesData::allowsContinuation, libsumo::TraCIBestLanesData::bestLaneOffset, libsumo::CMD_GET_VEHICLE_VARIABLE, libsumo::TraCIBestLanesData::continuationLanes, libsumo::TraCIBestLanesData::laneID, libsumo::TraCIBestLanesData::length, libsumo::TraCIBestLanesData::occupation, libsumo::TYPE_COMPOUND, and libsumo::VAR_BEST_LANES.

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

◆ getCO2Emission()

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

Definition at line 2312 of file TraCIAPI.cpp.

References libsumo::VAR_CO2EMISSION.

◆ getCOEmission()

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

Definition at line 2317 of file TraCIAPI.cpp.

References libsumo::VAR_COEMISSION.

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

◆ getColor()

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

Definition at line 2287 of file TraCIAPI.cpp.

References libsumo::VAR_COLOR.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

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

◆ getDecel()

double TraCIAPI::VehicleScope::getDecel ( const std::string & vehicleID ) const

Definition at line 2543 of file TraCIAPI.cpp.

References libsumo::VAR_DECEL.

◆ getDistance()

double TraCIAPI::VehicleScope::getDistance ( const std::string & vehicleID ) const

Definition at line 2297 of file TraCIAPI.cpp.

References libsumo::VAR_DISTANCE.

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

◆ getElectricityConsumption()

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

Definition at line 2347 of file TraCIAPI.cpp.

References libsumo::VAR_ELECTRICITYCONSUMPTION.

◆ getEmergencyDecel()

double TraCIAPI::VehicleScope::getEmergencyDecel ( const std::string & vehicleID ) const

◆ getEmissionClass()

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

Definition at line 2385 of file TraCIAPI.cpp.

References libsumo::VAR_EMISSIONCLASS.

◆ getFollower()

std::pair< std::string, double > TraCIAPI::VehicleScope::getFollower	(	const std::string &	vehicleID,
		double	dist
	)		const

Definition at line 2481 of file TraCIAPI.cpp.

References libsumo::CMD_GET_VEHICLE_VARIABLE, libsumo::INVALID_DOUBLE_VALUE, libsumo::TYPE_COMPOUND, libsumo::TYPE_DOUBLE, libsumo::VAR_FOLLOWER, tcpip::Storage::writeByte(), and tcpip::Storage::writeDouble().

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getFollowSpeed()

double TraCIAPI::VehicleScope::getFollowSpeed	(	const std::string &	vehicleID,
		double	speed,
		double	gap,
		double	leaderSpeed,
		double	leaderMaxDecel,
		const std::string &	leaderID = `""`
	)		const

Definition at line 2183 of file TraCIAPI.cpp.

References libsumo::TYPE_COMPOUND, libsumo::TYPE_DOUBLE, libsumo::TYPE_STRING, libsumo::VAR_FOLLOW_SPEED, 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:

◆ getFuelConsumption()

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

Definition at line 2337 of file TraCIAPI.cpp.

References libsumo::VAR_FUELCONSUMPTION.

◆ getHCEmission()

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

Definition at line 2322 of file TraCIAPI.cpp.

References libsumo::VAR_HCEMISSION.

◆ getHeight()

double TraCIAPI::VehicleScope::getHeight ( const std::string & veihcleID ) const

Definition at line 2588 of file TraCIAPI.cpp.

References libsumo::VAR_HEIGHT.

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

◆ getImperfection()

double TraCIAPI::VehicleScope::getImperfection ( const std::string & vehicleID ) const

Definition at line 2553 of file TraCIAPI.cpp.

References libsumo::VAR_IMPERFECTION.

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

◆ getLaneChangeMode()

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

Definition at line 2357 of file TraCIAPI.cpp.

References libsumo::VAR_LANECHANGE_MODE.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getLaneChangeState()

std::pair< int, int > TraCIAPI::VehicleScope::getLaneChangeState	(	const std::string &	vehicleID,
		int	direction
	)		const

Definition at line 2499 of file TraCIAPI.cpp.

References libsumo::CMD_CHANGELANE, libsumo::CMD_GET_VEHICLE_VARIABLE, libsumo::INVALID_INT_VALUE, libsumo::TYPE_COMPOUND, libsumo::TYPE_INTEGER, tcpip::Storage::writeByte(), and tcpip::Storage::writeInt().

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getLaneID()

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

Definition at line 2256 of file TraCIAPI.cpp.

References libsumo::VAR_LANE_ID.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getLaneIndex()

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

Definition at line 2261 of file TraCIAPI.cpp.

References libsumo::VAR_LANE_INDEX.

◆ getLanePosition()

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

Definition at line 2292 of file TraCIAPI.cpp.

References libsumo::VAR_LANEPOSITION.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getLateralAlignment()

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

Definition at line 2638 of file TraCIAPI.cpp.

References libsumo::VAR_LATALIGNMENT.

◆ getLateralLanePosition()

double TraCIAPI::VehicleScope::getLateralLanePosition ( const std::string & vehicleID ) const

Definition at line 2307 of file TraCIAPI.cpp.

References libsumo::VAR_LANEPOSITION_LAT.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getLateralSpeed()

double TraCIAPI::VehicleScope::getLateralSpeed ( const std::string & vehicleID ) const

Definition at line 2173 of file TraCIAPI.cpp.

References libsumo::VAR_SPEED_LAT.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getLeader()

std::pair< std::string, double > TraCIAPI::VehicleScope::getLeader	(	const std::string &	vehicleID,
		double	dist
	)		const

Definition at line 2463 of file TraCIAPI.cpp.

References libsumo::CMD_GET_VEHICLE_VARIABLE, libsumo::INVALID_DOUBLE_VALUE, libsumo::TYPE_COMPOUND, libsumo::TYPE_DOUBLE, libsumo::VAR_LEADER, tcpip::Storage::writeByte(), and tcpip::Storage::writeDouble().

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getLength()

double TraCIAPI::VehicleScope::getLength ( const std::string & vehicleID ) const

Definition at line 2583 of file TraCIAPI.cpp.

References libsumo::VAR_LENGTH.

◆ getLine()

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

Definition at line 2375 of file TraCIAPI.cpp.

References libsumo::VAR_LINE.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getMaxSpeed()

double TraCIAPI::VehicleScope::getMaxSpeed ( const std::string & vehicleID ) const

Definition at line 2231 of file TraCIAPI.cpp.

References libsumo::VAR_MAXSPEED.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getMaxSpeedLat()

double TraCIAPI::VehicleScope::getMaxSpeedLat ( const std::string & vehicleID ) const

Definition at line 2628 of file TraCIAPI.cpp.

References libsumo::VAR_MAXSPEED_LAT.

◆ getMinGap()

double TraCIAPI::VehicleScope::getMinGap ( const std::string & vehicleID ) const

Definition at line 2573 of file TraCIAPI.cpp.

References libsumo::VAR_MINGAP.

◆ getMinGapLat()

double TraCIAPI::VehicleScope::getMinGapLat ( const std::string & vehicleID ) const

Definition at line 2633 of file TraCIAPI.cpp.

References libsumo::VAR_MINGAP_LAT.

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

◆ getNextTLS()

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

Definition at line 2395 of file TraCIAPI.cpp.

References libsumo::CMD_GET_VEHICLE_VARIABLE, libsumo::TraCINextTLSData::dist, libsumo::TraCINextTLSData::id, libsumo::TraCINextTLSData::state, libsumo::TraCINextTLSData::tlIndex, libsumo::TYPE_COMPOUND, and libsumo::VAR_NEXT_TLS.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getNoiseEmission()

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

Definition at line 2342 of file TraCIAPI.cpp.

References libsumo::VAR_NOISEEMISSION.

◆ getNOxEmission()

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

Definition at line 2332 of file TraCIAPI.cpp.

References libsumo::VAR_NOXEMISSION.

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

◆ getPersonCapacity()

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

Definition at line 2608 of file TraCIAPI.cpp.

References libsumo::VAR_PERSON_CAPACITY.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getPersonIDList()

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

Definition at line 2613 of file TraCIAPI.cpp.

References libsumo::LAST_STEP_PERSON_ID_LIST.

◆ getPersonNumber()

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

Definition at line 2603 of file TraCIAPI.cpp.

References libsumo::VAR_PERSON_NUMBER.

◆ getPMxEmission()

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

Definition at line 2327 of file TraCIAPI.cpp.

References libsumo::VAR_PMXEMISSION.

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

◆ getPosition()

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

Definition at line 2236 of file TraCIAPI.cpp.

References libsumo::VAR_POSITION.

◆ getPosition3D()

libsumo::TraCIPosition TraCIAPI::VehicleScope::getPosition3D ( const std::string & vehicleID ) const

Definition at line 2241 of file TraCIAPI.cpp.

References libsumo::VAR_POSITION3D.

◆ getRoadID()

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

Definition at line 2251 of file TraCIAPI.cpp.

References libsumo::VAR_ROAD_ID.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getRoute()

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

Definition at line 2282 of file TraCIAPI.cpp.

References libsumo::VAR_EDGES.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getRouteID()

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

Definition at line 2271 of file TraCIAPI.cpp.

References libsumo::VAR_ROUTE_ID.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getRouteIndex()

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

Definition at line 2276 of file TraCIAPI.cpp.

References libsumo::VAR_ROUTE_INDEX.

◆ getRoutingMode()

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

Definition at line 2522 of file TraCIAPI.cpp.

References libsumo::VAR_ROUTING_MODE.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getSecureGap()

double TraCIAPI::VehicleScope::getSecureGap	(	const std::string &	vehicleID,
		double	speed,
		double	leaderSpeed,
		double	leaderMaxDecel,
		const std::string &	leaderID = `""`
	)		const

Definition at line 2202 of file TraCIAPI.cpp.

References libsumo::TYPE_COMPOUND, libsumo::TYPE_DOUBLE, libsumo::TYPE_STRING, libsumo::VAR_SECURE_GAP, 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:

◆ getShapeClass()

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

Definition at line 2390 of file TraCIAPI.cpp.

References libsumo::VAR_SHAPECLASS.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getSignals()

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

Definition at line 2302 of file TraCIAPI.cpp.

References libsumo::VAR_SIGNALS.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getSlope()

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

Definition at line 2369 of file TraCIAPI.cpp.

References libsumo::VAR_SLOPE.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getSpeed()

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

Definition at line 2168 of file TraCIAPI.cpp.

References libsumo::VAR_SPEED.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getSpeedDeviation()

double TraCIAPI::VehicleScope::getSpeedDeviation ( const std::string & vehicleID ) const

Definition at line 2563 of file TraCIAPI.cpp.

References libsumo::VAR_SPEED_DEVIATION.

◆ getSpeedFactor()

double TraCIAPI::VehicleScope::getSpeedFactor ( const std::string & vehicleID ) const

Definition at line 2558 of file TraCIAPI.cpp.

References libsumo::VAR_SPEED_FACTOR.

◆ getSpeedMode()

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

Definition at line 2363 of file TraCIAPI.cpp.

References libsumo::VAR_SPEEDSETMODE.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getSpeedWithoutTraCI()

double TraCIAPI::VehicleScope::getSpeedWithoutTraCI ( const std::string & vehicleID ) const

Definition at line 2618 of file TraCIAPI.cpp.

References libsumo::VAR_SPEED_WITHOUT_TRACI.

◆ getStopArrivalDelay()

double TraCIAPI::VehicleScope::getStopArrivalDelay ( const std::string & vehicleID ) const

Definition at line 2532 of file TraCIAPI.cpp.

References libsumo::VAR_STOP_ARRIVALDELAY.

◆ getStopDelay()

double TraCIAPI::VehicleScope::getStopDelay ( const std::string & vehicleID ) const

Definition at line 2527 of file TraCIAPI.cpp.

References libsumo::VAR_STOP_DELAY.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getStopSpeed()

double TraCIAPI::VehicleScope::getStopSpeed	(	const std::string &	vehicleID,
		double	speed,
		double	gap
	)		const

Definition at line 2218 of file TraCIAPI.cpp.

References libsumo::TYPE_COMPOUND, libsumo::TYPE_DOUBLE, libsumo::VAR_STOP_SPEED, tcpip::Storage::writeByte(), tcpip::Storage::writeDouble(), tcpip::Storage::writeInt(), and tcpip::Storage::writeUnsignedByte().

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getStopState()

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

Definition at line 2517 of file TraCIAPI.cpp.

References libsumo::VAR_STOPSTATE.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

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

◆ getTau()

double TraCIAPI::VehicleScope::getTau ( const std::string & vehicleID ) const

Definition at line 2548 of file TraCIAPI.cpp.

References libsumo::VAR_TAU.

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

◆ getTypeID()

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

Definition at line 2266 of file TraCIAPI.cpp.

References libsumo::VAR_TYPE.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

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

◆ getVehicleClass()

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

Definition at line 2568 of file TraCIAPI.cpp.

References libsumo::VAR_VEHICLECLASS.

◆ getVia()

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

Definition at line 2380 of file TraCIAPI.cpp.

References libsumo::VAR_VIA.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getWaitingTime()

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

Definition at line 2352 of file TraCIAPI.cpp.

References libsumo::VAR_WAITING_TIME.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getWidth()

double TraCIAPI::VehicleScope::getWidth ( const std::string & vehicleID ) const

Definition at line 2578 of file TraCIAPI.cpp.

References libsumo::VAR_WIDTH.

◆ isRouteValid()

bool TraCIAPI::VehicleScope::isRouteValid ( const std::string & vehicleID ) const

Definition at line 2623 of file TraCIAPI.cpp.

References libsumo::VAR_ROUTE_VALID.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ moveTo()

void TraCIAPI::VehicleScope::moveTo	(	const std::string &	vehicleID,
		const std::string &	laneID,
		double	position,
		int	reason = `libsumo::MOVE_TELEPORT`
	)		const

Definition at line 2804 of file TraCIAPI.cpp.

References libsumo::CMD_SET_VEHICLE_VARIABLE, libsumo::TYPE_COMPOUND, libsumo::TYPE_DOUBLE, libsumo::TYPE_INTEGER, libsumo::TYPE_STRING, libsumo::VAR_MOVE_TO, 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:

◆ moveToXY()

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

Definition at line 2819 of file TraCIAPI.cpp.

References libsumo::CMD_SET_VEHICLE_VARIABLE, TraCIAPI::lane, libsumo::MOVE_TO_XY, libsumo::TYPE_BYTE, 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:

◆ openGap()

void TraCIAPI::VehicleScope::openGap	(	const std::string &	vehicleID,
		double	newTau,
		double	duration,
		double	changeRate,
		double	maxDecel
	)		const

Definition at line 2854 of file TraCIAPI.cpp.

References libsumo::CMD_OPENGAP, libsumo::CMD_SET_VEHICLE_VARIABLE, libsumo::TYPE_COMPOUND, libsumo::TYPE_DOUBLE, tcpip::Storage::writeDouble(), tcpip::Storage::writeInt(), and tcpip::Storage::writeUnsignedByte().

◆ remove()

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

Definition at line 2703 of file TraCIAPI.cpp.

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

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ rerouteTraveltime()

void TraCIAPI::VehicleScope::rerouteTraveltime	(	const std::string &	vehicleID,
		bool	currentTravelTimes = `true`
	)		const

Definition at line 2787 of file TraCIAPI.cpp.

References libsumo::CMD_REROUTE_TRAVELTIME, libsumo::CMD_SET_VEHICLE_VARIABLE, libsumo::TYPE_COMPOUND, tcpip::Storage::writeInt(), and tcpip::Storage::writeUnsignedByte().

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ setAcceleration()

void TraCIAPI::VehicleScope::setAcceleration	(	const std::string &	vehicleID,
		double	accel,
		double	duration
	)		const

Definition at line 2886 of file TraCIAPI.cpp.

References libsumo::CMD_SET_VEHICLE_VARIABLE, libsumo::TYPE_COMPOUND, libsumo::TYPE_DOUBLE, libsumo::VAR_ACCELERATION, tcpip::Storage::writeDouble(), tcpip::Storage::writeInt(), and tcpip::Storage::writeUnsignedByte().

◆ setColor()

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

Definition at line 2990 of file TraCIAPI.cpp.

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

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

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

◆ setEmissionClass()

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

Definition at line 3051 of file TraCIAPI.cpp.

References libsumo::CMD_SET_VEHICLE_VARIABLE, libsumo::TYPE_STRING, libsumo::VAR_EMISSIONCLASS, tcpip::Storage::writeString(), 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().

◆ setLaneChangeMode()

void TraCIAPI::VehicleScope::setLaneChangeMode	(	const std::string &	vehicleID,
		int	mode
	)		const

Definition at line 2912 of file TraCIAPI.cpp.

References libsumo::CMD_SET_VEHICLE_VARIABLE, libsumo::TYPE_INTEGER, libsumo::VAR_LANECHANGE_MODE, tcpip::Storage::writeByte(), and tcpip::Storage::writeInt().

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ setLine()

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

Definition at line 3002 of file TraCIAPI.cpp.

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

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ setMaxSpeed()

void TraCIAPI::VehicleScope::setMaxSpeed	(	const std::string &	vehicleID,
		double	speed
	)		const

Definition at line 2981 of file TraCIAPI.cpp.

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

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ setMinGap()

void TraCIAPI::VehicleScope::setMinGap	(	const std::string &	vehicleID,
		double	minGap
	)		const

Definition at line 2972 of file TraCIAPI.cpp.

References libsumo::CMD_SET_VEHICLE_VARIABLE, libsumo::TYPE_DOUBLE, libsumo::VAR_MINGAP, tcpip::Storage::writeDouble(), 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:

◆ setPreviousSpeed()

void TraCIAPI::VehicleScope::setPreviousSpeed	(	const std::string &	vehicleID,
		double	prevSpeed,
		double	prevAcceleration = `std::numeric_limits<int>::min()`
	)		const

Definition at line 2899 of file TraCIAPI.cpp.

References libsumo::CMD_SET_VEHICLE_VARIABLE, libsumo::TYPE_COMPOUND, libsumo::TYPE_DOUBLE, libsumo::VAR_PREV_SPEED, tcpip::Storage::writeDouble(), tcpip::Storage::writeInt(), and tcpip::Storage::writeUnsignedByte().

◆ setRoute()

void TraCIAPI::VehicleScope::setRoute	(	const std::string &	vehicleID,
		const std::vector< std::string > &	edge
	)		const

Definition at line 2774 of file TraCIAPI.cpp.

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

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ setRouteID()

void TraCIAPI::VehicleScope::setRouteID	(	const std::string &	vehicleID,
		const std::string &	routeID
	)		const

Definition at line 2764 of file TraCIAPI.cpp.

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

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ setRoutingMode()

void TraCIAPI::VehicleScope::setRoutingMode	(	const std::string &	vehicleID,
		int	routingMode
	)		const

Definition at line 3032 of file TraCIAPI.cpp.

References libsumo::CMD_SET_VEHICLE_VARIABLE, libsumo::TYPE_INTEGER, libsumo::VAR_ROUTING_MODE, tcpip::Storage::writeInt(), and tcpip::Storage::writeUnsignedByte().

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ setShapeClass()

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

Definition at line 3041 of file TraCIAPI.cpp.

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

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ setSignals()

void TraCIAPI::VehicleScope::setSignals	(	const std::string &	vehicleID,
		int	signals
	)		const

Definition at line 3023 of file TraCIAPI.cpp.

References libsumo::CMD_SET_VEHICLE_VARIABLE, libsumo::TYPE_INTEGER, libsumo::VAR_SIGNALS, tcpip::Storage::writeInt(), and tcpip::Storage::writeUnsignedByte().

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ setSpeed()

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

Definition at line 2877 of file TraCIAPI.cpp.

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

◆ setSpeedFactor()

void TraCIAPI::VehicleScope::setSpeedFactor	(	const std::string &	vehicleID,
		double	factor
	)		const

Definition at line 2963 of file TraCIAPI.cpp.

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

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ setSpeedMode()

void TraCIAPI::VehicleScope::setSpeedMode	(	const std::string &	vehicleID,
		int	mode
	)		const

Definition at line 2921 of file TraCIAPI.cpp.

References libsumo::CMD_SET_VEHICLE_VARIABLE, libsumo::TYPE_INTEGER, libsumo::VAR_SPEEDSETMODE, tcpip::Storage::writeByte(), and tcpip::Storage::writeInt().

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ setStop()

void TraCIAPI::VehicleScope::setStop	(	const std::string	vehicleID,
		const std::string	edgeID,
		const double	endPos = `1.`,
		const int	laneIndex = `0`,
		const double	duration = `std::numeric_limits<double>::max()`,
		const int	flags = `0`,
		const double	startPos = `std::numeric_limits<int>::min()`,
		const double	until = `-1`
	)		const

Definition at line 2930 of file TraCIAPI.cpp.

References libsumo::CMD_SET_VEHICLE_VARIABLE, libsumo::CMD_STOP, libsumo::TYPE_BYTE, libsumo::TYPE_COMPOUND, libsumo::TYPE_DOUBLE, libsumo::TYPE_STRING, tcpip::Storage::writeByte(), tcpip::Storage::writeDouble(), tcpip::Storage::writeInt(), tcpip::Storage::writeString(), and tcpip::Storage::writeUnsignedByte().

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

◆ setType()

void TraCIAPI::VehicleScope::setType	(	const std::string &	vehicleID,
		const std::string &	typeID
	)		const

Definition at line 2954 of file TraCIAPI.cpp.

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

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ setVia()

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

Definition at line 3011 of file TraCIAPI.cpp.

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

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ slowDown()

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

Definition at line 2841 of file TraCIAPI.cpp.

References libsumo::CMD_SET_VEHICLE_VARIABLE, libsumo::CMD_SLOWDOWN, libsumo::TYPE_COMPOUND, libsumo::TYPE_DOUBLE, tcpip::Storage::writeDouble(), tcpip::Storage::writeInt(), 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:

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 Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ VehicleSignal

Constructor & Destructor Documentation

◆ VehicleScope()

◆ ~VehicleScope()

Member Function Documentation

◆ add()

◆ addSubscriptionFilterByteList()

◆ addSubscriptionFilterCFManeuver()

◆ addSubscriptionFilterDownstreamDistance()

◆ addSubscriptionFilterEmpty()

◆ addSubscriptionFilterFieldOfVision()

◆ addSubscriptionFilterFloat()

◆ addSubscriptionFilterLanes()

◆ addSubscriptionFilterLateralDistance()

◆ addSubscriptionFilterLCManeuver()

◆ addSubscriptionFilterLeadFollow()

◆ addSubscriptionFilterNoOpposite()

◆ addSubscriptionFilterStringList()

◆ addSubscriptionFilterTurn()

◆ addSubscriptionFilterUpstreamDistance()

◆ addSubscriptionFilterVClass()

◆ addSubscriptionFilterVType()

◆ changeLane()

◆ changeLaneRelative()

◆ changeSublane()

◆ changeTarget()

◆ clearSubscriptionResults()

◆ getAccel()

◆ getAcceleration()

◆ getAccumulatedWaitingTime()

◆ getAllContextSubscriptionResults()

◆ getAllowedSpeed()

◆ getAllSubscriptionResults()

◆ getAngle()

◆ getApparentDecel()

◆ getBestLanes()

◆ getByte()

◆ getCO2Emission()

◆ getCOEmission()

◆ getCol()

◆ getColor()

◆ getContextSubscriptionResults()

◆ getDecel()

◆ getDistance()

◆ getDouble()

◆ getDoubleVector()

◆ getElectricityConsumption()

◆ getEmergencyDecel()

◆ getEmissionClass()

◆ getFollower()

◆ getFollowSpeed()

◆ getFuelConsumption()

◆ getHCEmission()

◆ getHeight()

◆ getIDCount()

◆ getIDList()

◆ getImperfection()

◆ getInt()

◆ getLaneChangeMode()

◆ getLaneChangeState()

◆ getLaneID()

◆ getLaneIndex()

◆ getLanePosition()

◆ getLateralAlignment()

◆ getLateralLanePosition()

◆ getLateralSpeed()

◆ getLeader()

◆ getLength()

◆ getLine()

◆ getMaxSpeed()

◆ getMaxSpeedLat()

◆ getMinGap()