.. title:: CollectorBase

lisa.trace.CollectorBase
========================


.. autoclass:: lisa.trace::CollectorBase
   :no-members:
   :no-inherited-members:
   :no-undoc-members:
   :no-private-members:
   :no-special-members:

   
   .. rubric:: Attributes
   
   .. list-table::
      :align: left
   
      * - :attr:`~lisa.trace.CollectorBase.NAME`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.CollectorBase
         
         
            Name of the collector class.
      * - :attr:`~lisa.trace.CollectorBase.TOOLS`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.CollectorBase
         
         
            Sequence of tools to install on the target when using the collector.
   
   
   .. 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()``.
   
   
   .. rubric:: Methods
   
   .. list-table::
      :align: left
   
      * - :meth:`~lisa.trace.CollectorBase.__enter__`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.CollectorBase
      * - :meth:`~lisa.trace.CollectorBase.__exit__`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.CollectorBase
      * - :attr:`~lisa.trace.CollectorBase.__getattr__`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.DelegateToAttr.<locals>._DelegatedToAttr
         
         
            Delegate attribute lookup to a private attribute.
      * - :meth:`~lisa.trace.CollectorBase.get_data`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.CollectorBase
         
         
            Similar to :meth:`devlib.collector.CollectorBase.get_data` but takes the path directly as a parameter in order to disallow representing an invalid state where no path has been set.
      * - :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.trace::CollectorBase.NAME



.. autoattribute:: lisa.trace::CollectorBase.TOOLS



Properties
----------


.. autoproperty:: lisa.trace::CollectorBase.logger



Methods
-------


.. automethod:: lisa.trace::CollectorBase.__enter__



.. automethod:: lisa.trace::CollectorBase.__exit__



.. automethod:: lisa.trace::CollectorBase.__getattr__



.. automethod:: lisa.trace::CollectorBase.get_data



.. automethod:: lisa.trace::CollectorBase.get_logger



.. automethod:: lisa.trace::CollectorBase.log_locals



.. automethod:: lisa.trace::CollectorBase.get_trace