Class ActionResult<TResult>
Action Result.
Implements
Inherited Members
Namespace: Unity.SimulationPro.Foundation
Assembly: Unity.SimulationPro.Foundation.dll
Syntax
public abstract class ActionResult<TResult> : IMessage where TResult : IMessage
Type Parameters
| Name | Description |
|---|---|
| TResult | The result message type. |
Constructors
ActionResult()
Initializes a new ActionResult<TResult> with default field values.
Declaration
public ActionResult()
ActionResult(IMessageDeserializer)
Initializes a new ActionResult<TResult> by reading field values from the specified deserializer.
Declaration
protected ActionResult(IMessageDeserializer deserializer)
Parameters
| Type | Name | Description |
|---|---|---|
| IMessageDeserializer | deserializer | The deserializer to read field values from. |
ActionResult(HeaderMsg, GoalStatusMsg, TResult)
Initializes a new ActionResult<TResult> with the specified values.
Declaration
public ActionResult(HeaderMsg header, GoalStatusMsg status, TResult result)
Parameters
| Type | Name | Description |
|---|---|---|
| HeaderMsg | header | ROS message header containing timestamp and coordinate frame identifier. |
| GoalStatusMsg | status | Status of the goal this result relates to. |
| TResult | result | The result payload produced by the action server. |
Fields
header
ROS message header containing timestamp and coordinate frame identifier.
Declaration
public HeaderMsg header
Field Value
| Type | Description |
|---|---|
| HeaderMsg |
result
Outcome data from a completed action.
Declaration
public TResult result
Field Value
| Type | Description |
|---|---|
| TResult |
s_FieldNames
The s_field names.
Declaration
public static string[] s_FieldNames
Field Value
| Type | Description |
|---|---|
| string[] |
status
Status information.
Declaration
public GoalStatusMsg status
Field Value
| Type | Description |
|---|---|
| GoalStatusMsg |
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. |