Update Documentation for developer

This commit is contained in:
github-actions committed 2026-11-03 12:31:27 +00:00
1 parent ccfba6a670
commit 49277698d5
6 files changed
+12 -3

No files matched your search

Binary file not shown.
Binary file not shown.
+7
View File
@@ -292,6 +292,7 @@
<li class="toctree-l3"><a class="reference internal" href="#_CPPv4NK3sls8Detector8getRxROIEi"><code class="docutils literal notranslate"><span class="pre">getRxROI()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#_CPPv4N3sls8Detector8setRxROIERKNSt6vectorIN4defs3ROIEEE"><code class="docutils literal notranslate"><span class="pre">setRxROI()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#_CPPv4N3sls8Detector10clearRxROIEv"><code class="docutils literal notranslate"><span class="pre">clearRxROI()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#_CPPv4NK3sls8Detector15isCompleteRxRoiEv"><code class="docutils literal notranslate"><span class="pre">isCompleteRxRoi()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#_CPPv4NK3sls8Detector13getFileFormatE9Positions"><code class="docutils literal notranslate"><span class="pre">getFileFormat()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#_CPPv4N3sls8Detector13setFileFormatEN4defs10fileFormatE9Positions"><code class="docutils literal notranslate"><span class="pre">setFileFormat()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#_CPPv4NK3sls8Detector11getFilePathE9Positions"><code class="docutils literal notranslate"><span class="pre">getFilePath()</span></code></a></li>
@@ -2189,6 +2190,12 @@ containing results from all modules. (<a class="reference internal" href="result
<span id="_CPPv3N3sls8Detector10clearRxROIEv"></span><span id="_CPPv2N3sls8Detector10clearRxROIEv"></span><span id="sls::Detector::clearRxROI"></span><span class="target" id="classsls_1_1Detector_1ae641f4e52c11fa5fd99802e470176086"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">clearRxROI</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3sls8Detector10clearRxROIEv" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK3sls8Detector15isCompleteRxRoiEv">
<span id="_CPPv3NK3sls8Detector15isCompleteRxRoiEv"></span><span id="_CPPv2NK3sls8Detector15isCompleteRxRoiEv"></span><span id="sls::Detector::isCompleteRxRoiC"></span><span class="target" id="classsls_1_1Detector_1a229b688b9c2a7727662517329ee71a25"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">isCompleteRxRoi</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK3sls8Detector15isCompleteRxRoiEv" title="Link to this definition"></a><br /></dt>
<dd><p>Returns true if the current ROI covers the complete detector (default) </p>
</dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-file">File</p>
+4 -2
View File
@@ -5115,10 +5115,10 @@
</li>
<li><a href="detector.html#_CPPv4NK3sls8Detector24getDetectorServerVersionE9Positions">sls::Detector::getDetectorServerVersion (C++ function)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="detector.html#_CPPv4NK3sls8Detector15getDetectorSizeEv">sls::Detector::getDetectorSize (C++ function)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="detector.html#_CPPv4NK3sls8Detector17getDetectorStatusE9Positions">sls::Detector::getDetectorStatus (C++ function)</a>
</li>
<li><a href="detector.html#_CPPv4NK3sls8Detector15getDetectorTypeE9Positions">sls::Detector::getDetectorType (C++ function)</a>
@@ -5504,6 +5504,8 @@
<li><a href="detector.html#_CPPv4NK3sls8Detector16hasBitDefinitionE10BitAddress">sls::Detector::hasBitDefinition (C++ function)</a>, <a href="detector.html#_CPPv4NK3sls8Detector16hasBitDefinitionERKNSt6stringE">[1]</a>
</li>
<li><a href="detector.html#_CPPv4NK3sls8Detector21hasRegisterDefinitionE15RegisterAddress">sls::Detector::hasRegisterDefinition (C++ function)</a>, <a href="detector.html#_CPPv4NK3sls8Detector21hasRegisterDefinitionERKNSt6stringE">[1]</a>
</li>
<li><a href="detector.html#_CPPv4NK3sls8Detector15isCompleteRxRoiEv">sls::Detector::isCompleteRxRoi (C++ function)</a>
</li>
<li><a href="detector.html#_CPPv4NK3sls8Detector14isPowerEnabledEN4defs10powerIndexE">sls::Detector::isPowerEnabled (C++ function)</a>
</li>
Binary file not shown.
+1 -1
View File
@@ -1 +1 @@
Search.setIndex({"alltitles":{"$SLSDETNAME":[[18,"slsdetname"]],"1. Install pre-built binaries using conda (Recommended)":[[16,"install-pre-built-binaries-using-conda-recommended"]],"1. Total Failure of Packet Delivery":[[37,"total-failure-of-packet-delivery"]],"1GbE/ 10GbE Interfaces":[[8,"gbe-10gbe-interfaces"],[8,"id29"]],"2. Partial or Random Packet Loss (Performance)":[[37,"partial-or-random-packet-loss-performance"]],"2. Pip":[[16,"pip"]],"3. Build from source":[[16,"build-from-source"]],"3.1. Download Source Code from github":[[16,"download-source-code-from-github"]],"3.2. Build from Source":[[16,"build-from-source-using-cmake"]],"3.2.1. Build using CMake":[[16,"build-using-cmake"]],"3.2.2. Build using in-built cmk.sh script":[[16,"build-using-in-built-cmk-sh-script"]],"3.2.3. Build RPM packages":[[16,"build-rpm-packages"]],"3.3. Build on old distributions using conda":[[16,"build-on-old-distributions-using-conda"]],"3.4. Build slsDetectorGui (Qt5)":[[16,"build-slsdetectorgui-qt5"]],"3.5. Build this documentation":[[16,"build-this-documentation"]],"4. Pybind and Zeromq":[[16,"pybind-and-zeromq"]],"5.0.0 - 6.1.1":[[33,"id1"]],"6.1.1+ (no tftp required)":[[33,"no-tftp-required"]],"< 5.0.0":[[33,"id2"]],"<\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014- 8 bytes per row \u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014>":[[41,"id2"]],"<\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014- 8 bytes \u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014->":[[41,"id3"],[41,"id4"]],"Accessing individual modules":[[24,"accessing-individual-modules"]],"Arguments":[[32,"arguments"],[42,"arguments"]],"Autocompletion":[[4,"autocompletion"]],"Automatic start":[[32,"automatic-start"]],"Binaries":[[42,"binaries"]],"Binary File Format":[[3,null]],"Building from Source":[[24,"building-from-source"]],"C++ API":[[15,null]],"CATCH2 Tests":[[0,"catch2-tests"]],"CMake: find_package and conda":[[6,"cmake-find-package-and-conda"]],"CMake: find_package(slsDetectorPackage)":[[6,"cmake-find-package-slsdetectorpackage"]],"CMake: slsDetectorPackage as submodule in your project":[[6,"cmake-slsdetectorpackage-as-submodule-in-your-project"]],"Cannot connect to detector":[[37,"cannot-connect-to-detector"]],"Cannot connect to receiver":[[37,"cannot-connect-to-receiver"]],"Cannot get data without a module attached":[[37,"cannot-get-data-without-a-module-attached"]],"Cannot get multi module data":[[37,"cannot-get-multi-module-data"],[37,"jungfrau-troubleshooting-power-supply"]],"Cannot ping module (Nios)":[[37,"cannot-ping-module-nios"]],"Cannot stop slaves in sync mode":[[37,"cannot-stop-slaves-in-sync-mode"]],"Checking for other detectors":[[18,"checking-for-other-detectors"]],"Chip Test Board":[[3,"chip-test-board"],[17,"chip-test-board"]],"Client":[[27,"client"],[36,"client"],[42,"client"]],"Client Commands":[[34,"client-commands"]],"Client to Module":[[5,"client-to-module"]],"Client to Receiver":[[5,"client-to-receiver"]],"Command Execution":[[4,"command-execution"]],"Command line":[[15,null]],"Command line interface":[[4,null]],"Commands":[[4,"commands"]],"Common":[[37,"common"]],"Compilation":[[14,"compilation"],[42,"compilation"]],"Compile examples":[[11,"compile-examples"]],"Config file":[[39,null]],"Consuming slsDetectorPackage":[[6,null]],"ContainerUtils":[[7,null]],"Content":[[12,"content"]],"Converting numbers to hex":[[23,"converting-numbers-to-hex"]],"Core":[[9,"core"]],"Counters":[[8,"counters"]],"Ctb":[[13,"ctb"],[20,null],[31,"ctb"]],"Current Version":[[41,"current-version"]],"Custom Receiver":[[29,null]],"DACS":[[31,"dacs"],[31,"id1"],[31,"id2"],[31,"id3"],[31,"id4"]],"DAQ Info Field":[[40,"id10"]],"Data":[[27,"data"]],"Data File":[[3,"data-file"],[14,"data-file"]],"Default Configuration":[[8,"default-configuration"],[8,"id25"],[8,"id33"]],"Default Values":[[31,null]],"Default values":[[31,"id5"],[31,"id7"],[31,"id9"],[31,"id11"],[31,"id12"],[31,"id14"]],"Dependencies":[[9,null]],"Dependencies to build GUI":[[9,"dependencies-to-build-gui"]],"Dependencies to build Moench and Jungfrau executables":[[9,"dependencies-to-build-moench-and-jungfrau-executables"]],"Dependencies to build Python module":[[9,"dependencies-to-build-python-module"]],"Dependencies to build Tests":[[9,"dependencies-to-build-tests"]],"Dependencies to build documentation":[[9,"dependencies-to-build-documentation"]],"Deprecated commands":[[4,"deprecated-commands"],[4,"id1"]],"Description":[[41,"description"]],"Detector":[[10,null],[21,null],[27,"detector"]],"Detector Enum":[[41,"detector-enum"]],"Detector Image Size and Format":[[8,null]],"Detector Server":[[15,null]],"Detector Specific Field":[[40,"id8"],[40,"id9"],[40,"id11"],[40,"id12"]],"Detector Specific Fields":[[40,null]],"Detector UDP Header":[[15,null]],"Detector index":[[4,"detector-index"],[18,"detectLine truncated
Search.setIndex({"alltitles":{"$SLSDETNAME":[[18,"slsdetname"]],"1. Install pre-built binaries using conda (Recommended)":[[16,"install-pre-built-binaries-using-conda-recommended"]],"1. Total Failure of Packet Delivery":[[37,"total-failure-of-packet-delivery"]],"1GbE/ 10GbE Interfaces":[[8,"gbe-10gbe-interfaces"],[8,"id29"]],"2. Partial or Random Packet Loss (Performance)":[[37,"partial-or-random-packet-loss-performance"]],"2. Pip":[[16,"pip"]],"3. Build from source":[[16,"build-from-source"]],"3.1. Download Source Code from github":[[16,"download-source-code-from-github"]],"3.2. Build from Source":[[16,"build-from-source-using-cmake"]],"3.2.1. Build using CMake":[[16,"build-using-cmake"]],"3.2.2. Build using in-built cmk.sh script":[[16,"build-using-in-built-cmk-sh-script"]],"3.2.3. Build RPM packages":[[16,"build-rpm-packages"]],"3.3. Build on old distributions using conda":[[16,"build-on-old-distributions-using-conda"]],"3.4. Build slsDetectorGui (Qt5)":[[16,"build-slsdetectorgui-qt5"]],"3.5. Build this documentation":[[16,"build-this-documentation"]],"4. Pybind and Zeromq":[[16,"pybind-and-zeromq"]],"5.0.0 - 6.1.1":[[33,"id1"]],"6.1.1+ (no tftp required)":[[33,"no-tftp-required"]],"< 5.0.0":[[33,"id2"]],"<\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014- 8 bytes per row \u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014>":[[41,"id2"]],"<\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014- 8 bytes \u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014->":[[41,"id3"],[41,"id4"]],"Accessing individual modules":[[24,"accessing-individual-modules"]],"Arguments":[[32,"arguments"],[42,"arguments"]],"Autocompletion":[[4,"autocompletion"]],"Automatic start":[[32,"automatic-start"]],"Binaries":[[42,"binaries"]],"Binary File Format":[[3,null]],"Building from Source":[[24,"building-from-source"]],"C++ API":[[15,null]],"CATCH2 Tests":[[0,"catch2-tests"]],"CMake: find_package and conda":[[6,"cmake-find-package-and-conda"]],"CMake: find_package(slsDetectorPackage)":[[6,"cmake-find-package-slsdetectorpackage"]],"CMake: slsDetectorPackage as submodule in your project":[[6,"cmake-slsdetectorpackage-as-submodule-in-your-project"]],"Cannot connect to detector":[[37,"cannot-connect-to-detector"]],"Cannot connect to receiver":[[37,"cannot-connect-to-receiver"]],"Cannot get data without a module attached":[[37,"cannot-get-data-without-a-module-attached"]],"Cannot get multi module data":[[37,"cannot-get-multi-module-data"],[37,"jungfrau-troubleshooting-power-supply"]],"Cannot ping module (Nios)":[[37,"cannot-ping-module-nios"]],"Cannot stop slaves in sync mode":[[37,"cannot-stop-slaves-in-sync-mode"]],"Checking for other detectors":[[18,"checking-for-other-detectors"]],"Chip Test Board":[[3,"chip-test-board"],[17,"chip-test-board"]],"Client":[[27,"client"],[36,"client"],[42,"client"]],"Client Commands":[[34,"client-commands"]],"Client to Module":[[5,"client-to-module"]],"Client to Receiver":[[5,"client-to-receiver"]],"Command Execution":[[4,"command-execution"]],"Command line":[[15,null]],"Command line interface":[[4,null]],"Commands":[[4,"commands"]],"Common":[[37,"common"]],"Compilation":[[14,"compilation"],[42,"compilation"]],"Compile examples":[[11,"compile-examples"]],"Config file":[[39,null]],"Consuming slsDetectorPackage":[[6,null]],"ContainerUtils":[[7,null]],"Content":[[12,"content"]],"Converting numbers to hex":[[23,"converting-numbers-to-hex"]],"Core":[[9,"core"]],"Counters":[[8,"counters"]],"Ctb":[[13,"ctb"],[20,null],[31,"ctb"]],"Current Version":[[41,"current-version"]],"Custom Receiver":[[29,null]],"DACS":[[31,"dacs"],[31,"id1"],[31,"id2"],[31,"id3"],[31,"id4"]],"DAQ Info Field":[[40,"id10"]],"Data":[[27,"data"]],"Data File":[[3,"data-file"],[14,"data-file"]],"Default Configuration":[[8,"default-configuration"],[8,"id25"],[8,"id33"]],"Default Values":[[31,null]],"Default values":[[31,"id5"],[31,"id7"],[31,"id9"],[31,"id11"],[31,"id12"],[31,"id14"]],"Dependencies":[[9,null]],"Dependencies to build GUI":[[9,"dependencies-to-build-gui"]],"Dependencies to build Moench and Jungfrau executables":[[9,"dependencies-to-build-moench-and-jungfrau-executables"]],"Dependencies to build Python module":[[9,"dependencies-to-build-python-module"]],"Dependencies to build Tests":[[9,"dependencies-to-build-tests"]],"Dependencies to build documentation":[[9,"dependencies-to-build-documentation"]],"Deprecated commands":[[4,"deprecated-commands"],[4,"id1"]],"Description":[[41,"description"]],"Detector":[[10,null],[21,null],[27,"detector"]],"Detector Enum":[[41,"detector-enum"]],"Detector Image Size and Format":[[8,null]],"Detector Server":[[15,null]],"Detector Specific Field":[[40,"id8"],[40,"id9"],[40,"id11"],[40,"id12"]],"Detector Specific Fields":[[40,null]],"Detector UDP Header":[[15,null]],"Detector index":[[4,"detector-index"],[18,"detectLine truncated