================
AspectLayerGroup
================

.. py:currentmodule:: p3dsdk

.. py:class:: AspectLayerGroup


   .. py:method:: id
      :property:

      The id of the aspect layer group.

      :type: str, read-only

   .. py:method:: name
      :property:

      The name of the aspect layer group.

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

   .. py:method:: visible
      :property:

      The aspect layer group visibility.

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

   .. py:method:: parent_group
      :property:

      The parent group of this group or :py:obj:`None` if the group is at the root of the hierarchy.

      :type: AspectLayerGroup or None
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.


   .. py:method:: list_aspect_layers(recursive = True)

      List the aspect layers of the group.

      :param recursive: If :py:obj:`True`, list all aspect layers in this group and child groups, otherwise only aspect layers of this group are returned.
      :type recursive: bool

      :returns: The list of aspect layers in the group.
      :rtype: list(AspectLayer)


   .. py:method:: list_child_groups(recursive = True)

      List the child aspect layer groups of this group.

      :param recursive: If :py:obj:`True`, list aspect layer groups of this group recursively, otherwise only the direct child groups are returned.
      :type recursive: bool

      :returns: The list of child groups.
      :rtype: list(AspectLayerGroup)


   .. py:method:: duplicate()

      Duplicate this aspect layer group.


      :returns: The duplicated aspect layer group.
      :rtype: AspectLayerGroup

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

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

      Delete a aspect layer 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 aspect layers and/or groups.
      :type force: bool


      :raises NotEmptyError: If ``force`` is :py:obj:`False` and the group contains aspect layers and/or groups.
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.