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

updated users documentation

Browse Source
This commit is contained in:
Dhanya Maliakal
2017-08-25 15:42:56 +02:00
parent 891e76af0a
commit ce0aa98b3f
32 changed files with 586 additions and 398 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
manual/docs/html/slsDetectorUsersDocs/mainClient_8cpp.html
View File

@ -43,9 +43,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</div>
</div>
<div class="contents">
<h1>mainClient.cpp File Reference</h1><code>#include &lt;iostream&gt;</code><br/>
<code>#include &quot;<a class="el" href="slsDetectorUsers_8h_source.html">slsDetectorUsers.h</a>&quot;</code><br/>
<h1>mainClient.cpp File Reference</h1><code>#include &quot;<a class="el" href="slsDetectorUsers_8h_source.html">slsDetectorUsers.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="detectorData_8h_source.html">detectorData.h</a>&quot;</code><br/>
<code>#include &lt;iostream&gt;</code><br/>
<code>#include &lt;cstdlib&gt;</code><br/>
<p><a href="mainClient_8cpp_source.html">Go to the source code of this file.</a></p>
@ -56,8 +56,10 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This file is an example of how to implement the <a class="el" href="classslsDetectorUsers.html" title="Class for detector functionalitiesto embed the detector controls in the users custom...">slsDetectorUsers</a> class You can compile it linking it to the slsDetector library</p>
<p>gcc <a class="el" href="mainClient_8cpp.html">mainClient.cpp</a> -L lib -l SlsDetector -lm -pthread</p>
<p>where lib is the location of libSlsDetector.so gcc <a class="el" href="mainClient_8cpp.html">mainClient.cpp</a> -L . -l SlsDetector -lm -pthread -o users </p>
<p>g++ <a class="el" href="mainClient_8cpp.html">mainClient.cpp</a> -L lib -lSlsDetector -L/usr/lib64/ -L lib2 -lzmq -pthread -lrt -lm -lstdc++</p>
<p>where,</p>
<p>lib is the location of libSlsDetector.so</p>
<p>lib2 is the location of the libzmq.a. [ libzmq.a is required only when using data call backs and enabling data streaming from receiver to client. It is linked in manual/manual-api from slsReceiverSoftware/include ] </p>
<p>Definition in file <a class="el" href="mainClient_8cpp_source.html">mainClient.cpp</a>.</p>
<hr/><h2>Function Documentation</h2>
@ -97,9 +99,19 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</table>
</div>
<div class="memdoc">
<p>Definition of the data callback which simply prints out the number of points received and teh frame number </p>
<p>Data Call back function defined </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pData</em>&nbsp;</td><td>pointer to data structure received from the call back </td></tr>
<tr><td valign="top"></td><td valign="top"><em>iframe</em>&nbsp;</td><td>frame number of data passed </td></tr>
<tr><td valign="top"></td><td valign="top"><em>isubframe</em>&nbsp;</td><td>sub frame number of data passed ( only valid for EIGER in 32 bit mode) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pArg</em>&nbsp;</td><td>pointer to object </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>integer that is currently ignored </dd></dl>
<p>Definition at line <a class="el" href="mainClient_8cpp_source.html#l00020">20</a> of file <a class="el" href="mainClient_8cpp_source.html">mainClient.cpp</a>.</p>
<p>Definition at line <a class="el" href="mainClient_8cpp_source.html#l00032">32</a> of file <a class="el" href="mainClient_8cpp_source.html">mainClient.cpp</a>.</p>
</div>
</div>
@ -127,19 +139,49 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</table>
</div>
<div class="memdoc">
<p>example of a main program using the <a class="el" href="classslsDetectorUsers.html" title="Class for detector functionalitiesto embed the detector controls in the users custom...">slsDetectorUsers</a> class </p>
<p>Example of a main program using the <a class="el" href="classslsDetectorUsers.html" title="Class for detector functionalitiesto embed the detector controls in the users custom...">slsDetectorUsers</a> class</p>
<ul>
<li>Arguments are optional<ul>
<li>argv[1] : Configuration File</li>
<li>argv[2] : Measurement Setup File</li>
<li>argv[3] : Detector Id (default is zero) </li>
</ul>
</li>
</ul>
<p><p>if specified, argv[3] is used as detector ID (default is 0)</p>
<p><a class="el" href="classslsDetectorUsers.html" title="Class for detector functionalitiesto embed the detector controls in the users custom...">slsDetectorUsers</a> is instantiated</p>
<p>if specified, argv[1] is used as detector config file (necessary at least the first time it is called to properly configure advanced settings in the shared memory)</p>
<p>registering data callback</p>
<p>checking detector status and exiting if not idle</p>
<p>load detector settings</p>
<p>start measurement</p>
<p>returning when acquisition is finished or data are avilable </p>
<p><ul>
<li>if specified, set ID from argv[3]</li>
</ul>
<ul>
<li><a class="el" href="classslsDetectorUsers.html" title="Class for detector functionalitiesto embed the detector controls in the users custom...">slsDetectorUsers</a> Object is instantiated with appropriate ID</li>
</ul>
<ul>
<li>if specified, load configuration file (necessary at least the first time it is called to properly configure advanced settings in the shared memory)</li>
</ul>
<ul>
<li>registering data callback</li>
</ul>
<ul>
<li>if receiver exists, enable data streaming from receiver to get the data</li>
</ul>
<ul>
<li>ensuring detector status is idle before starting acquisition. exiting if not idle</li>
</ul>
<ul>
<li>if provided, load detector settings</li>
</ul>
<ul>
<li>start measurement</li>
</ul>
<ul>
<li>returning when acquisition is finished or data are avilable</li>
</ul>
<ul>
<li>delete <a class="el" href="classslsDetectorUsers.html" title="Class for detector functionalitiesto embed the detector controls in the users custom...">slsDetectorUsers</a> object </li>
</ul>
</p>
<p>Definition at line <a class="el" href="mainClient_8cpp_source.html#l00027">27</a> of file <a class="el" href="mainClient_8cpp_source.html">mainClient.cpp</a>.</p>
<p>Definition at line <a class="el" href="mainClient_8cpp_source.html#l00046">46</a> of file <a class="el" href="mainClient_8cpp_source.html">mainClient.cpp</a>.</p>
</div>
</div>
@ -158,7 +200,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 24 Aug 2017 by&nbsp;
<hr size="1"/><address style="text-align: right;"><small>Generated on 25 Aug 2017 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>