mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2025-04-28 17:10:03 +02:00
150 lines
15 KiB
HTML
150 lines
15 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.5"/>
|
|
<title>My Project: /afs/psi.ch/project/sls_det_software/dhanya_softwareDevelopment/mySoft/test/slsDetectorPackage/slsReceiverSoftware/include/slsReceiverUsers.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">My Project
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Macros</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_2a81099005c87b10dbd3ab3fe073d08e.html">slsReceiverSoftware</a></li><li class="navelem"><a class="el" href="dir_cda5313c19a4ccff8ceebb4444cecd0a.html">include</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">slsReceiverUsers.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="slsReceiverUsers_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor">#include <stdio.h></span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <stdint.h></span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="keyword">class </span>slsReceiver;</div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="classslsReceiverUsers.html"> 15</a></span> <span class="keyword">class </span><a class="code" href="classslsReceiverUsers.html">slsReceiverUsers</a> {</div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <a class="code" href="classslsReceiverUsers.html#a79a82ba94fbb19761c7701aa3901b8b1">slsReceiverUsers</a>(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> *argv[], <span class="keywordtype">int</span> &success);</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <a class="code" href="classslsReceiverUsers.html#a9b45943d81ce7a09543aa446de857cb0">~slsReceiverUsers</a>();</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordtype">int</span> <a class="code" href="classslsReceiverUsers.html#aef40b4987367b8a0116bcb66534dd7b7">start</a>();</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">void</span> <a class="code" href="classslsReceiverUsers.html#a394001d873a4b7912865a971d4d25f87">stop</a>();</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  int64_t <a class="code" href="classslsReceiverUsers.html#af206092e2744e12ce6b717f4181d91a2">getReceiverVersion</a>();</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">void</span> <a class="code" href="classslsReceiverUsers.html#a5ffca5973503b62cefb4a5e3b8f89dfb">registerCallBackStartAcquisition</a>(<span class="keywordtype">int</span> (*func)(<span class="keywordtype">char</span>* filepath, <span class="keywordtype">char</span>* filename, uint64_t fileindex, uint32_t datasize, <span class="keywordtype">void</span>*),<span class="keywordtype">void</span> *arg);</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">void</span> <a class="code" href="classslsReceiverUsers.html#adacc5da9dd812d62936ac456a73c0738">registerCallBackAcquisitionFinished</a>(<span class="keywordtype">void</span> (*func)(uint64_t nf, <span class="keywordtype">void</span>*),<span class="keywordtype">void</span> *arg);</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">void</span> <a class="code" href="classslsReceiverUsers.html#ad7126b940f6d8f11295ed6eed3e0bad4">registerCallBackRawDataReady</a>(<span class="keywordtype">void</span> (*func)(<span class="keywordtype">char</span>* header,</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordtype">char</span>* datapointer, uint32_t datasize, <span class="keywordtype">void</span>*),<span class="keywordtype">void</span> *arg);</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">void</span> <a class="code" href="classslsReceiverUsers.html#ae10c5eea94bf3bc63ae1acc210582069">registerCallBackRawDataModifyReady</a>(<span class="keywordtype">void</span> (*func)(<span class="keywordtype">char</span>* header,</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">char</span>* datapointer, uint32_t &revDatasize, <span class="keywordtype">void</span>*),<span class="keywordtype">void</span> *arg);</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="comment">//receiver object</span></div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="classslsReceiverUsers.html#abe77f3f45e0be9c3700c5254a84c0bfe"> 86</a></span>  slsReceiver* <a class="code" href="classslsReceiverUsers.html#abe77f3f45e0be9c3700c5254a84c0bfe">receiver</a>;</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> };</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div>
|
|
<div class="ttc" id="classslsReceiverUsers_html_ad7126b940f6d8f11295ed6eed3e0bad4"><div class="ttname"><a href="classslsReceiverUsers.html#ad7126b940f6d8f11295ed6eed3e0bad4">slsReceiverUsers::registerCallBackRawDataReady</a></div><div class="ttdeci">void registerCallBackRawDataReady(void(*func)(char *header, char *datapointer, uint32_t datasize, void *), void *arg)</div><div class="ttdoc">register callback to be called when data are available (to process and/or save the data)...</div></div>
|
|
<div class="ttc" id="classslsReceiverUsers_html_a79a82ba94fbb19761c7701aa3901b8b1"><div class="ttname"><a href="classslsReceiverUsers.html#a79a82ba94fbb19761c7701aa3901b8b1">slsReceiverUsers::slsReceiverUsers</a></div><div class="ttdeci">slsReceiverUsers(int argc, char *argv[], int &success)</div></div>
|
|
<div class="ttc" id="classslsReceiverUsers_html_a9b45943d81ce7a09543aa446de857cb0"><div class="ttname"><a href="classslsReceiverUsers.html#a9b45943d81ce7a09543aa446de857cb0">slsReceiverUsers::~slsReceiverUsers</a></div><div class="ttdeci">~slsReceiverUsers()</div></div>
|
|
<div class="ttc" id="classslsReceiverUsers_html_adacc5da9dd812d62936ac456a73c0738"><div class="ttname"><a href="classslsReceiverUsers.html#adacc5da9dd812d62936ac456a73c0738">slsReceiverUsers::registerCallBackAcquisitionFinished</a></div><div class="ttdeci">void registerCallBackAcquisitionFinished(void(*func)(uint64_t nf, void *), void *arg)</div><div class="ttdoc">register callback for end of acquisition </div></div>
|
|
<div class="ttc" id="classslsReceiverUsers_html_a394001d873a4b7912865a971d4d25f87"><div class="ttname"><a href="classslsReceiverUsers.html#a394001d873a4b7912865a971d4d25f87">slsReceiverUsers::stop</a></div><div class="ttdeci">void stop()</div></div>
|
|
<div class="ttc" id="classslsReceiverUsers_html_af206092e2744e12ce6b717f4181d91a2"><div class="ttname"><a href="classslsReceiverUsers.html#af206092e2744e12ce6b717f4181d91a2">slsReceiverUsers::getReceiverVersion</a></div><div class="ttdeci">int64_t getReceiverVersion()</div></div>
|
|
<div class="ttc" id="classslsReceiverUsers_html_abe77f3f45e0be9c3700c5254a84c0bfe"><div class="ttname"><a href="classslsReceiverUsers.html#abe77f3f45e0be9c3700c5254a84c0bfe">slsReceiverUsers::receiver</a></div><div class="ttdeci">slsReceiver * receiver</div><div class="ttdef"><b>Definition:</b> <a href="slsReceiverUsers_8h_source.html#l00086">slsReceiverUsers.h:86</a></div></div>
|
|
<div class="ttc" id="classslsReceiverUsers_html"><div class="ttname"><a href="classslsReceiverUsers.html">slsReceiverUsers</a></div><div class="ttdoc">Class for implementing the SLS data receiver in the users application. Callbacks can be defined for p...</div><div class="ttdef"><b>Definition:</b> <a href="slsReceiverUsers_8h_source.html#l00015">slsReceiverUsers.h:15</a></div></div>
|
|
<div class="ttc" id="classslsReceiverUsers_html_aef40b4987367b8a0116bcb66534dd7b7"><div class="ttname"><a href="classslsReceiverUsers.html#aef40b4987367b8a0116bcb66534dd7b7">slsReceiverUsers::start</a></div><div class="ttdeci">int start()</div></div>
|
|
<div class="ttc" id="classslsReceiverUsers_html_a5ffca5973503b62cefb4a5e3b8f89dfb"><div class="ttname"><a href="classslsReceiverUsers.html#a5ffca5973503b62cefb4a5e3b8f89dfb">slsReceiverUsers::registerCallBackStartAcquisition</a></div><div class="ttdeci">void registerCallBackStartAcquisition(int(*func)(char *filepath, char *filename, uint64_t fileindex, uint32_t datasize, void *), void *arg)</div><div class="ttdoc">register calbback for starting the acquisition </div></div>
|
|
<div class="ttc" id="classslsReceiverUsers_html_ae10c5eea94bf3bc63ae1acc210582069"><div class="ttname"><a href="classslsReceiverUsers.html#ae10c5eea94bf3bc63ae1acc210582069">slsReceiverUsers::registerCallBackRawDataModifyReady</a></div><div class="ttdeci">void registerCallBackRawDataModifyReady(void(*func)(char *header, char *datapointer, uint32_t &revDatasize, void *), void *arg)</div><div class="ttdoc">register callback to be called when data are available (to process and/or save the data)...</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.5
|
|
</small></address>
|
|
</body>
|
|
</html>
|