robokudo.annotators.file_writer
===============================

.. py:module:: robokudo.annotators.file_writer


Classes
-------

.. autoapisummary::

   robokudo.annotators.file_writer.FileWriter


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

.. py:class:: FileWriter(name='FileWriter', descriptor=Descriptor())

   Bases: :py:obj:`robokudo.annotators.core.BaseAnnotator`


   This module provides methods to store sensor data into the local filesystem.
   This way you can work on recorded data without having to use bag files.
   It is intended to be used with robokudo.io.file_reader_interface


   .. py:class:: Descriptor

      Bases: :py:obj:`robokudo.annotators.core.BaseAnnotator.Descriptor`


      .. py:class:: Parameters

         .. py:attribute:: target_dir
            :value: '/tmp/'



         .. py:attribute:: filename_prefix
            :value: 'rk_'




      .. py:attribute:: parameters



   .. py:attribute:: initialized
      :value: False



   .. py:attribute:: target_dir_path


   .. py:method:: generate_full_file_path_(cas_view: str, file_extension: str)

      Generate the full filename and path where data should be stored.

      :param cas_view: One of the definitions from CASView.X
      :param file_extension: .jpg, .png, etc.
      :return: A string with the full path according to our naming scheme.



   .. py:method:: update()

      Called every time the behavior is ticked.