Class MultiArrayDimensionMsg
ROS std_msgs/MultiArrayDimension message.
Implements
Inherited Members
Namespace: Unity.SimulationPro.Foundation.StdMessages
Assembly: Unity.SimulationPro.Foundation.dll
Syntax
[Serializable]
public class MultiArrayDimensionMsg : IMessage
Constructors
MultiArrayDimensionMsg()
stride of given dimension
Declaration
public MultiArrayDimensionMsg()
MultiArrayDimensionMsg(string, uint, uint)
Initializes a new instance with default values.
Declaration
public MultiArrayDimensionMsg(string label, uint size, uint stride)
Parameters
| Type | Name | Description |
|---|---|---|
| string | label | Short display label. |
| uint | size | Number of elements along this dimension. |
| uint | stride | Number of elements to step to advance one position along this dimension. |
Fields
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/MultiArrayDimension"
Field Value
| Type | Description |
|---|---|
| string |
label
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.
Declaration
public string label
Field Value
| Type | Description |
|---|---|
| string |
size
label of given dimension
Declaration
public uint size
Field Value
| Type | Description |
|---|---|
| uint |
stride
size of given dimension (in type units)
Declaration
public uint stride
Field Value
| Type | Description |
|---|---|
| uint |
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 MultiArrayDimensionMsg from the given deserializer.
Declaration
public static MultiArrayDimensionMsg Deserialize(IMessageDeserializer deserializer)
Parameters
| Type | Name | Description |
|---|---|---|
| IMessageDeserializer | deserializer | The deserializer. |
Returns
| Type | Description |
|---|---|
| MultiArrayDimensionMsg | A new MultiArrayDimensionMsg 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. |