traci._gui
index
/home/delphi/gcc/sumo/tools/traci/_gui.py

# -*- coding: utf-8 -*-
# Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
# Copyright (C) 2011-2024 German Aerospace Center (DLR) and others.
# This program and the accompanying materials are made available under the
# terms of the Eclipse Public License 2.0 which is available at
https://www.eclipse.org/legal/epl-2.0/
# This Source Code may also be made available under the following Secondary
# Licenses when the conditions for such availability set forth in the Eclipse
# Public License 2.0 are satisfied: GNU General Public License, version 2
# or later which is available at
https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
# SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later

 
Modules
       
traci.constants

 
Classes
       
traci.domain.Domain(builtins.object)
GuiDomain

 
class GuiDomain(traci.domain.Domain)
    
Method resolution order:
GuiDomain
traci.domain.Domain
builtins.object

Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
addView(self, viewID, schemeName='', in3D=False)
addView(string, string, bool) -> None
Adds new view and sets it to the given settings scheme (optionally as a 3D view)
getAngle(self, viewID='View #0')
getAngle(string): -> double
 
Returns the angle of the current view.
getBoundary(self, viewID='View #0')
getBoundary(string): -> ((double, double), (double, double))
 
Returns the coordinates of the lower left and the upper right corner of the currently visible view.
getOffset(self, viewID='View #0')
getOffset(string): -> (double, double)
 
Returns the x and y offset of the center of the current view.
getSchema(self, viewID='View #0')
getSchema(string): -> string
 
Returns the name of the current coloring scheme.
getTrackedVehicle(self, viewID='View #0')
getTrackedVehicle(string): -> string
 
Returns the id of the currently tracked vehicle
getZoom(self, viewID='View #0')
getZoom(string): -> double
 
Returns the current zoom factor.
hasView(self, viewID='View #0')
hasView(string): -> bool
 
Check whether the given view exists.
isSelected(self, objID, objType='vehicle')
isSelected(string, string) -> int
Return 1 if the object of the given type and id is select, 0 otherwise
removeView(self, viewID)
removeView(string) -> None
 
Removes the view with the given id
screenshot(self, viewID, filename, width=-1, height=-1)
screenshot(string, string, int, int) -> None
 
Save a screenshot for the given view to the given filename
at the next call to simulationStep.
The fileformat is guessed from the extension, the available
formats differ from platform to platform but should at least
include ps, svg and pdf, on linux probably gif, png and jpg as well.
Width and height of the image can be given as optional parameters.
setAngle(self, viewID, angle)
setAngle(string, double) -> None
 
Set the current angle for the given view.
setBoundary(self, viewID, xmin, ymin, xmax, ymax)
setBoundary(string, double, double, double, double) -> None
Sets the boundary of the visible network. If the window has a different
aspect ratio than the given boundary, the view is expanded along one
axis to meet the window aspect ratio and contain the given boundary.
setOffset(self, viewID, x, y)
setOffset(string, double, double) -> None
 
Set the current offset for the given view.
setSchema(self, viewID, schemeName)
setSchema(string, string) -> None
 
Set the current coloring scheme for the given view.
setZoom(self, viewID, zoom)
setZoom(string, double) -> None
 
Set the current zoom factor for the given view.
toggleSelection(self, objID, objType='vehicle')
toggleSelection(string, string) -> None
Toggle selection status for the object of the given type and id
track(self, objID, viewID='View #0')
track(string, string) -> None
Start visually tracking the given vehicle or person on the given view.
Stop tracking when an empty string is used as objID.
trackVehicle(self, viewID, vehID)
trackVehicle(string, string) -> None
 
Start visually tracking the given vehicle on the given view.
Stop tracking when an empty string is used as vehID.

Data and other attributes defined here:
DEFAULT_VIEW = 'View #0'

Methods inherited from traci.domain.Domain:
getAllContextSubscriptionResults(self)
getAllSubscriptionResults(self)
getAllSubscriptionResults() -> dict(string: dict(integer: <value_type>))
 
Returns the subscription results for the last time step and all objects of the domain.
It is not possible to retrieve older subscription results than the ones
from the last time step.
getContextSubscriptionResults(self, objectID)
getIDCount(self)
getIDCount() -> integer
 
Returns the number of currently loaded objects.
getIDList(self)
getIDList() -> list(string)
 
Returns a list of all objects in the network.
getParameter(self, objectID, key)
getParameter(string, string) -> string
 
Returns the value of the given parameter for the given objectID
getParameterWithKey(self, objectID, key)
getParameterWithKey(string, string) -> (string, string)
 
Returns the (key, value) tuple of the given parameter for the given objectID
getSubscriptionResults(self, objectID)
getSubscriptionResults(string) -> dict(integer: <value_type>)
 
Returns the subscription results for the last time step and the given object.
If the object id is unknown or the subscription did for any reason return no data,
'None' is returned.
It is not possible to retrieve older subscription results than the ones
from the last time step.
setParameter(self, objectID, key, value)
setParameter(string, string, string) -> None
 
Sets the value of the given parameter to value for the given objectID
subscribe(self, objectID, varIDs=None, begin=-1073741824.0, end=-1073741824.0, parameters=None)
subscribe(string, list(integer), double, double, map(string->tuple)) -> None
 
Subscribe to one or more object values for the given interval.
subscribeContext(self, objectID, domain, dist, varIDs=None, begin=-1073741824.0, end=-1073741824.0, parameters=None)
subscribeContext(string, int, double, list(integer), double, double) -> None
 
Subscribe to objects of the given domain (specified as domain=traci.constants.CMD_GET_<DOMAIN>_VARIABLE),
which are closer than dist to the object specified by objectID.
subscribeParameterWithKey(self, objectID, key, begin=-1073741824.0, end=-1073741824.0)
subscribeParameterWithKey(string, string) -> None
 
Subscribe for a generic parameter with the given key.
unsubscribe(self, objectID)
unsubscribe(string) -> None
 
Unsubscribe from receiving object values.
unsubscribeContext(self, objectID, domain, dist)

Data descriptors inherited from traci.domain.Domain:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
Data
        absolute_import = _Feature((2, 5, 0, 'alpha', 1), (3, 0, 0, 'alpha', 0), 262144)