.. oe:namespace:: OESystem



.. _OESystem_OETracerBase:

.. oe:class:: OETracerBase

   .. oe:api::

      class OETracerBase

   :ref:`OETracerBase <OESystem_OETracerBase>` is an abstract class which defines the
   interface necessary for setting up and using a tracer to report progress of
   task(s).

   The following class derives from this class:

    * :ref:`OEConsoleProgressTracer <OESystem_OEConsoleProgressTracer>`

   .. oe:method:: Aborted

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Aborted()=0

      .. oe:language:: python

         .. oe:api:: python

            Aborted() -> bool

   .. oe:method:: Pop

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Pop()=0

      .. oe:language:: python

         .. oe:api:: python

            Pop() -> None

   .. oe:method:: Push

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Push(std::string task)=0

      .. oe:language:: python

         .. oe:api:: python

            Push(task: str) -> None

   .. oe:method:: Refresh

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Refresh()=0

      .. oe:language:: python

         .. oe:api:: python

            Refresh() -> None

   .. oe:method:: SetProgress

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetProgress(double percent)=0
            void SetProgress(unsigned int current, unsigned int total)=0

      .. oe:language:: python

         .. oe:api:: python

            SetProgress(percent: float) -> None
            SetProgress(current: int, total: int) -> None

      This pure virtual method should report the current progress of the task
      when it has reached the percentage of completion specified
      by ``percent`` or by ``current`` / ``total``.

   .. oe:method:: SetTask

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTask(std::string task)=0

      .. oe:language:: python

         .. oe:api:: python

            SetTask(task: str) -> None

      This pure virtual method should register the tracer with a task name specified by,
      ``task``. It should start the timer to trace the progress of the task.
