PUB_ConfigurationFinished: Add new message

This message is sent after the JSON configuration for a panel or notebook is
finished.

Author: t-b

Packages/MIES/MIES_Configuration.ipf

@@ -512,6 +512,9 @@ Function CONF_RestoreWindow(string fName, [string rigFile])
 			Abort
 		endif
 	endtry
+
+	PUB_ConfigurationFinished(wName, panelType, fName, rigFile)
+
 	JSON_Release(jsonID)
 End
 

Packages/MIES/MIES_Constants.ipf

@@ -1868,6 +1868,7 @@ StrConstant ANALYSIS_FUNCTION_SE              = "analysis function:seal evaluati
 StrConstant ANALYSIS_FUNCTION_VM              = "analysis function:true resting membrane potential"
 StrConstant DAQ_TP_STATE_CHANGE_FILTER        = "data acquisition:state change"
 StrConstant ANALYSIS_FUNCTION_AR              = "analysis function:access resistance smoke"
+StrConstant CONFIG_FINISHED_FILTER            = "configuration:finished"
 ///@}
 
 /// which is sufficient to represent each sample point time with a distinctive number up to rates of 10 MHz.

Packages/MIES/MIES_ForeignFunctionInterface.ipf

@@ -84,18 +84,20 @@ End
 ///  :cpp:var:ZMQ_FILTER_TPRESULT_5s              TP evaluation result (every 5s)                      :cpp:func:PUB_TPResult
 ///  :cpp:var:ZMQ_FILTER_TPRESULT_10s             TP evaluation result (every 10s)                     :cpp:func:PUB_TPResult
 ///  :cpp:var:ZMQ_FILTER_TPRESULT_NOW_WITH_DATA   TP evaluation result with AD data (all TPs)          :cpp:func:PUB_TPResult
+///  :cpp:var:CONFIG_FINISHED_FILTER              JSON configuration for panel has finished            :cpp:func:PUB_ConfigurationFinished
 /// ============================================ ==================================================== =============================================
 ///
 /// \endrst
 ///
 Function/WAVE FFI_GetAvailableMessageFilters()
 
-	Make/FREE/T wv = {ZeroMQ_HEARTBEAT, PRESSURE_STATE_FILTER, PRESSURE_SEALED_FILTER,                  \
-	                  PRESSURE_BREAKIN_FILTER, AUTO_TP_FILTER, AMPLIFIER_CLAMP_MODE_FILTER,             \
-	                  AMPLIFIER_AUTO_BRIDGE_BALANCE, ANALYSIS_FUNCTION_PB, ANALYSIS_FUNCTION_SE,        \
-	                  ANALYSIS_FUNCTION_VM, DAQ_TP_STATE_CHANGE_FILTER,                                 \
-	                  ANALYSIS_FUNCTION_AR, ZMQ_FILTER_TPRESULT_NOW, ZMQ_FILTER_TPRESULT_1S,            \
-	                  ZMQ_FILTER_TPRESULT_5S, ZMQ_FILTER_TPRESULT_10S, ZMQ_FILTER_TPRESULT_NOW_WITH_DATA}
+	Make/FREE/T wv = {ZeroMQ_HEARTBEAT, PRESSURE_STATE_FILTER, PRESSURE_SEALED_FILTER,                    \
+	                  PRESSURE_BREAKIN_FILTER, AUTO_TP_FILTER, AMPLIFIER_CLAMP_MODE_FILTER,               \
+	                  AMPLIFIER_AUTO_BRIDGE_BALANCE, ANALYSIS_FUNCTION_PB, ANALYSIS_FUNCTION_SE,          \
+	                  ANALYSIS_FUNCTION_VM, DAQ_TP_STATE_CHANGE_FILTER,                                   \
+	                  ANALYSIS_FUNCTION_AR, ZMQ_FILTER_TPRESULT_NOW, ZMQ_FILTER_TPRESULT_1S,              \
+	                  ZMQ_FILTER_TPRESULT_5S, ZMQ_FILTER_TPRESULT_10S, ZMQ_FILTER_TPRESULT_NOW_WITH_DATA, \
+	                  CONFIG_FINISHED_FILTER}
 
 	Note/K wv, "Heartbeat is sent every 5 seconds."
 

