detectors/slsDetectorPackage
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/slsDetectorPackage.git synced 2025-06-12 21:07:13 +02:00
Code Issues Actions Packages Releases Activity

updating user documentation

Browse Source
This commit is contained in:
Dhanya Maliakal
2017-08-25 15:46:42 +02:00
parent 0de9682e72
commit 705e1a762c
4 changed files with 204 additions and 206 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
manual/docs/html/slsDetectorUsersDocs/classslsDetectorUsers.html
View File

@ -186,7 +186,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<p>Class for detector functionalitiesto embed the detector controls in the users custom interface e.g. EPICS, Lima etc. </p>
<p>The <a class="el" href="classslsDetectorUsers.html" title="Class for detector functionalitiesto embed the detector controls in the users custom...">slsDetectorUsers</a> class is a minimal interface class which should be instantiated by the users in their acquisition software (EPICS, spec etc.). More advanced configuration functions are not implemented and can be written in a configuration or parameters file that can be read/written. </p>
<p>Definition at line <a class="el" href="slsDetectorUsers_8h_source.html#l00084">84</a> of file <a class="el" href="slsDetectorUsers_8h_source.html">slsDetectorUsers.h</a>.</p>
<p>Definition at line <a class="el" href="slsDetectorUsers_8h_source.html#l00085">85</a> of file <a class="el" href="slsDetectorUsers_8h_source.html">slsDetectorUsers.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a17323cd635b9e5c2916be3ca30ec748c"></a><!-- doxytag: member="slsDetectorUsers::slsDetectorUsers" ref="a17323cd635b9e5c2916be3ca30ec748c" args="(int id=0)" -->
<div class="memitem">
@ -649,7 +649,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>standard, fast, highgain, dynamicgain, lowgain, mediumgain, veryhighgain, undefined when wrong index </dd></dl>
<p>Definition at line <a class="el" href="slsDetectorUsers_8h_source.html#l00585">585</a> of file <a class="el" href="slsDetectorUsers_8h_source.html">slsDetectorUsers.h</a>.</p>
<p>Definition at line <a class="el" href="slsDetectorUsers_8h_source.html#l00586">586</a> of file <a class="el" href="slsDetectorUsers_8h_source.html">slsDetectorUsers.h</a>.</p>
</div>
</div>
@ -678,7 +678,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>setting index (-1 unknown string) </dd></dl>
<p>Definition at line <a class="el" href="slsDetectorUsers_8h_source.html#l00571">571</a> of file <a class="el" href="slsDetectorUsers_8h_source.html">slsDetectorUsers.h</a>.</p>
<p>Definition at line <a class="el" href="slsDetectorUsers_8h_source.html#l00572">572</a> of file <a class="el" href="slsDetectorUsers_8h_source.html">slsDetectorUsers.h</a>.</p>
</div>
</div>
@ -1062,7 +1062,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>auto, trigger, ro_trigger, gating, triggered_gating, unknown when wrong mode </dd></dl>
<p>Definition at line <a class="el" href="slsDetectorUsers_8h_source.html#l00621">621</a> of file <a class="el" href="slsDetectorUsers_8h_source.html">slsDetectorUsers.h</a>.</p>
<p>Definition at line <a class="el" href="slsDetectorUsers_8h_source.html#l00622">622</a> of file <a class="el" href="slsDetectorUsers_8h_source.html">slsDetectorUsers.h</a>.</p>
</div>
</div>
@ -1091,7 +1091,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>auto, trigger, ro_trigger, gating, triggered_gating, unknown when wrong mode </dd></dl>
<p>Definition at line <a class="el" href="slsDetectorUsers_8h_source.html#l00605">605</a> of file <a class="el" href="slsDetectorUsers_8h_source.html">slsDetectorUsers.h</a>.</p>
<p>Definition at line <a class="el" href="slsDetectorUsers_8h_source.html#l00606">606</a> of file <a class="el" href="slsDetectorUsers_8h_source.html">slsDetectorUsers.h</a>.</p>
</div>
</div>
@ -1559,7 +1559,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>string error, waiting, running, data, finished or unknown when wrong index </dd></dl>
<p>Definition at line <a class="el" href="slsDetectorUsers_8h_source.html#l00553">553</a> of file <a class="el" href="slsDetectorUsers_8h_source.html">slsDetectorUsers.h</a>.</p>
<p>Definition at line <a class="el" href="slsDetectorUsers_8h_source.html#l00554">554</a> of file <a class="el" href="slsDetectorUsers_8h_source.html">slsDetectorUsers.h</a>.</p>
</div>
</div>