Class ActionGoal<TGoal>
Action Goal.
Implements
Inherited Members
Namespace: Unity.SimulationPro.Foundation
Assembly: Unity.SimulationPro.Foundation.dll
Syntax
public abstract class ActionGoal<TGoal> : IMessage where TGoal : IMessage
Type Parameters
| Name | Description |
|---|---|
| TGoal | The goal message type. |
Constructors
ActionGoal()
Initializes a new ActionGoal<TGoal> with default field values.
Declaration
public ActionGoal()
ActionGoal(IMessageDeserializer)
Initializes a new ActionGoal<TGoal> by reading field values from the specified deserializer.
Declaration
protected ActionGoal(IMessageDeserializer deserializer)
Parameters
| Type | Name | Description |
|---|---|---|
| IMessageDeserializer | deserializer | The deserializer to read field values from. |
ActionGoal(HeaderMsg, GoalIDMsg, TGoal)
Initializes a new ActionGoal<TGoal> with the specified values.
Declaration
public ActionGoal(HeaderMsg header, GoalIDMsg goal_id, TGoal goal)
Parameters
| Type | Name | Description |
|---|---|---|
| HeaderMsg | header | ROS message header containing timestamp and coordinate frame identifier. |
| GoalIDMsg | goal_id | Unique identifier for tracking this goal instance. |
| TGoal | goal | The goal to be pursued by the action server. |
Fields
goal
The goal to be pursued by the action server.
Declaration
public TGoal goal
Field Value
| Type | Description |
|---|---|
| TGoal |
goal_id
Unique identifier for tracking a specific goal instance.
Declaration
public GoalIDMsg goal_id
Field Value
| Type | Description |
|---|---|
| GoalIDMsg |
header
ROS message header containing timestamp and coordinate frame identifier.
Declaration
public HeaderMsg header
Field Value
| Type | Description |
|---|---|
| HeaderMsg |
s_FieldNames
The s_field names.
Declaration
public static string[] s_FieldNames
Field Value
| Type | Description |
|---|---|
| string[] |
Properties
MessageTypeId
Unique identifier used to register and look up this message type at runtime.
Declaration
public abstract MessageTypeId MessageTypeId { get; }
Property Value
| Type | Description |
|---|---|
| MessageTypeId |
MessageTypeName
The ROS message type name string used for serialization and topic matching.
Declaration
public abstract string MessageTypeName { get; }
Property Value
| Type | Description |
|---|---|
| string |
Methods
WriteTo(IMessageSerializer)
Writes all fields of this message into the specified serializer.
Declaration
public void WriteTo(IMessageSerializer serializer)
Parameters
| Type | Name | Description |
|---|---|---|
| IMessageSerializer | serializer | The serializer to write field values to. |