ELEC60015-HLP-CW/docs/reference/global-filemenuview.html

574 lines
23 KiB
HTML
Raw Normal View History

2022-02-10 23:15:22 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
<title>FileMenuView - issie</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<meta name="description" content=""/>
<meta name="author" content="tomcl"/>
<script src="https://code.jquery.com/jquery-1.8.0.js"></script>
<script src="https://code.jquery.com/ui/1.8.23/jquery-ui.js"></script>
<script src="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.1/js/bootstrap.min.js"></script>
<link href="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.1/css/bootstrap-combined.min.css" rel="stylesheet"/>
<link type="text/css" rel="stylesheet" href="https://tomcl.github.io/issie//content/style.css" />
<script type="text/javascript" src="https://tomcl.github.io/issie//content/tips.js"></script>
<!-- HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<![endif]-->
</head>
<body>
<div class="container">
<div class="masthead">
<ul class="nav nav-pills pull-right">
<li><a href="http://fsharp.org">fsharp.org</a></li>
</ul>
<h3 class="muted"><a href="https://tomcl.github.io/issie//index.html">issie</a></h3>
</div>
<hr />
<div class="row">
<div class="span9" id="main">
<h1>FileMenuView</h1>
<p>
<span>Namespace: global</span><br />
</p>
<div class="xmldoc">
</div>
<!-- Render nested types and modules, if there are any -->
<h3>Functions and values</h3>
<table class="table table-bordered member-list">
<thead>
<tr><td>Function or value</td><td>Description</td></tr>
</thead>
<tbody>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '20', 20)" onmouseover="showTip(event, '20', 20)">
addFileToProject model dispatch
</code>
<div class="tip" id="20">
<strong>Signature:</strong> model:Model -&gt; dispatch:(Msg -&gt; unit) -&gt; unit<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L119-119" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>Create a new file in this project and open it automatically.</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '21', 21)" onmouseover="showTip(event, '21', 21)">
bitNums(a, b)
</code>
<div class="tip" id="21">
<strong>Signature:</strong> (a:int * b:int) -&gt; string<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L473-473" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '22', 22)" onmouseover="showTip(event, '22', 22)">
clkAdvance(sD)
</code>
<div class="tip" id="22">
<strong>Signature:</strong> sD:SimulationData -&gt; SimulationData<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L505-505" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '23', 23)" onmouseover="showTip(event, '23', 23)">
compsConns2portLst(...)
</code>
<div class="tip" id="23">
<strong>Signature:</strong> model:Model -&gt; simData:SimulationData -&gt; diagElLst:DiagEl list -&gt; WaveSimPort []<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L336-336" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '24', 24)" onmouseover="showTip(event, '24', 24)">
currWS(model)
</code>
<div class="tip" id="24">
<strong>Signature:</strong> model:Model -&gt; WaveSimModel<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L30-30" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '25', 25)" onmouseover="showTip(event, '25', 25)">
driveOut simGraph targetCompId inPortN
</code>
<div class="tip" id="25">
<strong>Signature:</strong> simGraph:Map&lt;&#39;?8513,SimulationComponent&gt; -&gt; targetCompId:ComponentId -&gt; inPortN:InputPortNumber -&gt; (&#39;?8513 * OutputPortNumber) option<br />
<strong>Type parameters:</strong> '?8513 </div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L283-283" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>Returns a tuple option representing the output to which the target input is connected</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '26', 26)" onmouseover="showTip(event, '26', 26)">
extractSimData simData nCycles
</code>
<div class="tip" id="26">
<strong>Signature:</strong> simData:SimulationData -&gt; nCycles:uint32 -&gt; SimulationData []<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L510-510" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '27', 27)" onmouseover="showTip(event, '27', 27)">
extractSimTime model portFunc simData
</code>
<div class="tip" id="27">
<strong>Signature:</strong> model:&#39;?8528 -&gt; portFunc:(&#39;?8528 -&gt; SimulationData -&gt; WaveSimPort []) -&gt; simData:SimulationData -&gt; Sample []<br />
<strong>Type parameters:</strong> '?8528 </div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L491-491" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '28', 28)" onmouseover="showTip(event, '28', 28)">
extractWaveData(...)
</code>
<div class="tip" id="28">
<strong>Signature:</strong> model:&#39;a -&gt; portFunc:(&#39;a -&gt; SimulationData -&gt; WaveSimPort []) -&gt; simDataArr:SimulationData [] -&gt; SimTime []<br />
<strong>Type parameters:</strong> 'a </div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L514-514" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '29', 29)" onmouseover="showTip(event, '29', 29)">
extractWaveNames simData model portFunc
</code>
<div class="tip" id="29">
<strong>Signature:</strong> simData:SimulationData -&gt; model:Model -&gt; portFunc:(Model -&gt; SimulationData -&gt; WaveSimPort []) -&gt; string []<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L487-487" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '30', 30)" onmouseover="showTip(event, '30', 30)">
findName simGraph arg2
</code>
<div class="tip" id="30">
<strong>Signature:</strong> simGraph:SimulationGraph -&gt; WaveSimPort -&gt; (string * (int * int)) list<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L379-379" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '31', 31)" onmouseover="showTip(event, '31', 31)">
getCurrFile(model)
</code>
<div class="tip" id="31">
<strong>Signature:</strong> model:Model -&gt; string<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L25-25" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '32', 32)" onmouseover="showTip(event, '32', 32)">
getSelected(model)
</code>
<div class="tip" id="32">
<strong>Signature:</strong> model:Model -&gt; DiagEl list<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L301-301" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '33', 33)" onmouseover="showTip(event, '33', 33)">
initFileWS(model)
</code>
<div class="tip" id="33">
<strong>Signature:</strong> model:Model -&gt; Msg<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L530-530" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '34', 34)" onmouseover="showTip(event, '34', 34)">
limBits(name)
</code>
<div class="tip" id="34">
<strong>Signature:</strong> name:string -&gt; (int * int) option<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L371-371" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '35', 35)" onmouseover="showTip(event, '35', 35)">
makeSimData(model)
</code>
<div class="tip" id="35">
<strong>Signature:</strong> model:Model -&gt; Result&lt;SimulationData,SimulationError&gt; option * Result&lt;(Map&lt;string,WaveSimModel&gt; * SimulationError option),&#39;a&gt; option<br />
<strong>Type parameters:</strong> 'a </div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L518-518" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '36', 36)" onmouseover="showTip(event, '36', 36)">
processComp simData cId
</code>
<div class="tip" id="36">
<strong>Signature:</strong> simData:SimulationData -&gt; cId:ComponentId -&gt; WaveSimPort []<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L317-317" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '37', 37)" onmouseover="showTip(event, '37', 37)">
procIns simData compId inputs
</code>
<div class="tip" id="37">
<strong>Signature:</strong> simData:SimulationData -&gt; compId:ComponentId -&gt; inputs:InputPortNumber [] -&gt; WaveSimPort []<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L309-309" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '38', 38)" onmouseover="showTip(event, '38', 38)">
reloadablePorts model simData
</code>
<div class="tip" id="38">
<strong>Signature:</strong> model:Model -&gt; simData:SimulationData -&gt; WaveSimPort []<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L360-360" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '39', 39)" onmouseover="showTip(event, '39', 39)">
remDuplicates(arrWithDup)
</code>
<div class="tip" id="39">
<strong>Signature:</strong> arrWithDup:WaveSimPort [] -&gt; WaveSimPort []<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L331-331" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '40', 40)" onmouseover="showTip(event, '40', 40)">
saveOpenFileAction(model)
</code>
<div class="tip" id="40">
<strong>Signature:</strong> model:Model -&gt; unit<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L59-59" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>Save the file currently open.</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '41', 41)" onmouseover="showTip(event, '41', 41)">
selected2portLst model simData
</code>
<div class="tip" id="41">
<strong>Signature:</strong> model:Model -&gt; simData:SimulationData -&gt; WaveSimPort []<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L357-357" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '42', 42)" onmouseover="showTip(event, '42', 42)">
simLst model dispatch portsFunc
</code>
<div class="tip" id="42">
<strong>Signature:</strong> model:Model -&gt; dispatch:(Msg -&gt; unit) -&gt; portsFunc:(Model -&gt; SimulationData -&gt; WaveSimPort []) -&gt; Msg<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L532-532" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '43', 43)" onmouseover="showTip(event, '43', 43)">
simWireData2Wire(wireData)
</code>
<div class="tip" id="43">
<strong>Signature:</strong> wireData:Bit list -&gt; bigint<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L293-293" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '44', 44)" onmouseover="showTip(event, '44', 44)">
viewNoProjectMenu model dispatch
</code>
<div class="tip" id="44">
<strong>Signature:</strong> model:Model -&gt; dispatch:(Msg -&gt; unit) -&gt; (type)<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L235-235" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>Display the initial Open/Create Project menu at the beginning if no project
is open.</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '45', 45)" onmouseover="showTip(event, '45', 45)">
viewTopMenu model dispatch
</code>
<div class="tip" id="45">
<strong>Signature:</strong> model:Model -&gt; dispatch:(Msg -&gt; unit) -&gt; (type)<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L576-576" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>Display top menu.</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '46', 46)" onmouseover="showTip(event, '46', 46)">
wSPort2Name simGraph p
</code>
<div class="tip" id="46">
<strong>Signature:</strong> simGraph:SimulationGraph -&gt; p:WaveSimPort -&gt; string<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Renderer/UI/FileMenuView.fs#L479-479" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
</td>
</tr>
</tbody>
</table>
</div>
<div class="span3">
<ul class="nav nav-list" id="menu" style="margin-top: 20px;">
<li class="nav-header">issie</li>
<li class="divider"></li>
<li><a href="https://github.com/tomcl/ISSIE">Source Code</a></li>
<li><a href="https://tomcl.github.io/issie//release-notes.html">Release Notes</a></li>
<li><a href="https://tomcl.github.io/issie//contributing.html">Contributing</a></li>
<li class="nav-header">Documentation</li>
<li><a href="https://tomcl.github.io/issie//index.html">Introduction</a></li>
<li class="divider"></li>
<li><a href="https://tomcl.github.io/issie//community.html">Community</a></li>
<li class="nav-header">Reference</li>
<li><a href="https://tomcl.github.io/issie//reference/index.html">API Reference</a></li>
</ul>
</div>
</div>
</div>
</body>
</html>