docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class GetPlanRequest

    ROS nav_msgs/GetPlan message.

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

    Constructors

    GetPlanRequest()

    Initializes a new instance with default values.

    Declaration
    public GetPlanRequest()

    GetPlanRequest(PoseStampedMsg, PoseStampedMsg, float)

    Initializes a new instance with default values.

    Declaration
    public GetPlanRequest(PoseStampedMsg start, PoseStampedMsg goal, float tolerance)
    Parameters
    Type Name Description
    PoseStampedMsg start

    Start value or position.

    PoseStampedMsg goal

    The goal to be pursued by the action server.

    float tolerance

    Acceptable positional tolerance in meters.

    Fields

    goal

    The final pose of the goal position

    Declaration
    public PoseStampedMsg goal
    Field Value
    Type Description
    PoseStampedMsg

    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/GetPlan"
    Field Value
    Type Description
    string

    start

    Get a plan from the current position to the goal Pose The start pose for the plan

    Declaration
    public PoseStampedMsg start
    Field Value
    Type Description
    PoseStampedMsg

    tolerance

    If the goal is obstructed, how many meters the planner can relax the constraint in x and y before failing.

    Declaration
    public float tolerance
    Field Value
    Type Description
    float

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

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

    The deserializer.

    Returns
    Type Description
    GetPlanRequest

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