Prepare 2.1.0

InCore.Database/DatabaseExporter.rst

@@ -26,6 +26,7 @@ Properties
   * :ref:`errorString <property_DatabaseExporter_errorString>`
   * :ref:`output <property_DatabaseExporter_output>`
   * :ref:`query <property_DatabaseExporter_query>`
+  * :ref:`state <property_DatabaseExporter_state>`
   * :ref:`table <property_DatabaseExporter_table>`
   * :ref:`Object.objectId <property_Object_objectId>`
   * :ref:`Object.parent <property_Object_parent>`
@@ -46,6 +47,7 @@ Signals
 .. hlist::
   :columns: 1
 
+  * :ref:`done() <signal_DatabaseExporter_done>`
   * :ref:`errorOccurred() <signal_DatabaseExporter_errorOccurred>`
   * :ref:`Object.completed() <signal_Object_completed>`
 
@@ -57,6 +59,7 @@ Enumerations
 
   * :ref:`DataFormat <enum_DatabaseExporter_DataFormat>`
   * :ref:`Error <enum_DatabaseExporter_Error>`
+  * :ref:`ExportState <enum_DatabaseExporter_ExportState>`
 
 
 
@@ -150,6 +153,24 @@ This property holds the query which defines which data should be outputted. If l
 :**› Attributes**: Writable, Optional
 
 
+.. _property_DatabaseExporter_state:
+
+.. _signal_DatabaseExporter_stateChanged:
+
+.. index::
+   single: state
+
+state
++++++
+
+This property holds the current state of the exporter. The state will be :ref:`DatabaseExporter.Idle <enumitem_DatabaseExporter_Idle>` if it is ready to :ref:`execute() <method_DatabaseExporter_execute>` an export.
+
+:**› Type**: :ref:`ExportState <enum_DatabaseExporter_ExportState>`
+:**› Default**: :ref:`DatabaseExporter.Idle <enumitem_DatabaseExporter_Idle>`
+:**› Signal**: stateChanged()
+:**› Attributes**: Readonly
+
+
 .. _property_DatabaseExporter_table:
 
 .. _signal_DatabaseExporter_tableChanged:
@@ -178,7 +199,7 @@ Methods
 execute()
 +++++++++
 
-This method checks for errors and triggers the execution of the export.
+This method checks for errors and triggers the execution of the export. Signal :ref:`done() <signal_DatabaseExporter_done>` will be emitted after execution has finished.
 
 :**› Returns**: Boolean
 
@@ -187,6 +208,18 @@ Signals
 *******
 
 
+.. _signal_DatabaseExporter_done:
+
+.. index::
+   single: done
+
+done()
+++++++
+
+This signal is emitted after the export has been finished. Check the :ref:`error <property_DatabaseExporter_error>` property or connect to the :ref:`errorOccurred() <signal_DatabaseExporter_errorOccurred>` signal to detect errors occurred during the export.
+
+
+
 .. _signal_DatabaseExporter_errorOccurred:
 
 .. index::
@@ -253,6 +286,10 @@ This enumeration describes all errors which can occur in DatabaseExporter object
    single: DatabaseExporter.InvalidTableError
 .. index::
    single: DatabaseExporter.DataError
+.. index::
+   single: DatabaseExporter.OutputOpenError
+.. index::
+   single: DatabaseExporter.WriteError
 .. list-table::
   :widths: auto
   :header-rows: 1
@@ -281,6 +318,56 @@ This enumeration describes all errors which can occur in DatabaseExporter object
     - ``3``
     - Internal error while fetching data.
 
+      .. _enumitem_DatabaseExporter_OutputOpenError:
+  * - ``DatabaseExporter.OutputOpenError``
+    - ``4``
+    - Opening the output caused an error.
+
+      .. _enumitem_DatabaseExporter_WriteError:
+  * - ``DatabaseExporter.WriteError``
+    - ``5``
+    - Internal error while exporting data to file.
+
+
+.. _enum_DatabaseExporter_ExportState:
+
+.. index::
+   single: ExportState
+
+ExportState
++++++++++++
+
+This enumeration describes the current state of the exporter.
+
+.. index::
+   single: DatabaseExporter.Idle
+.. index::
+   single: DatabaseExporter.Preparing
+.. index::
+   single: DatabaseExporter.Exporting
+.. list-table::
+  :widths: auto
+  :header-rows: 1
+
+  * - Name
+    - Value
+    - Description
+
+      .. _enumitem_DatabaseExporter_Idle:
+  * - ``DatabaseExporter.Idle``
+    - ``0``
+    - 
+
+      .. _enumitem_DatabaseExporter_Preparing:
+  * - ``DatabaseExporter.Preparing``
+    - ``1``
+    - The exporter is perparing the output by performing the database query.
+
+      .. _enumitem_DatabaseExporter_Exporting:
+  * - ``DatabaseExporter.Exporting``
+    - ``2``
+    - The data is currently written to the output.
+
 
 .. _example_DatabaseExporter:
 

