Interface AvgMinMaxInstantStatsPrecision2DBm

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, MinMaxTime, StatIntervalState

    @Generated("mdsal-binding-generator")
    public interface AvgMinMaxInstantStatsPrecision2DBm
    extends org.opendaylight.yangtools.yang.binding.DataObject, StatIntervalState, MinMaxTime
    Common grouping for recording dBm values with 2 decimal precision. Values include the instantaneous, average, minimum, and maximum statistics. Statistics are computed and reported based on a moving time interval (e.g., the last 30s). If supported by the device, the time interval over which the statistics are computed, and the times at which the minimum and maximum values occurred, are also reported.

    This class represents the following YANG schema fragment defined in module openconfig-types

     grouping avg-min-max-instant-stats-precision2-dBm {
       leaf instant {
         type decimal64 {
           fraction-digits 2;
         }
         units dBm;
       }
       leaf avg {
         type decimal64 {
           fraction-digits 2;
         }
         units dBm;
       }
       leaf min {
         type decimal64 {
           fraction-digits 2;
         }
         units dBm;
       }
       leaf max {
         type decimal64 {
           fraction-digits 2;
         }
         units dBm;
       }
       uses stat-interval-state;
       uses min-max-time;
     }
     
    The schema path to identify an instance is openconfig-typesavg-min-max-instant-stats-precision2-dBm
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
    • Method Detail

      • getInstant

        BigDecimal getInstant()
        Return instant, or null if it is not present.
             
                 The instantaneous value of the statistic.
             
         
        Returns:
        BigDecimal instant, or null if it is not present.
      • requireInstant

        default @NonNull BigDecimal requireInstant()
        Return instant, guaranteed to be non-null.
             
                 The instantaneous value of the statistic.
             
         
        Returns:
        BigDecimal instant, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if instant is not present
      • getAvg

        BigDecimal getAvg()
        Return avg, or null if it is not present.
             
                 The arithmetic mean value of the statistic over the time interval.
             
         
        Returns:
        BigDecimal avg, or null if it is not present.
      • requireAvg

        default @NonNull BigDecimal requireAvg()
        Return avg, guaranteed to be non-null.
             
                 The arithmetic mean value of the statistic over the time interval.
             
         
        Returns:
        BigDecimal avg, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if avg is not present
      • getMin

        BigDecimal getMin()
        Return min, or null if it is not present.
             
                 The minimum value of the statistic over the time interval.
             
         
        Returns:
        BigDecimal min, or null if it is not present.
      • requireMin

        default @NonNull BigDecimal requireMin()
        Return min, guaranteed to be non-null.
             
                 The minimum value of the statistic over the time interval.
             
         
        Returns:
        BigDecimal min, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if min is not present
      • getMax

        BigDecimal getMax()
        Return max, or null if it is not present.
             
                 The maximum value of the statistic over the time interval.
             
         
        Returns:
        BigDecimal max, or null if it is not present.
      • requireMax

        default @NonNull BigDecimal requireMax()
        Return max, guaranteed to be non-null.
             
                 The maximum value of the statistic over the time interval.
             
         
        Returns:
        BigDecimal max, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if max is not present