robokudo.descriptors.analysis_engines.query_complex
===================================================

.. py:module:: robokudo.descriptors.analysis_engines.query_complex


Classes
-------

.. autoapisummary::

   robokudo.descriptors.analysis_engines.query_complex.AnalysisEngine


Module Contents
---------------

.. py:class:: AnalysisEngine

   Bases: :py:obj:`robokudo.analysis_engine.AnalysisEngineInterface`


   Protocol defining the interface for Analysis Engines.

   This interface must be implemented by all Analysis Engines in RoboKudo.
   Each Analysis Engine provides a behavior tree implementation for a specific
   task or pipeline. The RoboKudo runner will load and execute these
   implementations.

   .. warning::
       Do not instantiate this class directly. Instead, create a subclass
       that implements this interface.

   See :mod:`robokudo.descriptors.analysis_engines` for example implementations.


   .. py:method:: name()

      Get the name of this Analysis Engine.

      :return: The unique name identifying this Analysis Engine
      :rtype: str



   .. py:method:: implementation()

      Create a pipeline which responds to a query