Interface AvgMinMaxStatsPrecision1

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

    @Generated("mdsal-binding-generator")
    public interface AvgMinMaxStatsPrecision1
    extends org.opendaylight.yangtools.yang.binding.DataObject
    Common nodes for recording average, minimum, and maximum values for a These values all have fraction-digits set to 1.

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

     grouping avg-min-max-stats-precision1 {
       leaf avg {
         type decimal64 {
           fraction-digits 1;
         }
       }
       leaf min {
         type decimal64 {
           fraction-digits 1;
         }
       }
       leaf max {
         type decimal64 {
           fraction-digits 1;
         }
       }
     }
     
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      org.opendaylight.yangtools.yang.common.Decimal64 getAvg()
      Return avg, or null if it is not present.
      org.opendaylight.yangtools.yang.common.Decimal64 getMax()
      Return max, or null if it is not present.
      org.opendaylight.yangtools.yang.common.Decimal64 getMin()
      Return min, or null if it is not present.
      Class<? extends AvgMinMaxStatsPrecision1> implementedInterface()  
      default @NonNull org.opendaylight.yangtools.yang.common.Decimal64 requireAvg()
      Return avg, guaranteed to be non-null.
      default @NonNull org.opendaylight.yangtools.yang.common.Decimal64 requireMax()
      Return max, guaranteed to be non-null.
      default @NonNull org.opendaylight.yangtools.yang.common.Decimal64 requireMin()
      Return min, guaranteed to be non-null.
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
        YANG identifier of the statement represented by this class.
    • Method Detail

      • implementedInterface

        Class<? extends AvgMinMaxStatsPrecision1> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      • getAvg

        org.opendaylight.yangtools.yang.common.Decimal64 getAvg()
        Return avg, or null if it is not present.
             
                 The arithmetic mean value of the statistic over the sampling period.
             
         
        Returns:
        Decimal64 avg, or null if it is not present.
      • requireAvg

        default @NonNull org.opendaylight.yangtools.yang.common.Decimal64 requireAvg()
        Return avg, guaranteed to be non-null.
             
                 The arithmetic mean value of the statistic over the sampling period.
             
         
        Returns:
        Decimal64 avg, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if avg is not present
      • getMin

        org.opendaylight.yangtools.yang.common.Decimal64 getMin()
        Return min, or null if it is not present.
             
                 The minimum value of the statistic over the sampling period
             
         
        Returns:
        Decimal64 min, or null if it is not present.
      • requireMin

        default @NonNull org.opendaylight.yangtools.yang.common.Decimal64 requireMin()
        Return min, guaranteed to be non-null.
             
                 The minimum value of the statistic over the sampling period
             
         
        Returns:
        Decimal64 min, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if min is not present
      • getMax

        org.opendaylight.yangtools.yang.common.Decimal64 getMax()
        Return max, or null if it is not present.
             
                 The maximum value of the statitic over the sampling period
             
         
        Returns:
        Decimal64 max, or null if it is not present.
      • requireMax

        default @NonNull org.opendaylight.yangtools.yang.common.Decimal64 requireMax()
        Return max, guaranteed to be non-null.
             
                 The maximum value of the statitic over the sampling period
             
         
        Returns:
        Decimal64 max, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if max is not present