Clarify handling of purely technical IDs

Addresses #809. Signed-off-by: Pierre R. Mai <[email protected]>
OpenSimulationInterface · May 13, 2024 · daf0e7a · daf0e7a
1 parent 7c9529f
commit daf0e7a
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/osi_common.proto b/osi_common.proto
@@ -197,6 +197,9 @@ message Orientation3d
 // available address space is exhausted and the specific values have not been in
 // use for several time steps. Sensor specific tracking IDs have no restrictions
 // and should behave according to the sensor specifications.
+// Purely simulation technical IDs, like sensor IDs, are not required to be
+// unique among all simulated items, but rather unique within the context of the
+// given message type.
 //
 // The value MAX(uint64) = 2^(64) -1 =
 // 0b1111111111111111111111111111111111111111111111111111111111111111 is

diff --git a/osi_sensorview.proto b/osi_sensorview.proto
@@ -65,7 +65,6 @@ message SensorView
     // which are used in the detected features.
     //
     // \rules
-    // is_globally_unique
     // is_set
     // \endrules
     //

diff --git a/rules.yml b/rules.yml
@@ -10,4 +10,4 @@ is_iso_country_code: '^[ ]\b(is_iso_country_code)\b'
 first_element: '^[ ]\b(first_element)\b'
 last_element: '^[ ]\b(last_element)\b'
 check_if: '^[ ](\bcheck_if\b)(.*\belse do_check\b)'
-is_set: '^[ ]\b(is_set)\b'
+is_set: '^[ ]\b(is_set)\b'