389 lines
16 KiB
HTML
389 lines
16 KiB
HTML
<!DOCTYPE html>
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<title>Class FanucWhileDo | HiAPI-C# 2025 </title>
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
<meta name="title" content="Class FanucWhileDo | HiAPI-C# 2025 ">
|
||
|
||
<meta name="description" content="Fanuc Custom Macro B WHILE/END bounded-loop record. Stamped on the host block by after the control-flow decision has been made; produced earlier by as a parsing-stage sub-section (Parsing.FanucWhileDo) carrying the raw captured fields. Two phrases map to the same shape, distinguished by : WHILE [&lt;bool-expr&gt;] DO &lt;m&gt; — loop entry. holds the expression text from inside the brackets at parsing time; substituted to a numeric by in place. carries the host-level truthy outcome at stamp time.END &lt;m&gt; — loop terminator. Carries no condition; unconditionally reverse-jumps to the matching WHILE block on every execution (re-evaluation of the entry condition is the WHILE block's responsibility). is the spec-named "identification number for nesting" (the m in DO m / END m). Nested loops must use distinct LoopIds; matching is by exact value. Same-LoopId nesting is spec-undefined and not given special handling here. Active loop frames are carried block-to-block via the top-level WhileFrames JSON section (a keyed by LoopId-as-string, each entry recording the BeginLineNo of the WHILE block that opened that frame). Carried by as part of its tracked keys (mutated in Evaluation, must reach Logic-stage consumers and downstream blocks unchanged).">
|
||
<link rel="icon" href="../img/HiAPI.favicon.ico">
|
||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||
<link rel="stylesheet" href="../public/main.css">
|
||
<meta name="docfx:navrel" content="../toc.html">
|
||
<meta name="docfx:tocrel" content="toc.html">
|
||
|
||
<meta name="docfx:rel" content="../">
|
||
|
||
|
||
|
||
<meta name="loc:inThisArticle" content="In this article">
|
||
<meta name="loc:searchResultsCount" content="{count} results for "{query}"">
|
||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||
<meta name="loc:tocFilter" content="Filter by title">
|
||
<meta name="loc:nextArticle" content="Next">
|
||
<meta name="loc:prevArticle" content="Previous">
|
||
<meta name="loc:themeLight" content="Light">
|
||
<meta name="loc:themeDark" content="Dark">
|
||
<meta name="loc:themeAuto" content="Auto">
|
||
<meta name="loc:changeTheme" content="Change theme">
|
||
<meta name="loc:copy" content="Copy">
|
||
<meta name="loc:downloadPdf" content="Download PDF">
|
||
|
||
<script type="module" src="./../public/docfx.min.js"></script>
|
||
|
||
<script>
|
||
const theme = localStorage.getItem('theme') || 'auto'
|
||
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
|
||
</script>
|
||
|
||
</head>
|
||
|
||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||
<header class="bg-body border-bottom">
|
||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||
<div class="container-xxl flex-nowrap">
|
||
<a class="navbar-brand" href="../index.html">
|
||
<img id="logo" class="svg" src="../img/HiAPI.logo.png" alt="">
|
||
|
||
</a>
|
||
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
|
||
<i class="bi bi-three-dots"></i>
|
||
</button>
|
||
<div class="collapse navbar-collapse" id="navpanel">
|
||
<div id="navbar">
|
||
<form class="search" role="search" id="search">
|
||
<i class="bi bi-search"></i>
|
||
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
|
||
</form>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
</header>
|
||
|
||
<main class="container-xxl">
|
||
<div class="toc-offcanvas">
|
||
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
|
||
<div class="offcanvas-header">
|
||
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
|
||
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
|
||
</div>
|
||
<div class="offcanvas-body">
|
||
<nav class="toc" id="toc"></nav>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="content">
|
||
<div class="actionbar">
|
||
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
|
||
<i class="bi bi-list"></i>
|
||
</button>
|
||
|
||
<nav id="breadcrumb"></nav>
|
||
</div>
|
||
|
||
<article data-uid="Hi.NcParsers.Keywords.FanucWhileDo">
|
||
|
||
|
||
|
||
<h1 id="Hi_NcParsers_Keywords_FanucWhileDo" data-uid="Hi.NcParsers.Keywords.FanucWhileDo" class="text-break">
|
||
Class FanucWhileDo
|
||
</h1>
|
||
|
||
<div class="facts text-secondary">
|
||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcParsers.html">NcParsers</a>.<a class="xref" href="Hi.NcParsers.Keywords.html">Keywords</a></dd></dl>
|
||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||
</div>
|
||
|
||
<div class="markdown summary"><p>Fanuc Custom Macro B WHILE/END bounded-loop record. Stamped on the
|
||
host block by
|
||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Fanuc.FanucWhileDoSyntax.html">FanucWhileDoSyntax</a> after the
|
||
control-flow decision has been made; produced earlier by
|
||
<a class="xref" href="Hi.NcParsers.ParsingSyntaxs.Fanuc.FanucWhileDoParsingSyntax.html">FanucWhileDoParsingSyntax</a> as a
|
||
parsing-stage sub-section (<code>Parsing.FanucWhileDo</code>) carrying the
|
||
raw captured fields.</p>
|
||
<p>
|
||
Two phrases map to the same shape, distinguished by <a class="xref" href="Hi.NcParsers.Keywords.FanucWhileDo.html#Hi_NcParsers_Keywords_FanucWhileDo_Term">Term</a>:
|
||
<ul><li><code>WHILE [<bool-expr>] DO <m></code> — loop entry.
|
||
<a class="xref" href="Hi.NcParsers.Keywords.FanucWhileDo.html#Hi_NcParsers_Keywords_FanucWhileDo_Condition">Condition</a> holds the expression text from inside the
|
||
brackets at parsing time; substituted to a numeric
|
||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.json.nodes.jsonvalue">JsonValue</a> by
|
||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax</a> in place.
|
||
<a class="xref" href="Hi.NcParsers.Keywords.FanucWhileDo.html#Hi_NcParsers_Keywords_FanucWhileDo_ConditionEvaluated">ConditionEvaluated</a> carries the host-level truthy
|
||
outcome at stamp time.</li><li><code>END <m></code> — loop terminator. Carries no condition;
|
||
unconditionally reverse-jumps to the matching WHILE block on every
|
||
execution (re-evaluation of the entry condition is the WHILE block's
|
||
responsibility).</li></ul>
|
||
|
||
<p>
|
||
<a class="xref" href="Hi.NcParsers.Keywords.FanucWhileDo.html#Hi_NcParsers_Keywords_FanucWhileDo_LoopId">LoopId</a> is the spec-named "identification number for
|
||
nesting" (the <code>m</code> in <code>DO m</code> / <code>END m</code>). Nested loops
|
||
must use distinct LoopIds; matching is by exact value. Same-LoopId
|
||
nesting is spec-undefined and not given special handling here.
|
||
</p>
|
||
<p>
|
||
Active loop frames are carried block-to-block via the top-level
|
||
<code>WhileFrames</code> JSON section (a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.json.nodes.jsonobject">JsonObject</a>
|
||
keyed by LoopId-as-string, each entry recording the
|
||
<code>BeginLineNo</code> of the WHILE block that opened that frame).
|
||
Carried by <a class="xref" href="Hi.NcParsers.PostLogicSyntaxs.ModalCarrySyntax.html">ModalCarrySyntax</a> as part
|
||
of its <a class="xref" href="Hi.NcParsers.PostLogicSyntaxs.ModalCarrySyntax.html#Hi_NcParsers_PostLogicSyntaxs_ModalCarrySyntax_Logic">Logic</a> tracked
|
||
keys (mutated in Evaluation, must reach Logic-stage consumers and
|
||
downstream blocks unchanged).
|
||
</p>
|
||
</div>
|
||
<div class="markdown conceptual"></div>
|
||
|
||
<div class="codewrapper">
|
||
<pre><code class="lang-csharp hljs">public class FanucWhileDo</code></pre>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<dl class="typelist inheritance">
|
||
<dt>Inheritance</dt>
|
||
<dd>
|
||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||
<div><span class="xref">FanucWhileDo</span></div>
|
||
</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="typelist inheritedMembers">
|
||
<dt>Inherited Members</dt>
|
||
<dd>
|
||
<div>
|
||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||
</div>
|
||
<div>
|
||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||
</div>
|
||
<div>
|
||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||
</div>
|
||
<div>
|
||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||
</div>
|
||
<div>
|
||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||
</div>
|
||
<div>
|
||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||
</div>
|
||
<div>
|
||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="typelist extensionMethods">
|
||
<dt>Extension Methods</dt>
|
||
<dd>
|
||
<div>
|
||
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])</a>
|
||
</div>
|
||
<div>
|
||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)</a>
|
||
</div>
|
||
<div>
|
||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)</a>
|
||
</div>
|
||
<div>
|
||
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
|
||
</div>
|
||
<div>
|
||
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
|
||
</div>
|
||
<div>
|
||
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
|
||
</div>
|
||
<div>
|
||
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
|
||
</div>
|
||
</dd></dl>
|
||
|
||
|
||
|
||
|
||
|
||
<h2 class="section" id="properties">Properties
|
||
</h2>
|
||
|
||
|
||
<a id="Hi_NcParsers_Keywords_FanucWhileDo_Condition_" data-uid="Hi.NcParsers.Keywords.FanucWhileDo.Condition*"></a>
|
||
|
||
<h3 id="Hi_NcParsers_Keywords_FanucWhileDo_Condition" data-uid="Hi.NcParsers.Keywords.FanucWhileDo.Condition">
|
||
Condition
|
||
|
||
</h3>
|
||
|
||
<div class="markdown level1 summary"><p>Raw boolean expression text from inside the WHILE's <code>[...]</code>
|
||
brackets at Parsing time; substituted to a numeric
|
||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.json.nodes.jsonvalue">JsonValue</a> in place by
|
||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax</a> when the
|
||
expression evaluates successfully. The original text survives at
|
||
<code>Formula.FanucWhileDo.Condition</code>. Null on the END phrase.
|
||
Note: not written on the host-level stamp; the gate outcome lives at
|
||
<a class="xref" href="Hi.NcParsers.Keywords.FanucWhileDo.html#Hi_NcParsers_Keywords_FanucWhileDo_ConditionEvaluated">ConditionEvaluated</a>.</p>
|
||
</div>
|
||
<div class="markdown level1 conceptual"></div>
|
||
|
||
<div class="codewrapper">
|
||
<pre><code class="lang-csharp hljs">public string Condition { get; set; }</code></pre>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
<h4 class="section">Property Value</h4>
|
||
<dl class="parameters">
|
||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||
<dd></dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<a id="Hi_NcParsers_Keywords_FanucWhileDo_ConditionEvaluated_" data-uid="Hi.NcParsers.Keywords.FanucWhileDo.ConditionEvaluated*"></a>
|
||
|
||
<h3 id="Hi_NcParsers_Keywords_FanucWhileDo_ConditionEvaluated" data-uid="Hi.NcParsers.Keywords.FanucWhileDo.ConditionEvaluated">
|
||
ConditionEvaluated
|
||
|
||
</h3>
|
||
|
||
<div class="markdown level1 summary"><p>Tri-state outcome of evaluating the WHILE's boolean condition,
|
||
stamped on the host block by
|
||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Fanuc.FanucWhileDoSyntax.html">FanucWhileDoSyntax</a>:</p>
|
||
<ul><li><code>true</code> — condition met (body executes; loop continues).</li><li><code>false</code> — condition not met (loop exits; forward-jump
|
||
past matching END).</li><li><code>null</code> — evaluator could not produce a finite truth
|
||
value (vacant variable, parse error, NaN / ±∞); loop exits
|
||
defensively and emits
|
||
<code>FanucWhileDo--ConditionNotEvaluated</code>.</li></ul>
|
||
Null also on the END phrase (no condition to evaluate). The original
|
||
expression text is preserved at <code>Formula.FanucWhileDo.Condition</code>
|
||
by <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax</a>.
|
||
</div>
|
||
<div class="markdown level1 conceptual"></div>
|
||
|
||
<div class="codewrapper">
|
||
<pre><code class="lang-csharp hljs">public bool? ConditionEvaluated { get; set; }</code></pre>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
<h4 class="section">Property Value</h4>
|
||
<dl class="parameters">
|
||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>?</dt>
|
||
<dd></dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<a id="Hi_NcParsers_Keywords_FanucWhileDo_LoopId_" data-uid="Hi.NcParsers.Keywords.FanucWhileDo.LoopId*"></a>
|
||
|
||
<h3 id="Hi_NcParsers_Keywords_FanucWhileDo_LoopId" data-uid="Hi.NcParsers.Keywords.FanucWhileDo.LoopId">
|
||
LoopId
|
||
|
||
</h3>
|
||
|
||
<div class="markdown level1 summary"><p>The <code>m</code> identifier from <code>DO m</code> / <code>END m</code> — the
|
||
spec-named “identification number for nesting”. Nested loops use
|
||
distinct LoopIds (1–3 typical); WHILE and END pair by exact match.</p>
|
||
</div>
|
||
<div class="markdown level1 conceptual"></div>
|
||
|
||
<div class="codewrapper">
|
||
<pre><code class="lang-csharp hljs">public int LoopId { get; set; }</code></pre>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
<h4 class="section">Property Value</h4>
|
||
<dl class="parameters">
|
||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||
<dd></dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<a id="Hi_NcParsers_Keywords_FanucWhileDo_Term_" data-uid="Hi.NcParsers.Keywords.FanucWhileDo.Term*"></a>
|
||
|
||
<h3 id="Hi_NcParsers_Keywords_FanucWhileDo_Term" data-uid="Hi.NcParsers.Keywords.FanucWhileDo.Term">
|
||
Term
|
||
|
||
</h3>
|
||
|
||
<div class="markdown level1 summary"><p>Triggering phrase: <code>“WHILE...DO”</code> for the loop entry form,
|
||
<code>“END”</code> for the loop terminator.</p>
|
||
</div>
|
||
<div class="markdown level1 conceptual"></div>
|
||
|
||
<div class="codewrapper">
|
||
<pre><code class="lang-csharp hljs">public string Term { get; set; }</code></pre>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
<h4 class="section">Property Value</h4>
|
||
<dl class="parameters">
|
||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||
<dd></dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</article>
|
||
|
||
<div class="contribution d-print-none">
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
<div class="affix">
|
||
<nav id="affix"></nav>
|
||
</div>
|
||
</main>
|
||
|
||
<div class="container-xxl search-results" id="search-results"></div>
|
||
|
||
<footer class="border-top text-secondary">
|
||
<div class="container-xxl">
|
||
<div class="flex-fill">
|
||
<span> Copyright © 2025 <a href='https://superhightech.com.tw'>Tech Coordinate</a>. All rights reserved. <a href='https://superhightech.com.tw'>超級高科技股份有限公司</a> © 2025 版權所有 </span>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
</body>
|
||
</html>
|