============
OverlayGroup
============

.. py:currentmodule:: p3dsdk

.. py:class:: OverlayGroup


   .. py:method:: id
      :property:

      The id of the group.

      :type: str, read-only

   .. py:method:: name
      :property:

      The name of the group.

      :type: str
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.


   .. py:method:: list_overlays()

      List the overlays of this group.


      :returns: The list of overlays in the group.
      :rtype: list(Overlay)


   .. py:method:: duplicate()

      Duplicate this overlay group.


      :returns: The duplicated group.
      :rtype: OverlayGroup

      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: remove(force = False)

      Delete a overlay group

      .. note::
         By default, only empty groups can be deleted (:py:obj:`NotEmptyError` is raised otherwise), use ``force`` to force deletion of non empty groups.

      :param force: Force the deletion of the group even if it contains overlays.
      :type force: bool


      :raises NotEmptyError: If ``force`` is :py:obj:`False` and the group contains overlays.
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: create_overlay(name)

      Create a new overlay.

      :param name: The name of the new overlay.
      :type name: str

      :returns: The newly created overlay.
      :rtype: Overlay

      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.