Class MultiArrayLayoutMsg
ROS std_msgs/MultiArrayLayout message.
Implements
Inherited Members
Namespace: Unity.SimulationPro.Foundation.StdMessages
Assembly: Unity.SimulationPro.Foundation.dll
Syntax
[Serializable]
public class MultiArrayLayoutMsg : IMessage
Constructors
MultiArrayLayoutMsg()
padding bytes at front of data
Declaration
public MultiArrayLayoutMsg()
MultiArrayLayoutMsg(MultiArrayDimensionMsg[], uint)
Initializes a new instance with default values.
Declaration
public MultiArrayLayoutMsg(MultiArrayDimensionMsg[] dim, uint data_offset)
Parameters
| Type | Name | Description |
|---|---|---|
| MultiArrayDimensionMsg[] | dim | A single dimension descriptor (label, size, stride). |
| uint | data_offset | Byte offset to the start of valid data. |
Fields
data_offset
Array of dimension properties
Declaration
public uint data_offset
Field Value
| Type | Description |
|---|---|
| uint |
dim
This was originally provided as an example message. It is deprecated as of Foxy It is recommended to create your own semantically meaningful message. However if you would like to continue using this please use the equivalent in example_msgs. The multiarray declares a generic multi-dimensional array of a particular data type. Dimensions are ordered from outer most to inner most. Accessors should ALWAYS be written in terms of dimension stride and specified outer-most dimension first. multiarray(i,j,k) = data[data_offset + dim_stride[1]i + dim_stride[2]j + k] A standard, 3-channel 640x480 image with interleaved color channels would be specified as: dim[0].label = "height" dim[0].size = 480 dim[0].stride = 3640480 = 921600 (note dim[0] stride is just size of image) dim[1].label = "width" dim[1].size = 640 dim[1].stride = 3*640 = 1920 dim[2].label = "channel" dim[2].size = 3 dim[2].stride = 3 multiarray(i,j,k) refers to the ith row, jth column, and kth channel.
Declaration
public MultiArrayDimensionMsg[] dim
Field Value
| Type | Description |
|---|---|
| MultiArrayDimensionMsg[] |
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 = "std_msgs/MultiArrayLayout"
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 MultiArrayLayoutMsg from the given deserializer.
Declaration
public static MultiArrayLayoutMsg Deserialize(IMessageDeserializer deserializer)
Parameters
| Type | Name | Description |
|---|---|---|
| IMessageDeserializer | deserializer | The deserializer. |
Returns
| Type | Description |
|---|---|
| MultiArrayLayoutMsg | A new MultiArrayLayoutMsg 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. |