2018-09-27 18:32:20 +02:00

412 lines
20 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: slsReceiverUsers Class Reference</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&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><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="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="functions.html"><span>Class&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classslsReceiverUsers-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">slsReceiverUsers Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class for implementing the SLS data receiver in the users application. Callbacks can be defined for processing and/or saving data.
<a href="classslsReceiverUsers.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="slsReceiverUsers_8h_source.html">slsReceiverUsers.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a79a82ba94fbb19761c7701aa3901b8b1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classslsReceiverUsers.html#a79a82ba94fbb19761c7701aa3901b8b1">slsReceiverUsers</a> (int argc, char *argv[], int &amp;success)</td></tr>
<tr class="separator:a79a82ba94fbb19761c7701aa3901b8b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b45943d81ce7a09543aa446de857cb0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classslsReceiverUsers.html#a9b45943d81ce7a09543aa446de857cb0">~slsReceiverUsers</a> ()</td></tr>
<tr class="separator:a9b45943d81ce7a09543aa446de857cb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef40b4987367b8a0116bcb66534dd7b7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classslsReceiverUsers.html#aef40b4987367b8a0116bcb66534dd7b7">start</a> ()</td></tr>
<tr class="separator:aef40b4987367b8a0116bcb66534dd7b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a394001d873a4b7912865a971d4d25f87"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classslsReceiverUsers.html#a394001d873a4b7912865a971d4d25f87">stop</a> ()</td></tr>
<tr class="separator:a394001d873a4b7912865a971d4d25f87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af206092e2744e12ce6b717f4181d91a2"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classslsReceiverUsers.html#af206092e2744e12ce6b717f4181d91a2">getReceiverVersion</a> ()</td></tr>
<tr class="separator:af206092e2744e12ce6b717f4181d91a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ffca5973503b62cefb4a5e3b8f89dfb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classslsReceiverUsers.html#a5ffca5973503b62cefb4a5e3b8f89dfb">registerCallBackStartAcquisition</a> (int(*func)(char *filepath, char *filename, uint64_t fileindex, uint32_t datasize, void *), void *arg)</td></tr>
<tr class="memdesc:a5ffca5973503b62cefb4a5e3b8f89dfb"><td class="mdescLeft">&#160;</td><td class="mdescRight">register calbback for starting the acquisition <a href="#a5ffca5973503b62cefb4a5e3b8f89dfb">More...</a><br/></td></tr>
<tr class="separator:a5ffca5973503b62cefb4a5e3b8f89dfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adacc5da9dd812d62936ac456a73c0738"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classslsReceiverUsers.html#adacc5da9dd812d62936ac456a73c0738">registerCallBackAcquisitionFinished</a> (void(*func)(uint64_t nf, void *), void *arg)</td></tr>
<tr class="memdesc:adacc5da9dd812d62936ac456a73c0738"><td class="mdescLeft">&#160;</td><td class="mdescRight">register callback for end of acquisition <a href="#adacc5da9dd812d62936ac456a73c0738">More...</a><br/></td></tr>
<tr class="separator:adacc5da9dd812d62936ac456a73c0738"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7126b940f6d8f11295ed6eed3e0bad4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classslsReceiverUsers.html#ad7126b940f6d8f11295ed6eed3e0bad4">registerCallBackRawDataReady</a> (void(*func)(char *header, char *datapointer, uint32_t datasize, void *), void *arg)</td></tr>
<tr class="memdesc:ad7126b940f6d8f11295ed6eed3e0bad4"><td class="mdescLeft">&#160;</td><td class="mdescRight">register callback to be called when data are available (to process and/or save the data). <a href="#ad7126b940f6d8f11295ed6eed3e0bad4">More...</a><br/></td></tr>
<tr class="separator:ad7126b940f6d8f11295ed6eed3e0bad4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae10c5eea94bf3bc63ae1acc210582069"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classslsReceiverUsers.html#ae10c5eea94bf3bc63ae1acc210582069">registerCallBackRawDataModifyReady</a> (void(*func)(char *header, char *datapointer, uint32_t &amp;revDatasize, void *), void *arg)</td></tr>
<tr class="memdesc:ae10c5eea94bf3bc63ae1acc210582069"><td class="mdescLeft">&#160;</td><td class="mdescRight">register callback to be called when data are available (to process and/or save the data). <a href="#ae10c5eea94bf3bc63ae1acc210582069">More...</a><br/></td></tr>
<tr class="separator:ae10c5eea94bf3bc63ae1acc210582069"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:abe77f3f45e0be9c3700c5254a84c0bfe"><td class="memItemLeft" align="right" valign="top">slsReceiver *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classslsReceiverUsers.html#abe77f3f45e0be9c3700c5254a84c0bfe">receiver</a></td></tr>
<tr class="separator:abe77f3f45e0be9c3700c5254a84c0bfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class for implementing the SLS data receiver in the users application. Callbacks can be defined for processing and/or saving data. </p>
<p><a class="el" href="classslsReceiverUsers.html" title="Class for implementing the SLS data receiver in the users application. Callbacks can be defined for p...">slsReceiverUsers</a> is a class that can be instantiated in the users software to receive the data from the detectors. Callbacks can be defined for processing and/or saving data </p>
<p>Definition at line <a class="el" href="slsReceiverUsers_8h_source.html#l00015">15</a> of file <a class="el" href="slsReceiverUsers_8h_source.html">slsReceiverUsers.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a79a82ba94fbb19761c7701aa3901b8b1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">slsReceiverUsers::slsReceiverUsers </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>argv</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int &amp;&#160;</td>
<td class="paramname"><em>success</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor reads config file, creates socket, assigns function table </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">argc</td><td>from command line </td></tr>
<tr><td class="paramname">argv</td><td>from command line </td></tr>
<tr><td class="paramname">success</td><td>socket creation was successfull </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9b45943d81ce7a09543aa446de857cb0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">slsReceiverUsers::~slsReceiverUsers </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="af206092e2744e12ce6b717f4181d91a2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t slsReceiverUsers::getReceiverVersion </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get get Receiver Version </p>
<dl class="section return"><dt>Returns</dt><dd>id </dd></dl>
</div>
</div>
<a class="anchor" id="adacc5da9dd812d62936ac456a73c0738"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void slsReceiverUsers::registerCallBackAcquisitionFinished </td>
<td>(</td>
<td class="paramtype">void(*)(uint64_t nf, void *)&#160;</td>
<td class="paramname"><em>func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>arg</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>register callback for end of acquisition </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">func</td><td>end of acquisition callback. Argument nf is total frames caught </td></tr>
<tr><td class="paramname">arg</td><td>argument </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>nothing </dd></dl>
</div>
</div>
<a class="anchor" id="ae10c5eea94bf3bc63ae1acc210582069"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void slsReceiverUsers::registerCallBackRawDataModifyReady </td>
<td>(</td>
<td class="paramtype">void(*)(char *header, char *datapointer, uint32_t &amp;revDatasize, void *)&#160;</td>
<td class="paramname"><em>func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>arg</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>register callback to be called when data are available (to process and/or save the data). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">func</td><td>raw data ready callback. arguments are sls_receiver_header, dataPointer, revDatasize is the reference of data size in bytes. Can be modified to the new size to be written/streamed. (only smaller value). </td></tr>
<tr><td class="paramname">arg</td><td>argument </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>nothing </dd></dl>
</div>
</div>
<a class="anchor" id="ad7126b940f6d8f11295ed6eed3e0bad4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void slsReceiverUsers::registerCallBackRawDataReady </td>
<td>(</td>
<td class="paramtype">void(*)(char *header, char *datapointer, uint32_t datasize, void *)&#160;</td>
<td class="paramname"><em>func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>arg</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>register callback to be called when data are available (to process and/or save the data). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">func</td><td>raw data ready callback. arguments are sls_receiver_header, dataPointer, dataSize </td></tr>
<tr><td class="paramname">arg</td><td>argument </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>nothing </dd></dl>
</div>
</div>
<a class="anchor" id="a5ffca5973503b62cefb4a5e3b8f89dfb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void slsReceiverUsers::registerCallBackStartAcquisition </td>
<td>(</td>
<td class="paramtype">int(*)(char *filepath, char *filename, uint64_t fileindex, uint32_t datasize, void *)&#160;</td>
<td class="paramname"><em>func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>arg</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>register calbback for starting the acquisition </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">func</td><td>callback to be called when starting the acquisition. Its arguments are filepath, filename, fileindex, datasize </td></tr>
<tr><td class="paramname">arg</td><td>argument </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>value is insignificant at the moment, we write depending on file write enable, users get data to write depending on call backs registered </dd></dl>
</div>
</div>
<a class="anchor" id="aef40b4987367b8a0116bcb66534dd7b7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int slsReceiverUsers::start </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>starts listening on the TCP port for client comminication </p>
<dl class="section return"><dt>Returns</dt><dd>0 for success or 1 for FAIL in creating TCP server </dd></dl>
</div>
</div>
<a class="anchor" id="a394001d873a4b7912865a971d4d25f87"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void slsReceiverUsers::stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>stops listening to the TCP &amp; UDP port and exit receiver program </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="abe77f3f45e0be9c3700c5254a84c0bfe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">slsReceiver* slsReceiverUsers::receiver</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="slsReceiverUsers_8h_source.html#l00086">86</a> of file <a class="el" href="slsReceiverUsers_8h_source.html">slsReceiverUsers.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/afs/psi.ch/project/sls_det_software/dhanya_softwareDevelopment/mySoft/slsDetectorPackage/slsReceiverSoftware/include/<a class="el" href="slsReceiverUsers_8h_source.html">slsReceiverUsers.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>