Update Tracker.cs

martinmmueller · martinmmueller · commit 39c59f92d9ec · 2023-02-16T09:17:24.000+01:00
diff --git a/Assets/UXF/Scripts/Etc/Tracker.cs b/Assets/UXF/Scripts/Etc/Tracker.cs
@@ -7,13 +7,13 @@
 namespace UXF
 {
     /// <summary>
-    /// Create a new class that inherits from this component to create custom tracking behaviour on a frame-by-frame basis.
+    /// Create a new class that inherits from this component to create custom tracking behaviour
+    /// on a frame-by-frame basis.
     /// </summary>
     public abstract class Tracker : MonoBehaviour
     {
-        private bool recording = false;
         private static string[] baseHeaders = new string[] { "time" };
-        private TrackerState currentState = TrackerState.Uninitialised;
+        private TrackerState currentState = TrackerState.Stopped;
 
         /// <summary>
         /// Name of the object used in saving
@@ -37,12 +37,13 @@ public string DataName
         {
             get
             {
-                Debug.AssertFormat(MeasurementDescriptor.Length > 0, "No measurement descriptor has been specified for this Tracker!");
+                Debug.AssertFormat(MeasurementDescriptor.Length > 0,
+                    "No measurement descriptor has been specified for this Tracker!");
                 return string.Join("_", new string[]{ objectName, MeasurementDescriptor });
             }
         }
 
-        public bool Recording { get { return recording; } }
+        public bool Recording { get { return currentState == TrackerState.Recording; } }
 
         public UXFDataTable Data { get; private set; } = new UXFDataTable();
 
@@ -54,7 +55,9 @@ public string DataName
         /// <summary>
         /// When the tracker should take measurements.
         /// </summary>
-        [Tooltip("When the measurements should be taken.\n\nManual should only be selected if the user is calling the RecordRow method either from another script or a custom Tracker class.")]
+        [Tooltip("When the measurements should be taken." +
+            "\n\nManual should only be selected if the user is calling the RecordRow method" +
+            " either from another script or a custom Tracker class.")]
         public TrackerUpdateType updateType = TrackerUpdateType.LateUpdate;
 
         // called when component is added
@@ -66,21 +69,22 @@ void Reset()
         // called by unity just before rendering the frame
         void LateUpdate()
         {
-            if (recording && updateType == TrackerUpdateType.LateUpdate) RecordRow();
+            if (Recording && updateType == TrackerUpdateType.LateUpdate) RecordRow();
         }
 
         // called by unity when physics simulations are run
         void FixedUpdate()
         {
-            if (recording && updateType == TrackerUpdateType.FixedUpdate) RecordRow();
+            if (Recording && updateType == TrackerUpdateType.FixedUpdate) RecordRow();
         }
 
         /// <summary>
         /// Records a new row of data at current time.
         /// </summary>
         public void RecordRow()
         {
-            if (!recording) throw new System.InvalidOperationException("Tracker measurements cannot be taken when not recording!");
+            if (!Recording) throw new System.InvalidOperationException(
+                "Tracker measurements cannot be taken when not recording!");
             
             UXFDataRow newRow = GetCurrentValues();
             newRow.Add(("time", Time.time));
@@ -92,43 +96,40 @@ public void RecordRow()
         /// </summary>
         public void StartRecording()
         {
-            if (currentState == TrackerState.On)
+            if (currentState == TrackerState.Recording)
             {
-                Debug.LogWarning($"Start command received for tracker in state: '{TrackerState.On}'." +
-                    $" This will dump exisiting data! " +
-                    "If you want to restart a paused tracker, use 'ResumeRecording()' instead.");
+                Utilities.UXFDebugLogWarning($"Start command received for tracker in state: '{TrackerState.Recording}'." +
+                    " This will dump exisiting data! " +
+                    $"If you want to restart a paused tracker, use '{nameof(ResumeRecording)}()' instead.");
             }
             var header = baseHeaders.Concat(CustomHeader);
             Data = new UXFDataTable(header.ToArray());
-            recording = true;
-            currentState = TrackerState.On;
+            currentState = TrackerState.Recording;
         }
 
         /// <summary>
         /// Stops recording.
         /// </summary>
         public void StopRecording()
         {
-            if (currentState != TrackerState.On)
+            if (currentState != TrackerState.Recording)
             {
-                Debug.LogWarning($"Stop command received for tracker in state: '{currentState}'." +
-                    $" This should only be called when tracker is in state '{TrackerState.On}'");
+                Utilities.UXFDebugLogWarning($"Stop command received for tracker in state: '{currentState}'." +
+                    $" This should only be called when tracker is in state '{TrackerState.Recording}'");
             }
-            recording = false;
-            currentState = TrackerState.Off;
+            currentState = TrackerState.Stopped;
         }
 
         /// <summary>
         /// Pauses recording.
         /// </summary>
         public void PauseRecording()
         {
-            if (currentState != TrackerState.On)
+            if (currentState != TrackerState.Recording)
             {
-                Debug.LogWarning($"Pause command received for tracker in state: '{currentState}'." +
-                    $"This should only be called when tracker is in state '{TrackerState.On}'");
+                Utilities.UXFDebugLogWarning($"Pause command received for tracker in state: '{currentState}'." +
+                    $"This should only be called when tracker is in state '{TrackerState.Recording}'");
             }
-            recording = false;
             currentState = TrackerState.Paused;
         }
 
@@ -139,11 +140,10 @@ public void ResumeRecording()
         {
             if (currentState != TrackerState.Paused)
             {
-                Debug.LogWarning($"Resume command received for tracker in state: '{currentState}'." +
+                Utilities.UXFDebugLogWarning($"Resume command received for tracker in state: '{currentState}'." +
                     $"This should only be called when tracker is in state '{TrackerState.Paused}'");
             }
-            recording = true;
-            currentState = TrackerState.On;
+            currentState = TrackerState.Recording;
         }
 
         /// <summary>
@@ -155,7 +155,9 @@ public void ResumeRecording()
     }
 
     /// <summary>
-    /// When the tracker should collect new measurements. Manual should only be selected if the user is calling the RecordRow method either from another script or a custom Tracker class.
+    /// When the tracker should collect new measurements. 
+    /// Manual should only be selected if the user is calling the RecordRow method
+    /// either from another script or a custom Tracker class.
     /// </summary>
     public enum TrackerUpdateType
     {
@@ -167,6 +169,6 @@ public enum TrackerUpdateType
     /// </summary>
     public enum TrackerState
     {
-        On, Off, Paused, Uninitialised
+        Recording, Paused, Stopped
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -7,13 +7,13 @@`
`7`	`7`	`namespace UXF`
`8`	`8`	`{`
`9`	`9`	`/// <summary>`
`10`		`- /// Create a new class that inherits from this component to create custom tracking behaviour on a frame-by-frame basis.`
	`10`	`+ /// Create a new class that inherits from this component to create custom tracking behaviour`
	`11`	`+ /// on a frame-by-frame basis.`
`11`	`12`	`/// </summary>`
`12`	`13`	`public abstract class Tracker : MonoBehaviour`
`13`	`14`	`{`
`14`		`- private bool recording = false;`
`15`	`15`	`private static string[] baseHeaders = new string[] { "time" };`
`16`		`- private TrackerState currentState = TrackerState.Uninitialised;`
	`16`	`+ private TrackerState currentState = TrackerState.Stopped;`
`17`	`17`
`18`	`18`	`/// <summary>`
`19`	`19`	`/// Name of the object used in saving`
`@@ -37,12 +37,13 @@ public string DataName`
`37`	`37`	`{`
`38`	`38`	`get`
`39`	`39`	`{`
`40`		`- Debug.AssertFormat(MeasurementDescriptor.Length > 0, "No measurement descriptor has been specified for this Tracker!");`
	`40`	`+ Debug.AssertFormat(MeasurementDescriptor.Length > 0,`
	`41`	`+ "No measurement descriptor has been specified for this Tracker!");`
`41`	`42`	`return string.Join("_", new string[]{ objectName, MeasurementDescriptor });`
`42`	`43`	`}`
`43`	`44`	`}`
`44`	`45`
`45`		`- public bool Recording { get { return recording; } }`
	`46`	`+ public bool Recording { get { return currentState == TrackerState.Recording; } }`
`46`	`47`
`47`	`48`	`public UXFDataTable Data { get; private set; } = new UXFDataTable();`
`48`	`49`
`@@ -54,7 +55,9 @@ public string DataName`
`54`	`55`	`/// <summary>`
`55`	`56`	`/// When the tracker should take measurements.`
`56`	`57`	`/// </summary>`
`57`		`- [Tooltip("When the measurements should be taken.\n\nManual should only be selected if the user is calling the RecordRow method either from another script or a custom Tracker class.")]`
	`58`	`+ [Tooltip("When the measurements should be taken." +`
	`59`	`+ "\n\nManual should only be selected if the user is calling the RecordRow method" +`
	`60`	`+ " either from another script or a custom Tracker class.")]`
`58`	`61`	`public TrackerUpdateType updateType = TrackerUpdateType.LateUpdate;`
`59`	`62`
`60`	`63`	`// called when component is added`
`@@ -66,21 +69,22 @@ void Reset()`
`66`	`69`	`// called by unity just before rendering the frame`
`67`	`70`	`void LateUpdate()`
`68`	`71`	`{`
`69`		`- if (recording && updateType == TrackerUpdateType.LateUpdate) RecordRow();`
	`72`	`+ if (Recording && updateType == TrackerUpdateType.LateUpdate) RecordRow();`
`70`	`73`	`}`
`71`	`74`
`72`	`75`	`// called by unity when physics simulations are run`
`73`	`76`	`void FixedUpdate()`
`74`	`77`	`{`
`75`		`- if (recording && updateType == TrackerUpdateType.FixedUpdate) RecordRow();`
	`78`	`+ if (Recording && updateType == TrackerUpdateType.FixedUpdate) RecordRow();`
`76`	`79`	`}`
`77`	`80`
`78`	`81`	`/// <summary>`
`79`	`82`	`/// Records a new row of data at current time.`
`80`	`83`	`/// </summary>`
`81`	`84`	`public void RecordRow()`
`82`	`85`	`{`
`83`		`- if (!recording) throw new System.InvalidOperationException("Tracker measurements cannot be taken when not recording!");`
	`86`	`+ if (!Recording) throw new System.InvalidOperationException(`
	`87`	`+ "Tracker measurements cannot be taken when not recording!");`
`84`	`88`
`85`	`89`	`UXFDataRow newRow = GetCurrentValues();`
`86`	`90`	`newRow.Add(("time", Time.time));`
`@@ -92,43 +96,40 @@ public void RecordRow()`
`92`	`96`	`/// </summary>`
`93`	`97`	`public void StartRecording()`
`94`	`98`	`{`
`95`		`- if (currentState == TrackerState.On)`
	`99`	`+ if (currentState == TrackerState.Recording)`
`96`	`100`	`{`
`97`		`- Debug.LogWarning($"Start command received for tracker in state: '{TrackerState.On}'." +`
`98`		`- $" This will dump exisiting data! " +`
`99`		`- "If you want to restart a paused tracker, use 'ResumeRecording()' instead.");`
	`101`	`+ Utilities.UXFDebugLogWarning($"Start command received for tracker in state: '{TrackerState.Recording}'." +`
	`102`	`+ " This will dump exisiting data! " +`
	`103`	`+ $"If you want to restart a paused tracker, use '{nameof(ResumeRecording)}()' instead.");`
`100`	`104`	`}`
`101`	`105`	`var header = baseHeaders.Concat(CustomHeader);`
`102`	`106`	`Data = new UXFDataTable(header.ToArray());`
`103`		`- recording = true;`
`104`		`- currentState = TrackerState.On;`
	`107`	`+ currentState = TrackerState.Recording;`
`105`	`108`	`}`
`106`	`109`
`107`	`110`	`/// <summary>`
`108`	`111`	`/// Stops recording.`
`109`	`112`	`/// </summary>`
`110`	`113`	`public void StopRecording()`
`111`	`114`	`{`
`112`		`- if (currentState != TrackerState.On)`
	`115`	`+ if (currentState != TrackerState.Recording)`
`113`	`116`	`{`
`114`		`- Debug.LogWarning($"Stop command received for tracker in state: '{currentState}'." +`
`115`		`- $" This should only be called when tracker is in state '{TrackerState.On}'");`
	`117`	`+ Utilities.UXFDebugLogWarning($"Stop command received for tracker in state: '{currentState}'." +`
	`118`	`+ $" This should only be called when tracker is in state '{TrackerState.Recording}'");`
`116`	`119`	`}`
`117`		`- recording = false;`
`118`		`- currentState = TrackerState.Off;`
	`120`	`+ currentState = TrackerState.Stopped;`
`119`	`121`	`}`
`120`	`122`
`121`	`123`	`/// <summary>`
`122`	`124`	`/// Pauses recording.`
`123`	`125`	`/// </summary>`
`124`	`126`	`public void PauseRecording()`
`125`	`127`	`{`
`126`		`- if (currentState != TrackerState.On)`
	`128`	`+ if (currentState != TrackerState.Recording)`
`127`	`129`	`{`
`128`		`- Debug.LogWarning($"Pause command received for tracker in state: '{currentState}'." +`
`129`		`- $"This should only be called when tracker is in state '{TrackerState.On}'");`
	`130`	`+ Utilities.UXFDebugLogWarning($"Pause command received for tracker in state: '{currentState}'." +`
	`131`	`+ $"This should only be called when tracker is in state '{TrackerState.Recording}'");`
`130`	`132`	`}`
`131`		`- recording = false;`
`132`	`133`	`currentState = TrackerState.Paused;`
`133`	`134`	`}`
`134`	`135`
`@@ -139,11 +140,10 @@ public void ResumeRecording()`
`139`	`140`	`{`
`140`	`141`	`if (currentState != TrackerState.Paused)`
`141`	`142`	`{`
`142`		`- Debug.LogWarning($"Resume command received for tracker in state: '{currentState}'." +`
	`143`	`+ Utilities.UXFDebugLogWarning($"Resume command received for tracker in state: '{currentState}'." +`
`143`	`144`	`$"This should only be called when tracker is in state '{TrackerState.Paused}'");`
`144`	`145`	`}`
`145`		`- recording = true;`
`146`		`- currentState = TrackerState.On;`
	`146`	`+ currentState = TrackerState.Recording;`
`147`	`147`	`}`
`148`	`148`
`149`	`149`	`/// <summary>`
`@@ -155,7 +155,9 @@ public void ResumeRecording()`
`155`	`155`	`}`
`156`	`156`
`157`	`157`	`/// <summary>`
`158`		`- /// When the tracker should collect new measurements. Manual should only be selected if the user is calling the RecordRow method either from another script or a custom Tracker class.`
	`158`	`+ /// When the tracker should collect new measurements.`
	`159`	`+ /// Manual should only be selected if the user is calling the RecordRow method`
	`160`	`+ /// either from another script or a custom Tracker class.`
`159`	`161`	`/// </summary>`
`160`	`162`	`public enum TrackerUpdateType`
`161`	`163`	`{`
`@@ -167,6 +169,6 @@ public enum TrackerUpdateType`
`167`	`169`	`/// </summary>`
`168`	`170`	`public enum TrackerState`
`169`	`171`	`{`
`170`		`- On, Off, Paused, Uninitialised`
	`172`	`+ Recording, Paused, Stopped`
`171`	`173`	`}`
`172`	`174`	`}`