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

# -*- coding: utf-8 -*-
# Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
# Copyright (C) 2008-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)
PoiDomain

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

Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
add(self, poiID, x, y, color, poiType='', layer=0, imgFile='', width=1, height=1, angle=0, icon='')
add(string, double, double, (byte, byte, byte, byte), string, integer, string, double, double, double) -> None
 
Adds a poi with the given values
getAngle(self, poiID)
getAngle(string) -> double
 
Returns the angle of the given poi.
getColor(self, poiID)
getColor(string) -> (integer, integer, integer, integer)
 
Returns the rgba color of the given poi.
getHeight(self, poiID)
getHeight(string) -> double
 
Returns the height of the given poi.
getImageFile(self, poiID)
getImageFile(string) -> string
 
Returns the image file of the given poi.
getPosition(self, poiID)
getPosition(string) -> (double, double)
 
Returns the position coordinates of the given poi.
getType(self, poiID)
getType(string) -> string
 
Returns the (abstract) type of the poi.
getWidth(self, poiID)
getWidth(string) -> double
 
Returns the width of the given poi.
highlight(self, poiID, color=(255, 0, 0, 255), size=-1, alphaMax=-1, duration=-1, type=0)
highlight(string, color, float, ubyte) -> void
Adds a circle of the given color highlighting the poi.
If a positive size [in m] is given the size of the highlight is chosen accordingly,
otherwise the image size of the poi is used as reference.
If alphaMax and duration are positive, the circle fades in and out within the given duration,
otherwise it is permanently added on top of the poi.
remove(self, poiID, layer=0)
remove(string, integer) -> None
Removes the poi with the given poiID
setAngle(self, poiID, angle)
setAngle(string, double) -> None
 
Sets the angle of the poi.
setColor(self, poiID, color)
setColor(string, (integer, integer, integer, integer)) -> None
 
Sets the rgba color of the poi, i.e. (255,0,0) for the color red.
The fourth component (alpha) is optional.
setHeight(self, poiID, height)
setHeight(string, double) -> None
 
Sets the height of the poi.
setImageFile(self, poiID, imageFile)
setImageFile(string, string) -> None
 
Sets the image file of the poi.
setPosition(self, poiID, x, y)
setPosition(string, (double, double)) -> None
 
Sets the position coordinates of the poi.
setType(self, poiID, poiType)
setType(string, string) -> None
 
Sets the (abstract) type of the poi.
setWidth(self, poiID, width)
setWidth(string, double) -> None
 
Sets the width of the poi.

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)