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

# -*- coding: utf-8 -*-
# Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
# Copyright (C) 2011-2019 German Aerospace Center (DLR) and others.
# This program and the accompanying materials
# are made available under the terms of the Eclipse Public License v2.0
# which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v20.html
# SPDX-License-Identifier: EPL-2.0

 
Modules
       
struct
traci.constants

 
Classes
       
traci.domain.Domain
GuiDomain

 
class GuiDomain(traci.domain.Domain)
     Methods defined here:
__init__(self)
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.
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.
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.
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.
trackVehicle(self, viewID, vehID)
trackVehicle(string, string) -> None
 
Start visually tracking the given vehicle on the given view.

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, objID, param)
getParameter(string, string) -> string
 
Returns the value of the given parameter for the given objID
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, objID, param, value)
setParameter(string, string, string) -> string
 
Sets the value of the given parameter to value for the given objID
subscribe(self, objectID, varIDs=None, begin=-1073741824.0, end=-1073741824.0)
subscribe(string, list(integer), double, double) -> 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)
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.
unsubscribe(self, objectID)
unsubscribe(string) -> None
 
Unsubscribe from receiving object values.
unsubscribeContext(self, objectID, domain, dist)

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