Class StringMsg
ROS std_msgs/String message.
Implements
Inherited Members
Namespace: Unity.SimulationPro.Foundation.StdMessages
Assembly: Unity.SimulationPro.Foundation.dll
Syntax
[Serializable]
public class StringMsg : IMessage
Constructors
StringMsg()
Initializes a new instance with default values.
Declaration
public StringMsg()
StringMsg(string)
Initializes a new instance with default values.
Declaration
public StringMsg(string data)
Parameters
| Type | Name | Description |
|---|---|---|
| string | data | The payload data for this message. |
Fields
data
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 data
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 = "std_msgs/String"
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 StringMsg from the given deserializer.
Declaration
public static StringMsg Deserialize(IMessageDeserializer deserializer)
Parameters
| Type | Name | Description |
|---|---|---|
| IMessageDeserializer | deserializer | The deserializer. |
Returns
| Type | Description |
|---|---|
| StringMsg | A new StringMsg 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. |