Class GoalIDMsg
ROS actionlib_msgs/GoalID message.
Implements
Inherited Members
Namespace: Unity.SimulationPro.Foundation.ActionlibMessages
Assembly: Unity.SimulationPro.Foundation.dll
Syntax
[Serializable]
public class GoalIDMsg : IMessage
Constructors
GoalIDMsg()
Initializes a new instance with default values.
Declaration
public GoalIDMsg()
GoalIDMsg(TimeMsg, string)
Initializes a new instance with default values.
Declaration
public GoalIDMsg(TimeMsg stamp, string id)
Parameters
| Type | Name | Description |
|---|---|---|
| TimeMsg | stamp | Timestamp indicating when this data was captured. |
| string | id | Unique integer identifier. |
Fields
id
The id provides a way to associate feedback and result message with specific goal requests. The id specified must be unique.
Declaration
public string id
Field Value
| Type | Description |
|---|---|
| string |
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/GoalID"
Field Value
| Type | Description |
|---|---|
| string |
stamp
The stamp should store the time at which this goal was requested. It is used by an action server when it tries to preempt all goals that were requested before a certain time
Declaration
public TimeMsg stamp
Field Value
| Type | Description |
|---|---|
| TimeMsg |
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 GoalIDMsg from the given deserializer.
Declaration
public static GoalIDMsg Deserialize(IMessageDeserializer deserializer)
Parameters
| Type | Name | Description |
|---|---|---|
| IMessageDeserializer | deserializer | The deserializer. |
Returns
| Type | Description |
|---|---|
| GoalIDMsg | A new GoalIDMsg 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. |