docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class RosBinaryDeserializer

    Deserializes ROS binary-encoded messages (CDR for ROS 2, bare binary for ROS 1) into IMessage instances by reading from a raw byte buffer.

    Inheritance
    object
    RosBinaryDeserializer
    Implements
    IMessageDeserializer
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Unity.SimulationPro.RosIntegrations
    Assembly: Unity.SimulationPro.RosIntegrations.dll
    Syntax
    public class RosBinaryDeserializer : IMessageDeserializer
    Remarks

    Implements IMessageDeserializer and is used by RosEndpointConnector to decode incoming topic and service messages received over the TCP endpoint. Set IsRos2 to true to skip the 4-byte ROS 2 CDR header and apply alignment padding on multi-byte primitives.

    Constructors

    RosBinaryDeserializer(bool)

    Initializes a new RosBinaryDeserializer.

    Declaration
    public RosBinaryDeserializer(bool isRos2)
    Parameters
    Type Name Description
    bool isRos2

    Pass true to use ROS 2 CDR encoding; false for ROS 1.

    Properties

    IsRos2

    Gets a value indicating whether this deserializer operates in ROS 2 CDR mode.

    Declaration
    public bool IsRos2 { get; }
    Property Value
    Type Description
    bool

    UseRos2Schema

    Declaration
    public bool UseRos2Schema { get; }
    Property Value
    Type Description
    bool

    Methods

    BeginMessage(string[])

    BeginMessage method.

    Declaration
    public void BeginMessage(string[] fieldNames)
    Parameters
    Type Name Description
    string[] fieldNames

    The fieldNames.

    DeserializeMessage(MessageTypeId, byte[])

    Deserializes the raw byte buffer into a message of the type identified by messageTypeId.

    Declaration
    public IMessage DeserializeMessage(MessageTypeId messageTypeId, byte[] data)
    Parameters
    Type Name Description
    MessageTypeId messageTypeId

    The ROS message type identifier used to look up the deserialization function.

    byte[] data

    The payload data for this message.

    Returns
    Type Description
    IMessage

    The deserialized IMessage instance.

    DeserializeMessage<T>(byte[])

    Deserializes the raw byte buffer into a message of type T.

    Declaration
    public T DeserializeMessage<T>(byte[] data) where T : IMessage
    Parameters
    Type Name Description
    byte[] data

    The payload data for this message.

    Returns
    Type Description
    T

    The deserialized message.

    Type Parameters
    Name Description
    T

    The concrete IMessage type to deserialize into.

    DeserializeMessage<T>(byte[], out T)

    Declaration
    public void DeserializeMessage<T>(byte[] data, out T result) where T : IMessage
    Parameters
    Type Name Description
    byte[] data
    T result
    Type Parameters
    Name Description
    T

    EndMessage()

    EndMessage method.

    Declaration
    public void EndMessage()

    Read(out bool)

    Read method.

    Declaration
    public void Read(out bool value)
    Parameters
    Type Name Description
    bool value

    Associated value in a key-value pair.

    Read(out bool[])

    Declaration
    public void Read(out bool[] values)
    Parameters
    Type Name Description
    bool[] values

    Read(out bool[], int)

    Read method.

    Declaration
    public void Read(out bool[] values, int fixedLength)
    Parameters
    Type Name Description
    bool[] values

    Array of associated values.

    int fixedLength

    The fixedLength.

    Read(out byte)

    Declaration
    public void Read(out byte value)
    Parameters
    Type Name Description
    byte value

    Read(out byte[])

    Declaration
    public void Read(out byte[] values)
    Parameters
    Type Name Description
    byte[] values

    Read(out byte[], int)

    Declaration
    public void Read(out byte[] values, int fixedLength)
    Parameters
    Type Name Description
    byte[] values
    int fixedLength

    Read(out double)

    Declaration
    public void Read(out double value)
    Parameters
    Type Name Description
    double value

    Read(out double[])

    Declaration
    public void Read(out double[] values)
    Parameters
    Type Name Description
    double[] values

    Read(out double[], int)

    Declaration
    public void Read(out double[] values, int fixedLength)
    Parameters
    Type Name Description
    double[] values
    int fixedLength

    Read(out short)

    Declaration
    public void Read(out short value)
    Parameters
    Type Name Description
    short value

    Read(out short[])

    Declaration
    public void Read(out short[] values)
    Parameters
    Type Name Description
    short[] values

    Read(out short[], int)

    Declaration
    public void Read(out short[] values, int fixedLength)
    Parameters
    Type Name Description
    short[] values
    int fixedLength

    Read(out int)

    Declaration
    public void Read(out int value)
    Parameters
    Type Name Description
    int value

    Read(out int[])

    Declaration
    public void Read(out int[] values)
    Parameters
    Type Name Description
    int[] values

    Read(out int[], int)

    Declaration
    public void Read(out int[] values, int fixedLength)
    Parameters
    Type Name Description
    int[] values
    int fixedLength

    Read(out long)

    Declaration
    public void Read(out long value)
    Parameters
    Type Name Description
    long value

    Read(out long[])

    Declaration
    public void Read(out long[] values)
    Parameters
    Type Name Description
    long[] values

    Read(out long[], int)

    Declaration
    public void Read(out long[] values, int fixedLength)
    Parameters
    Type Name Description
    long[] values
    int fixedLength

    Read(out sbyte)

    Declaration
    public void Read(out sbyte value)
    Parameters
    Type Name Description
    sbyte value

    Read(out sbyte[])

    Declaration
    public void Read(out sbyte[] values)
    Parameters
    Type Name Description
    sbyte[] values

    Read(out sbyte[], int)

    Declaration
    public void Read(out sbyte[] values, int fixedLength)
    Parameters
    Type Name Description
    sbyte[] values
    int fixedLength

    Read(out float)

    Declaration
    public void Read(out float value)
    Parameters
    Type Name Description
    float value

    Read(out float[])

    Declaration
    public void Read(out float[] values)
    Parameters
    Type Name Description
    float[] values

    Read(out float[], int)

    Declaration
    public void Read(out float[] values, int fixedLength)
    Parameters
    Type Name Description
    float[] values
    int fixedLength

    Read(out string)

    Declaration
    public void Read(out string value)
    Parameters
    Type Name Description
    string value

    Read(out string[])

    Declaration
    public void Read(out string[] values)
    Parameters
    Type Name Description
    string[] values

    Read(out string[], int)

    Declaration
    public void Read(out string[] values, int length)
    Parameters
    Type Name Description
    string[] values
    int length

    Read(out ushort)

    Declaration
    public void Read(out ushort value)
    Parameters
    Type Name Description
    ushort value

    Read(out ushort[])

    Declaration
    public void Read(out ushort[] values)
    Parameters
    Type Name Description
    ushort[] values

    Read(out ushort[], int)

    Declaration
    public void Read(out ushort[] values, int fixedLength)
    Parameters
    Type Name Description
    ushort[] values
    int fixedLength

    Read(out uint)

    Declaration
    public void Read(out uint value)
    Parameters
    Type Name Description
    uint value

    Read(out uint[])

    Declaration
    public void Read(out uint[] values)
    Parameters
    Type Name Description
    uint[] values

    Read(out uint[], int)

    Declaration
    public void Read(out uint[] values, int fixedLength)
    Parameters
    Type Name Description
    uint[] values
    int fixedLength

    Read(out ulong)

    Declaration
    public void Read(out ulong value)
    Parameters
    Type Name Description
    ulong value

    Read(out ulong[])

    Declaration
    public void Read(out ulong[] values)
    Parameters
    Type Name Description
    ulong[] values

    Read(out ulong[], int)

    Declaration
    public void Read(out ulong[] values, int fixedLength)
    Parameters
    Type Name Description
    ulong[] values
    int fixedLength

    Read<T>(out T)

    Declaration
    public void Read<T>(out T value) where T : IMessage
    Parameters
    Type Name Description
    T value
    Type Parameters
    Name Description
    T

    Read<T>(out T[])

    Declaration
    public void Read<T>(out T[] values) where T : IMessage
    Parameters
    Type Name Description
    T[] values
    Type Parameters
    Name Description
    T

    Read<T>(out T[], int)

    Declaration
    public void Read<T>(out T[] values, int length) where T : IMessage
    Parameters
    Type Name Description
    T[] values
    int length
    Type Parameters
    Name Description
    T

    Implements

    IMessageDeserializer
    In This Article
    Back to top
    Copyright © 2026 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)