================
PostprocessGroup
================

.. py:currentmodule:: p3dsdk

.. py:class:: PostprocessGroup


   .. 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_postprocesses()

      List the postprocesses of this group.


      :returns: The list of postprocesses in the group.
      :rtype: list(Postprocess)


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

      Delete a postprocess group

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

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


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

   .. py:method:: create_postprocess(name)

      Create a new postprocess.

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

      :returns: The newly created postprocess.
      :rtype: Postprocess

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

   .. py:method:: import_kfx(filename)

      Import postprocess from a KFX file.

      :param filename: KFX filename.
      :type filename: str

      :returns: The imported postprocess.
      :rtype: Postprocess

      :raises FileNotFoundError: If :py:obj:`filename` can't be opened.
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.