Added C# event system for programatically hooking into session functions

Author: jackbrookes

Assets/DevelopmentScene.unity

@@ -370,6 +370,32 @@ Prefab:
       propertyPath: m_AnchorMax.y
       value: 1
       objectReference: {fileID: 0}
-    m_RemovedComponents: []
+    - target: {fileID: 224286096967890162, guid: 0a3b6392f04558844bd340e68ced1ff9,
+        type: 2}
+      propertyPath: m_AnchorMin.y
+      value: 1
+      objectReference: {fileID: 0}
+    - target: {fileID: 224286096967890162, guid: 0a3b6392f04558844bd340e68ced1ff9,
+        type: 2}
+      propertyPath: m_AnchorMax.y
+      value: 1
+      objectReference: {fileID: 0}
+    - target: {fileID: 224286096967890162, guid: 0a3b6392f04558844bd340e68ced1ff9,
+        type: 2}
+      propertyPath: m_AnchoredPosition.x
+      value: 164
+      objectReference: {fileID: 0}
+    - target: {fileID: 224286096967890162, guid: 0a3b6392f04558844bd340e68ced1ff9,
+        type: 2}
+      propertyPath: m_SizeDelta.x
+      value: 318
+      objectReference: {fileID: 0}
+    - target: {fileID: 224546371281550106, guid: 0a3b6392f04558844bd340e68ced1ff9,
+        type: 2}
+      propertyPath: m_SizeDelta.y
+      value: 0
+      objectReference: {fileID: 0}
+    m_RemovedComponents:
+    - {fileID: 114291432593817218, guid: 0a3b6392f04558844bd340e68ced1ff9, type: 2}
   m_ParentPrefab: {fileID: 100100000, guid: 0a3b6392f04558844bd340e68ced1ff9, type: 2}
   m_IsPrefabParent: 0

Assets/UXF/Scripts/Session.cs

@@ -176,12 +176,7 @@ public class Session : MonoBehaviour
         /// Reference to the associated FileIOManager which deals with inputting and outputting files.
         /// </summary>
         private FileIOManager fileIOManager;
-
-        /// <summary>
-        /// Reference to the associated SessionLogger which automatically stores all Debug.Log calls
-        /// </summary>
-        private SessionLogger logger;
-
+        
         List<string> baseHeaders = new List<string> { "experiment", "ppid", "session_num", "trial_num", "block_num", "trial_num_in_block", "start_time", "end_time" };
 
         /// <summary>
@@ -190,7 +185,6 @@ public class Session : MonoBehaviour
         /// <value></value>
         public string basePath { get; private set; }
 
-
         /// <summary>
         /// Path to the folder used for reading settings and storing the output. 
         /// </summary>
@@ -226,24 +220,37 @@ public class Session : MonoBehaviour
         /// </summary>
         public Dictionary<string, object> participantDetails;
 
+        /// <summary>
+        /// An event handler for a C# event containing the session as an argument.
+        /// </summary>
+        public delegate void EventHandler();
+
+        /// <summary>
+        /// Event raised after session has been initialised, used for UXF functionality. Users should use similar OnSessionBegin UnityEvent.
+        /// </summary>
+        public event EventHandler onInitialise;
+
+        /// <summary>
+        /// Event raised before session finished, used for UXF functionality. Users should use the similar OnSessionEnd UnityEvent.
+        /// </summary>
+        public event EventHandler cleanUp;
+
+        /// <summary>
+        /// Provide references to other components 
+        /// </summary>
         void Awake()
         {
             // get components attached to this gameobject and store their references 
-            AttachReferences(
-                GetComponent<FileIOManager>(),
-                GetComponent<SessionLogger>()
-                );
+            AttachReferences(GetComponent<FileIOManager>());
         }
 
         /// <summary>
         /// Provide references to other components 
         /// </summary>
         /// <param name="newFileIOManager"></param>
-        /// <param name="newSessionLogger"></param>
-        public void AttachReferences(FileIOManager newFileIOManager = null, SessionLogger newSessionLogger = null)
+        public void AttachReferences(FileIOManager newFileIOManager = null)
         {
             if (newFileIOManager != null) fileIOManager = newFileIOManager;
-            if (newSessionLogger != null) logger = newSessionLogger;
         }
 
         /// <summary>
@@ -376,16 +383,13 @@ public void Begin(string experimentName, string participantId, string baseFolder
 
             // Initialise FileIOManager
             if (!fileIOManager.IsActive) fileIOManager.Begin();
-
-            // Initialise logger
-            if (logger != null)
-                logger.Initialise();
-
             _hasInitialised = true;
+
+            // raise the session events
+            if (onInitialise != null) onInitialise();
             onSessionBegin.Invoke(this);
 
             // copy Settings to session folder
-
             WriteDictToSessionFolder(
                 new Dictionary<string, object>(settings.baseDict), // makes a copy
                 "settings");
@@ -537,11 +541,10 @@ public void End()
                     currentTrial.End();
                 SaveResults();
 
-                // end logger
-                if (logger != null)
-                    logger.Finalise();
+                // raise cleanup event
+                if (cleanUp != null) cleanUp();
 
-                // end FileIOManager
+                // end FileIOManager - forces immediate writing of all files
                 fileIOManager.End();
 
                 currentTrialNum = 0;
@@ -568,7 +571,6 @@ void SaveResults()
                 fileName
                 );
 
-            // in this case, write in main thread to block aborting
             fileIOManager.ManageInWorker(() => fileIOManager.WriteTrials(results, headers.ToArray(), fileInfo));
         }
 

Assets/UXF/Scripts/SessionDebugger.cs

@@ -23,6 +23,7 @@ void Awake()
 				newFileIOManager: GetComponent<FileIOManager>(),
 				newSession: GetComponent<Session>()
 			);
+			Initialise();
 		}
 
         /// <summary>
@@ -53,6 +54,7 @@ public void Initialise()
             );
 
             Application.logMessageReceived += HandleLog;
+			session.cleanUp += Finalise; // finilise logger when cleaning up the session
 		}		
 
 		void HandleLog(string logString, string stackTrace, LogType type)
@@ -80,6 +82,7 @@ public void Finalise()
 
 			fileIOManager.ManageInWorker(() => fileIOManager.WriteCSV(table, fileInfo));
             Application.logMessageReceived -= HandleLog;
+			session.cleanUp -= Finalise;
         }
 
 	}

Assets/UXF/Scripts/SessionDebugger.cs.meta

@@ -27,8 +27,7 @@ public void SetUp()
             session = gameObject.AddComponent<Session>();
 
             session.AttachReferences(
-                fileIOManager,
-                sessionLogger
+                fileIOManager
             );
 
             sessionLogger.AttachReferences(
@@ -39,8 +38,6 @@ public void SetUp()
             sessionLogger.Initialise();
 
             fileIOManager.debug = true;
-            fileIOManager.Begin();
-
         }
 
         [TearDown]

Assets/UXF/Scripts/SessionLogger.cs

@@ -27,8 +27,7 @@ public void SetUp()
             session = gameObject.AddComponent<Session>();
 
             session.AttachReferences(
-                fileIOManager,
-                sessionLogger
+                fileIOManager
             );
 
             sessionLogger.AttachReferences(

Assets/UXF/Scripts/Tests/Editor/TestMultithreading.cs

@@ -27,8 +27,7 @@ public void SetUp()
             session = gameObject.AddComponent<Session>();
 
             session.AttachReferences(
-                fileIOManager,
-                sessionLogger
+                fileIOManager
             );
 
             sessionLogger.AttachReferences(