Class MultiDOFJointStateMsg
ROS sensor_msgs/MultiDOFJointState message.
Implements
Inherited Members
Namespace: Unity.SimulationPro.Foundation.SensorMessages
Assembly: Unity.SimulationPro.Foundation.dll
Syntax
[Serializable]
public class MultiDOFJointStateMsg : IMessage
Constructors
MultiDOFJointStateMsg()
Initializes a new instance with default values.
Declaration
public MultiDOFJointStateMsg()
MultiDOFJointStateMsg(HeaderMsg, string[], TransformMsg[], TwistMsg[], WrenchMsg[])
Initializes a new instance with default values.
Declaration
public MultiDOFJointStateMsg(HeaderMsg header, string[] joint_names, TransformMsg[] transforms, TwistMsg[] twist, WrenchMsg[] wrench)
Parameters
| Type | Name | Description |
|---|---|---|
| HeaderMsg | header | ROS message header containing timestamp and coordinate frame identifier. |
| string[] | joint_names | Array of joint names identifying each entry. |
| TransformMsg[] | transforms | Array of timestamped transforms. |
| TwistMsg[] | twist | Linear and angular velocity. |
| WrenchMsg[] | wrench | Force and torque. |
Fields
header
Representation of state for joints with multiple degrees of freedom, following the structure of JointState which can only represent a single degree of freedom. It is assumed that a joint in a system corresponds to a transform that gets applied along the kinematic chain. For example, a planar joint (as in URDF) is 3DOF (x, y, yaw) and those 3DOF can be expressed as a transformation matrix, and that transformation matrix can be converted back to (x, y, yaw) Each joint is uniquely identified by its name The header specifies the time at which the joint states were recorded. All the joint states in one message have to be recorded at the same time. This message consists of a multiple arrays, one for each part of the joint state. The goal is to make each of the fields optional. When e.g. your joints have no wrench associated with them, you can leave the wrench array empty. All arrays in this message should have the same size, or be empty. This is the only way to uniquely associate the joint name with the correct states.
Declaration
public HeaderMsg header
Field Value
| Type | Description |
|---|---|
| HeaderMsg |
joint_names
Joint names field.
Declaration
public string[] joint_names
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 = "sensor_msgs/MultiDOFJointState"
Field Value
| Type | Description |
|---|---|
| string |
transforms
Transforms field.
Declaration
public TransformMsg[] transforms
Field Value
| Type | Description |
|---|---|
| TransformMsg[] |
twist
Twist field.
Declaration
public TwistMsg[] twist
Field Value
| Type | Description |
|---|---|
| TwistMsg[] |
wrench
Wrench field.
Declaration
public WrenchMsg[] wrench
Field Value
| Type | Description |
|---|---|
| WrenchMsg[] |
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 MultiDOFJointStateMsg from the given deserializer.
Declaration
public static MultiDOFJointStateMsg Deserialize(IMessageDeserializer deserializer)
Parameters
| Type | Name | Description |
|---|---|---|
| IMessageDeserializer | deserializer | The deserializer. |
Returns
| Type | Description |
|---|---|
| MultiDOFJointStateMsg | A new MultiDOFJointStateMsg 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. |