Package org.netxms.client

Class TrafficMetric

java.lang.Object
org.netxms.client.TrafficMetric
public class TrafficMetric extends Object
Traffic observer metric definition, as offered by the DCI editor metric picker. Served by the connector's metric catalog and filtered by the observer's capabilities.

  • Constructor Details

    • TrafficMetric

      public TrafficMetric(NXCPMessage msg, long baseId)
      Create traffic metric definition from NXCP message. Record stride is 10 fields: baseId = name, +1 = display name, +2 = unit, +3 = description, +4 = is-table, +5 = required capability bitmask (remaining fields reserved).
      Parameters:
      msg - NXCP message
      baseId - base field ID of this record

  • Method Details

    • getName

      public String getName()
      Returns:
      metric name (as used in the DCI metric field)

    • getDisplayName

      public String getDisplayName()
      Returns:
      human-readable display name

    • getUnit

      public String getUnit()
      Returns:
      unit string (may be empty)

    • getDescription

      public String getDescription()
      Returns:
      metric description

    • isTable

      public boolean isTable()
      Returns:
      true if this metric is a table

    • getRequiredCapability

      public long getRequiredCapability()
      Returns:
      required capability bitmask (0 = always available)