robokudo.pipeline
=================

.. py:module:: robokudo.pipeline


Classes
-------

.. autoapisummary::

   robokudo.pipeline.Pipeline


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

.. py:class:: Pipeline(name='Sequence', children=None, *args, **kwargs)

   Bases: :py:obj:`py_trees.composites.Sequence`


   A RoboKudo pipeline composed of annotators and their own cas


   .. py:attribute:: cas
      :value: None



   .. py:attribute:: cas_start_timer
      :value: None



   .. py:attribute:: rk_logger
      :value: None



   .. py:method:: create_new_cas()


   .. py:method:: setup(timeout)


   .. py:method:: get_cas()


   .. py:method:: get_annotators()


   .. py:method:: pipeline_children()

      Return a list with all children this pipeline contains.
      In contrast to the normal children method, this method will stop the traversal if it encounters a nested
      Pipeline object. The order is given by utils.tree.behavior_iterate_except_type.



   .. py:method:: update()


   .. py:method:: terminate(new_status)

      Called whenever behavior switches to !RUNNING state.
      new_status can be SUCCESS, FAILURE or INVALID