Class Action<TActionGoal, TActionResult, TActionFeedback, TGoal, TResult, TFeedback>
Action.
Implements
Inherited Members
Namespace: Unity.SimulationPro.Foundation
Assembly: Unity.SimulationPro.Foundation.dll
Syntax
public abstract class Action<TActionGoal, TActionResult, TActionFeedback, TGoal, TResult, TFeedback> : IMessage where TActionGoal : ActionGoal<TGoal> where TActionResult : ActionResult<TResult> where TActionFeedback : ActionFeedback<TFeedback> where TGoal : IMessage where TResult : IMessage where TFeedback : IMessage
Type Parameters
| Name | Description |
|---|---|
| TActionGoal | The action goal wrapper type. |
| TActionResult | The action result wrapper type. |
| TActionFeedback | The action feedback wrapper type. |
| TGoal | The goal message type. |
| TResult | The result message type. |
| TFeedback | The feedback message type. |
Constructors
Action()
Initializes a new Action<TActionGoal, TActionResult, TActionFeedback, TGoal, TResult, TFeedback> with default field values.
Declaration
public Action()
Action(IMessageDeserializer)
Initializes a new Action<TActionGoal, TActionResult, TActionFeedback, TGoal, TResult, TFeedback> by reading field values from the specified deserializer.
Declaration
public Action(IMessageDeserializer deserializer)
Parameters
| Type | Name | Description |
|---|---|---|
| IMessageDeserializer | deserializer | The deserializer to read field values from. |
Action(TActionGoal, TActionResult, TActionFeedback)
Initializes a new Action<TActionGoal, TActionResult, TActionFeedback, TGoal, TResult, TFeedback> with the specified values.
Declaration
public Action(TActionGoal action_goal, TActionResult action_result, TActionFeedback action_feedback)
Parameters
| Type | Name | Description |
|---|---|---|
| TActionGoal | action_goal | The action goal message. |
| TActionResult | action_result | The action result message. |
| TActionFeedback | action_feedback | The action feedback message. |
Fields
action_feedback
The wrapped action feedback containing header, status, and the feedback payload.
Declaration
public TActionFeedback action_feedback
Field Value
| Type | Description |
|---|---|
| TActionFeedback |
action_goal
The wrapped action goal containing header, goal ID, and the goal payload.
Declaration
public TActionGoal action_goal
Field Value
| Type | Description |
|---|---|
| TActionGoal |
action_result
The wrapped action result containing header, status, and the result payload.
Declaration
public TActionResult action_result
Field Value
| Type | Description |
|---|---|
| TActionResult |
s_FieldNames
Field names used for serialization ordering of the action message fields.
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. |