matthias muntwiler
cf1399e59c
FEATURES - pshell: convert scienta data to true counts - pre-process: add gauss2_reduction data reduction function - anglescan: add set_contrast and normalize_strip_phi functions - explorer: show info about multi-region scans - documentation: add detailed instructions for angle-scan processing BUGFIXES - explorer: fix attributes notebook - pshell: fix progress bar - elog: increase the number of accepted attachments
2292 lines
109 KiB
HTML
2292 lines
109 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.11"/>
|
|
<title>PEARL Procedures: pearl-elog.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 id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">PEARL Procedures
|
|
 <span id="projectnumber">rev-distro-1.4.0-1-g0a436db-dirty</span>
|
|
</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.11 -->
|
|
<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="pages.html"><span>Related 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 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-elog_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> |
|
|
<a href="#func-members">Functions</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">pearl-elog.ipf File Reference<div class="ingroups"><a class="el" href="group___arpes_package.html">ARPES package</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>interface for writing ELOG entries with Igor graphs as attachment.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><a href="pearl-elog_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_elog"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_pearl_elog.html">PearlElog</a></td></tr>
|
|
<tr class="memdesc:namespace_pearl_elog"><td class="mdescLeft"> </td><td class="mdescRight">interface for writing ELOG entries with Igor graphs as attachment. <br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </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:a4088a48a8428629f120c08a419af62d6"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a4088a48a8428629f120c08a419af62d6">pearl_elog</a> (string logbook)</td></tr>
|
|
<tr class="memdesc:a4088a48a8428629f120c08a419af62d6"><td class="mdescLeft"> </td><td class="mdescRight">main function to initialize ELOG and to open an ELOG panel. <a href="#a4088a48a8428629f120c08a419af62d6">More...</a><br /></td></tr>
|
|
<tr class="separator:a4088a48a8428629f120c08a419af62d6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae824bbf81f8b7d16b36b53e3f3d85f69"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#ae824bbf81f8b7d16b36b53e3f3d85f69">IgorBeforeNewHook</a> (string igorApplicationNameStr)</td></tr>
|
|
<tr class="memdesc:ae824bbf81f8b7d16b36b53e3f3d85f69"><td class="mdescLeft"> </td><td class="mdescRight">save preferences and recent values before Igor opens a new experiment. <a href="#ae824bbf81f8b7d16b36b53e3f3d85f69">More...</a><br /></td></tr>
|
|
<tr class="separator:ae824bbf81f8b7d16b36b53e3f3d85f69"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6fcae5eafc97bca9a637bd7800b13e25"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a6fcae5eafc97bca9a637bd7800b13e25">IgorQuitHook</a> (string igorApplicationNameStr)</td></tr>
|
|
<tr class="memdesc:a6fcae5eafc97bca9a637bd7800b13e25"><td class="mdescLeft"> </td><td class="mdescRight">save preferences and recent values before Igor quits. <a href="#a6fcae5eafc97bca9a637bd7800b13e25">More...</a><br /></td></tr>
|
|
<tr class="separator:a6fcae5eafc97bca9a637bd7800b13e25"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3f524f5190341d2accc8cb8c3ed2ceb5"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a3f524f5190341d2accc8cb8c3ed2ceb5">AfterFileOpenHook</a> (variable refNum, string file, string pathName, string type, string creator, variable kind)</td></tr>
|
|
<tr class="memdesc:a3f524f5190341d2accc8cb8c3ed2ceb5"><td class="mdescLeft"> </td><td class="mdescRight">initialize the package and reload preferences after an experiment is loaded. <a href="#a3f524f5190341d2accc8cb8c3ed2ceb5">More...</a><br /></td></tr>
|
|
<tr class="separator:a3f524f5190341d2accc8cb8c3ed2ceb5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac45196cb9ce8b43b76c9daf67689c49a"><td class="memItemLeft" align="right" valign="top">static dfr </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#ac45196cb9ce8b43b76c9daf67689c49a">get_elog_df</a> (string name, variable category)</td></tr>
|
|
<tr class="memdesc:ac45196cb9ce8b43b76c9daf67689c49a"><td class="mdescLeft"> </td><td class="mdescRight">get the package, logbook, or template datafolder. <a href="#ac45196cb9ce8b43b76c9daf67689c49a">More...</a><br /></td></tr>
|
|
<tr class="separator:ac45196cb9ce8b43b76c9daf67689c49a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7a4572f4f861f7eb46c932508d1164f9"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a7a4572f4f861f7eb46c932508d1164f9">init_package</a> (variable clean=defaultValue)</td></tr>
|
|
<tr class="memdesc:a7a4572f4f861f7eb46c932508d1164f9"><td class="mdescLeft"> </td><td class="mdescRight">initialize the package data folder. <a href="#a7a4572f4f861f7eb46c932508d1164f9">More...</a><br /></td></tr>
|
|
<tr class="separator:a7a4572f4f861f7eb46c932508d1164f9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaca820a0149ce6a0e843ca72b9c9e7ab"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#aaca820a0149ce6a0e843ca72b9c9e7ab">elog_init_pearl_templates</a> ()</td></tr>
|
|
<tr class="memdesc:aaca820a0149ce6a0e843ca72b9c9e7ab"><td class="mdescLeft"> </td><td class="mdescRight">setup PEARL template logbooks. <a href="#aaca820a0149ce6a0e843ca72b9c9e7ab">More...</a><br /></td></tr>
|
|
<tr class="separator:aaca820a0149ce6a0e843ca72b9c9e7ab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a85cf9d39ea917860b463b1b4111705f2"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a85cf9d39ea917860b463b1b4111705f2">init_volatile_vars</a> ()</td></tr>
|
|
<tr class="memdesc:a85cf9d39ea917860b463b1b4111705f2"><td class="mdescLeft"> </td><td class="mdescRight">initialize volatile variables. <a href="#a85cf9d39ea917860b463b1b4111705f2">More...</a><br /></td></tr>
|
|
<tr class="separator:a85cf9d39ea917860b463b1b4111705f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab6d97edbf33e8ec039b34ff756e7ab93"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#ab6d97edbf33e8ec039b34ff756e7ab93">elog_create_logbook</a> (string name, string template=defaultValue)</td></tr>
|
|
<tr class="memdesc:ab6d97edbf33e8ec039b34ff756e7ab93"><td class="mdescLeft"> </td><td class="mdescRight">create a new logbook. <a href="#ab6d97edbf33e8ec039b34ff756e7ab93">More...</a><br /></td></tr>
|
|
<tr class="separator:ab6d97edbf33e8ec039b34ff756e7ab93"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a424460442afd5f6f853e68cd665ed785"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a424460442afd5f6f853e68cd665ed785">elog_config</a> (string elog_path=defaultValue, string hostname=defaultValue, variable port=defaultValue, string subdir=defaultValue)</td></tr>
|
|
<tr class="memdesc:a424460442afd5f6f853e68cd665ed785"><td class="mdescLeft"> </td><td class="mdescRight">set global module configuration parameters <a href="#a424460442afd5f6f853e68cd665ed785">More...</a><br /></td></tr>
|
|
<tr class="separator:a424460442afd5f6f853e68cd665ed785"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3eac4012891c2813e401aee2c1134763"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a3eac4012891c2813e401aee2c1134763">elog_login</a> (string logbook, string username, string password)</td></tr>
|
|
<tr class="memdesc:a3eac4012891c2813e401aee2c1134763"><td class="mdescLeft"> </td><td class="mdescRight">set username and password for login to a logbook <a href="#a3eac4012891c2813e401aee2c1134763">More...</a><br /></td></tr>
|
|
<tr class="separator:a3eac4012891c2813e401aee2c1134763"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a96e4cbbdb0fd8c58d87b502dc1883664"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a96e4cbbdb0fd8c58d87b502dc1883664">elog_logout</a> (string logbook)</td></tr>
|
|
<tr class="memdesc:a96e4cbbdb0fd8c58d87b502dc1883664"><td class="mdescLeft"> </td><td class="mdescRight">clear username and password of a logbook or all logbooks. <a href="#a96e4cbbdb0fd8c58d87b502dc1883664">More...</a><br /></td></tr>
|
|
<tr class="separator:a96e4cbbdb0fd8c58d87b502dc1883664"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac729557a307bddd2f2ad298199976c01"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#ac729557a307bddd2f2ad298199976c01">save_prefs</a> ()</td></tr>
|
|
<tr class="memdesc:ac729557a307bddd2f2ad298199976c01"><td class="mdescLeft"> </td><td class="mdescRight">save persistent package data to the preferences file. <a href="#ac729557a307bddd2f2ad298199976c01">More...</a><br /></td></tr>
|
|
<tr class="separator:ac729557a307bddd2f2ad298199976c01"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a92c27964d49ab8bcd7afc858ebe214a3"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a92c27964d49ab8bcd7afc858ebe214a3">load_prefs</a> ()</td></tr>
|
|
<tr class="memdesc:a92c27964d49ab8bcd7afc858ebe214a3"><td class="mdescLeft"> </td><td class="mdescRight">load persistent package data from the preferences file. <a href="#a92c27964d49ab8bcd7afc858ebe214a3">More...</a><br /></td></tr>
|
|
<tr class="separator:a92c27964d49ab8bcd7afc858ebe214a3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a356bebea8eb41c9ac3ea2148af22707f"><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a356bebea8eb41c9ac3ea2148af22707f">list_logbooks</a> (variable templates=defaultValue)</td></tr>
|
|
<tr class="memdesc:a356bebea8eb41c9ac3ea2148af22707f"><td class="mdescLeft"> </td><td class="mdescRight">get a list of configured logbooks or templates. <a href="#a356bebea8eb41c9ac3ea2148af22707f">More...</a><br /></td></tr>
|
|
<tr class="separator:a356bebea8eb41c9ac3ea2148af22707f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab2558ef5cd5e5dfba410bd58ed258b64"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#ab2558ef5cd5e5dfba410bd58ed258b64">elog_validate_attributes</a> (string logbook, string attributes)</td></tr>
|
|
<tr class="memdesc:ab2558ef5cd5e5dfba410bd58ed258b64"><td class="mdescLeft"> </td><td class="mdescRight">validate attributes <a href="#ab2558ef5cd5e5dfba410bd58ed258b64">More...</a><br /></td></tr>
|
|
<tr class="separator:ab2558ef5cd5e5dfba410bd58ed258b64"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a05301d497e4796e5fb5adde3728ba971"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a05301d497e4796e5fb5adde3728ba971">elog_create_entry</a> (string logbook, string attributes, string message, variable encoding=defaultValue, string graphs=defaultValue, variable replyto=defaultValue)</td></tr>
|
|
<tr class="memdesc:a05301d497e4796e5fb5adde3728ba971"><td class="mdescLeft"> </td><td class="mdescRight">create a new entry in ELOG <a href="#a05301d497e4796e5fb5adde3728ba971">More...</a><br /></td></tr>
|
|
<tr class="separator:a05301d497e4796e5fb5adde3728ba971"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac2f76abed8cfaa7ac02a46c0b89004f0"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#ac2f76abed8cfaa7ac02a46c0b89004f0">elog_add_attachment</a> (string logbook, variable id, string graphs)</td></tr>
|
|
<tr class="memdesc:ac2f76abed8cfaa7ac02a46c0b89004f0"><td class="mdescLeft"> </td><td class="mdescRight">add one or more graphs to an existing ELOG entry <a href="#ac2f76abed8cfaa7ac02a46c0b89004f0">More...</a><br /></td></tr>
|
|
<tr class="separator:ac2f76abed8cfaa7ac02a46c0b89004f0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd15431defaec6d770cc8cab2a40e6b0"><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#abd15431defaec6d770cc8cab2a40e6b0">prepare_command_line</a> (string logbook)</td></tr>
|
|
<tr class="memdesc:abd15431defaec6d770cc8cab2a40e6b0"><td class="mdescLeft"> </td><td class="mdescRight">format the ELOG command and essential address arguments. <a href="#abd15431defaec6d770cc8cab2a40e6b0">More...</a><br /></td></tr>
|
|
<tr class="separator:abd15431defaec6d770cc8cab2a40e6b0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3cc9074c84d684d207dfdf2045755df4"><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a3cc9074c84d684d207dfdf2045755df4">format_url</a> (string logbook)</td></tr>
|
|
<tr class="memdesc:a3cc9074c84d684d207dfdf2045755df4"><td class="mdescLeft"> </td><td class="mdescRight">format the URL for display to the user <a href="#a3cc9074c84d684d207dfdf2045755df4">More...</a><br /></td></tr>
|
|
<tr class="separator:a3cc9074c84d684d207dfdf2045755df4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4986de01085dc5481500240ef7667419"><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a4986de01085dc5481500240ef7667419">prepare_graph_attachments</a> (string graphs)</td></tr>
|
|
<tr class="memdesc:a4986de01085dc5481500240ef7667419"><td class="mdescLeft"> </td><td class="mdescRight">prepare screenshots of graph windows for attachments <a href="#a4986de01085dc5481500240ef7667419">More...</a><br /></td></tr>
|
|
<tr class="separator:a4986de01085dc5481500240ef7667419"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6b2d6cf641c61120332ac1983b2f3846"><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a6b2d6cf641c61120332ac1983b2f3846">get_timestamp</a> (string sep)</td></tr>
|
|
<tr class="separator:a6b2d6cf641c61120332ac1983b2f3846"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af652f6f257be1ee749fe788d1b03f75f"><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#af652f6f257be1ee749fe788d1b03f75f">create_message_file</a> (string message)</td></tr>
|
|
<tr class="memdesc:af652f6f257be1ee749fe788d1b03f75f"><td class="mdescLeft"> </td><td class="mdescRight">save the message to a temporary text file <a href="#af652f6f257be1ee749fe788d1b03f75f">More...</a><br /></td></tr>
|
|
<tr class="separator:af652f6f257be1ee749fe788d1b03f75f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2417d079483f773f8231c5f2caba6cf0"><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a2417d079483f773f8231c5f2caba6cf0">create_graph_file</a> (string graphname, variable fileindex)</td></tr>
|
|
<tr class="memdesc:a2417d079483f773f8231c5f2caba6cf0"><td class="mdescLeft"> </td><td class="mdescRight">save a graph to a temporary graphics file <a href="#a2417d079483f773f8231c5f2caba6cf0">More...</a><br /></td></tr>
|
|
<tr class="separator:a2417d079483f773f8231c5f2caba6cf0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac8b61eefed231018cc36d47e95bd8c22"><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#ac8b61eefed231018cc36d47e95bd8c22">create_cmd_file</a> (string cmd)</td></tr>
|
|
<tr class="memdesc:ac8b61eefed231018cc36d47e95bd8c22"><td class="mdescLeft"> </td><td class="mdescRight">write the command line to a file. <a href="#ac8b61eefed231018cc36d47e95bd8c22">More...</a><br /></td></tr>
|
|
<tr class="separator:ac8b61eefed231018cc36d47e95bd8c22"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad1a72c63f269b2e22b21a72d1ef3b279"><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#ad1a72c63f269b2e22b21a72d1ef3b279">get_log_path</a> ()</td></tr>
|
|
<tr class="separator:ad1a72c63f269b2e22b21a72d1ef3b279"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad7640d06f004ecd4a8980ea29d24dcbe"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#ad7640d06f004ecd4a8980ea29d24dcbe">cleanup_temp_files</a> ()</td></tr>
|
|
<tr class="memdesc:ad7640d06f004ecd4a8980ea29d24dcbe"><td class="mdescLeft"> </td><td class="mdescRight">delete temporary files created by the ELOG module. <a href="#ad7640d06f004ecd4a8980ea29d24dcbe">More...</a><br /></td></tr>
|
|
<tr class="separator:ad7640d06f004ecd4a8980ea29d24dcbe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5306514bf7d1a582aec146256ae45a12"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a5306514bf7d1a582aec146256ae45a12">parse_result</a> ()</td></tr>
|
|
<tr class="memdesc:a5306514bf7d1a582aec146256ae45a12"><td class="mdescLeft"> </td><td class="mdescRight">parse the result file from an elog invokation. <a href="#a5306514bf7d1a582aec146256ae45a12">More...</a><br /></td></tr>
|
|
<tr class="separator:a5306514bf7d1a582aec146256ae45a12"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acedf0c8ae34e9ebadd6fa0d9d1353aa4"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#acedf0c8ae34e9ebadd6fa0d9d1353aa4">elog_prompt_logbook</a> ()</td></tr>
|
|
<tr class="memdesc:acedf0c8ae34e9ebadd6fa0d9d1353aa4"><td class="mdescLeft"> </td><td class="mdescRight">prompt to open or create a logbook <a href="#acedf0c8ae34e9ebadd6fa0d9d1353aa4">More...</a><br /></td></tr>
|
|
<tr class="separator:acedf0c8ae34e9ebadd6fa0d9d1353aa4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afbace5ffc3167b42b09657ce6cc854ca"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#afbace5ffc3167b42b09657ce6cc854ca">elog_prompt_login</a> (string logbook)</td></tr>
|
|
<tr class="memdesc:afbace5ffc3167b42b09657ce6cc854ca"><td class="mdescLeft"> </td><td class="mdescRight">prompt the user for login to a logbook <a href="#afbace5ffc3167b42b09657ce6cc854ca">More...</a><br /></td></tr>
|
|
<tr class="separator:afbace5ffc3167b42b09657ce6cc854ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6da33f1bb2639cb912e9b25af25bf663"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a6da33f1bb2639cb912e9b25af25bf663">PearlElogPanel</a> (string logbook)</td></tr>
|
|
<tr class="memdesc:a6da33f1bb2639cb912e9b25af25bf663"><td class="mdescLeft"> </td><td class="mdescRight">open a new panel for submitting data to ELOG. <a href="#a6da33f1bb2639cb912e9b25af25bf663">More...</a><br /></td></tr>
|
|
<tr class="separator:a6da33f1bb2639cb912e9b25af25bf663"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af8b1ea711208bcc2cd1647abe04131dc"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#af8b1ea711208bcc2cd1647abe04131dc">elog_panel_hook</a> (WMWinHookStruct *s)</td></tr>
|
|
<tr class="separator:af8b1ea711208bcc2cd1647abe04131dc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9c1cfd320e88e84dcf4f84bbcf3f46a5"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a9c1cfd320e88e84dcf4f84bbcf3f46a5">update_attach_items</a> (string logbook)</td></tr>
|
|
<tr class="memdesc:a9c1cfd320e88e84dcf4f84bbcf3f46a5"><td class="mdescLeft"> </td><td class="mdescRight">update the list of attachments <a href="#a9c1cfd320e88e84dcf4f84bbcf3f46a5">More...</a><br /></td></tr>
|
|
<tr class="separator:a9c1cfd320e88e84dcf4f84bbcf3f46a5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7990f2948d48aefe990271d1961df833"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a7990f2948d48aefe990271d1961df833">move_attach_item</a> (string logbook, variable item, variable distance)</td></tr>
|
|
<tr class="memdesc:a7990f2948d48aefe990271d1961df833"><td class="mdescLeft"> </td><td class="mdescRight">move an attachment item in the list of attachments <a href="#a7990f2948d48aefe990271d1961df833">More...</a><br /></td></tr>
|
|
<tr class="separator:a7990f2948d48aefe990271d1961df833"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa1dfae6d78a367d50ee8fc1ffe9cb69b"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#aa1dfae6d78a367d50ee8fc1ffe9cb69b">bp_attach_updown</a> (WMButtonAction *ba)</td></tr>
|
|
<tr class="memdesc:aa1dfae6d78a367d50ee8fc1ffe9cb69b"><td class="mdescLeft"> </td><td class="mdescRight">button procedure for the attachment up and down buttons <a href="#aa1dfae6d78a367d50ee8fc1ffe9cb69b">More...</a><br /></td></tr>
|
|
<tr class="separator:aa1dfae6d78a367d50ee8fc1ffe9cb69b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adeff6678e57313cb218824f06d32b5ec"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#adeff6678e57313cb218824f06d32b5ec">bp_submit</a> (WMButtonAction *ba)</td></tr>
|
|
<tr class="memdesc:adeff6678e57313cb218824f06d32b5ec"><td class="mdescLeft"> </td><td class="mdescRight">button procedure for the Submit and Reply buttons <a href="#adeff6678e57313cb218824f06d32b5ec">More...</a><br /></td></tr>
|
|
<tr class="separator:adeff6678e57313cb218824f06d32b5ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a91b5f51982d23a36d1760b8874b5736a"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a91b5f51982d23a36d1760b8874b5736a">bp_attach_top</a> (WMButtonAction *ba)</td></tr>
|
|
<tr class="memdesc:a91b5f51982d23a36d1760b8874b5736a"><td class="mdescLeft"> </td><td class="mdescRight">select top graph window for attachment <a href="#a91b5f51982d23a36d1760b8874b5736a">More...</a><br /></td></tr>
|
|
<tr class="separator:a91b5f51982d23a36d1760b8874b5736a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4040736819edadf4b26982bcfdb9c7b9"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a4040736819edadf4b26982bcfdb9c7b9">bp_attach_allnone</a> (WMButtonAction *ba)</td></tr>
|
|
<tr class="memdesc:a4040736819edadf4b26982bcfdb9c7b9"><td class="mdescLeft"> </td><td class="mdescRight">select/deselect all graph windows for attachment <a href="#a4040736819edadf4b26982bcfdb9c7b9">More...</a><br /></td></tr>
|
|
<tr class="separator:a4040736819edadf4b26982bcfdb9c7b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acbba78d869a543edf7c2b80d7a8d2344"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#acbba78d869a543edf7c2b80d7a8d2344">bp_attach</a> (WMButtonAction *ba)</td></tr>
|
|
<tr class="separator:acbba78d869a543edf7c2b80d7a8d2344"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8251cea45c8d1f1993a4051a6d0760c4"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a8251cea45c8d1f1993a4051a6d0760c4">bp_save_graphs</a> (WMButtonAction *ba)</td></tr>
|
|
<tr class="separator:a8251cea45c8d1f1993a4051a6d0760c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab39637298c93b7aefd67febf3a4e7672"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#ab39637298c93b7aefd67febf3a4e7672">bp_clear</a> (WMButtonAction *ba)</td></tr>
|
|
<tr class="separator:ab39637298c93b7aefd67febf3a4e7672"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a14f8376a0485aa654ccf3d2f30ab4d01"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a14f8376a0485aa654ccf3d2f30ab4d01">bp_login</a> (WMButtonAction *ba)</td></tr>
|
|
<tr class="separator:a14f8376a0485aa654ccf3d2f30ab4d01"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad4472ea917691c41ad0b4ea6f36010a5"><td class="memItemLeft" align="right" valign="top">static variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#ad4472ea917691c41ad0b4ea6f36010a5">bp_logout</a> (WMButtonAction *ba)</td></tr>
|
|
<tr class="separator:ad4472ea917691c41ad0b4ea6f36010a5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1376b5c9e6b1180a09961bc3296849ae"><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a1376b5c9e6b1180a09961bc3296849ae">get_default_panel_name</a> ()</td></tr>
|
|
<tr class="separator:a1376b5c9e6b1180a09961bc3296849ae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a66e1200515eff8cd5c961572eccd7220"><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a66e1200515eff8cd5c961572eccd7220">get_panel_attributes</a> (string windowname)</td></tr>
|
|
<tr class="memdesc:a66e1200515eff8cd5c961572eccd7220"><td class="mdescLeft"> </td><td class="mdescRight">get a list of attributes from the fields of the ELOG panel. <a href="#a66e1200515eff8cd5c961572eccd7220">More...</a><br /></td></tr>
|
|
<tr class="separator:a66e1200515eff8cd5c961572eccd7220"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a39a1f418c8a2f9a5e4ab976827d8efca"><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a39a1f418c8a2f9a5e4ab976827d8efca">set_panel_attributes</a> (string windowname, string attributes, variable clear=defaultValue)</td></tr>
|
|
<tr class="memdesc:a39a1f418c8a2f9a5e4ab976827d8efca"><td class="mdescLeft"> </td><td class="mdescRight">set the fields of the ELOG panel <a href="#a39a1f418c8a2f9a5e4ab976827d8efca">More...</a><br /></td></tr>
|
|
<tr class="separator:a39a1f418c8a2f9a5e4ab976827d8efca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7ce92b03b6a786129959d44bf1112efa"><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a7ce92b03b6a786129959d44bf1112efa">get_panel_message</a> (string windowname)</td></tr>
|
|
<tr class="memdesc:a7ce92b03b6a786129959d44bf1112efa"><td class="mdescLeft"> </td><td class="mdescRight">get the message field of the ELOG panel <a href="#a7ce92b03b6a786129959d44bf1112efa">More...</a><br /></td></tr>
|
|
<tr class="separator:a7ce92b03b6a786129959d44bf1112efa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa7a3988440bb6d73573b50a4698a0e75"><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#aa7a3988440bb6d73573b50a4698a0e75">set_panel_message</a> (string windowname, string message)</td></tr>
|
|
<tr class="memdesc:aa7a3988440bb6d73573b50a4698a0e75"><td class="mdescLeft"> </td><td class="mdescRight">set the message field of the ELOG panel <a href="#aa7a3988440bb6d73573b50a4698a0e75">More...</a><br /></td></tr>
|
|
<tr class="separator:aa7a3988440bb6d73573b50a4698a0e75"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ace94356f691cbe343761aabd67ced23c"><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#ace94356f691cbe343761aabd67ced23c">get_panel_graphs</a> (string windowname)</td></tr>
|
|
<tr class="memdesc:ace94356f691cbe343761aabd67ced23c"><td class="mdescLeft"> </td><td class="mdescRight">get the names of the graphs selected for attachment <a href="#ace94356f691cbe343761aabd67ced23c">More...</a><br /></td></tr>
|
|
<tr class="separator:ace94356f691cbe343761aabd67ced23c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6eca5f4fab999984df32b50dd669c0b1"><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a6eca5f4fab999984df32b50dd669c0b1">set_panel_graphs</a> (string windowname, string graphs)</td></tr>
|
|
<tr class="memdesc:a6eca5f4fab999984df32b50dd669c0b1"><td class="mdescLeft"> </td><td class="mdescRight">update selection of graphs for attachment <a href="#a6eca5f4fab999984df32b50dd669c0b1">More...</a><br /></td></tr>
|
|
<tr class="separator:a6eca5f4fab999984df32b50dd669c0b1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
|
|
Variables</h2></td></tr>
|
|
<tr class="memitem:aca457d1f4414d20a911254b1de13ebbb"><td class="memItemLeft" align="right" valign="top">static const string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#aca457d1f4414d20a911254b1de13ebbb">package_name</a> = "pearl_elog"</td></tr>
|
|
<tr class="separator:aca457d1f4414d20a911254b1de13ebbb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a75bb92ef5f80843e66a7243bd958ef8b"><td class="memItemLeft" align="right" valign="top">static const string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a75bb92ef5f80843e66a7243bd958ef8b">package_path</a> = "root:packages:pearl_elog:"</td></tr>
|
|
<tr class="separator:a75bb92ef5f80843e66a7243bd958ef8b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af34e46263aa50843f98f755988f9ab5c"><td class="memItemLeft" align="right" valign="top">static const variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#af34e46263aa50843f98f755988f9ab5c">kdfRoot</a> = 0</td></tr>
|
|
<tr class="separator:af34e46263aa50843f98f755988f9ab5c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a915905f2e57d0d9a25c75f39fcce485f"><td class="memItemLeft" align="right" valign="top">static const variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a915905f2e57d0d9a25c75f39fcce485f">kdfVolatile</a> = 1</td></tr>
|
|
<tr class="separator:a915905f2e57d0d9a25c75f39fcce485f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3498e65d04de046481170b49d4e3d0d6"><td class="memItemLeft" align="right" valign="top">static const variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a3498e65d04de046481170b49d4e3d0d6">kdfPersistent</a> = 2</td></tr>
|
|
<tr class="separator:a3498e65d04de046481170b49d4e3d0d6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a28eb44739e7d5c7f9899a69afa231b8e"><td class="memItemLeft" align="right" valign="top">static const variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a28eb44739e7d5c7f9899a69afa231b8e">kdfTemplates</a> = 3</td></tr>
|
|
<tr class="separator:a28eb44739e7d5c7f9899a69afa231b8e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a63aa38b624b66fe502505040c25bc0c3"><td class="memItemLeft" align="right" valign="top">static const string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a63aa38b624b66fe502505040c25bc0c3">elog_success_msg</a> = "Message successfully transmitted"</td></tr>
|
|
<tr class="separator:a63aa38b624b66fe502505040c25bc0c3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6a9923c6465c91b1f9d1d97b090f424b"><td class="memItemLeft" align="right" valign="top">static const string </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a6a9923c6465c91b1f9d1d97b090f424b">elog_parse_id</a> = "ID=%u"</td></tr>
|
|
<tr class="separator:a6a9923c6465c91b1f9d1d97b090f424b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aae61ff4d4a4d83dfc55af45d9ed1cbc3"><td class="memItemLeft" align="right" valign="top">static const variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#aae61ff4d4a4d83dfc55af45d9ed1cbc3">kAttachColSel</a> = 0</td></tr>
|
|
<tr class="separator:aae61ff4d4a4d83dfc55af45d9ed1cbc3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5afeb893f92034532341ae51471dc2d2"><td class="memItemLeft" align="right" valign="top">static const variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#a5afeb893f92034532341ae51471dc2d2">kAttachColTitle</a> = 1</td></tr>
|
|
<tr class="separator:a5afeb893f92034532341ae51471dc2d2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:addbdec64930e9c1e417b16b25df8c723"><td class="memItemLeft" align="right" valign="top">static const variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-elog_8ipf.html#addbdec64930e9c1e417b16b25df8c723">kAttachColName</a> = 2</td></tr>
|
|
<tr class="separator:addbdec64930e9c1e417b16b25df8c723"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>interface for writing ELOG entries with Igor graphs as attachment. </p>
|
|
<p>the functions in this module support the following ELOG features:</p><ul>
|
|
<li>submit new entries and replies to existing entries.</li>
|
|
<li>text field, list box, and check box attributes.</li>
|
|
<li>attach any Igor graph to ELOG.</li>
|
|
<li>configurable logbook templates for logbooks that share the same configuration.</li>
|
|
<li>common server configurations available on the ELOG command line (hostname, port, SSL, username, password, sub-directory).</li>
|
|
<li>not specific to the configuration at PEARL. PEARL code is concentrated in the <a class="el" href="pearl-elog_8ipf.html#aaca820a0149ce6a0e843ca72b9c9e7ab" title="setup PEARL template logbooks. ">elog_init_pearl_templates()</a> function.</li>
|
|
<li>the configuration of the ELOG server and logbooks as well as the most recently used attributes are persisted in the preference file.</li>
|
|
</ul>
|
|
<p>usage:</p><ol type="1">
|
|
<li>the administrator of the ELOG server creates logbook templates according to the configuration of the logbooks. the templates are written in Igor code.</li>
|
|
<li>the user opens logbooks via the <em>Open ELOG panel</em> menu item. before first use, select a template and enter a name for the logbook. the new logbook is written to the preference file, and can afterwards be opened directly.</li>
|
|
<li>if the server requires a user name and password, click the login button.</li>
|
|
<li>edit the message, attributes and attachments as necessary, and submit to ELOG.</li>
|
|
<li>log out before saving the experiment to clear the password.</li>
|
|
</ol>
|
|
<dl class="section attention"><dt>Attention</dt><dd>the user name and password are stored in the global data tree of an experiment. it is not possible to handle passwords safely in Igor. they can be read by anyone having access to an open Igor experiment or a saved experiment file (unless the password is reset before saving). therefore:<ul>
|
|
<li>use a password for the ELOG server which is different from your other passwords.</li>
|
|
<li>clear the password (logout button in the panel) before saving an experiment.</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<p>elog command line </p><pre class="fragment">* elog -h <hostname> [-p port] [-d subdir]
|
|
* Location where elogd is running
|
|
* -l logbook Name of logbook
|
|
* -s Use SSL for communication
|
|
* [-v] For verbose output
|
|
* [-w password] Write password defined on server
|
|
* [-u username password] User name and password
|
|
* [-f <attachment>] Up to 50 attachments
|
|
* -a <attribute>=<value> Up to 50 attributes
|
|
* [-r <id>] Reply to existing message
|
|
* [-q] Quote original text on reply
|
|
* [-e <id>] Edit existing message
|
|
* [-x] Suppress email notification
|
|
* [-n 0|1|2] Encoding: 0:ELcode,1:plain,2:HTML
|
|
* -m <textfile>] | <text>
|
|
* </pre><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>2013-17 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-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
</div><h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="a3f524f5190341d2accc8cb8c3ed2ceb5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable AfterFileOpenHook </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>refNum</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>file</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>pathName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>creator</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>kind</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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>initialize the package and reload preferences after an experiment is loaded. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00143">143</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="acbba78d869a543edf7c2b80d7a8d2344"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable bp_attach </td>
|
|
<td>(</td>
|
|
<td class="paramtype">WMButtonAction * </td>
|
|
<td class="paramname"><em>ba</em></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>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01634">1634</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4040736819edadf4b26982bcfdb9c7b9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable bp_attach_allnone </td>
|
|
<td>(</td>
|
|
<td class="paramtype">WMButtonAction * </td>
|
|
<td class="paramname"><em>ba</em></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>select/deselect all graph windows for attachment </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01613">1613</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a91b5f51982d23a36d1760b8874b5736a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable bp_attach_top </td>
|
|
<td>(</td>
|
|
<td class="paramtype">WMButtonAction * </td>
|
|
<td class="paramname"><em>ba</em></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>select top graph window for attachment </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01597">1597</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa1dfae6d78a367d50ee8fc1ffe9cb69b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable bp_attach_updown </td>
|
|
<td>(</td>
|
|
<td class="paramtype">WMButtonAction * </td>
|
|
<td class="paramname"><em>ba</em></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>button procedure for the attachment up and down buttons </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01518">1518</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab39637298c93b7aefd67febf3a4e7672"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable bp_clear </td>
|
|
<td>(</td>
|
|
<td class="paramtype">WMButtonAction * </td>
|
|
<td class="paramname"><em>ba</em></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>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01695">1695</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a14f8376a0485aa654ccf3d2f30ab4d01"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable bp_login </td>
|
|
<td>(</td>
|
|
<td class="paramtype">WMButtonAction * </td>
|
|
<td class="paramname"><em>ba</em></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>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01711">1711</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad4472ea917691c41ad0b4ea6f36010a5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable bp_logout </td>
|
|
<td>(</td>
|
|
<td class="paramtype">WMButtonAction * </td>
|
|
<td class="paramname"><em>ba</em></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>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01729">1729</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8251cea45c8d1f1993a4051a6d0760c4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable bp_save_graphs </td>
|
|
<td>(</td>
|
|
<td class="paramtype">WMButtonAction * </td>
|
|
<td class="paramname"><em>ba</em></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>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01667">1667</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="adeff6678e57313cb218824f06d32b5ec"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable bp_submit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">WMButtonAction * </td>
|
|
<td class="paramname"><em>ba</em></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>button procedure for the Submit and Reply buttons </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01550">1550</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad7640d06f004ecd4a8980ea29d24dcbe"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable cleanup_temp_files </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>delete temporary files created by the ELOG module. </p>
|
|
<p>this deletes all temporary graph files that are referenced by the volatile temp_graph_files list. temp_graph_files is a semicolon-delimited string. items are added by <a class="el" href="pearl-elog_8ipf.html#a2417d079483f773f8231c5f2caba6cf0" title="save a graph to a temporary graphics file ">create_graph_file()</a>.</p>
|
|
<p>this function should be called before a new experiment is loaded or igor quits. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01115">1115</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac8b61eefed231018cc36d47e95bd8c22"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static string create_cmd_file </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>cmd</em></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>write the command line to a file. </p>
|
|
<p>the command script changes the working directory to the Temporary directory. it also deletes a previous elog.log file.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>somewhere the command line (even inside command files) is limited to 1024 bytes. for this reason all files should now be in the Temporary directory assigned by igor. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01059">1059</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2417d079483f773f8231c5f2caba6cf0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static string create_graph_file </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>graphname</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>fileindex</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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>save a graph to a temporary graphics file </p>
|
|
<p>the file is saved to the Temporary directory returned by igor's SpecialDirPath function. the file name contains a time stamp and the specified file index to make it unique. the function returns the name of the file (excluding path!)</p>
|
|
<p>the full path is added to the temp_graph_files global list. a hook function will delete the files listed there when igor quits.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">graphname</td><td>object name of the graph to save. </td></tr>
|
|
<tr><td class="paramname">fileindex</td><td>incrememtal index of the file within one submission. the file name is made unique by a time stamp and this file index. submissions within the same second must have a unique file index. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>(string) name of the created file. empty string if unsuccessful.</dd></dl>
|
|
<dl class="section version"><dt>Version</dt><dd>1.41 the return value has changed from full path to file name only due to the limited length of the command line (1024 bytes). </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01023">1023</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af652f6f257be1ee749fe788d1b03f75f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static string create_message_file </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>message</em></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>save the message to a temporary text file </p>
|
|
<p>the file is saved to the Temporary directory returned by igor's SpecialDirPath function under the file name "elog_temp_message.txt". the function returns the name of the file (excluding path!)</p>
|
|
<dl class="section note"><dt>Note</dt><dd>percent characters (%) cannot be passed to elog. they are removed silently from the message.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">message</td><td>text message to save to the file. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>(string) name of the created file. empty string if unsuccessful.</dd></dl>
|
|
<dl class="section version"><dt>Version</dt><dd>1.41 the return value has changed from full path to file name only due to the limited length of the command line (1024 bytes). </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00982">982</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac2f76abed8cfaa7ac02a46c0b89004f0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable elog_add_attachment </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>logbook</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>graphs</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>add one or more graphs to an existing ELOG entry </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">logbook</td><td>name of the target logbook </td></tr>
|
|
<tr><td class="paramname">id</td><td>identification number of the existing entry </td></tr>
|
|
<tr><td class="paramname">graphs</td><td>names of graph windows to be added as attachments, semicolon separated</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section warning"><dt>Warning</dt><dd>this will delete all existing attachments of the entry! </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00792">792</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a424460442afd5f6f853e68cd665ed785"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable elog_config </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>elog_path</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>hostname</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>port</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>subdir</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>set global module configuration parameters </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00473">473</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a05301d497e4796e5fb5adde3728ba971"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable elog_create_entry </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>logbook</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>attributes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>message</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>encoding</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>graphs</em> = <code>defaultValue</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>replyto</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>create a new entry in ELOG </p>
|
|
<p>this is the main function to create a new entry in a logbook.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">logbook</td><td>name of the target logbook.</td></tr>
|
|
<tr><td class="paramname">attributes</td><td>key=value list of attributes, semicolon separated.</td></tr>
|
|
<tr><td class="paramname">message</td><td>free text part of the entry.</td></tr>
|
|
<tr><td class="paramname">encoding</td><td>encoding of message, 0:ELcode, 1:plain (default), 2:HTML.</td></tr>
|
|
<tr><td class="paramname">graphs</td><td>names of graph windows to be added as attachments, semicolon separated.</td></tr>
|
|
<tr><td class="paramname">replyto</td><td>existing message ID (> 1) to follow up on. 0 or default: start new thread.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>ID number of the new entry (> 0), or error code (< 0). <ul>
|
|
<li>-1: failed to save temporary message file. </li>
|
|
<li>-2: invalid/missing command line. </li>
|
|
<li>-3: invalid/missing attributes. </li>
|
|
<li>-4: elog returned error </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00685">685</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab6d97edbf33e8ec039b34ff756e7ab93"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable elog_create_logbook </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>template</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>create a new logbook. </p>
|
|
<p>create a new empty logbook or duplicate from a template.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>name of the new logbook. if the logbook exists, the existing logbook folder is killed and replaced by a new one. this may fail if a window is still open.</td></tr>
|
|
<tr><td class="paramname">template</td><td>name of the template. if empty string, a new empty logbook is created. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00414">414</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aaca820a0149ce6a0e843ca72b9c9e7ab"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable elog_init_pearl_templates </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>setup PEARL template logbooks. </p>
|
|
<p>template logbooks for PEARL.</p>
|
|
<dl class="section remark"><dt>Remarks</dt><dd>this function is specific to the setup at PEARL. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00262">262</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3eac4012891c2813e401aee2c1134763"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable elog_login </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>logbook</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>username</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>password</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>set username and password for login to a logbook </p>
|
|
<p>the username and password are stored (in plain text) in global strings under the selected logbook folder. this is necessary for sending data to the ELOG server.</p>
|
|
<p>call <a class="el" href="pearl-elog_8ipf.html#a96e4cbbdb0fd8c58d87b502dc1883664" title="clear username and password of a logbook or all logbooks. ">elog_logout()</a> to clear the password variables and to avoid unintended use of your credentials.</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>igor does not have a built-in mechanism to protect passwords. user names and passwords are stored in plain text in the data folder tree. as such they are saved to experiment files and preferences.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">logbook</td><td>name of the target logbook. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00513">513</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a96e4cbbdb0fd8c58d87b502dc1883664"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable elog_logout </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>logbook</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>clear username and password of a logbook or all logbooks. </p>
|
|
<p>the username and password are stored (in plain text) in global strings under the selected logbook folder. this function resets the username and password strings.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">logbook</td><td>name of the target logbook. if empty, the passwords of all logbooks are cleared. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00533">533</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af8b1ea711208bcc2cd1647abe04131dc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable elog_panel_hook </td>
|
|
<td>(</td>
|
|
<td class="paramtype">WMWinHookStruct * </td>
|
|
<td class="paramname"><em>s</em></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>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01394">1394</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="acedf0c8ae34e9ebadd6fa0d9d1353aa4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string elog_prompt_logbook </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>prompt to open or create a logbook </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01184">1184</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afbace5ffc3167b42b09657ce6cc854ca"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable elog_prompt_login </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>logbook</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>prompt the user for login to a logbook </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01214">1214</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab2558ef5cd5e5dfba410bd58ed258b64"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable elog_validate_attributes </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>logbook</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>attributes</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>validate attributes </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if all required attributes are present and enumerated items are correct. non-zero if a violation is detected.</dd></dl>
|
|
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000004">Todo:</a></b></dt><dd>function currently not implemented, always returns 0 </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00653">653</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3cc9074c84d684d207dfdf2045755df4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static string format_url </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>logbook</em></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>format the URL for display to the user </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">logbook</td><td>name of the target logbook </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00902">902</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1376b5c9e6b1180a09961bc3296849ae"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static string get_default_panel_name </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>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01746">1746</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac45196cb9ce8b43b76c9daf67689c49a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static dfr get_elog_df </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>category</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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>get the package, logbook, or template datafolder. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>name of logbook or template, or empty string for respective parent folder.</td></tr>
|
|
<tr><td class="paramname">category</td><td>parameter category: <ul>
|
|
<li>kdfRoot package root </li>
|
|
<li>kdfVolatile volatile </li>
|
|
<li>kdfPersistent persistent </li>
|
|
<li>kdfTemplates template</li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>data folder reference </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00170">170</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad1a72c63f269b2e22b21a72d1ef3b279"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static string get_log_path </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>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01095">1095</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a66e1200515eff8cd5c961572eccd7220"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static string get_panel_attributes </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>windowname</em></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>get a list of attributes from the fields of the ELOG panel. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">windowname</td><td>window name of the ELOG panel if empty, use default name "PearlElogPanel"</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>list of attributes to in the format <code>"key1=value1;key2=value2"</code>. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01759">1759</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ace94356f691cbe343761aabd67ced23c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static string get_panel_graphs </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>windowname</em></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>get the names of the graphs selected for attachment </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">windowname</td><td>panel window name </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>a semicolon-separated list, or the empty string if the selection is not valid. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01914">1914</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7ce92b03b6a786129959d44bf1112efa"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static string get_panel_message </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>windowname</em></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>get the message field of the ELOG panel </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">windowname</td><td>window name of the ELOG panel if empty, use default name "PearlElogPanel"</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>message text </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01868">1868</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6b2d6cf641c61120332ac1983b2f3846"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static string get_timestamp </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>sep</em></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>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00958">958</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae824bbf81f8b7d16b36b53e3f3d85f69"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable IgorBeforeNewHook </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>igorApplicationNameStr</em></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>save preferences and recent values before Igor opens a new experiment. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00127">127</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6fcae5eafc97bca9a637bd7800b13e25"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable IgorQuitHook </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>igorApplicationNameStr</em></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>save preferences and recent values before Igor quits. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00135">135</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7a4572f4f861f7eb46c932508d1164f9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable init_package </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>clean</em> = <code>defaultValue</code></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>initialize the package data folder. </p>
|
|
<p>the data folder is initialized with a default, local configuration without any logbooks. the server configuration should be set in the preferences.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">clean</td><td>decides what to do if the package configuration exists. <ul>
|
|
<li>0 (default) keep existing configuration. </li>
|
|
<li>1 overwrite existing configuration. </li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00217">217</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a85cf9d39ea917860b463b1b4111705f2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable init_volatile_vars </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>initialize volatile variables. </p>
|
|
<p>create and initialize all volatile variables for the configured notebooks. values of existing variables are not changed.</p>
|
|
<p>this function must be called after new logbooks have been configured, specifically by <a class="el" href="pearl-elog_8ipf.html#ab6d97edbf33e8ec039b34ff756e7ab93" title="create a new logbook. ">elog_create_logbook()</a> and <a class="el" href="pearl-elog_8ipf.html#a92c27964d49ab8bcd7afc858ebe214a3" title="load persistent package data from the preferences file. ">load_prefs()</a>. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00340">340</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a356bebea8eb41c9ac3ea2148af22707f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static string list_logbooks </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>templates</em> = <code>defaultValue</code></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>get a list of configured logbooks or templates. </p>
|
|
<p>this is list of data folder names under persistent:logbooks (or persistent:templates). the function does not check whether the folders contain valid data.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">templates</td><td>select whether logbooks (0, default) or templates (1) are returned.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>semicolon-separated list of logbooks </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00618">618</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a92c27964d49ab8bcd7afc858ebe214a3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable load_prefs </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>load persistent package data from the preferences file. </p>
|
|
<p>the preferences file is an Igor packed experiment file in a special preferences folder </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00584">584</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7990f2948d48aefe990271d1961df833"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable move_attach_item </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>logbook</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>item</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>distance</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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>move an attachment item in the list of attachments </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01494">1494</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5306514bf7d1a582aec146256ae45a12"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable parse_result </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>parse the result file from an elog invokation. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>the ID of the generated message, or a value <= 0 if an error occurred. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01141">1141</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4088a48a8428629f120c08a419af62d6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable pearl_elog </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>logbook</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>main function to initialize ELOG and to open an ELOG panel. </p>
|
|
<p>this function takes care of all necessary initialization, configuration, and preferences. if a panel exists, it will be moved to the front.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">logbook</td><td>name of the logbook if empty, the user is prompted to select or create a logbook by <a class="el" href="pearl-elog_8ipf.html#acedf0c8ae34e9ebadd6fa0d9d1353aa4" title="prompt to open or create a logbook ">elog_prompt_logbook()</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00097">97</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6da33f1bb2639cb912e9b25af25bf663"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string PearlElogPanel </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>logbook</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>open a new panel for submitting data to ELOG. </p>
|
|
<p>this function creates only the panel but not the necessary data folders. call <a class="el" href="pearl-elog_8ipf.html#a7a4572f4f861f7eb46c932508d1164f9" title="initialize the package data folder. ">init_package()</a> and <a class="el" href="pearl-elog_8ipf.html#a92c27964d49ab8bcd7afc858ebe214a3" title="load persistent package data from the preferences file. ">load_prefs()</a> once before creating panels.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">logbook</td><td>name of the target logbook </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01241">1241</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abd15431defaec6d770cc8cab2a40e6b0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static string prepare_command_line </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>logbook</em></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>format the ELOG command and essential address arguments. </p>
|
|
<p>the following arguments are included (from global variables) if applicable: host name, port, SSL, sub-dir, username, password the result string does not include leading or trailing space</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">logbook</td><td>name of the target logbook </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00853">853</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4986de01085dc5481500240ef7667419"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static string prepare_graph_attachments </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>graphs</em></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>prepare screenshots of graph windows for attachments </p>
|
|
<p>prepares the attachment files from Igor graph windows and returns the arguments to the elog command to attach the files. file names are returned without path. the result string does not include leading or trailing space.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">graphs</td><td>names of graph windows to be added as attachments, semicolon separated </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00939">939</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac729557a307bddd2f2ad298199976c01"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable save_prefs </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>save persistent package data to the preferences file. </p>
|
|
<p>saves everything under the persistent folder of the package. </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00564">564</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a39a1f418c8a2f9a5e4ab976827d8efca"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static string set_panel_attributes </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>windowname</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>attributes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>clear</em> = <code>defaultValue</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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>set the fields of the ELOG panel </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">windowname</td><td>window name of the ELOG panel if empty, use default name "PearlElogPanel"</td></tr>
|
|
<tr><td class="paramname">attributes</td><td>list of attributes to set (format "key1=value1;key2=value2")</td></tr>
|
|
<tr><td class="paramname">clear</td><td>what to do if a key is missing in attributes? <ul>
|
|
<li>0 (default) leave the field unchanged </li>
|
|
<li>1 clear the field </li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01806">1806</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6eca5f4fab999984df32b50dd669c0b1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static string set_panel_graphs </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>windowname</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>graphs</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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>update selection of graphs for attachment </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">windowname</td><td>panel window name. looks for default panel if empty.</td></tr>
|
|
<tr><td class="paramname">graphs</td><td>semicolon-separated list of names of graph windows to select for attachment. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01954">1954</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa7a3988440bb6d73573b50a4698a0e75"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static string set_panel_message </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>windowname</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>message</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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>set the message field of the ELOG panel </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">windowname</td><td>window name of the ELOG panel if empty, use default name "PearlElogPanel"</td></tr>
|
|
<tr><td class="paramname">message</td><td>message text that can be passed to the <code>Notebook</code> operation.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>original message (unchanged) </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01894">1894</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9c1cfd320e88e84dcf4f84bbcf3f46a5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static variable update_attach_items </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>logbook</em></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>update the list of attachments </p>
|
|
|
|
<p>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01433">1433</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Variable Documentation</h2>
|
|
<a class="anchor" id="a6a9923c6465c91b1f9d1d97b090f424b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const string elog_parse_id = "ID=%u"</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>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01134">1134</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a63aa38b624b66fe502505040c25bc0c3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const string elog_success_msg = "Message successfully transmitted"</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>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01133">1133</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="addbdec64930e9c1e417b16b25df8c723"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const variable kAttachColName = 2</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>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01430">1430</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aae61ff4d4a4d83dfc55af45d9ed1cbc3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const variable kAttachColSel = 0</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>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01428">1428</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5afeb893f92034532341ae51471dc2d2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const variable kAttachColTitle = 1</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>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l01429">1429</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3498e65d04de046481170b49d4e3d0d6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const variable kdfPersistent = 2</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>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00155">155</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af34e46263aa50843f98f755988f9ab5c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const variable kdfRoot = 0</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>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00153">153</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a28eb44739e7d5c7f9899a69afa231b8e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const variable kdfTemplates = 3</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>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00156">156</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a915905f2e57d0d9a25c75f39fcce485f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const variable kdfVolatile = 1</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>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00154">154</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aca457d1f4414d20a911254b1de13ebbb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const string package_name = "pearl_elog"</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>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00085">85</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a75bb92ef5f80843e66a7243bd958ef8b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const string package_path = "root:packages:pearl_elog:"</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>Definition at line <a class="el" href="pearl-elog_8ipf_source.html#l00086">86</a> of file <a class="el" href="pearl-elog_8ipf_source.html">pearl-elog.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-elog_8ipf.html">pearl-elog.ipf</a></li>
|
|
<li class="footer">Generated on Thu Sep 21 2017 12:35:04 for PEARL Procedures by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|