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

changed get_required_files docs (#7763) 

* changed get_required_files docs

* fixed overwritten user data
This commit is contained in:
MattRoweEAIF 2024-06-10 17:02:53 +02:00 committed by GitHub
parent 2c85c528cc
commit 18035969fe
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 197 additions and 81 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

116
Docs/python_api.md
View File

@ -421,19 +421,16 @@ Parses the location and extent of the bounding box to string.
## carla.CAMData<a name="carla.CAMData"></a>
<small style="display:block;margin-top:-20px;">Inherited from _[carla.SensorData](#carla.SensorData)_</small></br>
This is the data type for cooperative awareness message reception, contained in a [CAMEvent](#carlacamevent)
This is the data type for cooperative awareness message reception, contained in a [CAMEvent](#carlacamevent).
### Instance Variables
- <a name="carla.CAMData.power"></a>**<font color="#f8805a">power</font>** (_float<small> - dBm</small>_)
- <a name="carla.CAMData.power"></a>**<font color="#f8805a">power</font>** (_float - dBm_)
Received power.
### Methods
- <a name="carla.CAMData.get()"></a>**<font color="#7fb800">get</font>**(<font color="#00a6ed">**self**</font>)
Get the CAM data.
- **Return:** _dict_
Returns a nested dictionary containing the message following the ETSI standard:
- `"Header"`: _dict_
- `"Message"`: _dict_
- <a name="carla.CAMData.get"></a>**<font color="#7fb800">get</font>**(<font color="#00a6ed">**self**</font>)
Get the CAM data. Returns a nested dictionary containing the message following the ETSI standard: - `Header`: dict - `Message`: dict.
- **Return:** _dict_
##### Dunder methods
- <a name="carla.CAMData.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
@ -442,25 +439,23 @@ Get the CAM data.
## carla.CAMEvent<a name="carla.CAMEvent"></a>
<small style="display:block;margin-top:-20px;">Inherited from _[carla.SensorData](#carla.SensorData)_</small></br>
Class that defines the data provided by a <b>sensor.other.v2x</b>. This is a collection type to combine returning several [CAMData](#carlacamdata).
### Instance Variables
Class that defines the data provided by a **sensor.other.v2x**. This is a collection type to combine returning several [CAMData](#carlacamdata).
### Methods
- <a name="carla.CAMEvent.get_message_count()"></a>**<font color="#7fb800">get_message_count</font>**(<font color="#00a6ed">**self**</font>)
Get the number of received CAM's.
- **Return:** _int_
##### Getters
- <a name="carla.CAMEvent.get_message_count"></a>**<font color="#7fb800">get_message_count</font>**(<font color="#00a6ed">**self**</font>)
Get the number of received CAM's.
- **Return:** _int_
##### Dunder methods
- <a name="carla.CAMEvent.__getitem__"></a>**<font color="#7fb800">\__getitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>)
- <a name="carla.CAMEvent.__get_item__"></a>**<font color="#7fb800">\__get_item__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>)
- <a name="carla.CAMEvent.__iter__"></a>**<font color="#7fb800">\__iter__</font>**(<font color="#00a6ed">**self**</font>)
Iterate over the [carla.CAMData](#carla.CAMData) retrieved as data.
- <a name="carla.DVSEventArray.__len__"></a>**<font color="#7fb800">\__len__</font>**(<font color="#00a6ed">**self**</font>)
Iterate over the [CAMData](#carlacamdata) retrieved as data.
- <a name="carla.CAMEvent.__len__"></a>**<font color="#7fb800">\__len__</font>**(<font color="#00a6ed">**self**</font>)
---
## carla.CityObjectLabel<a name="carla.CityObjectLabel"></a>
Enum declaration that contains the different tags available to filter the bounding boxes returned by [carla.World.get_level_bbs](#carla.World.get_level_bbs)(). These values correspond to the [semantic tag](ref_sensors.md#semantic-segmentation-camera) that the elements in the scene have.
@ -618,8 +613,8 @@ Returns the client libcarla version by consulting it in the "Version.h" file. Bo
- <a name="carla.Client.get_required_files"></a>**<font color="#7fb800">get_required_files</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**folder**</font>, <font color="#00a6ed">**download**=True</font>)
Asks the server which files are required by the client to use the current map. Option to download files automatically if they are not already in the cache.
- **Parameters:**
- `folder` (_str_) - Folder where files required by the client will be downloaded to.
- `download` (_bool_) - If True, downloads files that are not already in cache.
- `folder` (_str_) - Specifies a folder to look through on the server maps. Leaving this blank will search recursively through all map folders in the server, which is recommended if you're unfamiliar with the server map folder structure.
- `download` (_bool_) - If True, downloads files that are not already in cache. The cache can be found at "HOME\carlaCache" or "USERPROFILE\carlaCache", depending on OS.
- <a name="carla.Client.get_server_version"></a>**<font color="#7fb800">get_server_version</font>**(<font color="#00a6ed">**self**</font>)
Returns the server libcarla version by consulting it in the "Version.h" file. Both client and server should use the same libcarla version.
- **Return:** _str_
@ -710,23 +705,19 @@ Converts the image to a depth map using a logarithmic scale, leading to better p
No changes applied to the image. Used by the [RGB camera](ref_sensors.md#rgb-camera).
---
## carla.CustomV2XData<a name="carla.CustomV2XData"></a>
<small style="display:block;margin-top:-20px;">Inherited from _[carla.SensorData](#carla.SensorData)_</small></br>
This is the data type defining a custom V2X message. Received as part of a [CustomV2XEvent](#carla.CustomV2XEvent).
This is the data type defining a custom V2X message. Received as part of a [CustomV2XEvent](#carlacustomv2xevent).
### Instance Variables
- <a name="carla.CustomV2XData.power"></a>**<font color="#f8805a">power</font>** (_float<small> - dBm</small>_)
- <a name="carla.CustomV2XData.power"></a>**<font color="#f8805a">power</font>** (_float - dBm_)
Received power.
### Methods
- <a name="carla.CustomV2XData.get()"></a>**<font color="#7fb800">get</font>**(<font color="#00a6ed">**self**</font>)
Get the custom message.
- **Return:** _dict_.
Returns a nested dictionary containing the message. It has two primary keys:
- `"Header"` : _dict_
- `"Message"`: _str_
- <a name="carla.CustomV2XData.get"></a>**<font color="#7fb800">get</font>**(<font color="#00a6ed">**self**</font>)
Get the custom message. Returns a nested dictionary containing the message. It has two primary keys: - `Header` : dict - `Message`: str.
- **Return:** _dict_
##### Dunder methods
- <a name="carla.CustomV2XData.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
@ -735,25 +726,23 @@ Get the custom message.
## carla.CustomV2XEvent<a name="carla.CustomV2XEvent"></a>
<small style="display:block;margin-top:-20px;">Inherited from _[carla.SensorData](#carla.SensorData)_</small></br>
Class that defines the data provided by a <b>sensor.other.v2x_custom</b>. This is a collection type to combine returning several [CustomV2XData](#carla.CustomV2XData).
### Instance Variables
Class that defines the data provided by a **sensor.other.v2x_custom**. This is a collection type to combine returning several [CustomV2XData](#carlacustomv2xdata).
### Methods
- <a name="carla.CustomV2XEvent.get_message_count()"></a>**<font color="#7fb800">get_message_count</font>**(<font color="#00a6ed">**self**</font>)
Get the number of received CAM's.
- **Return:** _int_
##### Getters
- <a name="carla.CustomV2XEvent.get_message_count"></a>**<font color="#7fb800">get_message_count</font>**(<font color="#00a6ed">**self**</font>)
Get the number of received CAM's.
- **Return:** _int_
##### Dunder methods
- <a name="carla.CustomV2XEvent.__getitem__"></a>**<font color="#7fb800">\__getitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>)
- <a name="carla.CustomV2XEvent.__get_item__"></a>**<font color="#7fb800">\__get_item__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>)
- <a name="carla.CustomV2XEvent.__iter__"></a>**<font color="#7fb800">\__iter__</font>**(<font color="#00a6ed">**self**</font>)
Iterate over the [carla.CustomV2XData](#carla.CustomV2XData) retrieved as data.
Iterate over the [CustomV2XData](#carlacustomv2xdata) retrieved as data.
- <a name="carla.CustomV2XEvent.__len__"></a>**<font color="#7fb800">\__len__</font>**(<font color="#00a6ed">**self**</font>)
---
## carla.DVSEvent<a name="carla.DVSEvent"></a>
Class that defines a DVS event. An event is a quadruple, so a tuple of 4 elements, with `x`, `y` pixel coordinate location, timestamp `t` and polarity `pol` of the event. Learn more about them [here](ref_sensors.md).
@ -942,7 +931,7 @@ Initializes a color, black by default.
---
## carla.GBufferTextureID<a name="carla.GBufferTextureID"></a>
Defines the identifiers of each GBuffer texture (See the method `[carla.Sensor.listen_to_gbuffer](#carla.Sensor.listen_to_gbuffer)`).
Defines the of each GBuffer texture (See the method `[carla.Sensor.listen_to_gbuffer](#carla.Sensor.listen_to_gbuffer)`).
### Instance Variables
- <a name="carla.GBufferTextureID.SceneColor"></a>**<font color="#f8805a">SceneColor</font>**
@ -2315,26 +2304,26 @@ Iterate over the [carla.SemanticLidarDetection](#carla.SemanticLidarDetection) r
<small style="display:block;margin-top:-20px;">Inherited from _[carla.Actor](#carla.Actor)_</small></br>
Sensors compound a specific family of actors quite diverse and unique. They are normally spawned as attachment/sons of a vehicle (take a look at [carla.World](#carla.World) to learn about actor spawning). Sensors are thoroughly designed to retrieve different types of data that they are listening to. The data they receive is shaped as different subclasses inherited from [carla.SensorData](#carla.SensorData) (depending on the sensor).
Most sensors can be divided in two groups: those receiving data on every tick (cameras, point clouds and some specific sensors) and those who only receive under certain circumstances (trigger detectors). CARLA provides a specific set of sensors and their blueprint can be found in [carla.BlueprintLibrary](#carla.BlueprintLibrary). All the information on their preferences and settlement can be found [here](ref_sensors.md), but the list of those available in CARLA so far goes as follow.
<br><b>Receive data on every tick.</b>
- [Depth camera](ref_sensors.md#depth-camera).
- [Gnss sensor](ref_sensors.md#gnss-sensor).
- [IMU sensor](ref_sensors.md#imu-sensor).
- [Lidar raycast](ref_sensors.md#lidar-raycast-sensor).
- [SemanticLidar raycast](ref_sensors.md#semanticlidar-raycast-sensor).
- [Radar](ref_sensors.md#radar-sensor).
- [RGB camera](ref_sensors.md#rgb-camera).
- [RSS sensor](ref_sensors.md#rss-sensor).
- [Semantic Segmentation camera](ref_sensors.md#semantic-segmentation-camera).
<br><b>Only receive data when triggered.</b>
- [Collision detector](ref_sensors.md#collision-detector).
- [Lane invasion detector](ref_sensors.md#lane-invasion-detector).
- [Obstacle detector](ref_sensors.md#obstacle-detector).
Most sensors can be divided in two groups: those receiving data on every tick (cameras, point clouds and some specific sensors) and those who only receive under certain circumstances (trigger detectors). CARLA provides a specific set of sensors and their blueprint can be found in [carla.BlueprintLibrary](#carla.BlueprintLibrary). All the information on their preferences and settlement can be found [here](ref_sensors.md), but the list of those available in CARLA so far goes as follows:<br>
<br><b>Receive data on every tick</b><br>
- [Depth camera](ref_sensors.md#depth-camera)<br>
- [Gnss sensor](ref_sensors.md#gnss-sensor)<br>
- [IMU sensor](ref_sensors.md#imu-sensor)<br>
- [Lidar raycast](ref_sensors.md#lidar-raycast-sensor)<br>
- [SemanticLidar raycast](ref_sensors.md#semanticlidar-raycast-sensor)<br>
- [Radar](ref_sensors.md#radar-sensor)<br>
- [RGB camera](ref_sensors.md#rgb-camera)<br>
- [RSS sensor](ref_sensors.md#rss-sensor)<br>
- [Semantic Segmentation camera](ref_sensors.md#semantic-segmentation-camera)<br>
<br><b>Only receive data when triggered.</b><br>
- [Collision detector](ref_sensors.md#collision-detector)<br>
- [Lane invasion detector](ref_sensors.md#lane-invasion-detector)<br>
- [Obstacle detector](ref_sensors.md#obstacle-detector)<br>
- [V2X sensor](ref_sensors.md#v2x-sensor).
### Instance Variables
- <a name="carla.Sensor.is_listening"></a>**<font color="#f8805a">is_listening</font>** (_boolean_)
When <b>True</b> the sensor will be waiting for data.
When **True** the sensor will be waiting for data.
### Methods
- <a name="carla.Sensor.disable_for_ros"></a>**<font color="#7fb800">disable_for_ros</font>**(<font color="#00a6ed">**self**</font>)
@ -2343,12 +2332,15 @@ Commands the sensor to not be processed for publishing in ROS2 if there is no an
Commands the sensor to be processed to be able to publish in ROS2 without any listen to it.
- <a name="carla.Sensor.is_enabled_for_ros"></a>**<font color="#7fb800">is_enabled_for_ros</font>**(<font color="#00a6ed">**self**</font>)
Returns if the sensor is enabled or not to publish in ROS2 if there is no any listen to it.
- **Return:** _bool_
- <a name="carla.Sensor.is_listening"></a>**<font color="#7fb800">is_listening</font>**(<font color="#00a6ed">**self**</font>)
Returns whether the sensor is in a listening state.
- **Return:** _bool_
- <a name="carla.Sensor.is_listening_gbuffer"></a>**<font color="#7fb800">is_listening_gbuffer</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**gbuffer_id**</font>)
Returns whether the sensor is in a listening state for a specific GBuffer texture.
- **Parameters:**
- `gbuffer_id` (_[carla.GBufferTextureID](#carla.GBufferTextureID)_) - The ID of the target Unreal Engine GBuffer texture.
- **Return:** _bool_
- <a name="carla.Sensor.listen"></a>**<font color="#7fb800">listen</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**callback**</font>)<button class="SnipetButton" id="carla.Sensor.listen-snipet_button">snippet &rarr;</button>
The function the sensor will be calling to every time a new measurement is received. This function needs for an argument containing an object type [carla.SensorData](#carla.SensorData) to work with.
- **Parameters:**
@ -2361,7 +2353,7 @@ The function the sensor will be calling to every time the desired GBuffer textur
- <a name="carla.Sensor.send"></a>**<font color="#7fb800">send</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**message**</font>)
Instructs the sensor to send the string given by `message` to all other CustomV2XSensors on the next tick.
- **Parameters:**
- `message` (_string_) - The data to send. *Note*: maximum string length is 100 chars.
- `message` (_string_) - The data to send. Note: maximum string length is 100 chars.
- <a name="carla.Sensor.stop"></a>**<font color="#7fb800">stop</font>**(<font color="#00a6ed">**self**</font>)
Commands the sensor to stop listening for data.
- <a name="carla.Sensor.stop_gbuffer"></a>**<font color="#7fb800">stop_gbuffer</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**gbuffer_id**</font>)
@ -2385,8 +2377,8 @@ Base class for all the objects containing data generated by a [carla.Sensor](#ca
- Obstacle detector: [carla.ObstacleDetectionEvent](#carla.ObstacleDetectionEvent).<br>
- Radar sensor: [carla.RadarMeasurement](#carla.RadarMeasurement).<br>
- RSS sensor: [carla.RssResponse](#carla.RssResponse).<br>
- Semantic LIDAR sensor: [carla.SemanticLidarMeasurement](#carla.SemanticLidarMeasurement).
- Cooperative awareness messages V2X sensor: [carla.CAMEvent](#carla.CAMEvent).
- Semantic LIDAR sensor: [carla.SemanticLidarMeasurement](#carla.SemanticLidarMeasurement).<br>
- Cooperative awareness messages V2X sensor: [carla.CAMEvent](#carla.CAMEvent).<br>
- Custom V2X messages V2X sensor: [carla.CustomV2XEvent](#carla.CustomV2XEvent).
### Instance Variables

4
PythonAPI/docs/client.yml
View File

@ -352,12 +352,12 @@
- param_name: folder
type: str
doc: >
Folder where files required by the client will be downloaded to.
Specifies a folder to look through on the server maps. Leaving this blank will search recursively through all map folders in the server, which is recommended if you're unfamiliar with the server map folder structure.
- param_name: download
type: bool
default: True
doc: >
If True, downloads files that are not already in cache.
If True, downloads files that are not already in cache. The cache can be found at "HOME\carlaCache" or "USERPROFILE\carlaCache", depending on OS.
doc: >
Asks the server which files are required by the client to use the current map. Option to download files automatically if they are not already in the cache.
# --------------------------------------

46
PythonAPI/docs/sensor.yml
View File

@ -8,21 +8,28 @@
doc: >
Sensors compound a specific family of actors quite diverse and unique. They are normally spawned as attachment/sons of a vehicle (take a look at carla.World to learn about actor spawning). Sensors are thoroughly designed to retrieve different types of data that they are listening to. The data they receive is shaped as different subclasses inherited from carla.SensorData (depending on the sensor).
Most sensors can be divided in two groups: those receiving data on every tick (cameras, point clouds and some specific sensors) and those who only receive under certain circumstances (trigger detectors). CARLA provides a specific set of sensors and their blueprint can be found in carla.BlueprintLibrary. All the information on their preferences and settlement can be found [here](ref_sensors.md), but the list of those available in CARLA so far goes as follow.
<br><b>Receive data on every tick.</b>
- [Depth camera](ref_sensors.md#depth-camera).
- [Gnss sensor](ref_sensors.md#gnss-sensor).
- [IMU sensor](ref_sensors.md#imu-sensor).
- [Lidar raycast](ref_sensors.md#lidar-raycast-sensor).
- [SemanticLidar raycast](ref_sensors.md#semanticlidar-raycast-sensor).
- [Radar](ref_sensors.md#radar-sensor).
- [RGB camera](ref_sensors.md#rgb-camera).
- [RSS sensor](ref_sensors.md#rss-sensor).
- [Semantic Segmentation camera](ref_sensors.md#semantic-segmentation-camera).
<br><b>Only receive data when triggered.</b>
- [Collision detector](ref_sensors.md#collision-detector).
- [Lane invasion detector](ref_sensors.md#lane-invasion-detector).
- [Obstacle detector](ref_sensors.md#obstacle-detector).
Most sensors can be divided in two groups: those receiving data on every tick (cameras, point clouds and some specific sensors) and those who only receive under certain circumstances (trigger detectors). CARLA provides a specific set of sensors and their blueprint can be found in carla.BlueprintLibrary. All the information on their preferences and settlement can be found [here](ref_sensors.md), but the list of those available in CARLA so far goes as follows:<br>
<br><b>Receive data on every tick</b><br>
- [Depth camera](ref_sensors.md#depth-camera)<br>
- [Gnss sensor](ref_sensors.md#gnss-sensor)<br>
- [IMU sensor](ref_sensors.md#imu-sensor)<br>
- [Lidar raycast](ref_sensors.md#lidar-raycast-sensor)<br>
- [SemanticLidar raycast](ref_sensors.md#semanticlidar-raycast-sensor)<br>
- [Radar](ref_sensors.md#radar-sensor)<br>
- [RGB camera](ref_sensors.md#rgb-camera)<br>
- [RSS sensor](ref_sensors.md#rss-sensor)<br>
- [Semantic Segmentation camera](ref_sensors.md#semantic-segmentation-camera)<br>
<br><b>Only receive data when triggered.</b><br>
- [Collision detector](ref_sensors.md#collision-detector)<br>
- [Lane invasion detector](ref_sensors.md#lane-invasion-detector)<br>
- [Obstacle detector](ref_sensors.md#obstacle-detector)<br>
- [V2X sensor](ref_sensors.md#v2x-sensor)
# - PROPERTIES -------------------------
instance_variables:
- var_name: is_listening
type: boolean
doc: >
When **True** the sensor will be waiting for data.
# - METHODS ----------------------------
methods:
- def_name: listen
@ -92,6 +99,15 @@
doc: >
Commands the sensor to stop listening for the specified GBuffer texture.
# --------------------------------------
- def_name: send
params:
- param_name: message
type: string
doc: >
The data to send. Note: maximum string length is 100 chars.
doc: >
Instructs the sensor to send the string given by `message` to all other CustomV2XSensors on the next tick.
# --------------------------------------
- def_name: __str__
# --------------------------------------

112
PythonAPI/docs/sensor_data.yml
View File

@ -15,7 +15,9 @@
- Obstacle detector: carla.ObstacleDetectionEvent.<br>
- Radar sensor: carla.RadarMeasurement.<br>
- RSS sensor: carla.RssResponse.<br>
- Semantic LIDAR sensor: carla.SemanticLidarMeasurement.
- Semantic LIDAR sensor: carla.SemanticLidarMeasurement.<br>
- Cooperative awareness messages V2X sensor: carla.CAMEvent.<br>
- Custom V2X messages V2X sensor: carla.CustomV2XEvent.
# - PROPERTIES -------------------------
instance_variables:
- var_name: frame
@ -878,7 +880,7 @@
- class_name: GBufferTextureID
# - DESCRIPTION ------------------------
doc: >
Defines the identifiers of each GBuffer texture (See the method `carla.Sensor.listen_to_gbuffer`).
Defines the of each GBuffer texture (See the method `carla.Sensor.listen_to_gbuffer`).
# - PROPERTIES -------------------------
instance_variables:
- var_name: SceneColor
@ -941,4 +943,110 @@
The texture "CustomStencil" contains the Unreal Engine custom stencil data.
# --------------------------------------
- class_name: CAMData
parent: carla.SensorData
# - DESCRIPTION ------------------------
doc: >
This is the data type for cooperative awareness message reception, contained in a [CAMEvent](#carlacamevent)
# - PROPERTIES -------------------------
instance_variables:
- var_name: power
type: float - dBm
doc: >
Received power.
# - METHODS ----------------------------
# --------------------------------------
methods:
- def_name: get
return: dict
doc: >
Get the CAM data. Returns a nested dictionary containing the message following the ETSI standard: - `Header`: dict - `Message`: dict
# --------------------------------------
- def_name: __str__
# --------------------------------------
- class_name: CAMEvent
parent: carla.SensorData
# - DESCRIPTION ------------------------
doc: >
Class that defines the data provided by a **sensor.other.v2x**. This is a collection type to combine returning several [CAMData](#carlacamdata).
# - PROPERTIES -------------------------
instance_variables:
# - METHODS ----------------------------
# --------------------------------------
methods:
- def_name: get_message_count
return: int
doc: >
Get the number of received CAM's.
# --------------------------------------
- def_name: __get_item__
params:
- param_name: pos
type: int
# --------------------------------------
- def_name: __iter__
doc: >
Iterate over the [CAMData](#carlacamdata) retrieved as data.
# --------------------------------------
- def_name: __len__
# --------------------------------------
- class_name: CustomV2XEvent
parent: carla.SensorData
# - DESCRIPTION ------------------------
doc: >
Class that defines the data provided by a **sensor.other.v2x_custom**. This is a collection type to combine returning several [CustomV2XData](#carlacustomv2xdata).
# - PROPERTIES -------------------------
instance_variables:
# - METHODS ----------------------------
# --------------------------------------
methods:
- def_name: get_message_count
return: int
doc: >
Get the number of received CAM's.
# --------------------------------------
- def_name: __get_item__
params:
- param_name: pos
type: int
# --------------------------------------
- def_name: __iter__
doc: >
Iterate over the [CustomV2XData](#carlacustomv2xdata) retrieved as data.
# --------------------------------------
- def_name: __len__
# --------------------------------------
- class_name: CustomV2XData
parent: carla.SensorData
# - DESCRIPTION ------------------------
doc: >
This is the data type defining a custom V2X message. Received as part of a [CustomV2XEvent](#carlacustomv2xevent).
# - PROPERTIES -------------------------
instance_variables:
- var_name: power
type: float - dBm
doc: >
Received power.
# - METHODS ----------------------------
# --------------------------------------
methods:
- def_name: get
return: dict
doc: >
Get the custom message. Returns a nested dictionary containing the message. It has two primary keys: - `Header` : dict - `Message`: str
# --------------------------------------
- def_name: __str__
# --------------------------------------
...