docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class TopicStatisticsMsg

    ROS rosgraph_msgs/TopicStatistics message.

    Inheritance
    object
    TopicStatisticsMsg
    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.RosgraphMessages
    Assembly: Unity.SimulationPro.Foundation.dll
    Syntax
    [Serializable]
    public class TopicStatisticsMsg : IMessage

    Constructors

    TopicStatisticsMsg()

    Initializes a new instance with default values.

    Declaration
    public TopicStatisticsMsg()

    TopicStatisticsMsg(string, string, string, TimeMsg, TimeMsg, int, int, int, DurationMsg, DurationMsg, DurationMsg, DurationMsg, DurationMsg, DurationMsg)

    Initializes a new instance with default values.

    Declaration
    public TopicStatisticsMsg(string topic, string node_pub, string node_sub, TimeMsg window_start, TimeMsg window_stop, int delivered_msgs, int dropped_msgs, int traffic, DurationMsg period_mean, DurationMsg period_stddev, DurationMsg period_max, DurationMsg stamp_age_mean, DurationMsg stamp_age_stddev, DurationMsg stamp_age_max)
    Parameters
    Type Name Description
    string topic

    ROS topic name.

    string node_pub

    Name of the publishing node.

    string node_sub

    Name of the subscribing node.

    TimeMsg window_start

    Start position of the processing window.

    TimeMsg window_stop

    End position of the processing window.

    int delivered_msgs

    Number of messages successfully delivered.

    int dropped_msgs

    Number of messages dropped.

    int traffic

    Network traffic in bytes.

    DurationMsg period_mean

    Mean period between messages in seconds.

    DurationMsg period_stddev

    Standard deviation of the message period.

    DurationMsg period_max

    Maximum observed message period in seconds.

    DurationMsg stamp_age_mean

    Mean age of message timestamps in seconds.

    DurationMsg stamp_age_stddev

    Standard deviation of timestamp ages.

    DurationMsg stamp_age_max

    Maximum observed timestamp age in seconds.

    Fields

    delivered_msgs

    number of messages delivered during the window

    Declaration
    public int delivered_msgs
    Field Value
    Type Description
    int

    dropped_msgs

    numbers of messages dropped during the window

    Declaration
    public int dropped_msgs
    Field Value
    Type Description
    int

    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 = "rosgraph_msgs/TopicStatistics"
    Field Value
    Type Description
    string

    node_pub

    node id of the publisher

    Declaration
    public string node_pub
    Field Value
    Type Description
    string

    node_sub

    node id of the subscriber

    Declaration
    public string node_sub
    Field Value
    Type Description
    string

    period_max

    Period max field.

    Declaration
    public DurationMsg period_max
    Field Value
    Type Description
    DurationMsg

    period_mean

    mean/stddev/max period between two messages

    Declaration
    public DurationMsg period_mean
    Field Value
    Type Description
    DurationMsg

    period_stddev

    Period stddev field.

    Declaration
    public DurationMsg period_stddev
    Field Value
    Type Description
    DurationMsg

    stamp_age_max

    Stamp age max field.

    Declaration
    public DurationMsg stamp_age_max
    Field Value
    Type Description
    DurationMsg

    stamp_age_mean

    mean/stddev/max age of the message based on the timestamp in the message header. In case the message does not have a header, it will be 0.

    Declaration
    public DurationMsg stamp_age_mean
    Field Value
    Type Description
    DurationMsg

    stamp_age_stddev

    Stamp age stddev field.

    Declaration
    public DurationMsg stamp_age_stddev
    Field Value
    Type Description
    DurationMsg

    topic

    name of the topic

    Declaration
    public string topic
    Field Value
    Type Description
    string

    traffic

    traffic during the window, in bytes

    Declaration
    public int traffic
    Field Value
    Type Description
    int

    window_start

    the statistics apply to this time window

    Declaration
    public TimeMsg window_start
    Field Value
    Type Description
    TimeMsg

    window_stop

    Window stop field.

    Declaration
    public TimeMsg window_stop
    Field Value
    Type Description
    TimeMsg

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

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

    The deserializer.

    Returns
    Type Description
    TopicStatisticsMsg

    A new TopicStatisticsMsg 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)