docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class OccupancyGridMsg

    ROS nav_msgs/OccupancyGrid message.

    Inheritance
    object
    OccupancyGridMsg
    Implements
    IMessage
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Unity.SimulationPro.Foundation.NavMessages
    Assembly: Unity.SimulationPro.Foundation.dll
    Syntax
    [Serializable]
    public class OccupancyGridMsg : IMessage

    Constructors

    OccupancyGridMsg()

    Initializes a new instance with default values.

    Declaration
    public OccupancyGridMsg()

    OccupancyGridMsg(HeaderMsg, MapMetaDataMsg, sbyte[])

    Initializes a new instance with default values.

    Declaration
    public OccupancyGridMsg(HeaderMsg header, MapMetaDataMsg info, sbyte[] data)
    Parameters
    Type Name Description
    HeaderMsg header

    ROS message header containing timestamp and coordinate frame identifier.

    MapMetaDataMsg info

    Metadata describing the map (resolution, dimensions, origin).

    sbyte[] data

    The payload data for this message.

    Fields

    data

    The map data, in row-major order, starting with (0,0). Cell (1, 0) will be listed second, representing the next cell in the x direction. Cell (0, 1) will be at the index equal to info.width, followed by (1, 1). The values inside are application dependent, but frequently, 0 represents unoccupied, 1 represents definitely occupied, and -1 represents unknown.

    Declaration
    public sbyte[] data
    Field Value
    Type Description
    sbyte[]

    header

    This represents a 2-D grid map

    Declaration
    public HeaderMsg header
    Field Value
    Type Description
    HeaderMsg

    info

    MetaData for the map

    Declaration
    public MapMetaDataMsg info
    Field Value
    Type Description
    MapMetaDataMsg

    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 = "nav_msgs/OccupancyGrid"
    Field Value
    Type Description
    string

    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 OccupancyGridMsg from the given deserializer.

    Declaration
    public static OccupancyGridMsg Deserialize(IMessageDeserializer deserializer)
    Parameters
    Type Name Description
    IMessageDeserializer deserializer

    The deserializer.

    Returns
    Type Description
    OccupancyGridMsg

    A new OccupancyGridMsg 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
    object.ToString()

    WriteTo(IMessageSerializer)

    Serializes this message to the given serializer.

    Declaration
    public void WriteTo(IMessageSerializer serializer)
    Parameters
    Type Name Description
    IMessageSerializer serializer

    The serializer.

    Implements

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