docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class DiagnosticStatusMsg

    ROS diagnostic_msgs/DiagnosticStatus message.

    Inheritance
    object
    DiagnosticStatusMsg
    Implements
    IMessage
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Unity.SimulationPro.Foundation.DiagnosticMessages
    Assembly: Unity.SimulationPro.Foundation.dll
    Syntax
    [Serializable]
    public class DiagnosticStatusMsg : IMessage

    Constructors

    DiagnosticStatusMsg()

    Initializes a new instance with default values.

    Declaration
    public DiagnosticStatusMsg()

    DiagnosticStatusMsg(sbyte, string, string, string, KeyValueMsg[])

    Initializes a new instance with default values.

    Declaration
    public DiagnosticStatusMsg(sbyte level, string name, string message, string hardware_id, KeyValueMsg[] values)
    Parameters
    Type Name Description
    sbyte level

    Severity or diagnostic level.

    string name

    Identifying name or label.

    string message

    The message data to visualize.

    string hardware_id

    Identifier of the hardware device being diagnosed.

    KeyValueMsg[] values

    Array of associated values.

    Fields

    ERROR

    Constant value for ERROR.

    Declaration
    public const sbyte ERROR = 2
    Field Value
    Type Description
    sbyte

    OK

    This message holds the status of an individual component of the robot. Possible levels of operations.

    Declaration
    public const sbyte OK = 0
    Field Value
    Type Description
    sbyte

    STALE

    Constant value for STALE.

    Declaration
    public const sbyte STALE = 3
    Field Value
    Type Description
    sbyte

    WARN

    Constant value for WARN.

    Declaration
    public const sbyte WARN = 1
    Field Value
    Type Description
    sbyte

    hardware_id

    A hardware unique string.

    Declaration
    public string hardware_id
    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 = "diagnostic_msgs/DiagnosticStatus"
    Field Value
    Type Description
    string

    level

    Level of operation enumerated above.

    Declaration
    public sbyte level
    Field Value
    Type Description
    sbyte

    message

    A description of the status.

    Declaration
    public string message
    Field Value
    Type Description
    string

    name

    A description of the test/component reporting.

    Declaration
    public string name
    Field Value
    Type Description
    string

    values

    An array of values associated with the status.

    Declaration
    public KeyValueMsg[] values
    Field Value
    Type Description
    KeyValueMsg[]

    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 DiagnosticStatusMsg from the given deserializer.

    Declaration
    public static DiagnosticStatusMsg Deserialize(IMessageDeserializer deserializer)
    Parameters
    Type Name Description
    IMessageDeserializer deserializer

    The deserializer.

    Returns
    Type Description
    DiagnosticStatusMsg

    A new DiagnosticStatusMsg 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
    object.ToString()

    WriteTo(IMessageSerializer)

    Serializes this message to the given serializer.

    Declaration
    public void WriteTo(IMessageSerializer serializer)
    Parameters
    Type Name Description
    IMessageSerializer serializer

    The serializer.

    Implements

    IMessage
    In This Article
    Back to top
    Copyright © 2026 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)