.. title:: EnergyModelRoot

lisa.energy_model.EnergyModelRoot
=================================


.. autoclass:: lisa.energy_model::EnergyModelRoot
   :no-members:
   :no-inherited-members:
   :no-undoc-members:
   :no-private-members:
   :no-special-members:

   
   .. rubric:: Attributes
   
   .. list-table::
      :align: left
   
      * - :attr:`~lisa.energy_model.EnergyModelNode.cpu` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.energy_model
            :class: lisa.energy_model._CpuTree
         
         
            For convenience, this holds the single CPU contained by leaf nodes. ``None`` for non-leaf nodes.
      * - :attr:`~lisa.energy_model.EnergyModelNode.cpus` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.energy_model
            :class: lisa.energy_model._CpuTree
         
         
            CPUs contained in this node. Includes those of child nodes.
   
   
   .. rubric:: Properties
   
   .. list-table::
      :align: left
   
      * - :attr:`~lisa.utils.Loggable.logger` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Loggable
         
         
            Convenience short-hand for ``self.get_logger()``.
      * - :attr:`~lisa.energy_model.EnergyModelNode.max_capacity` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.energy_model
            :class: lisa.energy_model.EnergyModelNode
         
         
            Compute capacity at highest frequency.
   
   
   .. rubric:: Methods
   
   .. list-table::
      :align: left
   
      * - :meth:`~lisa.utils.Loggable.get_logger` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Loggable
         
         
            Provides a :class:`logging.Logger` named after ``cls``.
      * - :meth:`~lisa.energy_model.EnergyModelNode.idle_state_by_idx` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.energy_model
            :class: lisa.energy_model.EnergyModelNode
         
         
            Return the idle state with index ``idx``.
      * - :meth:`~lisa.energy_model.EnergyModelNode.iter_leaves` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.energy_model
            :class: lisa.energy_model._CpuTree
         
         
            Iterate over leaves.
      * - :meth:`~lisa.energy_model.EnergyModelNode.iter_nodes` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.energy_model
            :class: lisa.energy_model._CpuTree
         
         
            Iterate over nodes depth-first, post-order.
      * - :meth:`~lisa.utils.Loggable.log_locals` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Loggable
         
         
            Debugging aid: log the local variables of the calling function.
   


Attributes
----------


.. attribute:: EnergyModelRoot.cpu
   :canonical: lisa.energy_model.EnergyModelRoot.cpu

   
   *Inherited attribute, see* :attr:`lisa.energy_model.EnergyModelNode.cpu`
   
   
   .. withrefctx::
      :module: lisa.energy_model
      :class: lisa.energy_model._CpuTree
   
   
      For convenience, this holds the single CPU contained by leaf nodes. ``None`` for non-leaf nodes.
   
   



.. attribute:: EnergyModelRoot.cpus
   :canonical: lisa.energy_model.EnergyModelRoot.cpus

   
   *Inherited attribute, see* :attr:`lisa.energy_model.EnergyModelNode.cpus`
   
   
   .. withrefctx::
      :module: lisa.energy_model
      :class: lisa.energy_model._CpuTree
   
   
      CPUs contained in this node. Includes those of child nodes.
   
   



Properties
----------


.. autoproperty:: lisa.energy_model::EnergyModelRoot.logger



.. autoproperty:: lisa.energy_model::EnergyModelRoot.max_capacity



Methods
-------


.. automethod:: lisa.energy_model::EnergyModelRoot.get_logger



.. automethod:: lisa.energy_model::EnergyModelRoot.idle_state_by_idx



.. automethod:: lisa.energy_model::EnergyModelRoot.iter_leaves



.. automethod:: lisa.energy_model::EnergyModelRoot.iter_nodes



.. automethod:: lisa.energy_model::EnergyModelRoot.log_locals