Update to 2.4.0

in-hub · Aug 3, 2021 · 8624693 · 8624693
1 parent 5652075
commit 8624693
Show file tree

Hide file tree

Showing 198 changed files with 96,865 additions and 287 deletions.
diff --git a/InCore.CloudOfThings/CloudOfThingsClient.rst b/InCore.CloudOfThings/CloudOfThingsClient.rst
@@ -41,6 +41,7 @@ Methods
 .. hlist::
   :columns: 1
 
+  * :ref:`Object.deserializeProperties() <method_Object_deserializeProperties>`
   * :ref:`Object.fromJson() <method_Object_fromJson>`
   * :ref:`Object.toJson() <method_Object_toJson>`
 

diff --git a/InCore.CloudOfThings/CloudOfThingsDeviceManager.rst b/InCore.CloudOfThings/CloudOfThingsDeviceManager.rst
@@ -34,6 +34,7 @@ Methods
 .. hlist::
   :columns: 1
 
+  * :ref:`Object.deserializeProperties() <method_Object_deserializeProperties>`
   * :ref:`Object.fromJson() <method_Object_fromJson>`
   * :ref:`Object.toJson() <method_Object_toJson>`
 

diff --git a/InCore.CloudOfThings/CloudOfThingsDeviceRegistrator.rst b/InCore.CloudOfThings/CloudOfThingsDeviceRegistrator.rst
@@ -35,6 +35,7 @@ Methods
 .. hlist::
   :columns: 1
 
+  * :ref:`Object.deserializeProperties() <method_Object_deserializeProperties>`
   * :ref:`Object.fromJson() <method_Object_fromJson>`
   * :ref:`Object.toJson() <method_Object_toJson>`
 

diff --git a/InCore.CloudOfThings/CloudOfThingsEventDatabase.rst b/InCore.CloudOfThings/CloudOfThingsEventDatabase.rst
@@ -36,6 +36,7 @@ Methods
 
   * :ref:`clear() <method_CloudOfThingsEventDatabase_clear>`
   * :ref:`datasetCount() <method_CloudOfThingsEventDatabase_datasetCount>`
+  * :ref:`Object.deserializeProperties() <method_Object_deserializeProperties>`
   * :ref:`Object.fromJson() <method_Object_fromJson>`
   * :ref:`Object.toJson() <method_Object_toJson>`
 

diff --git a/InCore.CloudOfThings/CloudOfThingsEventWriter.rst b/InCore.CloudOfThings/CloudOfThingsEventWriter.rst
@@ -41,6 +41,7 @@ Methods
 .. hlist::
   :columns: 1
 
+  * :ref:`Object.deserializeProperties() <method_Object_deserializeProperties>`
   * :ref:`Object.fromJson() <method_Object_fromJson>`
   * :ref:`Object.toJson() <method_Object_toJson>`
 

diff --git a/InCore.CloudOfThings/CloudOfThingsMeasurementDatabase.rst b/InCore.CloudOfThings/CloudOfThingsMeasurementDatabase.rst
@@ -37,6 +37,7 @@ Methods
 
   * :ref:`clear() <method_CloudOfThingsMeasurementDatabase_clear>`
   * :ref:`datasetCount() <method_CloudOfThingsMeasurementDatabase_datasetCount>`
+  * :ref:`Object.deserializeProperties() <method_Object_deserializeProperties>`
   * :ref:`Object.fromJson() <method_Object_fromJson>`
   * :ref:`Object.toJson() <method_Object_toJson>`
 

diff --git a/InCore.CloudOfThings/CloudOfThingsMeasurementWriter.rst b/InCore.CloudOfThings/CloudOfThingsMeasurementWriter.rst
@@ -40,13 +40,14 @@ Methods
 +++++++
 
 .. hlist::
