Class JoyMsg
ROS sensor_msgs/Joy message.
Implements
Inherited Members
Namespace: Unity.SimulationPro.Foundation.SensorMessages
Assembly: Unity.SimulationPro.Foundation.dll
Syntax
[Serializable]
public class JoyMsg : IMessage
Constructors
JoyMsg()
Initializes a new instance with default values.
Declaration
public JoyMsg()
JoyMsg(HeaderMsg, float[], int[])
Initializes a new instance with default values.
Declaration
public JoyMsg(HeaderMsg header, float[] axes, int[] buttons)
Parameters
| Type | Name | Description |
|---|---|---|
| HeaderMsg | header | ROS message header containing timestamp and coordinate frame identifier. |
| float[] | axes | Array of analog axis values, typically in the range [-1, 1]. |
| int[] | buttons | Array of discrete button states (0 = released, 1 = pressed). |
Fields
axes
The axes measurements from a joystick.
Declaration
public float[] axes
Field Value
| Type | Description |
|---|---|
| float[] |
buttons
The buttons measurements from a joystick.
Declaration
public int[] buttons
Field Value
| Type | Description |
|---|---|
| int[] |
header
Reports the state of a joystick's axes and buttons. The timestamp is the time at which data is received from the joystick.
Declaration
public HeaderMsg header
Field Value
| Type | Description |
|---|---|
| HeaderMsg |
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 = "sensor_msgs/Joy"
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 JoyMsg from the given deserializer.
Declaration
public static JoyMsg Deserialize(IMessageDeserializer deserializer)
Parameters
| Type | Name | Description |
|---|---|---|
| IMessageDeserializer | deserializer | The deserializer. |
Returns
| Type | Description |
|---|---|
| JoyMsg | A new JoyMsg 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. |