docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class LoadMapResponse

    ROS nav_msgs/LoadMap message.

    Inheritance
    object
    LoadMapResponse
    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 LoadMapResponse : IMessage

    Constructors

    LoadMapResponse()

    Initializes a new instance with default values.

    Declaration
    public LoadMapResponse()

    LoadMapResponse(OccupancyGridMsg, byte)

    Initializes a new instance with default values.

    Declaration
    public LoadMapResponse(OccupancyGridMsg map, byte result)
    Parameters
    Type Name Description
    OccupancyGridMsg map

    The occupancy or point-cloud map data.

    byte result

    Outcome data from a completed action.

    Fields

    RESULT_INVALID_MAP_DATA

    Constant value for RESULT_INVALID_MAP_DATA.

    Declaration
    public const byte RESULT_INVALID_MAP_DATA = 2
    Field Value
    Type Description
    byte

    RESULT_INVALID_MAP_METADATA

    Constant value for RESULT_INVALID_MAP_METADATA.

    Declaration
    public const byte RESULT_INVALID_MAP_METADATA = 3
    Field Value
    Type Description
    byte

    RESULT_MAP_DOES_NOT_EXIST

    Constant value for RESULT_MAP_DOES_NOT_EXIST.

    Declaration
    public const byte RESULT_MAP_DOES_NOT_EXIST = 1
    Field Value
    Type Description
    byte

    RESULT_SUCCESS

    Result code defintions

    Declaration
    public const byte RESULT_SUCCESS = 0
    Field Value
    Type Description
    byte

    RESULT_UNDEFINED_FAILURE

    Constant value for RESULT_UNDEFINED_FAILURE.

    Declaration
    public const byte RESULT_UNDEFINED_FAILURE = 255
    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 = "nav_msgs/LoadMap"
    Field Value
    Type Description
    string

    map

    Returned map is only valid if result equals RESULT_SUCCESS

    Declaration
    public OccupancyGridMsg map
    Field Value
    Type Description
    OccupancyGridMsg

    result

    Result field.

    Declaration
    public byte result
    Field Value
    Type Description
    byte

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

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

    The deserializer.

    Returns
    Type Description
    LoadMapResponse

    A new LoadMapResponse 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)