Class PointFieldMsg
ROS sensor_msgs/PointField message.
Implements
Inherited Members
Namespace: Unity.SimulationPro.Foundation.SensorMessages
Assembly: Unity.SimulationPro.Foundation.dll
Syntax
[Serializable]
public class PointFieldMsg : IMessage
Constructors
PointFieldMsg()
How many elements in the field
Declaration
public PointFieldMsg()
PointFieldMsg(string, uint, byte, uint)
Initializes a new instance with default values.
Declaration
public PointFieldMsg(string name, uint offset, byte datatype, uint count)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Identifying name or label. |
| uint | offset | Byte offset of this field within the point structure. |
| byte | datatype | Integer code identifying the field's primitive data type. |
| uint | count | Number of elements in this field per point. |
Fields
FLOAT32
Constant value for FLOAT32.
Declaration
public const byte FLOAT32 = 7
Field Value
| Type | Description |
|---|---|
| byte |
FLOAT64
Constant value for FLOAT64.
Declaration
public const byte FLOAT64 = 8
Field Value
| Type | Description |
|---|---|
| byte |
INT16
Constant value for INT16.
Declaration
public const byte INT16 = 3
Field Value
| Type | Description |
|---|---|
| byte |
INT32
Constant value for INT32.
Declaration
public const byte INT32 = 5
Field Value
| Type | Description |
|---|---|
| byte |
INT8
This message holds the description of one point entry in the PointCloud2 message format.
Declaration
public const byte INT8 = 1
Field Value
| Type | Description |
|---|---|
| byte |
UINT16
Constant value for UINT16.
Declaration
public const byte UINT16 = 4
Field Value
| Type | Description |
|---|---|
| byte |
UINT32
Constant value for UINT32.
Declaration
public const byte UINT32 = 6
Field Value
| Type | Description |
|---|---|
| byte |
UINT8
Constant value for UINT8.
Declaration
public const byte UINT8 = 2
Field Value
| Type | Description |
|---|---|
| byte |
count
Datatype enumeration, see above
Declaration
public uint count
Field Value
| Type | Description |
|---|---|
| uint |
datatype
Offset from start of point struct
Declaration
public byte datatype
Field Value
| Type | Description |
|---|---|
| byte |
k_MessageTypeId
Identifier for this message type.
Declaration
public static readonly MessageTypeId k_MessageTypeId
Field Value
| Type | Description |
|---|---|
| MessageTypeId |
k_MessageTypeName
The ROS message type name string used for serialization and topic matching.
Declaration
public const string k_MessageTypeName = "sensor_msgs/PointField"
Field Value
| Type | Description |
|---|---|
| string |
name
Common PointField names are x, y, z, intensity, rgb, rgba
Declaration
public string name
Field Value
| Type | Description |
|---|---|
| string |
offset
Name of field
Declaration
public uint offset
Field Value
| Type | Description |
|---|---|
| uint |
Properties
MessageTypeId
Gets the unique runtime identifier for this message type.
Declaration
public MessageTypeId MessageTypeId { get; }
Property Value
| Type | Description |
|---|---|
| MessageTypeId |
MessageTypeName
Gets the ROS message type name for this message.
Declaration
public string MessageTypeName { get; }
Property Value
| Type | Description |
|---|---|
| string |
Methods
Deserialize(IMessageDeserializer)
Deserializes a PointFieldMsg from the given deserializer.
Declaration
public static PointFieldMsg Deserialize(IMessageDeserializer deserializer)
Parameters
| Type | Name | Description |
|---|---|---|
| IMessageDeserializer | deserializer | The deserializer. |
Returns
| Type | Description |
|---|---|
| PointFieldMsg | A new PointFieldMsg instance. |
Register()
Registers this message type with the MessageTypeRegistry.
Declaration
[InitializeOnLoadMethod]
public static void Register()
ToString()
Returns a human-readable string representation of this message.
Declaration
public override string ToString()
Returns
| Type | Description |
|---|---|
| string | A string representation of this instance. |
Overrides
WriteTo(IMessageSerializer)
Serializes this message to the given serializer.
Declaration
public void WriteTo(IMessageSerializer serializer)
Parameters
| Type | Name | Description |
|---|---|---|
| IMessageSerializer | serializer | The serializer. |