:py:mod:`rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics`
==========================================================================

.. py:module:: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics

.. autodoc2-docstring:: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`SelectiveReflection <rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.SelectiveReflection>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.SelectiveReflection
          :summary:
   * - :py:obj:`YamlReflection <rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.YamlReflection>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.YamlReflection
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`xml_string <rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.xml_string>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.xml_string
          :summary:
   * - :py:obj:`dict_sub <rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.dict_sub>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.dict_sub
          :summary:
   * - :py:obj:`node_add <rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.node_add>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.node_add
          :summary:
   * - :py:obj:`pfloat <rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.pfloat>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.pfloat
          :summary:
   * - :py:obj:`xml_children <rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.xml_children>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.xml_children
          :summary:
   * - :py:obj:`isstring <rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.isstring>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.isstring
          :summary:
   * - :py:obj:`to_yaml <rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.to_yaml>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.to_yaml
          :summary:

API
~~~

.. py:function:: xml_string(rootXml, addHeader=True)
   :canonical: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.xml_string

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.xml_string

.. py:function:: dict_sub(obj, keys)
   :canonical: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.dict_sub

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.dict_sub

.. py:function:: node_add(doc, sub)
   :canonical: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.node_add

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.node_add

.. py:function:: pfloat(x)
   :canonical: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.pfloat

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.pfloat

.. py:function:: xml_children(node)
   :canonical: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.xml_children

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.xml_children

.. py:function:: isstring(obj)
   :canonical: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.isstring

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.isstring

.. py:function:: to_yaml(obj)
   :canonical: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.to_yaml

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.to_yaml

.. py:class:: SelectiveReflection
   :canonical: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.SelectiveReflection

   Bases: :py:obj:`object`

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.SelectiveReflection

   .. py:method:: get_refl_vars()
      :canonical: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.SelectiveReflection.get_refl_vars

      .. autodoc2-docstring:: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.SelectiveReflection.get_refl_vars

.. py:class:: YamlReflection
   :canonical: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.YamlReflection

   Bases: :py:obj:`rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.SelectiveReflection`

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.YamlReflection

   .. py:method:: to_yaml()
      :canonical: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.YamlReflection.to_yaml

      .. autodoc2-docstring:: rofunc.utils.robolab.formatter.urdf_parser.xml_reflection.basics.YamlReflection.to_yaml