InCore.Foundation/Comparator.rst

@@ -158,7 +158,7 @@ This property holds the current state of the comparator.
 thresholdValueOff
 +++++++++++++++++
 
-This property holds the lower threshold. The value of the :ref:`input <property_Comparator_input>` property has to be less or equal to this value to switch :ref:`state <property_Comparator_state>` to ``false``. If not set the value of property :ref:`thresholdValueOn <property_Comparator_thresholdValueOn>` is used instead, i.e. no value hysteresis functionality is realized.
+This property holds the lower threshold. The value of the :ref:`input <property_Comparator_input>` property has to be less or equal to this value to switch :ref:`state <property_Comparator_state>` to ``false``. If set to ``undefined`` or left blank the value of property :ref:`thresholdValueOn <property_Comparator_thresholdValueOn>` is used instead, i.e. no value hysteresis functionality is realized.
 
 :**› Type**: Variant
 :**› Signal**: thresholdValueOffChanged()

InCore.Foundation/CsvWriter.rst

@@ -19,14 +19,15 @@ Properties
 ++++++++++
 
 .. hlist::
-  :columns: 2
+  :columns: 3
 
   * :ref:`delimiter <property_CsvWriter_delimiter>`
   * :ref:`error <property_CsvWriter_error>`
   * :ref:`errorString <property_CsvWriter_errorString>`
   * :ref:`output <property_CsvWriter_output>`
   * :ref:`outputMode <property_CsvWriter_outputMode>`
   * :ref:`rotationMode <property_CsvWriter_rotationMode>`
+  * :ref:`writeByteOrderMark <property_CsvWriter_writeByteOrderMark>`
   * :ref:`writeHeader <property_CsvWriter_writeHeader>`
   * :ref:`DataObjectWriter.datasetCount <property_DataObjectWriter_datasetCount>`
   * :ref:`DataObjectWriter.objects <property_DataObjectWriter_objects>`
@@ -182,6 +183,24 @@ This property holds the rotation mode which allows rotating files periodically i
 :**› Attributes**: Writable
 
 
+.. _property_CsvWriter_writeByteOrderMark:
+
+.. _signal_CsvWriter_writeByteOrderMarkChanged:
+
+.. index::
+   single: writeByteOrderMark
+
+writeByteOrderMark
+++++++++++++++++++
+
+This property holds whether to write the `Byte Order Mark (BOM) <https://en.wikipedia.org/wiki/Byte_order_mark>`_ ``EF BB BF`` as the first characters to the output. These BOM characters indicate that UTF-8 encoding should be used when reading the file.
+
+:**› Type**: Boolean
+:**› Default**: ``false``
+:**› Signal**: writeByteOrderMarkChanged()
+:**› Attributes**: Writable
+
+
 .. _property_CsvWriter_writeHeader:
 
 .. _signal_CsvWriter_writeHeaderChanged:

InCore.Foundation/DockerNetwork.rst

@@ -74,7 +74,7 @@ Properties
 internal
 ++++++++
 
-This property defines whether this network should be configured as an internal network used for connecting containers only. Internal networks can't be accessed by the outside world.
+This property holds whether this network should be configured as an internal network used for connecting containers only. Internal networks can't be accessed by the outside world.
 
 :**› Type**: Boolean
 :**› Default**: ``false``

InCore.Foundation/DockerVolume.rst

@@ -92,7 +92,7 @@ This property holds the destination path where the volume is mounted in the cont
 readOnly
 ++++++++
 
-This property defines whether this volume should be provided read-only for the container. Read-only volumes can be used to provide configuration files and other static data.
+This property holds whether this volume should be provided read-only for the container. Read-only volumes can be used to provide configuration files and other static data.
 
 :**› Type**: Boolean
 :**› Default**: ``false``