Resolve change requests

Author: moritzsommer

sdk/basyx/aas/examples/tutorial_navigate_aas.py

@@ -12,7 +12,28 @@
 # through them using IdShorts and IdShortPaths.
 #
 # Step-by-Step Guide:
-# Step 1: Create a Submodel with a Property, a Property Collection, a Property List and a Collection List
+# Step 1: Create a Submodel with a Property, a SubmodelElementCollection of Properties, a SubmodelElementList of
+#         Properties and a SubmodelElementList of SubmodelElementCollections
+#
+#         Submodel "https://iat.rwth-aachen.de/Simple_Submodel"
+#         ├── Property "MyProperty"
+#         │
+#         ├── SubmodelElementCollection "MyPropertyCollection"
+#         │   ├── Property "MyProperty0"
+#         │   └── Property "MyProperty1"
+#         │
+#         ├── SubmodelElementList "MyPropertyList"
+#         │   ├── Property [0]
+#         │   └── Property [1]
+#         │
+#         └── SubmodelElementList "MyCollectionList"
+#             ├── SubmodelElementCollection [0]
+#             │   └── Property "MyProperty"
+#             ├── SubmodelElementCollection [1]
+#             │   └── Property "MyProperty"
+#             └── SubmodelElementCollection [2]
+#                 └── Property "MyProperty"
+#
 # Step 2: Navigate through the Submodel using IdShorts and IdShortPaths
 
 
@@ -31,25 +52,25 @@
 )
 submodel.submodel_element.add(my_property)
 
-# Step 1.3: Add a Property Collection to the Submodel
+# Step 1.3: Add a SubmodelElementCollection of Properties to the Submodel
 my_property_collection = model.SubmodelElementCollection(
     id_short="MyPropertyCollection",
     value={
         model.Property(
             id_short="MyProperty0",
             value_type=model.datatypes.String,
-            value="I am the first of two Properties within a Property Collection"
+            value="I am the first of two Properties within a SubmodelElementCollection"
         ),
         model.Property(
             id_short="MyProperty1",
             value_type=model.datatypes.String,
-            value="I am the second of two Properties within a Property Collection"
+            value="I am the second of two Properties within a SubmodelElementCollection"
         )
     }
 )
 submodel.submodel_element.add(my_property_collection)
 
-# Step 1.4: Add a Property List to the Submodel
+# Step 1.4: Add a SubmodelElementList of Properties to the Submodel
 my_property_list = model.SubmodelElementList(
     id_short="MyPropertyList",
     type_value_list_element=model.Property,
@@ -59,40 +80,40 @@
         model.Property(
             id_short=None,
             value_type=model.datatypes.String,
-            value="I am Property 0 within a Property List"
+            value="I am Property 0 within a SubmodelElementList"
         ),
         model.Property(
             id_short=None,
             value_type=model.datatypes.String,
-            value="I am Property 1 within a Property List"
+            value="I am Property 1 within a SubmodelElementList"
         )
     ]
 )
 submodel.submodel_element.add(my_property_list)
 
