p71924506
/
carla
mirror of https://github.com/carla-simulator/carla.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

First iteration on iter methods

This commit is contained in:
sergi-e 2020-10-02 17:08:50 +02:00 committed by Marc Garcia Puig
parent b91e1b5e0e
commit 507121620d
5 changed files with 23 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Docs/python_api.md
View File

@ -202,7 +202,7 @@ If the `id` attribute is modifiable, changes its value to `value`.
<h5 style="margin-top: -20px">Dunder methods</h5>
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.ActorBlueprint.__iter__"></a>**<font color="#7fb800">\__iter__</font>**(<font color="#00a6ed">**self**</font>)
Allows iteration within this class' attributes.
Iterate over the [carla.ActorAttribute](#carla.ActorAttribute) that this blueprint has.
- <a name="carla.ActorBlueprint.__len__"></a>**<font color="#7fb800">\__len__</font>**(<font color="#00a6ed">**self**</font>)
Returns the amount of attributes for this blueprint.
- <a name="carla.ActorBlueprint.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
@ -229,7 +229,7 @@ Finds an actor using its identifier and returns it or <b>None</b> if it is not p
Returns the actor corresponding to `pos` position in the list.
- **Return:** _[carla.Actor](#carla.Actor)_
- <a name="carla.ActorList.__iter__"></a>**<font color="#7fb800">\__iter__</font>**(<font color="#00a6ed">**self**</font>)
Allows the iteration for the actors in this object.
Iterate over the [carla.Actor](#carla.Actor) contained in the list.
- <a name="carla.ActorList.__len__"></a>**<font color="#7fb800">\__len__</font>**(<font color="#00a6ed">**self**</font>)
Returns the amount of actors listed.
- **Return:** _int_
@ -297,7 +297,7 @@ Returns the blueprint corresponding to that identifier.
Returns the blueprint stored in `pos` position inside the data structure containing them.
- **Return:** _[carla.ActorBlueprint](#carla.ActorBlueprint)_
- <a name="carla.BlueprintLibrary.__iter__"></a>**<font color="#7fb800">\__iter__</font>**(<font color="#00a6ed">**self**</font>)
Method that allows iteration within the blueprints provided.
Iterate over the [carla.ActorBlueprint](#carla.ActorBlueprint) stored in the library.
- <a name="carla.BlueprintLibrary.__len__"></a>**<font color="#7fb800">\__len__</font>**(<font color="#00a6ed">**self**</font>)
Returns the amount of blueprints comprising the library.
- **Return:** _int_
@ -608,6 +608,7 @@ Returns an array with the polarity of all the events in the stream.
<h5 style="margin-top: -20px">Dunder methods</h5>
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.DVSEventArray.__getitem__"></a>**<font color="#7fb800">\__getitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>)
- <a name="carla.DVSEventArray.__iter__"></a>**<font color="#7fb800">\__iter__</font>**(<font color="#00a6ed">**self**</font>)
Iterate over the [carla.DVSEvent](#carla.DVSEvent) retrieved as data.
- <a name="carla.DVSEventArray.__len__"></a>**<font color="#7fb800">\__len__</font>**(<font color="#00a6ed">**self**</font>)
- <a name="carla.DVSEventArray.__setitem__"></a>**<font color="#7fb800">\__setitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>, <font color="#00a6ed">**color**=[carla.Color](#carla.Color)</font>)
- <a name="carla.DVSEventArray.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
@ -773,6 +774,7 @@ Saves the image to disk using a converter pattern stated as `color_converter`. T
<h5 style="margin-top: -20px">Dunder methods</h5>
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Image.__getitem__"></a>**<font color="#7fb800">\__getitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>)
- <a name="carla.Image.__iter__"></a>**<font color="#7fb800">\__iter__</font>**(<font color="#00a6ed">**self**</font>)
Iterate over the [carla.Image](#carla.Image) that form the image.
- <a name="carla.Image.__len__"></a>**<font color="#7fb800">\__len__</font>**(<font color="#00a6ed">**self**</font>)
- <a name="carla.Image.__setitem__"></a>**<font color="#7fb800">\__setitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>, <font color="#00a6ed">**color**=[carla.Color](#carla.Color)</font>)
- <a name="carla.Image.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
@ -1101,6 +1103,7 @@ Retrieves the number of points sorted by channel that are generated by this meas
<h5 style="margin-top: -20px">Dunder methods</h5>
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.LidarMeasurement.__getitem__"></a>**<font color="#7fb800">\__getitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>)
- <a name="carla.LidarMeasurement.__iter__"></a>**<font color="#7fb800">\__iter__</font>**(<font color="#00a6ed">**self**</font>)
Iterate over the [carla.LidarDetection](#carla.LidarDetection) retrieved as data.
- <a name="carla.LidarMeasurement.__len__"></a>**<font color="#7fb800">\__len__</font>**(<font color="#00a6ed">**self**</font>)
- <a name="carla.LidarMeasurement.__setitem__"></a>**<font color="#7fb800">\__setitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>, <font color="#00a6ed">**detection**=[carla.LidarDetection](#carla.LidarDetection)</font>)
- <a name="carla.LidarMeasurement.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
@ -1524,6 +1527,7 @@ Retrieves the number of entries generated, same as **<font color="#7fb800">\__st
<h5 style="margin-top: -20px">Dunder methods</h5>
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.RadarMeasurement.__getitem__"></a>**<font color="#7fb800">\__getitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>)
- <a name="carla.RadarMeasurement.__iter__"></a>**<font color="#7fb800">\__iter__</font>**(<font color="#00a6ed">**self**</font>)
Iterate over the [carla.RadarDetection](#carla.RadarDetection) retrieved as data.
- <a name="carla.RadarMeasurement.__len__"></a>**<font color="#7fb800">\__len__</font>**(<font color="#00a6ed">**self**</font>)
- <a name="carla.RadarMeasurement.__setitem__"></a>**<font color="#7fb800">\__setitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>, <font color="#00a6ed">**detection**=[carla.RadarDetection](#carla.RadarDetection)</font>)
- <a name="carla.RadarMeasurement.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
@ -1817,6 +1821,7 @@ Retrieves the number of points sorted by channel that are generated by this meas
<h5 style="margin-top: -20px">Dunder methods</h5>
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.SemanticLidarMeasurement.__getitem__"></a>**<font color="#7fb800">\__getitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>)
- <a name="carla.SemanticLidarMeasurement.__iter__"></a>**<font color="#7fb800">\__iter__</font>**(<font color="#00a6ed">**self**</font>)
Iterate over the [carla.SemanticLidarDetection](#carla.SemanticLidarDetection) retrieved as data.
- <a name="carla.SemanticLidarMeasurement.__len__"></a>**<font color="#7fb800">\__len__</font>**(<font color="#00a6ed">**self**</font>)
- <a name="carla.SemanticLidarMeasurement.__setitem__"></a>**<font color="#7fb800">\__setitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>, <font color="#00a6ed">**detection**=[carla.SemanticLidarDetection](#carla.SemanticLidarDetection)</font>)
- <a name="carla.SemanticLidarMeasurement.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
@ -2848,7 +2853,7 @@ Given a certain actor ID, checks if there is a snapshot corresponding it and so,
<h5 style="margin-top: -20px">Dunder methods</h5>
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.WorldSnapshot.__iter__"></a>**<font color="#7fb800">\__iter__</font>**(<font color="#00a6ed">**self**</font>)
Method that enables iteration for this class using **<font color="#f8805a">timestamp</font>** as reference value.
Iterate over the [carla.ActorSnapshot](#carla.ActorSnapshot) stored in the snapshot.
- <a name="carla.WorldSnapshot.__len__"></a>**<font color="#7fb800">\__len__</font>**(<font color="#00a6ed">**self**</font>)
Returns the amount of [carla.ActorSnapshot](#carla.ActorSnapshot) present in this snapshot.
- **Return:** _int_

4
PythonAPI/docs/blueprint.yml
View File

@ -211,7 +211,7 @@
# --------------------------------------
- def_name: __iter__
doc: >
Allows iteration within this class' attributes.
Iterate over the carla.ActorAttribute that this blueprint has.
# --------------------------------------
- def_name: __len__
doc: >
@ -254,7 +254,7 @@
# --------------------------------------
- def_name: __iter__
doc: >
Method that allows iteration within the blueprints provided.
Iterate over the carla.ActorBlueprint stored in the library.
# --------------------------------------
- def_name: __len__
return: int

10
PythonAPI/docs/sensor_data.yml
View File

@ -134,6 +134,8 @@
type: int
# --------------------------------------
- def_name: __iter__
doc: >
Iterate over the carla.Image that form the image.
# --------------------------------------
- def_name: __len__
# --------------------------------------
@ -189,6 +191,8 @@
type: int
# --------------------------------------
- def_name: __iter__
doc: >
Iterate over the carla.LidarDetection retrieved as data.
# --------------------------------------
- def_name: __len__
# --------------------------------------
@ -265,6 +269,8 @@
type: int
# --------------------------------------
- def_name: __iter__
doc: >
Iterate over the carla.SemanticLidarDetection retrieved as data.
# --------------------------------------
- def_name: __len__
# --------------------------------------
@ -452,6 +458,8 @@
type: int
# --------------------------------------
- def_name: __iter__
doc: >
Iterate over the carla.RadarDetection retrieved as data.
# --------------------------------------
- def_name: __len__
# --------------------------------------
@ -785,6 +793,8 @@
type: int
# --------------------------------------
- def_name: __iter__
doc: >
Iterate over the carla.DVSEvent retrieved as data.
# --------------------------------------
- def_name: __len__
# --------------------------------------

2
PythonAPI/docs/snapshot.yml
View File

@ -42,7 +42,7 @@
# --------------------------------------
- def_name: __iter__
doc: >
Method that enables iteration for this class using **<font color="#f8805a">timestamp</font>** as reference value.
Iterate over the carla.ActorSnapshot stored in the snapshot.
# --------------------------------------
- def_name: __len__
return: int

2
PythonAPI/docs/world.yml
View File

@ -91,7 +91,7 @@
# --------------------------------------
- def_name: __iter__
doc: >
Allows the iteration for the actors in this object.
Iterate over the carla.Actor contained in the list.
# --------------------------------------
- def_name: __len__
return: int