docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class RosBinarySerializer

    Serializes IMessage instances to the ROS binary wire format (CDR for ROS 2, bare little-endian binary for ROS 1) for transmission over the TCP endpoint.

    Inheritance
    object
    RosBinarySerializer
    Implements
    IMessageSerializer
    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 RosBinarySerializer : IMessageSerializer
    Remarks

    Implements IMessageSerializer and is used internally by RosEndpointConnector. In ROS 2 mode a 4-byte CDR header is prepended and multi-byte primitives are aligned according to the eProsima Fast-CDR specification. Call SerializeMessageWithHeader(IMessage) to produce a standalone encoded buffer, or use the internal SendMessage helpers to write directly to a Stream.

    Constructors

    RosBinarySerializer(bool)

    Initializes a new RosBinarySerializer.

    Declaration
    public RosBinarySerializer(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 serializer 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.

    EndMessage()

    EndMessage method.

    Declaration
    public void EndMessage()

    SerializeMessageWithHeader(IMessage)

    Serializes msg into a standalone byte array that includes the ROS 2 CDR header (when applicable).

    Declaration
    public byte[] SerializeMessageWithHeader(IMessage msg)
    Parameters
    Type Name Description
    IMessage msg

    The message instance.

    Returns
    Type Description
    byte[]

    The encoded byte array.

    Write(bool)

    Write method.

    Declaration
    public void Write(bool value)
    Parameters
    Type Name Description
    bool value

    Associated value in a key-value pair.

    Write(bool[])

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

    Write(bool[], int)

    Write method.

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

    Array of associated values.

    int fixedLength

    The fixedLength.

    Write(byte)

    Declaration
    public void Write(byte value)
    Parameters
    Type Name Description
    byte value

    Write(byte[])

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

    Write(byte[], int)

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

    Write(double)

    Declaration
    public void Write(double value)
    Parameters
    Type Name Description
    double value

    Write(double[])

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

    Write(double[], int)

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

    Write(short)

    Declaration
    public void Write(short value)
    Parameters
    Type Name Description
    short value

    Write(short[])

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

    Write(short[], int)

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

    Write(int)

    Declaration
    public void Write(int value)
    Parameters
    Type Name Description
    int value

    Write(int[])

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

    Write(int[], int)

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

    Write(long)

    Declaration
    public void Write(long value)
    Parameters
    Type Name Description
    long value

    Write(long[])

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

    Write(long[], int)

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

    Write(sbyte)

    Declaration
    public void Write(sbyte value)
    Parameters
    Type Name Description
    sbyte value

    Write(sbyte[])

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

    Write(sbyte[], int)

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

    Write(float)

    Declaration
    public void Write(float value)
    Parameters
    Type Name Description
    float value

    Write(float[])

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

    Write(float[], int)

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

    Write(string)

    Declaration
    public void Write(string inputString)
    Parameters
    Type Name Description
    string inputString

    Write(string[])

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

    Write(string[], int)

    Declaration
    public void Write(string[] values, int fixedLength)
    Parameters
    Type Name Description
    string[] values
    int fixedLength

    Write(ushort)

    Declaration
    public void Write(ushort value)
    Parameters
    Type Name Description
    ushort value

    Write(ushort[])

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

    Write(ushort[], int)

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

    Write(uint)

    Declaration
    public void Write(uint value)
    Parameters
    Type Name Description
    uint value

    Write(uint[])

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

    Write(uint[], int)

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

    Write(ulong)

    Declaration
    public void Write(ulong value)
    Parameters
    Type Name Description
    ulong value

    Write(ulong[])

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

    Write(ulong[], int)

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

    Write(IMessage)

    Declaration
    public void Write(IMessage message)
    Parameters
    Type Name Description
    IMessage message

    Write<T>(T)

    Declaration
    public void Write<T>(T data) where T : IMessage
    Parameters
    Type Name Description
    T data
    Type Parameters
    Name Description
    T

    Write<T>(T[])

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

    Write<T>(T[], int)

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

    Implements

    IMessageSerializer
    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)