Class GetPlanResponse
ROS nav_msgs/GetPlan message.
Implements
Inherited Members
Namespace: Unity.SimulationPro.Foundation.NavMessages
Assembly: Unity.SimulationPro.Foundation.dll
Syntax
[Serializable]
public class GetPlanResponse : IMessage
Constructors
GetPlanResponse()
Initializes a new instance with default values.
Declaration
public GetPlanResponse()
GetPlanResponse(PathMsg)
Initializes a new instance with default values.
Declaration
public GetPlanResponse(PathMsg plan)
Parameters
| Type | Name | Description |
|---|---|---|
| PathMsg | plan | Planned path as a sequence of poses. |
Fields
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 |
plan
Array of poses from start to goal if one was successfully found.
Declaration
public PathMsg plan
Field Value
| Type | Description |
|---|---|
| PathMsg |
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 GetPlanResponse from the given deserializer.
Declaration
public static GetPlanResponse Deserialize(IMessageDeserializer deserializer)
Parameters
| Type | Name | Description |
|---|---|---|
| IMessageDeserializer | deserializer | The deserializer. |
Returns
| Type | Description |
|---|---|
| GetPlanResponse | A new GetPlanResponse 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
WriteTo(IMessageSerializer)
Serializes this message to the given serializer.
Declaration
public void WriteTo(IMessageSerializer serializer)
Parameters
| Type | Name | Description |
|---|---|---|
| IMessageSerializer | serializer | The serializer. |