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

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

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

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

Classes
~~~~~~~

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

   * - :py:obj:`String <rofunc.utils.robolab.formatter.mjcf_parser.attribute.String>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.String
          :summary:
   * - :py:obj:`Integer <rofunc.utils.robolab.formatter.mjcf_parser.attribute.Integer>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Integer
          :summary:
   * - :py:obj:`Float <rofunc.utils.robolab.formatter.mjcf_parser.attribute.Float>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Float
          :summary:
   * - :py:obj:`Keyword <rofunc.utils.robolab.formatter.mjcf_parser.attribute.Keyword>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Keyword
          :summary:
   * - :py:obj:`Array <rofunc.utils.robolab.formatter.mjcf_parser.attribute.Array>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Array
          :summary:
   * - :py:obj:`Identifier <rofunc.utils.robolab.formatter.mjcf_parser.attribute.Identifier>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Identifier
          :summary:
   * - :py:obj:`Reference <rofunc.utils.robolab.formatter.mjcf_parser.attribute.Reference>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Reference
          :summary:
   * - :py:obj:`BasePath <rofunc.utils.robolab.formatter.mjcf_parser.attribute.BasePath>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.BasePath
          :summary:
   * - :py:obj:`BaseAsset <rofunc.utils.robolab.formatter.mjcf_parser.attribute.BaseAsset>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.BaseAsset
          :summary:
   * - :py:obj:`Asset <rofunc.utils.robolab.formatter.mjcf_parser.attribute.Asset>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Asset
          :summary:
   * - :py:obj:`SkinAsset <rofunc.utils.robolab.formatter.mjcf_parser.attribute.SkinAsset>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.SkinAsset
          :summary:
   * - :py:obj:`File <rofunc.utils.robolab.formatter.mjcf_parser.attribute.File>`
     - .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.File
          :summary:

API
~~~

.. py:class:: String(name, required, parent, value, conflict_allowed, conflict_behavior)
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.attribute.String

   Bases: :py:obj:`rofunc.utils.robolab.formatter.mjcf_parser.attribute._Attribute`

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.String

   .. rubric:: Initialization

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.String.__init__

.. py:class:: Integer(name, required, parent, value, conflict_allowed, conflict_behavior)
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Integer

   Bases: :py:obj:`rofunc.utils.robolab.formatter.mjcf_parser.attribute._Attribute`

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Integer

   .. rubric:: Initialization

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Integer.__init__

.. py:class:: Float(name, required, parent, value, conflict_allowed, conflict_behavior)
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Float

   Bases: :py:obj:`rofunc.utils.robolab.formatter.mjcf_parser.attribute._Attribute`

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Float

   .. rubric:: Initialization

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Float.__init__

   .. py:method:: to_xml_string(prefix_root=None, *, precision=constants.XML_DEFAULT_PRECISION, zero_threshold=0, **kwargs)
      :canonical: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Float.to_xml_string

      .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Float.to_xml_string

.. py:class:: Keyword(name, required, parent, value, conflict_allowed, conflict_behavior, valid_values)
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Keyword

   Bases: :py:obj:`rofunc.utils.robolab.formatter.mjcf_parser.attribute._Attribute`

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Keyword

   .. rubric:: Initialization

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Keyword.__init__

   .. py:property:: valid_values
      :canonical: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Keyword.valid_values

      .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Keyword.valid_values

.. py:class:: Array(name, required, parent, value, conflict_allowed, conflict_behavior, length, dtype)
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Array

   Bases: :py:obj:`rofunc.utils.robolab.formatter.mjcf_parser.attribute._Attribute`

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Array

   .. rubric:: Initialization

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Array.__init__

   .. py:method:: to_xml_string(prefix_root=None, *, precision=constants.XML_DEFAULT_PRECISION, zero_threshold=0, **kwargs)
      :canonical: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Array.to_xml_string

      .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Array.to_xml_string

.. py:class:: Identifier(name, required, parent, value, conflict_allowed, conflict_behavior)
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Identifier

   Bases: :py:obj:`rofunc.utils.robolab.formatter.mjcf_parser.attribute._Attribute`

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Identifier

   .. rubric:: Initialization

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Identifier.__init__

   .. py:method:: to_xml_string(prefix_root=None, **kwargs)
      :canonical: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Identifier.to_xml_string

      .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Identifier.to_xml_string

.. py:class:: Reference(name, required, parent, value, conflict_allowed, conflict_behavior, reference_namespace)
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Reference

   Bases: :py:obj:`rofunc.utils.robolab.formatter.mjcf_parser.attribute._Attribute`

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Reference

   .. rubric:: Initialization

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Reference.__init__

   .. py:property:: value
      :canonical: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Reference.value

      .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Reference.value

   .. py:property:: reference_namespace
      :canonical: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Reference.reference_namespace

      .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Reference.reference_namespace

   .. py:method:: to_xml_string(prefix_root, **kwargs)
      :canonical: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Reference.to_xml_string

      .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Reference.to_xml_string

.. py:class:: BasePath(name, required, parent, value, conflict_allowed, conflict_behavior, path_namespace)
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.attribute.BasePath

   Bases: :py:obj:`rofunc.utils.robolab.formatter.mjcf_parser.attribute._Attribute`

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.BasePath

   .. rubric:: Initialization

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.BasePath.__init__

   .. py:method:: to_xml_string(prefix_root=None, **kwargs)
      :canonical: rofunc.utils.robolab.formatter.mjcf_parser.attribute.BasePath.to_xml_string

      .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.BasePath.to_xml_string

.. py:class:: BaseAsset(extension, prefix='')
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.attribute.BaseAsset

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.BaseAsset

   .. rubric:: Initialization

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.BaseAsset.__init__

   .. py:method:: get_vfs_filename()
      :canonical: rofunc.utils.robolab.formatter.mjcf_parser.attribute.BaseAsset.get_vfs_filename

      .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.BaseAsset.get_vfs_filename

.. py:class:: Asset(contents, extension, prefix='')
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Asset

   Bases: :py:obj:`rofunc.utils.robolab.formatter.mjcf_parser.attribute.BaseAsset`

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Asset

   .. rubric:: Initialization

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.Asset.__init__

.. py:class:: SkinAsset(contents, parent, extension, prefix='')
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.attribute.SkinAsset

   Bases: :py:obj:`rofunc.utils.robolab.formatter.mjcf_parser.attribute.BaseAsset`

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.SkinAsset

   .. rubric:: Initialization

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.SkinAsset.__init__

   .. py:property:: contents
      :canonical: rofunc.utils.robolab.formatter.mjcf_parser.attribute.SkinAsset.contents

      .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.SkinAsset.contents

.. py:class:: File(name, required, parent, value, conflict_allowed, conflict_behavior, path_namespace)
   :canonical: rofunc.utils.robolab.formatter.mjcf_parser.attribute.File

   Bases: :py:obj:`rofunc.utils.robolab.formatter.mjcf_parser.attribute._Attribute`

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.File

   .. rubric:: Initialization

   .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.File.__init__

   .. py:method:: get_contents()
      :canonical: rofunc.utils.robolab.formatter.mjcf_parser.attribute.File.get_contents

      .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.File.get_contents

   .. py:method:: to_xml_string(prefix_root=None, **kwargs)
      :canonical: rofunc.utils.robolab.formatter.mjcf_parser.attribute.File.to_xml_string

      .. autodoc2-docstring:: rofunc.utils.robolab.formatter.mjcf_parser.attribute.File.to_xml_string