igor-public/doc/html/pearl-preparation_8ipf.html

210 lines
9.9 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.9.1"/>
<title>PEARL Procedures: pearl-preparation.ipf File 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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">PEARL Procedures
</div>
<div id="projectbrief">Igor procedures for the analysis of PEARL data</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<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><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Packages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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&#160;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('pearl-preparation_8ipf.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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 class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">pearl-preparation.ipf File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>PEARL sample preparation package.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;pearl-area-display&quot;</code><br />
<code>#include &quot;pearl-area-profiles&quot;</code><br />
<code>#include &quot;pearl-elog&quot;</code><br />
</div>
<p><a href="pearl-preparation_8ipf_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespace_pearl_preparation"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_pearl_preparation.html">PearlPreparation</a></td></tr>
<tr class="memdesc:namespace_pearl_preparation"><td class="mdescLeft">&#160;</td><td class="mdescRight">PEARL sample preparation package. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a8e4eacc6efacf2c65615c1ea72d722ed"><td class="memItemLeft" align="right" valign="top">static variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-preparation_8ipf.html#a8e4eacc6efacf2c65615c1ea72d722ed">AfterCompiledHook</a> ()</td></tr>
<tr class="memdesc:a8e4eacc6efacf2c65615c1ea72d722ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">initializes package data once when the procedure is first loaded <a href="#a8e4eacc6efacf2c65615c1ea72d722ed">More...</a><br /></td></tr>
<tr class="separator:a8e4eacc6efacf2c65615c1ea72d722ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae0e7e9a648143f006d6701d178914cf"><td class="memItemLeft" align="right" valign="top">variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-preparation_8ipf.html#aae0e7e9a648143f006d6701d178914cf">UnloadPearlPreparationPackage</a> ()</td></tr>
<tr class="separator:aae0e7e9a648143f006d6701d178914cf"><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>PEARL sample preparation package. </p>
<p>this procedure defines the PEARL sample preparation package the main purpose of this file is to load the necessary dependent procedures (see the include statements at the top)</p>
<dl class="section pre"><dt>Precondition</dt><dd><ul>
<li>on-line process control functionality requires the EPICS XOP to be loaded</li>
</ul>
</dd></dl>
<dl class="section author"><dt>Author</dt><dd>matthias muntwiler, <a href="#" onclick="location.href='mai'+'lto:'+'mat'+'th'+'ias'+'.m'+'unt'+'wi'+'ler'+'@p'+'si.'+'ch'; return false;">matth<span style="display: none;">.nosp@m.</span>ias.<span style="display: none;">.nosp@m.</span>muntw<span style="display: none;">.nosp@m.</span>iler<span style="display: none;">.nosp@m.</span>@psi.<span style="display: none;">.nosp@m.</span>ch</a></dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>2015 Paul Scherrer Institut <br />
Licensed under the Apache License, Version 2.0 (the "License"); <br />
you may not use this file except in compliance with the License. <br />
You may obtain a copy of the License at <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a> </dd></dl>
<p>Definition in file <a class="el" href="pearl-preparation_8ipf_source.html">pearl-preparation.ipf</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a8e4eacc6efacf2c65615c1ea72d722ed"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static variable AfterCompiledHook </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>initializes package data once when the procedure is first loaded </p>
<p>Definition at line <a class="el" href="pearl-preparation_8ipf_source.html#l00063">63</a> of file <a class="el" href="pearl-preparation_8ipf_source.html">pearl-preparation.ipf</a>.</p>
</div>
</div>
<a class="anchor" id="aae0e7e9a648143f006d6701d178914cf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">variable UnloadPearlPreparationPackage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="pearl-preparation_8ipf_source.html#l00070">70</a> of file <a class="el" href="pearl-preparation_8ipf_source.html">pearl-preparation.ipf</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_fe5dc42579d4b99403482a3a637d9f7d.html">pearl</a></li><li class="navelem"><a class="el" href="pearl-preparation_8ipf.html">pearl-preparation.ipf</a></li>
<li class="footer">Generated on Sat Apr 9 2016 13:10:44 for PEARL Procedures by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
</ul>
</div>
</body>
</html>