@@ -90,13 +90,14 @@ <h1 class="title">Module <code>state_signals</code></h1>
9090 method for converting object data to json string.
9191
9292 Fields:
93- - publisher_id: A unique id generated by the SignalExporter for identification
94- - process_name: The name of the process that the state signals are describing
95- - event: The current state of the process
96- - runner_host: The host that the process is currently being run on
97- - sample_no: The current sample number (if applicable, default -1)
98- - tag: Any user-supplied string tag for the signal (default 'No tag specified')
99- - metadata: Dictionary containing any additional necessary data (optional)
93+
94+ - publisher_id: A unique id generated by the SignalExporter for identification
95+ - process_name: The name of the process that the state signals are describing
96+ - event: The current state of the process
97+ - runner_host: The host that the process is currently being run on
98+ - sample_no: The current sample number (if applicable, default -1)
99+ - tag: Any user-supplied string tag for the signal (default 'No tag specified')
100+ - metadata: Dictionary containing any additional necessary data (optional)
100101 """
101102
102103 publisher_id: str
@@ -140,13 +141,14 @@ <h1 class="title">Module <code>state_signals</code></h1>
140141 method for converting object data to json string.
141142
142143 Fields:
143- - responder_id: A unique id generated by the SignalResponder for identification
144- - publisher_id: The id of the publisher that is being responded to
145- - event: The published state of the signal-publishing process
146- - ras: Response Action Success code
147- - Whether or not the responding process successfully processed/acted upon the signal
148- - 1 = successful, 0 (or other) = unsuccessful
149- - Not needed when not subscribed or responding to initialization
144+
145+ - responder_id: A unique id generated by the SignalResponder for identification
146+ - publisher_id: The id of the publisher that is being responded to
147+ - event: The published state of the signal-publishing process
148+ - ras: Response Action Success code
149+ - Whether or not the responding process successfully processed/acted upon the signal
150+ - 1 = successful, 0 (or other) = unsuccessful
151+ - Not needed when not subscribed or responding to initialization
150152 """
151153
152154 responder_id: str
@@ -547,14 +549,24 @@ <h2 class="section-title" id="header-classes">Classes</h2>
547549< div class ="desc "> < p > Standard signal response protocol payload. All required fields, defaults,
548550and type restrictions are defined in this dataclass. Also includes a
549551method for converting object data to json string.</ p >
550- < p > Fields:
551- - responder_id: A unique id generated by the SignalResponder for identification
552- - publisher_id: The id of the publisher that is being responded to
553- - event: The published state of the signal-publishing process
554- - ras: Response Action Success code
555- - Whether or not the responding process successfully processed/acted upon the signal
556- - 1 = successful, 0 (or other) = unsuccessful
557- - Not needed when not subscribed or responding to initialization</ p > </ div >
552+ < h2 id ="fields "> Fields</ h2 >
553+ < ul >
554+ < li > responder_id: A unique id generated by the SignalResponder for identification
555+ </ li >
556+ < li > publisher_id: The id of the publisher that is being responded to
557+ </ li >
558+ < li > event: The published state of the signal-publishing process
559+ </ li >
560+ < li > ras: Response Action Success code
561+ < ul >
562+ < li > Whether or not the responding process successfully processed/acted upon the signal
563+ </ li >
564+ < li > 1 = successful, 0 (or other) = unsuccessful
565+ </ li >
566+ < li > Not needed when not subscribed or responding to initialization</ li >
567+ </ ul >
568+ </ li >
569+ </ ul > </ div >
558570< details class ="source ">
559571< summary >
560572< span > Expand source code</ span >
@@ -566,13 +578,14 @@ <h2 class="section-title" id="header-classes">Classes</h2>
566578 method for converting object data to json string.
567579
568580 Fields:
569- - responder_id: A unique id generated by the SignalResponder for identification
570- - publisher_id: The id of the publisher that is being responded to
571- - event: The published state of the signal-publishing process
572- - ras: Response Action Success code
573- - Whether or not the responding process successfully processed/acted upon the signal
574- - 1 = successful, 0 (or other) = unsuccessful
575- - Not needed when not subscribed or responding to initialization
581+
582+ - responder_id: A unique id generated by the SignalResponder for identification
583+ - publisher_id: The id of the publisher that is being responded to
584+ - event: The published state of the signal-publishing process
585+ - ras: Response Action Success code
586+ - Whether or not the responding process successfully processed/acted upon the signal
587+ - 1 = successful, 0 (or other) = unsuccessful
588+ - Not needed when not subscribed or responding to initialization
576589 """
577590
578591 responder_id: str
@@ -692,14 +705,22 @@ <h3>Class variables</h3>
692705< div class ="desc "> < p > Standard event signal protocol payload. All required fields, defaults,
693706and type restrictions are defined in this dataclass. Also includes a
694707method for converting object data to json string.</ p >
695- < p > Fields:
696- - publisher_id: A unique id generated by the SignalExporter for identification
697- - process_name: The name of the process that the state signals are describing
698- - event: The current state of the process
699- - runner_host: The host that the process is currently being run on
700- - sample_no: The current sample number (if applicable, default -1)
701- - tag: Any user-supplied string tag for the signal (default 'No tag specified')
702- - metadata: Dictionary containing any additional necessary data (optional)</ p > </ div >
708+ < h2 id ="fields "> Fields</ h2 >
709+ < ul >
710+ < li > publisher_id: A unique id generated by the SignalExporter for identification
711+ </ li >
712+ < li > process_name: The name of the process that the state signals are describing
713+ </ li >
714+ < li > event: The current state of the process
715+ </ li >
716+ < li > runner_host: The host that the process is currently being run on
717+ </ li >
718+ < li > sample_no: The current sample number (if applicable, default -1)
719+ </ li >
720+ < li > tag: Any user-supplied string tag for the signal (default 'No tag specified')
721+ </ li >
722+ < li > metadata: Dictionary containing any additional necessary data (optional)</ li >
723+ </ ul > </ div >
703724< details class ="source ">
704725< summary >
705726< span > Expand source code</ span >
@@ -711,13 +732,14 @@ <h3>Class variables</h3>
711732 method for converting object data to json string.
712733
713734 Fields:
714- - publisher_id: A unique id generated by the SignalExporter for identification
715- - process_name: The name of the process that the state signals are describing
716- - event: The current state of the process
717- - runner_host: The host that the process is currently being run on
718- - sample_no: The current sample number (if applicable, default -1)
719- - tag: Any user-supplied string tag for the signal (default 'No tag specified')
720- - metadata: Dictionary containing any additional necessary data (optional)
735+
736+ - publisher_id: A unique id generated by the SignalExporter for identification
737+ - process_name: The name of the process that the state signals are describing
738+ - event: The current state of the process
739+ - runner_host: The host that the process is currently being run on
740+ - sample_no: The current sample number (if applicable, default -1)
741+ - tag: Any user-supplied string tag for the signal (default 'No tag specified')
742+ - metadata: Dictionary containing any additional necessary data (optional)
721743 """
722744
723745 publisher_id: str
0 commit comments