Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.system.rev200413

Interface SystemNtpServerState

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
All Known Subinterfaces:
State
@Generated("mdsal-binding-generator") public interface SystemNtpServerState extends org.opendaylight.yangtools.yang.binding.DataObject
Operational state data for NTP servers

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

 grouping system-ntp-server-state {
   leaf stratum {
     type uint8;
   }
   leaf root-delay {
     type uint32;
     units milliseconds;
   }
   leaf root-dispersion {
     type uint64;
     units milliseconds;
   }
   leaf offset {
     type uint64;
     units milliseconds;
   }
   leaf poll-interval {
     type uint32;
     units seconds;
   }
 }

  • Field Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    org.opendaylight.yangtools.yang.common.Uint64
    getOffset()
    Return offset, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint32
    getPollInterval()
    Return pollInterval, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint32
    getRootDelay()
    Return rootDelay, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint64
    getRootDispersion()
    Return rootDispersion, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint8
    getStratum()
    Return stratum, or null if it is not present.
    Class<? extends SystemNtpServerState>
    implementedInterface()
     
    default @NonNull org.opendaylight.yangtools.yang.common.Uint64
    requireOffset()
    Return offset, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint32
    requirePollInterval()
    Return pollInterval, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint32
    requireRootDelay()
    Return rootDelay, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint64
    requireRootDispersion()
    Return rootDispersion, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint8
    requireStratum()
    Return stratum, guaranteed to be non-null.

  • Field Details

    • QNAME

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

  • Method Details

    • implementedInterface

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

    • getStratum

      org.opendaylight.yangtools.yang.common.Uint8 getStratum()
      Return stratum, or null if it is not present. 
           
         Indicates the level of the server in the NTP hierarchy. As stratum number
         increases, the accuracy is degraded. Primary servers are stratum while a maximum
         value of 16 indicates unsynchronized. The values have the following specific
         semantics: | 0 | unspecified or invalid | 1 | primary server (e.g., equipped
         with a GPS receiver) | 2-15 | secondary server (via NTP) | 16 | unsynchronized |
         17-255 | reserved
      Returns:
      Uint8 stratum, or null if it is not present.

    • requireStratum

      default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requireStratum()
      Return stratum, guaranteed to be non-null. 
           
         Indicates the level of the server in the NTP hierarchy. As stratum number
         increases, the accuracy is degraded. Primary servers are stratum while a maximum
         value of 16 indicates unsynchronized. The values have the following specific
         semantics: | 0 | unspecified or invalid | 1 | primary server (e.g., equipped
         with a GPS receiver) | 2-15 | secondary server (via NTP) | 16 | unsynchronized |
         17-255 | reserved
      Returns:
      Uint8 stratum, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if stratum is not present

    • getRootDelay

      org.opendaylight.yangtools.yang.common.Uint32 getRootDelay()
      Return rootDelay, or null if it is not present. 
           
         The round-trip delay to the server, in milliseconds.
      Returns:
      Uint32 rootDelay, or null if it is not present.

    • requireRootDelay

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireRootDelay()
      Return rootDelay, guaranteed to be non-null. 
           
         The round-trip delay to the server, in milliseconds.
      Returns:
      Uint32 rootDelay, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if rootDelay is not present

    • getRootDispersion

      org.opendaylight.yangtools.yang.common.Uint64 getRootDispersion()
      Return rootDispersion, or null if it is not present. 
           
         Dispersion (epsilon) represents the maximum error inherent in the measurement
      Returns:
      Uint64 rootDispersion, or null if it is not present.

    • requireRootDispersion

      default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireRootDispersion()
      Return rootDispersion, guaranteed to be non-null. 
           
         Dispersion (epsilon) represents the maximum error inherent in the measurement
      Returns:
      Uint64 rootDispersion, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if rootDispersion is not present

    • getOffset

      org.opendaylight.yangtools.yang.common.Uint64 getOffset()
      Return offset, or null if it is not present. 
           
         Estimate of the current time offset from the peer. This is the time difference
         between the local and reference clock.
      Returns:
      Uint64 offset, or null if it is not present.

    • requireOffset

      default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireOffset()
      Return offset, guaranteed to be non-null. 
           
         Estimate of the current time offset from the peer. This is the time difference
         between the local and reference clock.
      Returns:
      Uint64 offset, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if offset is not present

    • getPollInterval

      org.opendaylight.yangtools.yang.common.Uint32 getPollInterval()
      Return pollInterval, or null if it is not present. 
           
         Polling interval of the peer
      Returns:
      Uint32 pollInterval, or null if it is not present.

    • requirePollInterval

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requirePollInterval()
      Return pollInterval, guaranteed to be non-null. 
           
         Polling interval of the peer
      Returns:
      Uint32 pollInterval, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if pollInterval is not present