Merge pull request #1211 from AllenInstitute/feature/1211-fix-message-filter-listing

Feature/1211 fix message filter listing

Author: t-b

Packages/MIES/MIES_Constants.ipf

@@ -1516,8 +1516,6 @@ StrConstant PACKAGE_SETTINGS_JSON = "Settings.json"
 
 StrConstant LOGFILE_NAME = "Log.jsonl"
 
-StrConstant IVS_PUB_FILTER = "ivscc"
-
 Constant PSQ_CR_SPIKE_CHECK_DEFAULT = 1
 
 StrConstant NOT_AVAILABLE = "n/a"
@@ -1577,11 +1575,17 @@ Constant LBN_TEXTUAL_KEYS     = 0x4
 Constant LBN_TEXTUAL_VALUES   = 0x8
 /// @}
 
-StrConstant PRESSURE_STATE_FILTER  = "pressure:state"
-StrConstant PRESSURE_SEALED_FILTER = "pressure:sealed"
-StrConstant PRESSURE_BREAKIN_FILTER = "pressure:break in"
-
-StrConstant AUTO_TP_FILTER = "testpulse:autotune result"
+/// @name All available ZeroMQ message filters
+/// @anchor ZeroMQMessageFilters
+/// @{
+StrConstant IVS_PUB_FILTER                = "ivscc"
+StrConstant PRESSURE_STATE_FILTER         = "pressure:state"
+StrConstant PRESSURE_SEALED_FILTER        = "pressure:sealed"
+StrConstant PRESSURE_BREAKIN_FILTER       = "pressure:break in"
+StrConstant AUTO_TP_FILTER                = "testpulse:autotune result"
+StrConstant AMPLIFIER_CLAMP_MODE_FILTER   = "amplifier:clamp mode"
+StrConstant AMPLIFIER_AUTO_BRIDGE_BALANCE = "amplifier:auto bridge balance"
+/// @}
 
 /// which is sufficient to represent each sample point time with a distinctive number up to rates of 10 MHz.
 Constant EPOCHTIME_PRECISION = 7
@@ -1659,6 +1663,3 @@ Constant TP_BASELINE_FIT_RESULT_TOO_NOISY = 32
 Constant TP_GETVALUES_DEFAULT            = 0x0
 Constant TP_GETVALUES_LATEST_AUTOTPCYCLE = 0x1
 /// @}
-
-StrConstant AMPLIFIER_CLAMP_MODE_FILTER   = "amplifier:clamp mode"
-StrConstant AMPLIFIER_AUTO_BRIDGE_BALANCE = "amplifier:auto bridge balance"

Packages/MIES/MIES_ForeignFunctionInterface.ipf

@@ -71,12 +71,17 @@ Function FFI_GetJSONTemplate(string device, variable headstage)
 	return jsonID
 End
 
-/// @brief Return a text wave with all available message filters for Publisher/Subscriber ZeroMQ sockets
+/// @brief Return a text wave with all available message filters for
+/// Publisher/Subscriber ZeroMQ sockets
+///
+/// See also @ref ZeroMQMessageFilters.
 ///
 /// @sa FFI_GetJSONTemplate
 Function/WAVE FFI_GetAvailableMessageFilters()
 
-	Make/FREE/T wv = {ZeroMQ_HEARTBEAT, IVS_PUB_FILTER, PRESSURE_STATE_FILTER, PRESSURE_SEALED_FILTER, AUTO_TP_FILTER}
+	Make/FREE/T wv = {ZeroMQ_HEARTBEAT, IVS_PUB_FILTER, PRESSURE_STATE_FILTER, PRESSURE_SEALED_FILTER, \
+					  PRESSURE_BREAKIN_FILTER, AUTO_TP_FILTER, AMPLIFIER_CLAMP_MODE_FILTER,            \
+					  AMPLIFIER_AUTO_BRIDGE_BALANCE}
 
 	Note/K wv "Heartbeat is sent every 5 seconds."
 

Packages/Testing-MIES/UTF_ZeroMQPublishing.ipf

@@ -19,6 +19,14 @@ static Function TEST_CASE_END_OVERRIDE(string testname)
 	zeromq_sub_add_filter("")
 End
 
+Function CheckMessageFilters_IGNORE(string filter)
+	WAVE/T/Z allFilters = FFI_GetAvailableMessageFilters()
+	CHECK_WAVE(allFilters, TEXT_WAVE)
+
+	FindValue/TXOP=4/TEXT=(filter) allFilters
+	CHECK_GE_VAR(V_Value, 0)
+End
+
 static Function CheckPressureStatePublishing()
 	string device, msg, filter, expected, actual
 	variable headstage, i, jsonID
@@ -43,6 +51,7 @@ static Function CheckPressureStatePublishing()
 	expected = PRESSURE_STATE_FILTER
 	actual   = filter
 	CHECK_EQUAL_STR(actual, expected)
+	CheckMessageFilters_IGNORE(expected)
 
 	jsonID = JSON_Parse(msg)
 
@@ -81,6 +90,7 @@ static Function CheckPressureSealPublishing()
 	expected = PRESSURE_SEALED_FILTER
 	actual   = filter
 	CHECK_EQUAL_STR(actual, expected)
+	CheckMessageFilters_IGNORE(expected)
 
 	jsonID = JSON_Parse(msg)
 
@@ -114,6 +124,7 @@ static Function CheckClampModePublishing()
 	expected = AMPLIFIER_CLAMP_MODE_FILTER
 	actual   = filter
 	CHECK_EQUAL_STR(actual, expected)
+	CheckMessageFilters_IGNORE(expected)
 
 	jsonID = JSON_Parse(msg)
 
@@ -152,6 +163,7 @@ static Function CheckAutoBridgeBalancePublishing()
 	expected = AMPLIFIER_AUTO_BRIDGE_BALANCE
 	actual   = filter
 	CHECK_EQUAL_STR(actual, expected)
+	CheckMessageFilters_IGNORE(expected)
 
 	jsonID = JSON_Parse(msg)
 
@@ -189,6 +201,7 @@ static Function CheckPressureBreakinPublishing()
 	expected = PRESSURE_BREAKIN_FILTER
 	actual   = filter
 	CHECK_EQUAL_STR(actual, expected)
+	CheckMessageFilters_IGNORE(expected)
 
 	jsonID = JSON_Parse(msg)
 
@@ -240,6 +253,7 @@ static Function CheckAutoTPPublishing()
 	expected = AUTO_TP_FILTER
 	actual   = filter
 	CHECK_EQUAL_STR(actual, expected)
+	CheckMessageFilters_IGNORE(expected)
 
 	jsonID = JSON_Parse(msg)