:py:mod:`rofunc.utils.robolab.formatter.mjcf_parser.debugging`
==============================================================

.. py:module:: rofunc.utils.robolab.formatter.mjcf_parser.debugging

.. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging
   :allowtitles:

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

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`DebugContext <rofunc.utils.robolab.formatter.mjcf_parser.debugging.DebugContext>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.DebugContext
          :summary:

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`debug_mode <rofunc.utils.robolab.formatter.mjcf_parser.debugging.debug_mode>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.debug_mode
          :summary:
   * - :py:obj:`enable_debug_mode <rofunc.utils.robolab.formatter.mjcf_parser.debugging.enable_debug_mode>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.enable_debug_mode
          :summary:
   * - :py:obj:`disable_debug_mode <rofunc.utils.robolab.formatter.mjcf_parser.debugging.disable_debug_mode>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.disable_debug_mode
          :summary:
   * - :py:obj:`get_full_dump_dir <rofunc.utils.robolab.formatter.mjcf_parser.debugging.get_full_dump_dir>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.get_full_dump_dir
          :summary:
   * - :py:obj:`set_full_dump_dir <rofunc.utils.robolab.formatter.mjcf_parser.debugging.set_full_dump_dir>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.set_full_dump_dir
          :summary:
   * - :py:obj:`get_current_stack_trace <rofunc.utils.robolab.formatter.mjcf_parser.debugging.get_current_stack_trace>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.get_current_stack_trace
          :summary:
   * - :py:obj:`freeze_current_stack_trace <rofunc.utils.robolab.formatter.mjcf_parser.debugging.freeze_current_stack_trace>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.freeze_current_stack_trace
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`FLAGS <rofunc.utils.robolab.formatter.mjcf_parser.debugging.FLAGS>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.FLAGS
          :summary:
   * - :py:obj:`StackTraceEntry <rofunc.utils.robolab.formatter.mjcf_parser.debugging.StackTraceEntry>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.StackTraceEntry
          :summary:
   * - :py:obj:`ElementDebugInfo <rofunc.utils.robolab.formatter.mjcf_parser.debugging.ElementDebugInfo>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.ElementDebugInfo
          :summary:
   * - :py:obj:`MODULE_PATH <rofunc.utils.robolab.formatter.mjcf_parser.debugging.MODULE_PATH>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.MODULE_PATH
          :summary:
   * - :py:obj:`DEBUG_METADATA_PREFIX <rofunc.utils.robolab.formatter.mjcf_parser.debugging.DEBUG_METADATA_PREFIX>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.DEBUG_METADATA_PREFIX
          :summary:

API
~~~

.. py:data:: FLAGS
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.debugging.FLAGS
   :value: None

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.FLAGS

.. py:data:: StackTraceEntry
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.debugging.StackTraceEntry
   :value: None

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.StackTraceEntry

.. py:data:: ElementDebugInfo
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.debugging.ElementDebugInfo
   :value: None

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.ElementDebugInfo

.. py:data:: MODULE_PATH
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.debugging.MODULE_PATH
   :value: None

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.MODULE_PATH

.. py:data:: DEBUG_METADATA_PREFIX
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.debugging.DEBUG_METADATA_PREFIX
   :value: 'pymjcfdebug'

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.DEBUG_METADATA_PREFIX

.. py:function:: debug_mode()
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.debugging.debug_mode

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.debug_mode

.. py:function:: enable_debug_mode()
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.debugging.enable_debug_mode

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.enable_debug_mode

.. py:function:: disable_debug_mode()
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.debugging.disable_debug_mode

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.disable_debug_mode

.. py:function:: get_full_dump_dir()
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.debugging.get_full_dump_dir

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.get_full_dump_dir

.. py:function:: set_full_dump_dir(dump_path)
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.debugging.set_full_dump_dir

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.set_full_dump_dir

.. py:function:: get_current_stack_trace()
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.debugging.get_current_stack_trace

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.get_current_stack_trace

.. py:function:: freeze_current_stack_trace()
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.debugging.freeze_current_stack_trace

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.freeze_current_stack_trace

.. py:class:: DebugContext()
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.debugging.DebugContext

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.DebugContext

   .. rubric:: Initialization

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.DebugContext.__init__

   .. py:method:: register_element_for_debugging(elem)
      :canonical: rofunc.utils.robolab.formatter.mjcf_parser.debugging.DebugContext.register_element_for_debugging

      .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.DebugContext.register_element_for_debugging

   .. py:method:: commit_xml_string(xml_string)
      :canonical: rofunc.utils.robolab.formatter.mjcf_parser.debugging.DebugContext.commit_xml_string

      .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.DebugContext.commit_xml_string

   .. py:method:: process_and_raise_last_exception()
      :canonical: rofunc.utils.robolab.formatter.mjcf_parser.debugging.DebugContext.process_and_raise_last_exception

      .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.DebugContext.process_and_raise_last_exception

   .. py:property:: default_dump_dir
      :canonical: rofunc.utils.robolab.formatter.mjcf_parser.debugging.DebugContext.default_dump_dir

      .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.DebugContext.default_dump_dir

   .. py:property:: debug_mode
      :canonical: rofunc.utils.robolab.formatter.mjcf_parser.debugging.DebugContext.debug_mode

      .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.DebugContext.debug_mode

   .. py:method:: dump_full_debug_info_to_disk(dump_dir=None)
      :canonical: rofunc.utils.robolab.formatter.mjcf_parser.debugging.DebugContext.dump_full_debug_info_to_disk

      .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.debugging.DebugContext.dump_full_debug_info_to_disk
