Module org.eclipse.milo.opcua.stack.core
Package org.eclipse.milo.opcua.stack.core.types.builtin

Record Class StatusCode.DataValueInfoBits

java.lang.Object
java.lang.Record
org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode.DataValueInfoBits
All Implemented Interfaces:
StatusCode.InfoBits
Enclosing class:
StatusCode
public static record StatusCode.DataValueInfoBits(int bits) extends Record implements StatusCode.InfoBits
Additional information bits that qualify the StatusCode when the StatusCode.InfoType is StatusCode.InfoType.DataValue.

  • Constructor Details

    • DataValueInfoBits

      public DataValueInfoBits(int bits)
      Creates an instance of a DataValueInfoBits record class.
      Parameters:
      bits - the value for the bits record component

  • Method Details

    • getLimitBits

      public int getLimitBits()
      Returns:
      the limit bits associated with the data value.

    • isLimitNone

      public boolean isLimitNone()
      Returns:
      true if the value is free to change.

    • isLimitLow

      public boolean isLimitLow()
      Returns:
      true if the value is at the lower limit for the datasource.

    • isLimitHigh

      public boolean isLimitHigh()
      Returns:
      true if the value is at the upper limit for the datasource.

    • isLimitConstant

      public boolean isLimitConstant()
      Returns:
      true if the value is constant and cannot change.

    • isOverflow

      public boolean isOverflow()
      This bit shall only be set if the MonitoredItem queue size is greater than 1.

      If this bit is set, not every detected change has been returned since the Server's queue for the MonitoredItem reached its limit and had to purge out data.

      Returns:
      true if the MonitoredItem queue overflowed at some point.

    • getReservedBits

      public int getReservedBits()

    • getHistorianBits

      public int getHistorianBits()
      These bits are set only when reading historical data. They indicate where the data value came from and provide information that affects how the Client uses the data value.
      Returns:
      the historian bits.

    • isHistoryRaw

      public boolean isHistoryRaw()
      A raw data value.
      Returns:
      true if the Raw bits are set.

    • isHistoryCalculated

      public boolean isHistoryCalculated()
      A data value which was calculated.
      Returns:
      true if the Calculated bits are set.

    • isHistoryInterpolated

      public boolean isHistoryInterpolated()
      A data value which was interpolated.
      Returns:
      true if the Interpolated bits are set.

    • isHistoryReserved

      public boolean isHistoryReserved()
      Undefined. This value is reserved for future use.

    • isHistoryPartial

      public boolean isHistoryPartial()
      A data value which was calculated with an incomplete interval.
      Returns:
      true if the Partial bit is set.

    • isHistoryExtraData

      public boolean isHistoryExtraData()
      A raw data value that hides other data at the same timestamp.
      Returns:
      true if the Extra Data bit is set.

    • isHistoryMultiValue

      public boolean isHistoryMultiValue()
      Multiple values match the Aggregate criteria (e.g. multiple minimum values at different timestamps within the same interval).
      Returns:
      true if the Multi Value bit is set.

    • toString

      public String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • bits

      public int bits()
      Returns the value of the bits record component.
      Specified by:
      bits in interface StatusCode.InfoBits
      Returns:
      the value of the bits record component