Packages/MIES/MIES_Publish.ipf

@@ -910,3 +910,36 @@ threadsafe static Function PUB_CheckPublishingTime(string pubFilter, variable pe
 
 	return 0
 End
+
+/// Filter: #CONFIG_FINISHED_FILTER
+///
+/// Example:
+///
+/// \rst
+/// .. code-block:: json
+///
+///    {
+///      "device": null,
+///      "fileName": "fileA",
+///      "headstage": "NaN",
+///      "panelType": "DataBrowser",
+///      "rigFileName": "fileB",
+///      "sweep number": "NaN",
+///      "timestamp": "2025-02-25T15:06:19Z",
+///      "window": "Databrowser"
+///    }
+///
+/// \endrst
+Function PUB_ConfigurationFinished(string windowName, string panelType, string fileName, string rigfileName)
+
+	variable jsonID
+
+	jsonID = PUB_GetJSONTemplate("", NaN)
+
+	JSON_AddString(jsonID, "window", windowName)
+	JSON_AddString(jsonID, "panelType", panelType)
+	JSON_AddString(jsonID, "fileName", fileName)
+	JSON_AddString(jsonID, "rigFileName", rigFileName)
+
+	PUB_Publish(jsonID, CONFIG_FINISHED_FILTER)
+End

Packages/tests/Basic/UTF_Configuration.ipf

@@ -320,7 +320,10 @@ static Function TCONF_SaveNotebookAndRestore()
 	string fName      = "NotebookTest.json"
 	string nbTextRef  = "This is fine."
 	string nbTextRef2 = "This is not fine."
-	string nbText
+	string nbText, expected, actual
+	variable jsonID
+
+	PrepareForPublishTest()
 
 	DoWindow/K $wName
 	NewNotebook/N=$wName/F=0
@@ -339,6 +342,11 @@ static Function TCONF_SaveNotebookAndRestore()
 	CONF_RestoreWindow(PrependExperimentFolder_IGNORE(fName))
 	nbText = GetNotebookText(wName, mode = 2)
 	CHECK_EQUAL_STR(nbTextRef2, nbText)
+
+	jsonID   = FetchAndParseMessage(CONFIG_FINISHED_FILTER)
+	expected = wName
+	actual   = JSON_GetString(jsonID, "window")
+	CHECK_EQUAL_STR(actual, expected)
 End
 
 /// @brief Checks if every (qualified) panel has a panel type set

Packages/tests/Basic/UTF_ZeroMQPublishing.ipf

@@ -626,3 +626,36 @@ static Function CheckTPPublishingWithData()
 
 	JSON_Release(jsonID)
 End
+
+static Function CheckConfigurationFinished()
+
+	string windowName, file, rigFile, panelType, actual, expected
+	variable jsonID
+
+	windowName = "Databrowser"
+	file       = "fileA"
+	rigFile    = "fileB"
+	panelType  = PANELTAG_DATABROWSER
+
+	PUB_ConfigurationFinished(windowName, panelType, file, rigFile)
+
+	jsonID = FetchAndParseMessage(CONFIG_FINISHED_FILTER)
+
+	actual   = JSON_GetString(jsonID, "/window")
+	expected = windowName
+	CHECK_EQUAL_STR(actual, expected)
+
+	actual   = JSON_GetString(jsonID, "/panelType")
+	expected = panelType
+	CHECK_EQUAL_STR(actual, expected)
+
+	actual   = JSON_GetString(jsonID, "/fileName")
+	expected = file
+	CHECK_EQUAL_STR(actual, expected)
+
+	actual   = JSON_GetString(jsonID, "/rigFileName")
+	expected = rigFile
+	CHECK_EQUAL_STR(actual, expected)
+
+	JSON_Release(jsonID)
+End