AbstractSequenceTask
====================

.. currentmodule:: hive.implementation.abstract_task

.. autoclass:: AbstractSequenceTask
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~AbstractSequenceTask.MODE_FOOD_CONSIST
      ~AbstractSequenceTask.MODE_FOOD_INCREASE
      ~AbstractSequenceTask.STATE_INIT
      ~AbstractSequenceTask.STATE_RUN
      ~AbstractSequenceTask.count
      ~AbstractSequenceTask.current_trial
      ~AbstractSequenceTask.door_forbidden_period
      ~AbstractSequenceTask.food_basic_mount
      ~AbstractSequenceTask.food_inc_mount
      ~AbstractSequenceTask.food_max_mount
      ~AbstractSequenceTask.keyboard_shortcut
      ~AbstractSequenceTask.max_trial
      ~AbstractSequenceTask.routine_battery_check
      ~AbstractSequenceTask.running
      ~AbstractSequenceTask.sequence
      ~AbstractSequenceTask.state
      ~AbstractSequenceTask.stay_duration
      ~AbstractSequenceTask.task_duration
      ~AbstractSequenceTask.task_start
      ~AbstractSequenceTask.task_start_time
      ~AbstractSequenceTask.task_stop_time
      ~AbstractSequenceTask.time_out
      ~AbstractSequenceTask.time_stay
      ~AbstractSequenceTask.use_door_devices
      ~AbstractSequenceTask.use_food_devices
      ~AbstractSequenceTask.visit_history
      ~AbstractSequenceTask.visit_notes
      ~AbstractSequenceTask.visit_timestamp

   .. rubric:: Methods Summary

   .. autosummary::

      ~AbstractSequenceTask.all_commands
      ~AbstractSequenceTask.all_modes
      ~AbstractSequenceTask.all_states
      ~AbstractSequenceTask.filter_event
      ~AbstractSequenceTask.get_command
      ~AbstractSequenceTask.get_mode
      ~AbstractSequenceTask.get_para
      ~AbstractSequenceTask.give_food
      ~AbstractSequenceTask.invoke_command
      ~AbstractSequenceTask.log_emit
      ~AbstractSequenceTask.logging_result_visit_arm
      ~AbstractSequenceTask.new_seq_control
      ~AbstractSequenceTask.process_command
      ~AbstractSequenceTask.process_detection
      ~AbstractSequenceTask.process_low_battery
      ~AbstractSequenceTask.reset
      ~AbstractSequenceTask.set_mode
      ~AbstractSequenceTask.set_para
      ~AbstractSequenceTask.set_visit_note
      ~AbstractSequenceTask.setup
      ~AbstractSequenceTask.show_task_summary
      ~AbstractSequenceTask.start_task
      ~AbstractSequenceTask.stop_task
      ~AbstractSequenceTask.visit_arm

   .. rubric:: Attributes Documentation

   .. autoattribute:: MODE_FOOD_CONSIST
   .. autoattribute:: MODE_FOOD_INCREASE
   .. autoattribute:: STATE_INIT
   .. autoattribute:: STATE_RUN
   .. autoattribute:: count
   .. autoattribute:: current_trial
   .. autoattribute:: door_forbidden_period
   .. autoattribute:: food_basic_mount
   .. autoattribute:: food_inc_mount
   .. autoattribute:: food_max_mount
   .. autoattribute:: keyboard_shortcut
   .. autoattribute:: max_trial
   .. autoattribute:: routine_battery_check
   .. autoattribute:: running
   .. autoattribute:: sequence
   .. autoattribute:: state
   .. autoattribute:: stay_duration
   .. autoattribute:: task_duration
   .. autoattribute:: task_start
   .. autoattribute:: task_start_time
   .. autoattribute:: task_stop_time
   .. autoattribute:: time_out
   .. autoattribute:: time_stay
   .. autoattribute:: use_door_devices
   .. autoattribute:: use_food_devices
   .. autoattribute:: visit_history
   .. autoattribute:: visit_notes
   .. autoattribute:: visit_timestamp

   .. rubric:: Methods Documentation

   .. automethod:: all_commands
   .. automethod:: all_modes
   .. automethod:: all_states
   .. automethod:: filter_event
   .. automethod:: get_command
   .. automethod:: get_mode
   .. automethod:: get_para
   .. automethod:: give_food
   .. automethod:: invoke_command
   .. automethod:: log_emit
   .. automethod:: logging_result_visit_arm
   .. automethod:: new_seq_control
   .. automethod:: process_command
   .. automethod:: process_detection
   .. automethod:: process_low_battery
   .. automethod:: reset
   .. automethod:: set_mode
   .. automethod:: set_para
   .. automethod:: set_visit_note
   .. automethod:: setup
   .. automethod:: show_task_summary
   .. automethod:: start_task
   .. automethod:: stop_task
   .. automethod:: visit_arm