Class OdometryMsg
ROS nav_msgs/Odometry message.
Implements
Inherited Members
Namespace: Unity.SimulationPro.Foundation.NavMessages
Assembly: Unity.SimulationPro.Foundation.dll
Syntax
[Serializable]
public class OdometryMsg : IMessage
Constructors
OdometryMsg()
Initializes a new instance with default values.
Declaration
public OdometryMsg()
OdometryMsg(HeaderMsg, string, PoseWithCovarianceMsg, TwistWithCovarianceMsg)
Initializes a new instance with default values.
Declaration
public OdometryMsg(HeaderMsg header, string child_frame_id, PoseWithCovarianceMsg pose, TwistWithCovarianceMsg twist)
Parameters
| Type | Name | Description |
|---|---|---|
| HeaderMsg | header | ROS message header containing timestamp and coordinate frame identifier. |
| string | child_frame_id | TF frame identifier of the child frame in a transform relationship. |
| PoseWithCovarianceMsg | pose | Position and orientation in 3D space. |
| TwistWithCovarianceMsg | twist | Linear and angular velocity. |
Fields
child_frame_id
Frame id the pose points to. The twist is in this coordinate frame.
Declaration
public string child_frame_id
Field Value
| Type | Description |
|---|---|
| string |
header
This represents an estimate of a position and velocity in free space. The pose in this message should be specified in the coordinate frame given by header.frame_id The twist in this message should be specified in the coordinate frame given by the child_frame_id Includes the frame id of the pose parent.
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 = "nav_msgs/Odometry"
Field Value
| Type | Description |
|---|---|
| string |
pose
Estimated pose that is typically relative to a fixed world frame.
Declaration
public PoseWithCovarianceMsg pose
Field Value
| Type | Description |
|---|---|
| PoseWithCovarianceMsg |
twist
Estimated linear and angular velocity relative to child_frame_id.
Declaration
public TwistWithCovarianceMsg twist
Field Value
| Type | Description |
|---|---|
| TwistWithCovarianceMsg |
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 OdometryMsg from the given deserializer.
Declaration
public static OdometryMsg Deserialize(IMessageDeserializer deserializer)
Parameters
| Type | Name | Description |
|---|---|---|
| IMessageDeserializer | deserializer | The deserializer. |
Returns
| Type | Description |
|---|---|
| OdometryMsg | A new OdometryMsg 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. |