Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.platform.rev210118

Interface PlatformComponentPowerState

  • All Superinterfaces:
    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 PlatformComponentPowerState
extends org.opendaylight.yangtools.yang.binding.DataObject
    Power-related operational state for device components.

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

     grouping platform-component-power-state {
   leaf allocated-power {
     type uint32;
     units watts;
   }
   leaf used-power {
     type uint32;
     units watts;
   }
 }

    • 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.

    • 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 PlatformComponentPowerState> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • getAllocatedPower

        org.opendaylight.yangtools.yang.common.Uint32 getAllocatedPower()
        Return allocatedPower, or null if it is not present. 
             
         Power allocated by the system for the component.
        Returns:
        Uint32 allocatedPower, or null if it is not present.

      • requireAllocatedPower

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireAllocatedPower()
        Return allocatedPower, guaranteed to be non-null. 
             
         Power allocated by the system for the component.
        Returns:
        Uint32 allocatedPower, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if allocatedPower is not present

      • getUsedPower

        org.opendaylight.yangtools.yang.common.Uint32 getUsedPower()
        Return usedPower, or null if it is not present. 
             
         Actual power used by the component.
        Returns:
        Uint32 usedPower, or null if it is not present.

      • requireUsedPower

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireUsedPower()
        Return usedPower, guaranteed to be non-null. 
             
         Actual power used by the component.
        Returns:
        Uint32 usedPower, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if usedPower is not present