-  :columns: 1
+  :columns: 2
 
   * :ref:`DataObjectWriter.close() <method_DataObjectWriter_close>`
   * :ref:`DataObjectWriter.open() <method_DataObjectWriter_open>`
   * :ref:`DataObjectWriter.submit() <method_DataObjectWriter_submit>`
   * :ref:`DataObjectWriter.sync() <method_DataObjectWriter_sync>`
   * :ref:`DataObjectWriter.truncate() <method_DataObjectWriter_truncate>`
+  * :ref:`Object.deserializeProperties() <method_Object_deserializeProperties>`
   * :ref:`Object.fromJson() <method_Object_fromJson>`
   * :ref:`Object.toJson() <method_Object_toJson>`
 

diff --git a/InCore.CloudOfThings/CloudOfThingsRemoteConnectionManager.rst b/InCore.CloudOfThings/CloudOfThingsRemoteConnectionManager.rst
@@ -34,6 +34,7 @@ Methods
 .. hlist::
   :columns: 1
 
+  * :ref:`Object.deserializeProperties() <method_Object_deserializeProperties>`
   * :ref:`Object.fromJson() <method_Object_fromJson>`
   * :ref:`Object.toJson() <method_Object_toJson>`
 

diff --git a/InCore.CloudOfThings/CloudOfThingsTransport.rst b/InCore.CloudOfThings/CloudOfThingsTransport.rst
@@ -46,6 +46,7 @@ Methods
   * :ref:`connectToHost() <method_CloudOfThingsTransport_connectToHost>`
   * :ref:`disconnectFromHost() <method_CloudOfThingsTransport_disconnectFromHost>`
   * :ref:`requestPing() <method_CloudOfThingsTransport_requestPing>`
+  * :ref:`Object.deserializeProperties() <method_Object_deserializeProperties>`
   * :ref:`Object.fromJson() <method_Object_fromJson>`
   * :ref:`Object.toJson() <method_Object_toJson>`
 
@@ -59,6 +60,7 @@ Signals
   * :ref:`disconnected() <signal_CloudOfThingsTransport_disconnected>`
   * :ref:`errorOccurred() <signal_CloudOfThingsTransport_errorOccurred>`
   * :ref:`pingResponseReceived() <signal_CloudOfThingsTransport_pingResponseReceived>`
+  * :ref:`sslErrorOccurred() <signal_CloudOfThingsTransport_sslErrorOccurred>`
   * :ref:`Object.completed() <signal_Object_completed>`
 
 Enumerations