-# Step 1.5: Add a Collection List to the Submodel
+# Step 1.5: Add a SubmodelElementList of SubmodelElementCollections to the Submodel
 my_property_collection_0 = model.SubmodelElementCollection(
     id_short=None,
     value={model.Property(
         id_short="MyProperty",
         value_type=model.datatypes.String,
-        value="I am a simple Property within Property Collection 0"
+        value="I am a simple Property within SubmodelElementCollection 0"
     )}
 )
 my_property_collection_1 = model.SubmodelElementCollection(
     id_short=None,
     value={model.Property(
         id_short="MyProperty",
         value_type=model.datatypes.String,
-        value="I am a simple Property within Property Collection 1"
+        value="I am a simple Property within SubmodelElementCollection 1"
     )}
 )
 my_property_collection_2 = model.SubmodelElementCollection(
     id_short=None,
     value={model.Property(
         id_short="MyProperty",
         value_type=model.datatypes.String,
-        value="I am a simple Property within Property Collection 2"
+        value="I am a simple Property within SubmodelElementCollection 2"
     )}
 )
 my_collection_list = model.SubmodelElementList(
@@ -112,7 +133,8 @@
 my_property = cast(model.Property, submodel.get_referable("MyProperty"))
 print(f"my_property: id_short = {my_property.id_short}, value = {my_property.value}\n")
 
-# Step 2.2.1: Access a Property within a Property Collection step by step via its IdShort
+# Step 2.2: Navigate through a SubmodelElementCollection of Properties
+# Step 2.2.1: Access a Property within a SubmodelElementCollection step by step via its IdShort
 my_property_collection = cast(model.SubmodelElementCollection, submodel.get_referable("MyPropertyCollection"))
 my_property_collection_property_0 = cast(model.Property, my_property_collection.get_referable("MyProperty0"))
 print(
@@ -121,7 +143,7 @@
     f"value = {my_property_collection_property_0.value}"
 )
 
-# Step 2.2.2: Access a Property within a Property Collection via its IdShortPath
+# Step 2.2.2: Access a Property within a SubmodelElementCollection via its IdShortPath
 my_property_collection_property_1 = cast(
     model.Property,
     submodel.get_referable(["MyPropertyCollection", "MyProperty1"])
@@ -132,7 +154,8 @@
     f"value = {my_property_collection_property_1.value}\n"
 )
 
-# Step 2.3.1: Access a Property within a Property List step by step via its index
+# Step 2.3: Navigate through a SubmodelElementList of Properties
+# Step 2.3.1: Access a Property within a SubmodelElementList step by step via its index
 my_property_list = cast(model.SubmodelElementList, submodel.get_referable("MyPropertyList"))
 my_property_list_property_0 = cast(model.Property, my_property_list.get_referable("0"))
 print(
@@ -141,15 +164,17 @@
     f"value = {my_property_list_property_0.value}"
 )
 
-# Step 2.3.2: Access a Property within a Property List via its IdShortPath
+# Step 2.3.2: Access a Property within a SubmodelElementList via its IdShortPath
 my_property_list_property_1 = cast(model.Property, submodel.get_referable(["MyPropertyList", "1"]))
 print(
     f"my_property_list_property_1: "
     f"id_short = {my_property_list_property_1}, "
     f"value = {my_property_list_property_1.value}\n"
 )
 
-# Step 2.4.1: Access a Property within a Collection List step by step via its index and IdShort
+# Step 2.4: Navigate through a SubmodelElementList of SubmodelElementCollections
+# Step 2.4.1: Access a Property within a SubmodelElementList of SubmodelElementCollections step by step via its index
+# and IdShort
 my_collection_list = cast(model.SubmodelElementList, submodel.get_referable("MyCollectionList"))
 my_collection_list_collection_0 = cast(model.SubmodelElementCollection, my_collection_list.get_referable("0"))
 my_collection_list_collection_0_property_0 = cast(
@@ -162,7 +187,7 @@
     f"value = {my_collection_list_collection_0_property_0.value}"
 )
 
-# Step 2.4.2: Access a Property within a Collection List via its IdShortPath
+# Step 2.4.2: Access a Property within a SubmodelElementList of SubmodelElementCollections via its IdShortPath
 my_collection_list_collection_2_property_0 = cast(
     model.Property,
     submodel.get_referable(["MyCollectionList", "2", "MyProperty"])

sdk/docs/source/tutorials/index.rst

@@ -10,5 +10,5 @@ Tutorials for working with the Eclipse BaSyx Python SDK
    tutorial_navigate_aas
    tutorial_storage
    tutorial_serialization_deserialization
-   tutorial_backend_couchdb
    tutorial_aasx
+   tutorial_backend_couchdb