Prepare 2.1.0

InCore.CloudOfThings/CloudOfThingsTransport.rst

@@ -29,6 +29,7 @@ Properties
   * :ref:`errorString <property_CloudOfThingsTransport_errorString>`
   * :ref:`keepAlive <property_CloudOfThingsTransport_keepAlive>`
   * :ref:`protocol <property_CloudOfThingsTransport_protocol>`
+  * :ref:`requestCredentialsIntervalREST <property_CloudOfThingsTransport_requestCredentialsIntervalREST>`
   * :ref:`requestOperationsIntervalMQTT <property_CloudOfThingsTransport_requestOperationsIntervalMQTT>`
   * :ref:`sendBufferInterval <property_CloudOfThingsTransport_sendBufferInterval>`
   * :ref:`state <property_CloudOfThingsTransport_state>`
@@ -184,6 +185,24 @@ This property was introduced in InCore 2.0.
 :**› Attributes**: Writable
 
 
+.. _property_CloudOfThingsTransport_requestCredentialsIntervalREST:
+
+.. _signal_CloudOfThingsTransport_requestCredentialsIntervalRESTChanged:
+
+.. index::
+   single: requestCredentialsIntervalREST
+
+requestCredentialsIntervalREST
+++++++++++++++++++++++++++++++
+
+This property holds the interval which is used to request device credentials from Cloud of Things. This property is only necessary if the first registration should be delayed and does normally not have to be changed. This only has effect if protocol is ``REST``.
+
+:**› Type**: SignedInteger
+:**› Default**: ``1000``
+:**› Signal**: requestCredentialsIntervalRESTChanged()
+:**› Attributes**: Writable
+
+
 .. _property_CloudOfThingsTransport_requestOperationsIntervalMQTT:
 
 .. _signal_CloudOfThingsTransport_requestOperationsIntervalMQTTChanged:

InCore.Database/DatabaseExporter.rst

@@ -21,11 +21,15 @@ Properties
 .. hlist::
   :columns: 2
 
+  * :ref:`chunkSize <property_DatabaseExporter_chunkSize>`
   * :ref:`dataFormat <property_DatabaseExporter_dataFormat>`
   * :ref:`error <property_DatabaseExporter_error>`
   * :ref:`errorString <property_DatabaseExporter_errorString>`
   * :ref:`output <property_DatabaseExporter_output>`
+  * :ref:`progress <property_DatabaseExporter_progress>`
   * :ref:`query <property_DatabaseExporter_query>`
+  * :ref:`rowFilter <property_DatabaseExporter_rowFilter>`
+  * :ref:`running <property_DatabaseExporter_running>`
   * :ref:`table <property_DatabaseExporter_table>`
   * :ref:`Object.objectId <property_Object_objectId>`
   * :ref:`Object.parent <property_Object_parent>`
@@ -47,6 +51,7 @@ Signals
   :columns: 1
 
   * :ref:`errorOccurred() <signal_DatabaseExporter_errorOccurred>`
+  * :ref:`finished() <signal_DatabaseExporter_finished>`
   * :ref:`Object.completed() <signal_Object_completed>`
 
 Enumerations
@@ -64,6 +69,24 @@ Properties
 **********
 
 
+.. _property_DatabaseExporter_chunkSize:
+
+.. _signal_DatabaseExporter_chunkSizeChanged:
+
+.. index::
+   single: chunkSize
+
+chunkSize
++++++++++
+
+This property holds the number of datasets to export in each internal iteration. Reducing this value improves the responsiveness but decreases the performance. When a custom :ref:`query <property_DatabaseExporter_query>` is used, this value is not used and all datasets are exported at once.
+
+:**› Type**: SignedInteger
+:**› Default**: ``1000``
+:**› Signal**: chunkSizeChanged()
+:**› Attributes**: Writable
+
+
 .. _property_DatabaseExporter_dataFormat:
 
 .. _signal_DatabaseExporter_dataFormatChanged:
@@ -133,6 +156,24 @@ This property holds the :ref:`DataObjectWriter <object_DataObjectWriter>` to out
 :**› Attributes**: Writable
 
 
+.. _property_DatabaseExporter_progress:
+
+.. _signal_DatabaseExporter_progressChanged:
+
+.. index::
+   single: progress
+
+progress
+++++++++
+
+This property holds the overall progress of the current export operatoin
+
+:**› Type**: SignedInteger
+:**› Default**: ``0``
+:**› Signal**: progressChanged()
+:**› Attributes**: Readonly
+
+
 .. _property_DatabaseExporter_query:
 
 .. _signal_DatabaseExporter_queryChanged:
