===========
SensorGroup
===========

.. py:currentmodule:: p3dsdk

.. py:class:: SensorGroup


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

      List the sensors of this group.


      :returns: The list of sensors in the group.
      :rtype: list(Sensor)


   .. py:method:: duplicate()

      Duplicate this sensor group.


      :returns: The duplicated group.
      :rtype: SensorGroup

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

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

      Delete a sensor 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 sensors.
      :type force: bool


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

   .. py:method:: create_sensor(name)

      Create a new sensor.

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

      :returns: The newly created sensor.
      :rtype: Sensor

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