Interface Cpu

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Cpu>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Cpus>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<CpuKey>

    @Generated("mdsal-binding-generator")
    public interface Cpu
    extends org.opendaylight.yangtools.yang.binding.ChildOf<Cpus>, org.opendaylight.yangtools.yang.binding.Augmentable<Cpu>, org.opendaylight.yangtools.yang.binding.Identifiable<CpuKey>
    List of CPU cores on the system (including logical CPUs on hyperthreaded systems), keyed by either a numerical index, or the ALL value for an entry representing the aggregation across all CPUs.

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

     list cpu {
       key index;
       leaf index {
         type leafref {
           path ../state/index;
         }
       }
       container state {
         uses system-cpu-state;
       }
     }
     
    The schema path to identify an instance is openconfig-systemsystem-cpu-topcpuscpu

    To create instances of this class use CpuBuilder.

    See Also:
    CpuBuilder, CpuKey
    • Field Detail

      • QNAME

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

      • implementedInterface

        default Class<Cpu> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      • bindingHashCode

        static int bindingHashCode​(@NonNull Cpu obj)
        Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
        Parameters:
        obj - Object for which to generate hashCode() result.
        Returns:
        Hash code value of data modeled by this interface.
        Throws:
        NullPointerException - if obj is null
      • bindingEquals

        static boolean bindingEquals​(@NonNull Cpu thisObj,
                                     Object obj)
        Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
        Parameters:
        thisObj - Object acting as the receiver of equals invocation
        obj - Object acting as argument to equals invocation
        Returns:
        True if thisObj and obj are considered equal
        Throws:
        NullPointerException - if thisObj is null
      • bindingToString

        static String bindingToString​(@NonNull Cpu obj)
        Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
        Parameters:
        obj - Object for which to generate toString() result.
        Returns:
        String value of data modeled by this interface.
        Throws:
        NullPointerException - if obj is null
      • key

        CpuKey key()
        Specified by:
        key in interface org.opendaylight.yangtools.yang.binding.Identifiable<CpuKey>
      • getIndex

        SystemCpuState.Index getIndex()
        Return index, or null if it is not present.
             
                 Reference to list key
             
         
        Returns:
        Index index, or null if it is not present.
      • requireIndex

        default @NonNull SystemCpuState.Index requireIndex()
        Return index, guaranteed to be non-null.
             
                 Reference to list key
             
         
        Returns:
        Index index, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if index is not present
      • getState

        State getState()
        Return state, or null if it is not present.
             
                 Operational state data for the system CPU(s)
             
         
        Returns:
        State state, or null if it is not present.