Package org.netxms.client.datacollection

Class Threshold

java.lang.Object
org.netxms.client.datacollection.Threshold
public class Threshold extends Object
Represents data collection item's threshold

  • Field Details

  • Constructor Details

    • Threshold

      public Threshold(NXCPMessage msg, long baseId)
      Create DCI threshold object from NXCP message
      Parameters:
      msg - NXCP message
      baseId - Base variable ID for this threshold in message

    • Threshold

      public Threshold()
      Create new threshold object

    • Threshold

      public Threshold(Threshold src)
      Copy constructor
      Parameters:
      src - source object

  • Method Details

    • fillMessage

      protected void fillMessage(NXCPMessage msg, long baseId)
      Fill NXCP message with threshold's data. Operational data maintained by server will not be put into message.
      Parameters:
      msg - NXCP message
      baseId - Base variable identifier

    • getFireEvent

      public int getFireEvent()
      Returns:
      the fireEvent

    • setFireEvent

      public void setFireEvent(int fireEvent)
      Parameters:
      fireEvent - the fireEvent to set

    • getRearmEvent

      public int getRearmEvent()
      Returns:
      the rearmEvent

    • setRearmEvent

      public void setRearmEvent(int rearmEvent)
      Parameters:
      rearmEvent - the rearmEvent to set

    • getSampleCount

      public int getSampleCount()
      Returns:
      sample count

    • setSampleCount

      public void setSampleCount(int sampleCount)
      Set sample count for threshold
      Parameters:
      sampleCount - sample count

    • getFunction

      public int getFunction()
      Returns:
      the function

    • setFunction

      public void setFunction(int function)
      Parameters:
      function - the function to set

    • getOperation

      public int getOperation()
      Returns:
      the operation

    • setOperation

      public void setOperation(int operation)
      Parameters:
      operation - the operation to set

    • getRepeatInterval

      public int getRepeatInterval()
      Returns:
      the repeatInterval

    • setRepeatInterval

      public void setRepeatInterval(int repeatInterval)
      Parameters:
      repeatInterval - the repeatInterval to set

    • getValue

      public String getValue()
      Returns:
      the value

    • setValue

      public void setValue(String value)
      Parameters:
      value - the value to set

    • getId

      public long getId()
      Returns:
      the id

    • isActive

      public boolean isActive()
      Returns true if threshold is currently active (it's condition was evaluated to true at last poll). This field cannot be set and is always false when threshold received as part of DCI configuration.
      Returns:
      the active status

    • getCurrentSeverity

      public Severity getCurrentSeverity()
      Returns:
      the currentSeverity

    • getLastEventTimestamp

      public Date getLastEventTimestamp()
      Get timestamp of last event generated when this threshold was activated.
      Returns:
      timestamp of last event generated when this threshold was activated or 0

    • getLastEventMessage

      public String getLastEventMessage()
      Get message from last event generated when this threshold was activated.
      Returns:
      message from last event generated when this threshold was activated or null

    • getScript

      public String getScript()
      Returns:
      the script

    • setScript

      public void setScript(String script)
      Parameters:
      script - the script to set

    • isDisabled

      public boolean isDisabled()
      Returns:
      the disabled

    • setDisabled

      public void setDisabled(boolean disabled)
      Parameters:
      disabled - the disabled to set

    • getTextualRepresentation

      public String getTextualRepresentation()
      Get textual representation of this threshold
      Returns:
      textual representation of this threshold

    • duplicate

      public Threshold duplicate()
      Duplicate threshold for later use (do not copy ID for duplicated threshold)
      Returns:
      threshold copy