Class GoalStatusMsg
ROS actionlib_msgs/GoalStatus message.
Implements
Inherited Members
Namespace: Unity.SimulationPro.Foundation.ActionlibMessages
Assembly: Unity.SimulationPro.Foundation.dll
Syntax
[Serializable]
public class GoalStatusMsg : IMessage
Constructors
GoalStatusMsg()
Initializes a new instance with default values.
Declaration
public GoalStatusMsg()
GoalStatusMsg(GoalIDMsg, byte, string)
Initializes a new instance with default values.
Declaration
public GoalStatusMsg(GoalIDMsg goal_id, byte status, string text)
Parameters
| Type | Name | Description |
|---|---|---|
| GoalIDMsg | goal_id | Unique identifier for tracking a specific goal instance. |
| byte | status | Status information. |
| string | text | Human-readable text content. |
Fields
ABORTED
(Terminal State).
Declaration
public const byte ABORTED = 4
Field Value
| Type | Description |
|---|---|
| byte |
ACTIVE
Constant value for ACTIVE.
Declaration
public const byte ACTIVE = 1
Field Value
| Type | Description |
|---|---|
| byte |
LOST
and was successfully cancelled (Terminal State).
Declaration
public const byte LOST = 9
Field Value
| Type | Description |
|---|---|
| byte |
PENDING
Constant value for PENDING.
Declaration
public const byte PENDING = 0
Field Value
| Type | Description |
|---|---|
| byte |
PREEMPTED
Constant value for PREEMPTED.
Declaration
public const byte PREEMPTED = 2
Field Value
| Type | Description |
|---|---|
| byte |
PREEMPTING
because the goal was unattainable or invalid (Terminal State).
Declaration
public const byte PREEMPTING = 6
Field Value
| Type | Description |
|---|---|
| byte |
RECALLED
the action server has not yet confirmed that the goal is canceled.
Declaration
public const byte RECALLED = 8
Field Value
| Type | Description |
|---|---|
| byte |
RECALLING
and has not yet completed execution.
Declaration
public const byte RECALLING = 7
Field Value
| Type | Description |
|---|---|
| byte |
REJECTED
to some failure (Terminal State).
Declaration
public const byte REJECTED = 5
Field Value
| Type | Description |
|---|---|
| byte |
SUCCEEDED
and has since completed its execution (Terminal State).
Declaration
public const byte SUCCEEDED = 3
Field Value
| Type | Description |
|---|---|
| byte |
goal_id
Goal id field.
Declaration
public GoalIDMsg goal_id
Field Value
| Type | Description |
|---|---|
| GoalIDMsg |
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 = "actionlib_msgs/GoalStatus"
Field Value
| Type | Description |
|---|---|
| string |
status
Status field.
Declaration
public byte status
Field Value
| Type | Description |
|---|---|
| byte |
text
be sent over the wire by an action server. Allow for the user to associate a string with GoalStatus for debugging.
Declaration
public string text
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 GoalStatusMsg from the given deserializer.
Declaration
public static GoalStatusMsg Deserialize(IMessageDeserializer deserializer)
Parameters
| Type | Name | Description |
|---|---|---|
| IMessageDeserializer | deserializer | The deserializer. |
Returns
| Type | Description |
|---|---|
| GoalStatusMsg | A new GoalStatusMsg 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. |