@@ -143,13 +184,48 @@ This property holds the :ref:`DataObjectWriter <object_DataObjectWriter>` to out
 query
 +++++
 
-This property holds the query which defines which data should be outputted. If left blank the whole :ref:`table <property_DatabaseExporter_table>` is used.
+This property holds the query which defines which data should be exported. If left blank the whole :ref:`table <property_DatabaseExporter_table>` is exported.
 
 :**› Type**: :ref:`DatabaseQuery <object_DatabaseQuery>`
 :**› Signal**: queryChanged()
 :**› Attributes**: Writable, Optional
 
 
+.. _property_DatabaseExporter_rowFilter:
+
+.. _signal_DatabaseExporter_rowFilterChanged:
+
+.. index::
+   single: rowFilter
+
+rowFilter
++++++++++
+
+This property holds an expression which is used to filter rows when :ref:`query <property_DatabaseExporter_query>` can't be used. The respective data row is provided in the ``item`` variable. Therefore an expression looks like ``item.myField > 123`` or ``item.userId !== undefined``.
+
+:**› Type**: <QML expression>
+:**› Signal**: rowFilterChanged()
+:**› Attributes**: Writable
+
+
+.. _property_DatabaseExporter_running:
+
+.. _signal_DatabaseExporter_runningChanged:
+
+.. index::
+   single: running
+
+running
++++++++
+
+This property holds whether an export operation is in progress.
+
+:**› Type**: Boolean
+:**› Default**: ``false``
+:**› Signal**: runningChanged()
+:**› Attributes**: Writable
+
+
 .. _property_DatabaseExporter_table:
 
 .. _signal_DatabaseExporter_tableChanged:
@@ -160,7 +236,7 @@ This property holds the query which defines which data should be outputted. If l
 table
 +++++
 
-This property holds the table which data should be outputted. If left blank the table of the :ref:`query <property_DatabaseExporter_query>` property is used. If :ref:`query <property_DatabaseExporter_query>` is left blank or you want to export the whole table you have to set this property properly.
+This property holds the table which data should be exported. If left blank the table of the :ref:`query <property_DatabaseExporter_query>` property is used. If :ref:`query <property_DatabaseExporter_query>` is left blank or you want to export the whole table you have to set this property properly.
 
 :**› Type**: :ref:`DatabaseTable <object_DatabaseTable>`
 :**› Signal**: tableChanged()
@@ -178,7 +254,7 @@ Methods
 execute()
 +++++++++
 
-This method checks for errors and triggers the execution of the export.
+This method checks for errors and starts an export operation. The :ref:`finished() <signal_DatabaseExporter_finished>` signal will be emitted after execution has finished.
 
 :**› Returns**: Boolean
 
@@ -198,6 +274,18 @@ errorOccurred()
 This signal is emitted whenever an error has occurred, regardless of whether the :ref:`error <property_DatabaseExporter_error>` property has changed or not. In contrast to the change notification signal of the :ref:`error <property_DatabaseExporter_error>` property this signal is also emitted several times if a certain error occurs several times in succession.
 
 
+
+.. _signal_DatabaseExporter_finished:
+
+.. index::
+   single: finished
+
+finished()
+++++++++++
+
+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.
+
+
 Enumerations
 ************
 
@@ -253,6 +341,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 +373,16 @@ 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.
+
 
 .. _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/DockerContainer.rst

@@ -37,6 +37,7 @@ Properties
   * :ref:`ports <property_DockerContainer_ports>`
   * :ref:`restartPolicy <property_DockerContainer_restartPolicy>`
   * :ref:`running <property_DockerContainer_running>`
+  * :ref:`seccompProfile <property_DockerContainer_seccompProfile>`
   * :ref:`volumes <property_DockerContainer_volumes>`
   * :ref:`Object.objectId <property_Object_objectId>`
   * :ref:`Object.parent <property_Object_parent>`
@@ -362,6 +363,23 @@ This property holds whether the container is currently running. This property is
 :**› Attributes**: Readonly
 
 
+.. _property_DockerContainer_seccompProfile:
+
+.. _signal_DockerContainer_seccompProfileChanged:
+
+.. index::
+   single: seccompProfile
+
+seccompProfile
+++++++++++++++
+
+This property holds the path to a custom seccomp profile file. This allows to customize the system calls which the container is allowed to use. See the `official Docker documentation on seccomp security profiles <https://docs.docker.com/engine/security/seccomp/>`_ for details.
+
+:**› Type**: String
+:**› Signal**: seccompProfileChanged()
+:**› Attributes**: Writable
+
+
 .. _property_DockerContainer_volumes:
 
 .. _signal_DockerContainer_volumesChanged:

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``