From 68b0622a1f5344fe40b12cf97b4901b59c96e44f Mon Sep 17 00:00:00 2001
From: Pascal Serrarens <pse@pale.blue>
Date: Mon, 28 Apr 2025 18:14:23 +0200
Subject: [PATCH] Align participant documentation

---
 src/Participant.cs | 100 +++++++++++++++++++--------------------------
 1 file changed, 43 insertions(+), 57 deletions(-)

diff --git a/src/Participant.cs b/src/Participant.cs
index feb2f05..3c13c1a 100644
--- a/src/Participant.cs
+++ b/src/Participant.cs
@@ -11,10 +11,6 @@ namespace RoboidControl {
     /// It also maintains the communcation information to contact the participant.
     /// It is used as a basis for the local participant, but also as a reference to remote participants.
     public class Participant {
-        /// <summary>
-        /// Default constructor
-        /// </summary>
-        public Participant() { }
         /// <summary>
         /// Create a new participant with the given communcation info
         /// </summary>
@@ -35,7 +31,7 @@ namespace RoboidControl {
         public int port = 0;
 
         /// <summary>
-        /// The network ID of the participant
+        /// he network Id to identify the participant
         /// </summary>
         public byte networkId = 0;
 
@@ -44,6 +40,48 @@ namespace RoboidControl {
         /// </summary>
         public readonly List<Thing> things = new();
 
+        /// <summary>
+        /// Get the thing with the given properties
+        /// </summary>
+        /// <param name="thingId">The ID of the thing</param>
+        /// <returns>The thing when it is found, null in other cases.</returns>
+        public Thing Get(byte thingId) {
+            Thing thing = things.Find(aThing => aThing.id == thingId);
+            //Thing thing = things.Find(aThing => Thing.IsThing(aThing, networkId, thingId));
+            // if (thing == null)
+            //     Console.WriteLine($"Could not find thing {ipAddress}:{port}[{networkId}/{thingId}]");
+            return thing;
+        }
+
+        /// <summary>
+        /// Add a new thing for this participant
+        /// </summary>
+        /// <param name="thing">The thing to add</param>
+        /// <param name="checkId">If true, the thing.id is regenerated if it is zero
+        public void Add(Thing thing, bool checkId = true) {
+            if (checkId && thing.id == 0) {
+                thing.id = (byte)(this.things.Count + 1);
+                this.things.Add(thing);
+            }
+            else {
+                Thing foundThing = Get(thing.id);
+                if (foundThing == null)
+                    this.things.Add(thing);
+            }
+        }
+
+        /// <summary>
+        /// Remove a thing for this participant
+        /// </summary>
+        /// <param name="thing">The thing to remove</param>
+        public void Remove(Thing thing) {
+            this.things.Remove(thing);
+        }
+
+        /// <summary>
+        /// Update all things for this participant
+        /// </summary>
+        /// <param name="currentTimeMS">The current time in milliseconds (optional)</param>
         public virtual void Update(ulong currentTimeMS = 0) {
             int n = this.things.Count;
             for (int ix = 0; ix < n; ix++) {
@@ -111,58 +149,6 @@ namespace RoboidControl {
                 Participant.participants.Add(participant);
         }
 
-        /// <summary>
-        /// Get a thing with the given ids
-        /// </summary>
-        /// <param name="networkId">The network ID of the thing</param>
-        /// <param name="thingId">The ID of the thing</param>
-        /// <returns>The thing when it is found, null in other cases.</returns>
-        public Thing Get(byte networkId, byte thingId) {
-            Thing thing = things.Find(aThing => aThing.id == thingId);
-            //Thing thing = things.Find(aThing => Thing.IsThing(aThing, networkId, thingId));
-            // if (thing == null)
-            //     Console.WriteLine($"Could not find thing {ipAddress}:{port}[{networkId}/{thingId}]");
-            return thing;
-        }
-
-        /// <summary>
-        /// Add a new thing for this participant
-        /// </summary>
-        /// <param name="thing">The thing to add</param>
-        /// <param name="invokeEvent">Invoke an notification event when the thing has been added</param>
-        public void Add(Thing thing, bool checkId = true, bool invokeEvent = true) {
-            if (checkId && thing.id == 0) {
-                thing.id = (byte)(this.things.Count + 1);
-                this.things.Add(thing);
-            }
-            // Console.WriteLine($"added thing [{thing.networkId}/{thing.id}]"); 
-            Thing foundThing = Get(thing.networkId, thing.id);
-
-            if (foundThing == null) {
-                this.things.Add(thing);
-
-                // if (invokeEvent)
-                //     Thing.InvokeNewThing(thing);
-                // Console.Write($"Add thing {ipAddress}:{port}[{networkId}/{thing.id}]");
-            }
-            // else {
-            //     if (thing != foundThing) {
-            //         // should be: find first non-existing id...
-            //         thing.id = (byte)this.things.Count;
-            //         things.Add(thing);
-            //         // Console.Write($"Add thing, updated thing id to [{thing.networkId}/{thing.id}]");
-            //     }
-            // }
-        }
-
-        /// <summary>
-        /// Remove a thing for this participant
-        /// </summary>
-        /// <param name="thing">The thing to remove</param>
-        public void Remove(Thing thing) {
-            this.things.Remove(thing);
-        }
-
     }
 
 }
\ No newline at end of file