@@ -379,6 +381,20 @@ This signal is emitted after :ref:`requestPing() <method_CloudOfThingsTransport_
 This signal was introduced in InCore 2.0.
 
 
+
+.. _signal_CloudOfThingsTransport_sslErrorOccurred:
+
+.. index::
+   single: sslErrorOccurred
+
+sslErrorOccurred(String errorString)
+++++++++++++++++++++++++++++++++++++
+
+This signal is emitted when an TLS/SSL-related error has occurred.
+
+This signal was introduced in InCore 2.4.
+
+
 Enumerations
 ************
 
@@ -399,6 +415,8 @@ This enumeration describes all errors which can occur in CloudOfThingsTransport
    single: CloudOfThingsTransport.MissingTenant
 .. index::
    single: CloudOfThingsTransport.TransportError
+.. index::
+   single: CloudOfThingsTransport.SslError
 .. list-table::
   :widths: auto
   :header-rows: 1
@@ -422,6 +440,11 @@ This enumeration describes all errors which can occur in CloudOfThingsTransport
     - ``2``
     - The underlaying transport had an error: .
 
+      .. _enumitem_CloudOfThingsTransport_SslError:
+  * - ``CloudOfThingsTransport.SslError``
+    - ``3``
+    - Error while establishing TLS/SSL connection.
+
 
 .. _enum_CloudOfThingsTransport_Protocol:
 

diff --git a/InCore.Database/Database.rst b/InCore.Database/Database.rst
@@ -44,6 +44,7 @@ Methods
   * :ref:`close() <method_Database_close>`
   * :ref:`dropAllTables() <method_Database_dropAllTables>`
   * :ref:`open() <method_Database_open>`
+  * :ref:`Object.deserializeProperties() <method_Object_deserializeProperties>`
   * :ref:`Object.fromJson() <method_Object_fromJson>`
   * :ref:`Object.toJson() <method_Object_toJson>`
 
@@ -344,8 +345,6 @@ This enumeration describes all errors which can occur in Database objects. The m
 
 .. index::
    single: Database.NoError
-.. index::
-   single: Database.InvalidIdError
 .. index::
    single: Database.InvalidStorageError
 .. index::
@@ -359,7 +358,7 @@ This enumeration describes all errors which can occur in Database objects. The m
 .. index::
    single: Database.InvalidCredentials
 .. index::
-   single: Database.InvalidDatabase
+   single: Database.InvalidNameError
 .. index::
    single: Database.ConnectionError
 .. list-table::
@@ -375,47 +374,42 @@ This enumeration describes all errors which can occur in Database objects. The m
     - ``0``
     - No error occurred or was detected.
 
-      .. _enumitem_Database_InvalidIdError:
-  * - ``Database.InvalidIdError``
-    - ``1``
-    - Empty or invalid database id (only ASCII letters and numbers allowed).
-
       .. _enumitem_Database_InvalidStorageError:
   * - ``Database.InvalidStorageError``
-    - ``2``
+    - ``1``
     - None or invalid storage set.
 
       .. _enumitem_Database_StoragePathError:
   * - ``Database.StoragePathError``
-    - ``3``
+    - ``2``
     - Error while creating directories on storage.
 
       .. _enumitem_Database_OpenError:
   * - ``Database.OpenError``
-    - ``4``
+    - ``3``
     - Can't open database.
 
       .. _enumitem_Database_InitializationError:
   * - ``Database.InitializationError``
-    - ``5``
+    - ``4``
     - Error while performing database initialization tasks.
 
       .. _enumitem_Database_CreateTablesError:
   * - ``Database.CreateTablesError``
-    - ``6``
+    - ``5``
     - Failed to create tables in database.
 
       .. _enumitem_Database_InvalidCredentials:
   * - ``Database.InvalidCredentials``
-    - ``7``
+    - ``6``
     - Some credentials are missing or invalid, e.g. no password set.
 
-      .. _enumitem_Database_InvalidDatabase:
-  * - ``Database.InvalidDatabase``
-    - ``8``
-    - None or invalid database specified.
+      .. _enumitem_Database_InvalidNameError:
+  * - ``Database.InvalidNameError``
+    - ``7``
+    - None or invalid database name specified.
 
       .. _enumitem_Database_ConnectionError:
   * - ``Database.ConnectionError``
-    - ``9``
+    - ``8``
     - Connection lost.
diff --git a/InCore.Database/DatabaseEventTable.rst b/InCore.Database/DatabaseEventTable.rst
@@ -58,6 +58,7 @@ Methods
   * :ref:`DataObjectWriter.submit() <method_DataObjectWriter_submit>`
   * :ref:`DataObjectWriter.sync() <method_DataObjectWriter_sync>`
   * :ref:`DataObjectWriter.truncate() <method_DataObjectWriter_truncate>`
+  * :ref:`Object.deserializeProperties() <method_Object_deserializeProperties>`
   * :ref:`Object.fromJson() <method_Object_fromJson>`
   * :ref:`Object.toJson() <method_Object_toJson>`
 

diff --git a/InCore.Database/DatabaseEventWriter.rst b/InCore.Database/DatabaseEventWriter.rst
@@ -37,6 +37,7 @@ Methods
 .. hlist::
   :columns: 1
 
+  * :ref:`Object.deserializeProperties() <method_Object_deserializeProperties>`
   * :ref:`Object.fromJson() <method_Object_fromJson>`
   * :ref:`Object.toJson() <method_Object_toJson>`
 

diff --git a/InCore.Database/DatabaseExporter.rst b/InCore.Database/DatabaseExporter.rst
@@ -41,6 +41,7 @@ Methods
   :columns: 1
 
   * :ref:`execute() <method_DatabaseExporter_execute>`
+  * :ref:`Object.deserializeProperties() <method_Object_deserializeProperties>`
   * :ref:`Object.fromJson() <method_Object_fromJson>`
   * :ref:`Object.toJson() <method_Object_toJson>`
 

diff --git a/InCore.Database/DatabaseFieldOptions.rst b/InCore.Database/DatabaseFieldOptions.rst
@@ -41,6 +41,7 @@ Methods
 .. hlist::
   :columns: 1
 
+  * :ref:`Object.deserializeProperties() <method_Object_deserializeProperties>`
   * :ref:`Object.fromJson() <method_Object_fromJson>`
   * :ref:`Object.toJson() <method_Object_toJson>`
 

diff --git a/InCore.Database/DatabaseQuery.rst b/InCore.Database/DatabaseQuery.rst
@@ -30,6 +30,7 @@ Properties
   * :ref:`limitPos <property_DatabaseQuery_limitPos>`
   * :ref:`objects <property_DatabaseQuery_objects>`
   * :ref:`orderBy <property_DatabaseQuery_orderBy>`
+  * :ref:`orderByNames <property_DatabaseQuery_orderByNames>`
   * :ref:`results <property_DatabaseQuery_results>`
   * :ref:`table <property_DatabaseQuery_table>`
   * :ref:`Object.objectId <property_Object_objectId>`
@@ -43,6 +44,7 @@ Methods
 
   * :ref:`execute() <method_DatabaseQuery_execute>`
   * :ref:`pollResults() <method_DatabaseQuery_pollResults>`
+  * :ref:`Object.deserializeProperties() <method_Object_deserializeProperties>`
   * :ref:`Object.fromJson() <method_Object_fromJson>`
   * :ref:`Object.toJson() <method_Object_toJson>`
 
@@ -186,13 +188,32 @@ This property holds the list of objects which column should be queried. The orde
 orderBy
 +++++++
 
-This property holds a list of columns to use for ordering (sorting) the rows. Currently only ``ascending`` ordering is done.
+This property holds a list of columns to use for ordering (sorting) the rows. Only ``ascending`` ordering is done. See also :ref:`orderByNames <property_DatabaseQuery_orderByNames>`.
 
 :**› Type**: :ref:`List <object_List>`\<:ref:`DataObject <object_DataObject>`>
 :**› Signal**: orderByChanged()
 :**› Attributes**: Readonly
 
 
+.. _property_DatabaseQuery_orderByNames:
+
+.. _signal_DatabaseQuery_orderByNamesChanged:
+
+.. index::
+   single: orderByNames
+
+orderByNames
+++++++++++++
+
+This property holds a string list of column ids to use for ordering (sorting) the rows. This will have no effect if :ref:`orderBy <property_DatabaseQuery_orderBy>` is set. The negative sign in front of an id indicates ``descending`` order. See also the example at the bottom.
+
+This property was introduced in InCore 2.4.
+
+:**› Type**: StringList
+:**› Signal**: orderByNamesChanged()
+:**› Attributes**: Writable
+
+
 .. _property_DatabaseQuery_results:
 
 .. _signal_DatabaseQuery_resultsChanged:

diff --git a/InCore.Database/DatabaseQueryFilter.rst b/InCore.Database/DatabaseQueryFilter.rst
@@ -31,6 +31,7 @@ Methods
 .. hlist::
   :columns: 1
 
+  * :ref:`Object.deserializeProperties() <method_Object_deserializeProperties>`
   * :ref:`Object.fromJson() <method_Object_fromJson>`
   * :ref:`Object.toJson() <method_Object_toJson>`
 

diff --git a/InCore.Database/DatabaseQueryWhere.rst b/InCore.Database/DatabaseQueryWhere.rst
@@ -33,6 +33,7 @@ Methods
 .. hlist::
   :columns: 1
 
+  * :ref:`Object.deserializeProperties() <method_Object_deserializeProperties>`
   * :ref:`Object.fromJson() <method_Object_fromJson>`
   * :ref:`Object.toJson() <method_Object_toJson>`
 

diff --git a/InCore.Database/DatabaseSqlQuery.rst b/InCore.Database/DatabaseSqlQuery.rst
@@ -38,6 +38,7 @@ Methods
 
   * :ref:`execute() <method_DatabaseSqlQuery_execute>`
   * :ref:`pollResults() <method_DatabaseSqlQuery_pollResults>`
+  * :ref:`Object.deserializeProperties() <method_Object_deserializeProperties>`
   * :ref:`Object.fromJson() <method_Object_fromJson>`
   * :ref:`Object.toJson() <method_Object_toJson>`
 

diff --git a/InCore.Database/DatabaseTable.rst b/InCore.Database/DatabaseTable.rst
@@ -51,6 +51,7 @@ Methods
   * :ref:`DataObjectWriter.submit() <method_DataObjectWriter_submit>`
   * :ref:`DataObjectWriter.sync() <method_DataObjectWriter_sync>`
   * :ref:`DataObjectWriter.truncate() <method_DataObjectWriter_truncate>`
+  * :ref:`Object.deserializeProperties() <method_Object_deserializeProperties>`
   * :ref:`Object.fromJson() <method_Object_fromJson>`
   * :ref:`Object.toJson() <method_Object_toJson>`
 
@@ -402,7 +403,7 @@ Example
 .. code-block:: qml
 
     import InCore.Foundation 2.0
-    import InCore.Database 2.0
+    import InCore.Database 2.4
     
     Application {
     
@@ -444,6 +445,17 @@ Example
                         }
     
                         Polling on results { interval: 10000 }
+                    },
+    
+                    DatabaseQuery {
+                        // query only sensor3 data
+                        objects: [sensor3]
+                        // sort by sensor3 descending, then sensor2 ascending
+                        orderByNames: ["-sensor3", "sensor2"]
+    
+                        // only get 10 values descending
+                        limitPos: 0
+                        limitLength: 10
                     }
                 ]
             }

diff --git a/InCore.Database/LocalDatabase.rst b/InCore.Database/LocalDatabase.rst
@@ -8,7 +8,7 @@
 Description
 ***********
 
-The LocalDatabase object is used to store data in a local database using SQLite.
+The LocalDatabase object is used to store data in a local database using SQLite. The filename is constructed based on the :ref:`Database.name <property_Database_name>` property or alternatively on the object ID, either specified through the QML object ID or the :ref:`Object.objectId <property_Object_objectId>` property.
 
 :**› Inherits**: :ref:`Database <object_Database>`
 
@@ -44,6 +44,7 @@ Methods
   * :ref:`Database.close() <method_Database_close>`
   * :ref:`Database.dropAllTables() <method_Database_dropAllTables>`
   * :ref:`Database.open() <method_Database_open>`
+  * :ref:`Object.deserializeProperties() <method_Object_deserializeProperties>`
   * :ref:`Object.fromJson() <method_Object_fromJson>`
   * :ref:`Object.toJson() <method_Object_toJson>`
 

diff --git a/InCore.Database/MSSQLDatabase.rst b/InCore.Database/MSSQLDatabase.rst
@@ -8,7 +8,7 @@
 Description
 ***********
 
-The MSSQLDatabase object is used to connect to a Microsoft SQL Server using ODBC.
+The MSSQLDatabase object can be used to connect to a Microsoft SQL Server using ODBC.
 
 :**› Inherits**: :ref:`NetworkDatabase <object_NetworkDatabase>`
 
@@ -49,6 +49,7 @@ Methods
   * :ref:`Database.close() <method_Database_close>`
   * :ref:`Database.dropAllTables() <method_Database_dropAllTables>`
   * :ref:`Database.open() <method_Database_open>`
+  * :ref:`Object.deserializeProperties() <method_Object_deserializeProperties>`
   * :ref:`Object.fromJson() <method_Object_fromJson>`
   * :ref:`Object.toJson() <method_Object_toJson>`