pearl-public/igor-public
2
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
ef9d08e5f53a0e9a534de722e452e2d62977b3d7
igor-public/doc/html/pearl-elog_8ipf_source.html
T

163 lines
249 KiB
HTML
Raw Normal View History

include documentation in public distribution
2017-07-04 11:24:41 +02:00
<!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"/>
make documentation for release 2.0.2
2019-02-10 14:39:57 +01:00
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
include documentation in public distribution
2017-07-04 11:24:41 +02:00
<title>PEARL Procedures: pearl-elog.ipf Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="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);
</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>
<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
distro release 2.1.1
2020-06-09 12:31:05 +02:00
&#160;<span id="projectnumber">rev-distro-2.1.0-1-gb7390cb-dirty</span>
include documentation in public distribution
2017-07-04 11:24:41 +02:00
</div>
<div id="projectbrief">Igor procedures for the analysis of PEARL data</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
make documentation for release 2.0.2
2019-02-10 14:39:57 +01:00
<!-- Generated by Doxygen 1.8.13 -->
include documentation in public distribution
2017-07-04 11:24:41 +02:00
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
make documentation for release 2.0.2
2019-02-10 14:39:57 +01:00
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
include documentation in public distribution
2017-07-04 11:24:41 +02:00
</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_source.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="headertitle">
<div class="title">pearl-elog.ipf</div> </div>
</div><!--header-->
<div class="contents">
distro release 2.1.1
2020-06-09 12:31:05 +02:00
<a href="pearl-elog_8ipf.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#pragma rtGlobals=3 // Use modern global access method and strict wave access.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#pragma version = 1.41</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#pragma IgorVersion = 6.2</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#pragma ModuleName = PearlElog</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// author: matthias.muntwiler@psi.ch</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// Copyright (c) 2013-17 Paul Scherrer Institut</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// You may obtain a copy of the License at</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div><div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="pearl-elog_8ipf.html#aca457d1f4414d20a911254b1de13ebbb"> 85</a></span>&#160;<span class="keyword">static</span> strconstant <a class="code" href="pearl-elog_8ipf.html#aca457d1f4414d20a911254b1de13ebbb">package_name</a> = <span class="stringliteral">&quot;pearl_elog&quot;</span></div><div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="pearl-elog_8ipf.html#a75bb92ef5f80843e66a7243bd958ef8b"> 86</a></span>&#160;<span class="keyword">static</span> strconstant <a class="code" href="pearl-elog_8ipf.html#a75bb92ef5f80843e66a7243bd958ef8b">package_path</a> = <span class="stringliteral">&quot;root:packages:pearl_elog:&quot;</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;</div><div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="pearl-elog_8ipf.html#a4088a48a8428629f120c08a419af62d6"> 97</a></span>&#160;<span class="keyword">function</span> <a class="code" href="pearl-elog_8ipf.html#a4088a48a8428629f120c08a419af62d6">pearl_elog</a>(logbook)</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keywordtype">string</span> logbook</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="pearl-elog_8ipf.html#a7a4572f4f861f7eb46c932508d1164f9">init_package</a>() == 0)</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <a class="code" href="pearl-elog_8ipf.html#a92c27964d49ab8bcd7afc858ebe214a3">load_prefs</a>()</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; string templates = <a class="code" href="pearl-elog_8ipf.html#a356bebea8eb41c9ac3ea2148
make documentation for version 2.0.3
2019-02-28 18:57:56 +01:00
<div class="ttc" id="pearl-elog_8ipf_html_a3f524f5190341d2accc8cb8c3ed2ceb5"><div class="ttname"><a href="pearl-elog_8ipf.html#a3f524f5190341d2accc8cb8c3ed2ceb5">AfterFileOpenHook</a></div><div class="ttdeci">static variable AfterFileOpenHook(variable refNum, string file, string pathName, string type, string creator, variable kind)</div><div class="ttdoc">initialize the package and reload preferences after an experiment is loaded. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00143">pearl-elog.ipf:143</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_ac2f76abed8cfaa7ac02a46c0b89004f0"><div class="ttname"><a href="pearl-elog_8ipf.html#ac2f76abed8cfaa7ac02a46c0b89004f0">elog_add_attachment</a></div><div class="ttdeci">variable elog_add_attachment(string logbook, variable id, string graphs)</div><div class="ttdoc">add one or more graphs to an existing ELOG entry </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00792">pearl-elog.ipf:792</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_a75bb92ef5f80843e66a7243bd958ef8b"><div class="ttname"><a href="pearl-elog_8ipf.html#a75bb92ef5f80843e66a7243bd958ef8b">package_path</a></div><div class="ttdeci">static const string package_path</div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00086">pearl-elog.ipf:86</a></div></div>
distro release 2.1.1
2020-06-09 12:31:05 +02:00
<div class="ttc" id="pearl-elog_8ipf_html_ace94356f691cbe343761aabd67ced23c"><div class="ttname"><a href="pearl-elog_8ipf.html#ace94356f691cbe343761aabd67ced23c">get_panel_graphs</a></div><div class="ttdeci">static string get_panel_graphs(string windowname)</div><div class="ttdoc">get the names of the graphs selected for attachment </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01926">pearl-elog.ipf:1926</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_aa1dfae6d78a367d50ee8fc1ffe9cb69b"><div class="ttname"><a href="pearl-elog_8ipf.html#aa1dfae6d78a367d50ee8fc1ffe9cb69b">bp_attach_updown</a></div><div class="ttdeci">static variable bp_attach_updown(WMButtonAction *ba)</div><div class="ttdoc">button procedure for the attachment up and down buttons </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01519">pearl-elog.ipf:1519</a></div></div>
make documentation for version 2.0.3
2019-02-28 18:57:56 +01:00
<div class="ttc" id="pearl-elog_8ipf_html_af652f6f257be1ee749fe788d1b03f75f"><div class="ttname"><a href="pearl-elog_8ipf.html#af652f6f257be1ee749fe788d1b03f75f">create_message_file</a></div><div class="ttdeci">static string create_message_file(string message)</div><div class="ttdoc">save the message to a temporary text file </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00982">pearl-elog.ipf:982</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_a5306514bf7d1a582aec146256ae45a12"><div class="ttname"><a href="pearl-elog_8ipf.html#a5306514bf7d1a582aec146256ae45a12">parse_result</a></div><div class="ttdeci">static variable parse_result()</div><div class="ttdoc">parse the result file from an elog invokation. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01141">pearl-elog.ipf:1141</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_ab6d97edbf33e8ec039b34ff756e7ab93"><div class="ttname"><a href="pearl-elog_8ipf.html#ab6d97edbf33e8ec039b34ff756e7ab93">elog_create_logbook</a></div><div class="ttdeci">variable elog_create_logbook(string name, string template=defaultValue)</div><div class="ttdoc">create a new logbook. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00414">pearl-elog.ipf:414</a></div></div>
distro release 2.1.1
2020-06-09 12:31:05 +02:00
<div class="ttc" id="pearl-elog_8ipf_html_a39a1f418c8a2f9a5e4ab976827d8efca"><div class="ttname"><a href="pearl-elog_8ipf.html#a39a1f418c8a2f9a5e4ab976827d8efca">set_panel_attributes</a></div><div class="ttdeci">static string set_panel_attributes(string windowname, string attributes, variable clear=defaultValue)</div><div class="ttdoc">set the fields of the ELOG panel </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01807">pearl-elog.ipf:1807</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_ad4472ea917691c41ad0b4ea6f36010a5"><div class="ttname"><a href="pearl-elog_8ipf.html#ad4472ea917691c41ad0b4ea6f36010a5">bp_logout</a></div><div class="ttdeci">static variable bp_logout(WMButtonAction *ba)</div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01730">pearl-elog.ipf:1730</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_a1376b5c9e6b1180a09961bc3296849ae"><div class="ttname"><a href="pearl-elog_8ipf.html#a1376b5c9e6b1180a09961bc3296849ae">get_default_panel_name</a></div><div class="ttdeci">static string get_default_panel_name()</div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01747">pearl-elog.ipf:1747</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_af8b1ea711208bcc2cd1647abe04131dc"><div class="ttname"><a href="pearl-elog_8ipf.html#af8b1ea711208bcc2cd1647abe04131dc">elog_panel_hook</a></div><div class="ttdeci">static variable elog_panel_hook(WMWinHookStruct *s)</div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01395">pearl-elog.ipf:1395</a></div></div>
make documentation for version 2.0.3
2019-02-28 18:57:56 +01:00
<div class="ttc" id="pearl-elog_8ipf_html_a424460442afd5f6f853e68cd665ed785"><div class="ttname"><a href="pearl-elog_8ipf.html#a424460442afd5f6f853e68cd665ed785">elog_config</a></div><div class="ttdeci">variable elog_config(string elog_path=defaultValue, string hostname=defaultValue, variable port=defaultValue, string subdir=defaultValue)</div><div class="ttdoc">set global module configuration parameters </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00473">pearl-elog.ipf:473</a></div></div>
<div class="ttc" id="namespace_pearl_elog_html"><div class="ttname"><a href="namespace_pearl_elog.html">PearlElog</a></div><div class="ttdoc">interface for writing ELOG entries with Igor graphs as attachment. </div></div>
<div class="ttc" id="pearl-elog_8ipf_html_ae824bbf81f8b7d16b36b53e3f3d85f69"><div class="ttname"><a href="pearl-elog_8ipf.html#ae824bbf81f8b7d16b36b53e3f3d85f69">IgorBeforeNewHook</a></div><div class="ttdeci">static variable IgorBeforeNewHook(string igorApplicationNameStr)</div><div class="ttdoc">save preferences and recent values before Igor opens a new experiment. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00127">pearl-elog.ipf:127</a></div></div>
distro release 2.1.1
2020-06-09 12:31:05 +02:00
<div class="ttc" id="pearl-elog_8ipf_html_a6eca5f4fab999984df32b50dd669c0b1"><div class="ttname"><a href="pearl-elog_8ipf.html#a6eca5f4fab999984df32b50dd669c0b1">set_panel_graphs</a></div><div class="ttdeci">static string set_panel_graphs(string windowname, string graphs)</div><div class="ttdoc">update selection of graphs for attachment </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01966">pearl-elog.ipf:1966</a></div></div>
make documentation for version 2.0.3
2019-02-28 18:57:56 +01:00
<div class="ttc" id="pearl-elog_8ipf_html_aaca820a0149ce6a0e843ca72b9c9e7ab"><div class="ttname"><a href="pearl-elog_8ipf.html#aaca820a0149ce6a0e843ca72b9c9e7ab">elog_init_pearl_templates</a></div><div class="ttdeci">variable elog_init_pearl_templates()</div><div class="ttdoc">setup PEARL template logbooks. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00262">pearl-elog.ipf:262</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_a2417d079483f773f8231c5f2caba6cf0"><div class="ttname"><a href="pearl-elog_8ipf.html#a2417d079483f773f8231c5f2caba6cf0">create_graph_file</a></div><div class="ttdeci">static string create_graph_file(string graphname, variable fileindex)</div><div class="ttdoc">save a graph to a temporary graphics file </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01023">pearl-elog.ipf:1023</a></div></div>
distro release 2.1.1
2020-06-09 12:31:05 +02:00
<div class="ttc" id="pearl-elog_8ipf_html_addbdec64930e9c1e417b16b25df8c723"><div class="ttname"><a href="pearl-elog_8ipf.html#addbdec64930e9c1e417b16b25df8c723">kAttachColName</a></div><div class="ttdeci">static const variable kAttachColName</div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01431">pearl-elog.ipf:1431</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_ab39637298c93b7aefd67febf3a4e7672"><div class="ttname"><a href="pearl-elog_8ipf.html#ab39637298c93b7aefd67febf3a4e7672">bp_clear</a></div><div class="ttdeci">static variable bp_clear(WMButtonAction *ba)</div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01696">pearl-elog.ipf:1696</a></div></div>
make documentation for version 2.0.3
2019-02-28 18:57:56 +01:00
<div class="ttc" id="pearl-elog_8ipf_html_a3eac4012891c2813e401aee2c1134763"><div class="ttname"><a href="pearl-elog_8ipf.html#a3eac4012891c2813e401aee2c1134763">elog_login</a></div><div class="ttdeci">variable elog_login(string logbook, string username, string password)</div><div class="ttdoc">set username and password for login to a logbook </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00513">pearl-elog.ipf:513</a></div></div>
distro release 2.1.1
2020-06-09 12:31:05 +02:00
<div class="ttc" id="pearl-elog_8ipf_html_a91b5f51982d23a36d1760b8874b5736a"><div class="ttname"><a href="pearl-elog_8ipf.html#a91b5f51982d23a36d1760b8874b5736a">bp_attach_top</a></div><div class="ttdeci">static variable bp_attach_top(WMButtonAction *ba)</div><div class="ttdoc">select top graph window for attachment </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01598">pearl-elog.ipf:1598</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_aae61ff4d4a4d83dfc55af45d9ed1cbc3"><div class="ttname"><a href="pearl-elog_8ipf.html#aae61ff4d4a4d83dfc55af45d9ed1cbc3">kAttachColSel</a></div><div class="ttdeci">static const variable kAttachColSel</div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01429">pearl-elog.ipf:1429</a></div></div>
make documentation for version 2.0.3
2019-02-28 18:57:56 +01:00
<div class="ttc" id="pearl-elog_8ipf_html_a6da33f1bb2639cb912e9b25af25bf663"><div class="ttname"><a href="pearl-elog_8ipf.html#a6da33f1bb2639cb912e9b25af25bf663">PearlElogPanel</a></div><div class="ttdeci">string PearlElogPanel(string logbook)</div><div class="ttdoc">open a new panel for submitting data to ELOG. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01241">pearl-elog.ipf:1241</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_ab2558ef5cd5e5dfba410bd58ed258b64"><div class="ttname"><a href="pearl-elog_8ipf.html#ab2558ef5cd5e5dfba410bd58ed258b64">elog_validate_attributes</a></div><div class="ttdeci">variable elog_validate_attributes(string logbook, string attributes)</div><div class="ttdoc">validate attributes </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00653">pearl-elog.ipf:653</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_a4986de01085dc5481500240ef7667419"><div class="ttname"><a href="pearl-elog_8ipf.html#a4986de01085dc5481500240ef7667419">prepare_graph_attachments</a></div><div class="ttdeci">static string prepare_graph_attachments(string graphs)</div><div class="ttdoc">prepare screenshots of graph windows for attachments </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00939">pearl-elog.ipf:939</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_a356bebea8eb41c9ac3ea2148af22707f"><div class="ttname"><a href="pearl-elog_8ipf.html#a356bebea8eb41c9ac3ea2148af22707f">list_logbooks</a></div><div class="ttdeci">static string list_logbooks(variable templates=defaultValue)</div><div class="ttdoc">get a list of configured logbooks or templates. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00618">pearl-elog.ipf:618</a></div></div>
distro release 2.1.1
2020-06-09 12:31:05 +02:00
<div class="ttc" id="pearl-elog_8ipf_html_acbba78d869a543edf7c2b80d7a8d2344"><div class="ttname"><a href="pearl-elog_8ipf.html#acbba78d869a543edf7c2b80d7a8d2344">bp_attach</a></div><div class="ttdeci">static variable bp_attach(WMButtonAction *ba)</div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01635">pearl-elog.ipf:1635</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_a7990f2948d48aefe990271d1961df833"><div class="ttname"><a href="pearl-elog_8ipf.html#a7990f2948d48aefe990271d1961df833">move_attach_item</a></div><div class="ttdeci">static variable move_attach_item(string logbook, variable item, variable distance)</div><div class="ttdoc">move an attachment item in the list of attachments </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01495">pearl-elog.ipf:1495</a></div></div>
make documentation for version 2.0.3
2019-02-28 18:57:56 +01:00
<div class="ttc" id="pearl-elog_8ipf_html_ac45196cb9ce8b43b76c9daf67689c49a"><div class="ttname"><a href="pearl-elog_8ipf.html#ac45196cb9ce8b43b76c9daf67689c49a">get_elog_df</a></div><div class="ttdeci">static dfr get_elog_df(string name, variable category)</div><div class="ttdoc">get the package, logbook, or template datafolder. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00170">pearl-elog.ipf:170</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_acedf0c8ae34e9ebadd6fa0d9d1353aa4"><div class="ttname"><a href="pearl-elog_8ipf.html#acedf0c8ae34e9ebadd6fa0d9d1353aa4">elog_prompt_logbook</a></div><div class="ttdeci">string elog_prompt_logbook()</div><div class="ttdoc">prompt to open or create a logbook </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01184">pearl-elog.ipf:1184</a></div></div>
distro release 2.1.1
2020-06-09 12:31:05 +02:00
<div class="ttc" id="pearl-elog_8ipf_html_a8251cea45c8d1f1993a4051a6d0760c4"><div class="ttname"><a href="pearl-elog_8ipf.html#a8251cea45c8d1f1993a4051a6d0760c4">bp_save_graphs</a></div><div class="ttdeci">static variable bp_save_graphs(WMButtonAction *ba)</div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01668">pearl-elog.ipf:1668</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_a9c1cfd320e88e84dcf4f84bbcf3f46a5"><div class="ttname"><a href="pearl-elog_8ipf.html#a9c1cfd320e88e84dcf4f84bbcf3f46a5">update_attach_items</a></div><div class="ttdeci">static variable update_attach_items(string logbook)</div><div class="ttdoc">update the list of attachments </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01434">pearl-elog.ipf:1434</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_a14f8376a0485aa654ccf3d2f30ab4d01"><div class="ttname"><a href="pearl-elog_8ipf.html#a14f8376a0485aa654ccf3d2f30ab4d01">bp_login</a></div><div class="ttdeci">static variable bp_login(WMButtonAction *ba)</div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01712">pearl-elog.ipf:1712</a></div></div>
make documentation for version 2.0.3
2019-02-28 18:57:56 +01:00
<div class="ttc" id="pearl-elog_8ipf_html_a915905f2e57d0d9a25c75f39fcce485f"><div class="ttname"><a href="pearl-elog_8ipf.html#a915905f2e57d0d9a25c75f39fcce485f">kdfVolatile</a></div><div class="ttdeci">static const variable kdfVolatile</div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00154">pearl-elog.ipf:154</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_a28eb44739e7d5c7f9899a69afa231b8e"><div class="ttname"><a href="pearl-elog_8ipf.html#a28eb44739e7d5c7f9899a69afa231b8e">kdfTemplates</a></div><div class="ttdeci">static const variable kdfTemplates</div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00156">pearl-elog.ipf:156</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_abd15431defaec6d770cc8cab2a40e6b0"><div class="ttname"><a href="pearl-elog_8ipf.html#abd15431defaec6d770cc8cab2a40e6b0">prepare_command_line</a></div><div class="ttdeci">static string prepare_command_line(string logbook)</div><div class="ttdoc">format the ELOG command and essential address arguments. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00853">pearl-elog.ipf:853</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_ad7640d06f004ecd4a8980ea29d24dcbe"><div class="ttname"><a href="pearl-elog_8ipf.html#ad7640d06f004ecd4a8980ea29d24dcbe">cleanup_temp_files</a></div><div class="ttdeci">static variable cleanup_temp_files()</div><div class="ttdoc">delete temporary files created by the ELOG module. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01115">pearl-elog.ipf:1115</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_ad1a72c63f269b2e22b21a72d1ef3b279"><div class="ttname"><a href="pearl-elog_8ipf.html#ad1a72c63f269b2e22b21a72d1ef3b279">get_log_path</a></div><div class="ttdeci">static string get_log_path()</div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01095">pearl-elog.ipf:1095</a></div></div>
distro release 2.1.1
2020-06-09 12:31:05 +02:00
<div class="ttc" id="pearl-elog_8ipf_html_a5afeb893f92034532341ae51471dc2d2"><div class="ttname"><a href="pearl-elog_8ipf.html#a5afeb893f92034532341ae51471dc2d2">kAttachColTitle</a></div><div class="ttdeci">static const variable kAttachColTitle</div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01430">pearl-elog.ipf:1430</a></div></div>
make documentation for version 2.0.3
2019-02-28 18:57:56 +01:00
<div class="ttc" id="pearl-elog_8ipf_html_a6a9923c6465c91b1f9d1d97b090f424b"><div class="ttname"><a href="pearl-elog_8ipf.html#a6a9923c6465c91b1f9d1d97b090f424b">elog_parse_id</a></div><div class="ttdeci">static const string elog_parse_id</div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01134">pearl-elog.ipf:1134</a></div></div>
distro release 2.1.1
2020-06-09 12:31:05 +02:00
<div class="ttc" id="pearl-elog_8ipf_html_a7ce92b03b6a786129959d44bf1112efa"><div class="ttname"><a href="pearl-elog_8ipf.html#a7ce92b03b6a786129959d44bf1112efa">get_panel_message</a></div><div class="ttdeci">static string get_panel_message(string windowname)</div><div class="ttdoc">get the message field of the ELOG panel </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01880">pearl-elog.ipf:1880</a></div></div>
make documentation for version 2.0.3
2019-02-28 18:57:56 +01:00
<div class="ttc" id="pearl-elog_8ipf_html_ac8b61eefed231018cc36d47e95bd8c22"><div class="ttname"><a href="pearl-elog_8ipf.html#ac8b61eefed231018cc36d47e95bd8c22">create_cmd_file</a></div><div class="ttdeci">static string create_cmd_file(string cmd)</div><div class="ttdoc">write the command line to a file. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01059">pearl-elog.ipf:1059</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_a85cf9d39ea917860b463b1b4111705f2"><div class="ttname"><a href="pearl-elog_8ipf.html#a85cf9d39ea917860b463b1b4111705f2">init_volatile_vars</a></div><div class="ttdeci">static variable init_volatile_vars()</div><div class="ttdoc">initialize volatile variables. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00340">pearl-elog.ipf:340</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_a92c27964d49ab8bcd7afc858ebe214a3"><div class="ttname"><a href="pearl-elog_8ipf.html#a92c27964d49ab8bcd7afc858ebe214a3">load_prefs</a></div><div class="ttdeci">static variable load_prefs()</div><div class="ttdoc">load persistent package data from the preferences file. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00584">pearl-elog.ipf:584</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_a3498e65d04de046481170b49d4e3d0d6"><div class="ttname"><a href="pearl-elog_8ipf.html#a3498e65d04de046481170b49d4e3d0d6">kdfPersistent</a></div><div class="ttdeci">static const variable kdfPersistent</div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00155">pearl-elog.ipf:155</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_a7a4572f4f861f7eb46c932508d1164f9"><div class="ttname"><a href="pearl-elog_8ipf.html#a7a4572f4f861f7eb46c932508d1164f9">init_package</a></div><div class="ttdeci">static variable init_package(variable clean=defaultValue)</div><div class="ttdoc">initialize the package data folder. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00217">pearl-elog.ipf:217</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_ac729557a307bddd2f2ad298199976c01"><div class="ttname"><a href="pearl-elog_8ipf.html#ac729557a307bddd2f2ad298199976c01">save_prefs</a></div><div class="ttdeci">static variable save_prefs()</div><div class="ttdoc">save persistent package data to the preferences file. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00564">pearl-elog.ipf:564</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_af34e46263aa50843f98f755988f9ab5c"><div class="ttname"><a href="pearl-elog_8ipf.html#af34e46263aa50843f98f755988f9ab5c">kdfRoot</a></div><div class="ttdeci">static const variable kdfRoot</div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00153">pearl-elog.ipf:153</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_afbace5ffc3167b42b09657ce6cc854ca"><div class="ttname"><a href="pearl-elog_8ipf.html#afbace5ffc3167b42b09657ce6cc854ca">elog_prompt_login</a></div><div class="ttdeci">variable elog_prompt_login(string logbook)</div><div class="ttdoc">prompt the user for login to a logbook </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01214">pearl-elog.ipf:1214</a></div></div>
distro release 2.1.1
2020-06-09 12:31:05 +02:00
<div class="ttc" id="pearl-elog_8ipf_html_aa7a3988440bb6d73573b50a4698a0e75"><div class="ttname"><a href="pearl-elog_8ipf.html#aa7a3988440bb6d73573b50a4698a0e75">set_panel_message</a></div><div class="ttdeci">static string set_panel_message(string windowname, string message)</div><div class="ttdoc">set the message field of the ELOG panel </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01906">pearl-elog.ipf:1906</a></div></div>
make documentation for version 2.0.3
2019-02-28 18:57:56 +01:00
<div class="ttc" id="pearl-elog_8ipf_html_a6fcae5eafc97bca9a637bd7800b13e25"><div class="ttname"><a href="pearl-elog_8ipf.html#a6fcae5eafc97bca9a637bd7800b13e25">IgorQuitHook</a></div><div class="ttdeci">static variable IgorQuitHook(string igorApplicationNameStr)</div><div class="ttdoc">save preferences and recent values before Igor quits. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00135">pearl-elog.ipf:135</a></div></div>
distro release 2.1.1
2020-06-09 12:31:05 +02:00
<div class="ttc" id="pearl-elog_8ipf_html_adeff6678e57313cb218824f06d32b5ec"><div class="ttname"><a href="pearl-elog_8ipf.html#adeff6678e57313cb218824f06d32b5ec">bp_submit</a></div><div class="ttdeci">static variable bp_submit(WMButtonAction *ba)</div><div class="ttdoc">button procedure for the Submit and Reply buttons </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01551">pearl-elog.ipf:1551</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_a4040736819edadf4b26982bcfdb9c7b9"><div class="ttname"><a href="pearl-elog_8ipf.html#a4040736819edadf4b26982bcfdb9c7b9">bp_attach_allnone</a></div><div class="ttdeci">static variable bp_attach_allnone(WMButtonAction *ba)</div><div class="ttdoc">select/deselect all graph windows for attachment </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01614">pearl-elog.ipf:1614</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_a66e1200515eff8cd5c961572eccd7220"><div class="ttname"><a href="pearl-elog_8ipf.html#a66e1200515eff8cd5c961572eccd7220">get_panel_attributes</a></div><div class="ttdeci">static string get_panel_attributes(string windowname)</div><div class="ttdoc">get a list of attributes from the fields of the ELOG panel. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01760">pearl-elog.ipf:1760</a></div></div>
make documentation for version 2.0.3
2019-02-28 18:57:56 +01:00
<div class="ttc" id="pearl-elog_8ipf_html_a63aa38b624b66fe502505040c25bc0c3"><div class="ttname"><a href="pearl-elog_8ipf.html#a63aa38b624b66fe502505040c25bc0c3">elog_success_msg</a></div><div class="ttdeci">static const string elog_success_msg</div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l01133">pearl-elog.ipf:1133</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_a6b2d6cf641c61120332ac1983b2f3846"><div class="ttname"><a href="pearl-elog_8ipf.html#a6b2d6cf641c61120332ac1983b2f3846">get_timestamp</a></div><div class="ttdeci">static string get_timestamp(string sep)</div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00958">pearl-elog.ipf:958</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_a96e4cbbdb0fd8c58d87b502dc1883664"><div class="ttname"><a href="pearl-elog_8ipf.html#a96e4cbbdb0fd8c58d87b502dc1883664">elog_logout</a></div><div class="ttdeci">variable elog_logout(string logbook)</div><div class="ttdoc">clear username and password of a logbook or all logbooks. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00533">pearl-elog.ipf:533</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_a4088a48a8428629f120c08a419af62d6"><div class="ttname"><a href="pearl-elog_8ipf.html#a4088a48a8428629f120c08a419af62d6">pearl_elog</a></div><div class="ttdeci">variable pearl_elog(string logbook)</div><div class="ttdoc">main function to initialize ELOG and to open an ELOG panel. </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00097">pearl-elog.ipf:97</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_a3cc9074c84d684d207dfdf2045755df4"><div class="ttname"><a href="pearl-elog_8ipf.html#a3cc9074c84d684d207dfdf2045755df4">format_url</a></div><div class="ttdeci">static string format_url(string logbook)</div><div class="ttdoc">format the URL for display to the user </div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00902">pearl-elog.ipf:902</a></div></div>
<div class="ttc" id="pearl-elog_8ipf_html_aca457d1f4414d20a911254b1de13ebbb"><div class="ttname"><a href="pearl-elog_8ipf.html#aca457d1f4414d20a911254b1de13ebbb">package_name</a></div><div class="ttdeci">static const string package_name</div><div class="ttdef"><b>Definition:</b> <a href="pearl-elog_8ipf_source.html#l00085">pearl-elog.ipf:85</a></div></div>
</div><!-- fragment --></div><!-- contents -->
include documentation in public distribution
2017-07-04 11:24:41 +02:00
</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>
distro release 2.1.1
2020-06-09 12:31:05 +02:00
<li class="footer">Generated on Tue Jun 9 2020 12:30:01 for PEARL Procedures by
include documentation in public distribution
2017-07-04 11:24:41 +02:00
<a href="http://www.doxygen.org/index.html">
make documentation for release 2.0.2
2019-02-10 14:39:57 +01:00
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
include documentation in public distribution
2017-07-04 11:24:41 +02:00
</ul>
</div>
</body>
</html>
Reference in New Issue Copy Permalink