docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class RecoveryStatusMsg

    ROS move_base_msgs/RecoveryStatus message.

    Inheritance
    object
    RecoveryStatusMsg
    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.MoveBaseMessages
    Assembly: Unity.SimulationPro.Foundation.dll
    Syntax
    [Serializable]
    public class RecoveryStatusMsg : IMessage

    Constructors

    RecoveryStatusMsg()

    Namespace of the recovery being executed

    Declaration
    public RecoveryStatusMsg()

    RecoveryStatusMsg(PoseStampedMsg, ushort, ushort, string)

    Initializes a new instance with default values.

    Declaration
    public RecoveryStatusMsg(PoseStampedMsg pose_stamped, ushort current_recovery_number, ushort total_number_of_recoveries, string recovery_behavior_name)
    Parameters
    Type Name Description
    PoseStampedMsg pose_stamped

    Pose with an associated header containing timestamp and frame.

    ushort current_recovery_number

    Index of the current recovery behavior attempt.

    ushort total_number_of_recoveries

    Total number of recovery behaviors executed.

    string recovery_behavior_name

    Name of the last executed recovery behavior.

    Fields

    current_recovery_number

    The robot's pose when the recovery was triggered

    Declaration
    public ushort current_recovery_number
    Field Value
    Type Description
    ushort

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

    pose_stamped

    Pose stamped field.

    Declaration
    public PoseStampedMsg pose_stamped
    Field Value
    Type Description
    PoseStampedMsg

    recovery_behavior_name

    Total number of recoveries configured

    Declaration
    public string recovery_behavior_name
    Field Value
    Type Description
    string

    total_number_of_recoveries

    0-based index of current recovery number

    Declaration
    public ushort total_number_of_recoveries
    Field Value
    Type Description
    ushort

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

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

    The deserializer.

    Returns
    Type Description
    RecoveryStatusMsg

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