Package org.netxms.client.datacollection

Class DciValue

java.lang.Object
org.netxms.client.datacollection.DciValue
Direct Known Subclasses:
SimpleDciValue, TableDciValue
public abstract class DciValue extends Object
DCI value

  • Field Details

    • MULTIPLIERS_DEFAULT

      public static final int MULTIPLIERS_DEFAULT
      See Also:

    • MULTIPLIERS_YES

      public static final int MULTIPLIERS_YES
      See Also:

    • MULTIPLIERS_NO

      public static final int MULTIPLIERS_NO
      See Also:

    • id

      protected long id

    • nodeId

      protected long nodeId

    • templateDciId

      protected long templateDciId

    • name

      protected String name

    • description

      protected String description

    • value

      protected String value

    • userTag

      protected String userTag

    • comments

      protected String comments

    • source

      protected DataOrigin source

    • dataType

      protected DataType dataType

    • status

      protected DataCollectionObjectStatus status

    • errorCount

      protected int errorCount

    • dcObjectType

      protected int dcObjectType

    • timestamp

      protected Date timestamp

    • activeThreshold

      protected Threshold activeThreshold

    • flags

      protected int flags

    • measurementUnit

      protected MeasurementUnit measurementUnit

    • multiplier

      protected int multiplier

    • noValueObject

      protected boolean noValueObject

    • anomalyDetected

      protected boolean anomalyDetected

    • thresholdDisableEndTime

      protected long thresholdDisableEndTime

  • Constructor Details

    • DciValue

      protected DciValue()
      Simple constructor for DciValue

    • DciValue

      protected DciValue(NXCPMessage msg, long base)
      Constructor for creating DciValue from NXCP message
      Parameters:
      msg - NXCP message
      base - Base field ID for value object

  • Method Details

    • createFromMessage

      public static DciValue createFromMessage(NXCPMessage msg, long base)
      Factory method to create correct DciValue subclass from NXCP message.
      Parameters:
      msg - NXCP message
      base - Base variable ID for value object
      Returns:
      DciValue object

    • createDataFormatter

      public DataFormatter createDataFormatter()
      Get data formatter for this DCI value.
      Returns:
      data formatter

    • getFormattedValue

      public String getFormattedValue(boolean useMultipliers, TimeFormatter timeFormatter)
      Parameters:
      timeFormatter -
      useMultipliers -
      Returns:

    • getFormattedValue

      public Object getFormattedValue(String formatString, TimeFormatter timeFormatter)
      Parameters:
      formatString -
      timeFormatter -
      Returns:

    • getId

      public long getId()
      Returns:
      the id

    • getName

      public String getName()
      Returns:
      the name

    • getDescription

      public String getDescription()
      Get DCi description.
      Returns:
      DCI description

    • getValue

      public String getValue()
      Get current (last collected) DCI value.
      Returns:
      current DCI value

    • getUserTag

      public String getUserTag()
      Returns:
      the userTag

    • getComments

      public String getComments()
      Get DCI comments.
      Returns:
      DCI comments

    • getSource

      public DataOrigin getSource()
      Returns:
      the source

    • getDataType

      public DataType getDataType()
      Returns:
      the dataType

    • getStatus

      public DataCollectionObjectStatus getStatus()
      Returns:
      the status

    • getTimestamp

      public Date getTimestamp()
      Returns:
      the timestamp

    • getNodeId

      public long getNodeId()
      Returns:
      the nodeId

    • getActiveThreshold

      public Threshold getActiveThreshold()
      Returns:
      the activeThreshold

    • getDcObjectType

      public int getDcObjectType()
      Returns:
      the dcObjectType

    • getErrorCount

      public int getErrorCount()
      Returns:
      the errorCount

    • getTemplateDciId

      public final long getTemplateDciId()
      Returns:
      the templateDciId

    • getThresholdSeverity

      public Severity getThresholdSeverity()
      Get severity of active threshold
      Returns:
      severity of active threshold or NORMAL if there are no active thresholds

    • getFlags

      public int getFlags()
      Returns:
      the flags

    • getMultipliersSelection

      public int getMultipliersSelection()
      Get multipliers selection.
      Returns:
      multiplier usage mode (DEFAULT, YES, or NO)

    • getMostCriticalSeverity

      public Severity getMostCriticalSeverity()
      Returns:
      the mostCriticalSeverity

    • getMeasurementUnit

      public MeasurementUnit getMeasurementUnit()
      Returns:
      the unitName

    • getMultiplier

      public int getMultiplier()
      Returns:
      the multiplier

    • isNoValueObject

      public boolean isNoValueObject()
      Returns:
      the noValueObject

    • isAnomalyDetected

      public boolean isAnomalyDetected()
      Returns:
      the anomalyDetected

    • getThresholdDisableEndTime

      public long getThresholdDisableEndTime()
      Get time until which threshold processing is disabled for this DCI. Value of 0 means that threshold processing is enabled. Value of -1 means that threshold processing is disabled permanently.
      Returns:
      the thresholdDisableEndTime time in seconds since epoch until which threshold processing is disabled

    • toString

      public String toString()
      Overrides:
      toString in class Object
      See Also: