.. title:: EnergyMeter

lisa.energy_meter.EnergyMeter
=============================


.. autoclass:: lisa.energy_meter::EnergyMeter
   :no-members:
   :no-inherited-members:
   :no-undoc-members:
   :no-private-members:
   :no-special-members:

   
   .. rubric:: Attributes
   
   .. list-table::
      :align: left
   
      * - :attr:`~lisa.conf.Configurable.CONF_CLASS` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.Configurable
         
         
            Configuration class associated with the current class.
      * - :attr:`~lisa.conf.Configurable.INIT_KWARGS_KEY_MAP` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.Configurable
         
         
            Dictionary of ``__init__`` parameter names to configuration key path.
   
   
   .. rubric:: Properties
   
   .. list-table::
      :align: left
   
      * - :attr:`~lisa.energy_meter.EnergyMeter.name`
        -
         
         .. withrefctx::
            :module: lisa.energy_meter
            :class: lisa.energy_meter.EnergyMeter
      * - :attr:`~lisa.utils.Loggable.logger` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Loggable
         
         
            Convenience short-hand for ``self.get_logger()``.
   
   
   .. rubric:: Methods
   
   .. list-table::
      :align: left
   
      * - :meth:`~lisa.energy_meter.EnergyMeter.from_conf`
        -
         
         .. withrefctx::
            :module: lisa.energy_meter
            :class: lisa.energy_meter.EnergyMeter
         
         
            Build an instance of :class:`EnergyMeter` from a configuration object.
      * - :meth:`~lisa.energy_meter.EnergyMeter.report`
        -
         
         .. withrefctx::
            :module: lisa.energy_meter
            :class: lisa.energy_meter.EnergyMeter
         
         
            Get total energy consumption since last :meth:`reset`.
      * - :meth:`~lisa.energy_meter.EnergyMeter.reset`
        -
         
         .. withrefctx::
            :module: lisa.energy_meter
            :class: lisa.energy_meter.EnergyMeter
         
         
            Reset the energy meter.
      * - :meth:`~lisa.energy_meter.EnergyMeter.sample`
        -
         
         .. withrefctx::
            :module: lisa.energy_meter
            :class: lisa.energy_meter.EnergyMeter
         
         
            Get a sample from the energy meter.
      * - :meth:`~lisa.conf.Configurable.check_init_param` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.Configurable
         
         
            Take the same parameters as ``__init__``, and check their types according to what is specified in the configuration class.
      * - :meth:`~lisa.conf.Configurable.conf_to_init_kwargs` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.Configurable
         
         
            Turn a configuration object into a dictionary suitable for passing to ``__init__`` as ``**kwargs``.
      * - :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.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
----------


.. autoattribute:: lisa.energy_meter::EnergyMeter.CONF_CLASS



.. autoattribute:: lisa.energy_meter::EnergyMeter.INIT_KWARGS_KEY_MAP



Properties
----------


.. autoproperty:: lisa.energy_meter::EnergyMeter.name



.. autoproperty:: lisa.energy_meter::EnergyMeter.logger



Methods
-------


.. automethod:: lisa.energy_meter::EnergyMeter.from_conf



.. automethod:: lisa.energy_meter::EnergyMeter.report



.. automethod:: lisa.energy_meter::EnergyMeter.reset



.. automethod:: lisa.energy_meter::EnergyMeter.sample



.. automethod:: lisa.energy_meter::EnergyMeter.check_init_param



.. automethod:: lisa.energy_meter::EnergyMeter.conf_to_init_kwargs



.. automethod:: lisa.energy_meter::EnergyMeter.get_logger



.. automethod:: lisa.energy_meter::EnergyMeter.log_locals