HiNC-Deploy/HiNC-2025-win-desktop-Deploy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.NcParsers.SoftNcRunner.html

976 lines
37 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class SoftNcRunner | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class SoftNcRunner | HiAPI-C# 2025 ">
<meta name="description" content="Configurable NC Runner.">
<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 &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<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.SoftNcRunner">
<h1 id="Hi_NcParsers_SoftNcRunner" data-uid="Hi.NcParsers.SoftNcRunner" class="text-break">
Class SoftNcRunner
</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></dd></dl>
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>Configurable NC Runner.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class SoftNcRunner : IControlRunner, IMakeXmlSource</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">SoftNcRunner</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="Hi.Numerical.IControlRunner.html">IControlRunner</a></div>
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></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&lt;TSelf&gt;(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&lt;TSrc&gt;(TSrc, Action&lt;TSrc&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke&lt;TSrc, TDst&gt;(TSrc, Func&lt;TSrc, TDst&gt;)</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="constructors">Constructors
</h2>
<a id="Hi_NcParsers_SoftNcRunner__ctor_" data-uid="Hi.NcParsers.SoftNcRunner.#ctor*"></a>
<h3 id="Hi_NcParsers_SoftNcRunner__ctor" data-uid="Hi.NcParsers.SoftNcRunner.#ctor">
SoftNcRunner()
</h3>
<div class="markdown level1 summary"><p>Creates an empty runner; populate the pipeline lists before use.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SoftNcRunner()</code></pre>
</div>
<a id="Hi_NcParsers_SoftNcRunner__ctor_" data-uid="Hi.NcParsers.SoftNcRunner.#ctor*"></a>
<h3 id="Hi_NcParsers_SoftNcRunner__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_System_Object__System_Object___" data-uid="Hi.NcParsers.SoftNcRunner.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{System.Object},System.Object[])">
SoftNcRunner(XElement, string, string, IProgress&lt;object&gt;, object[])
</h3>
<div class="markdown level1 summary"><p>Reconstructs a <a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a> from a project XML element.
Each pipeline list (<a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_NcDependencyList">NcDependencyList</a>, <a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_Segmenter">Segmenter</a>,
<a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_NcInitializationList">NcInitializationList</a>, <a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_NcSyntaxList">NcSyntaxList</a>,
<a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_NcSemanticList">NcSemanticList</a>) is rehydrated via <a class="xref" href="Hi.Common.XmlUtils.XFactory.html">XFactory</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SoftNcRunner(XElement src, string baseDirectory, string relFile, IProgress&lt;object&gt; progress, object[] res = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
<dd><p>XML element previously produced by <a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_MakeXmlSource_System_String_System_String_System_Boolean_">MakeXmlSource(string, string, bool)</a>.</p>
</dd>
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Project base directory for resolving relative paths.</p>
</dd>
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Project file path relative to <code class="paramref">baseDirectory</code>.</p>
</dd>
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>&gt;</dt>
<dd><p>Diagnostic sink propagated to nested factories.</p>
</dd>
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
<dd><p>Optional ambient resources (e.g. <code>ProjectApiVersion</code> for legacy patches).</p>
</dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_NcParsers_SoftNcRunner_FanucNcRunner_" data-uid="Hi.NcParsers.SoftNcRunner.FanucNcRunner*"></a>
<h3 id="Hi_NcParsers_SoftNcRunner_FanucNcRunner" data-uid="Hi.NcParsers.SoftNcRunner.FanucNcRunner">
FanucNcRunner
</h3>
<div class="markdown level1 summary"><p>Brand preset for Fanuc — composes a <a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a> whose
<a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_NcSyntaxList">NcSyntaxList</a> comes from <a class="xref" href="Hi.NcParsers.Syntaxs.FanucSyntaxUtil.html#Hi_NcParsers_Syntaxs_FanucSyntaxUtil_DefaultSyntaxList">DefaultSyntaxList</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SoftNcRunner FanucNcRunner { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a></dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_SoftNcRunner_HeidenhainNcRunner_" data-uid="Hi.NcParsers.SoftNcRunner.HeidenhainNcRunner*"></a>
<h3 id="Hi_NcParsers_SoftNcRunner_HeidenhainNcRunner" data-uid="Hi.NcParsers.SoftNcRunner.HeidenhainNcRunner">
HeidenhainNcRunner
</h3>
<div class="markdown level1 summary"><p>Brand preset for Heidenhain — composes a <a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a> whose
<a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_NcSyntaxList">NcSyntaxList</a> comes from <a class="xref" href="Hi.NcParsers.Syntaxs.HeidenhainSyntaxUtil.html#Hi_NcParsers_Syntaxs_HeidenhainSyntaxUtil_DefaultSyntaxList">DefaultSyntaxList</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SoftNcRunner HeidenhainNcRunner { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a></dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_SoftNcRunner_MazakNcRunner_" data-uid="Hi.NcParsers.SoftNcRunner.MazakNcRunner*"></a>
<h3 id="Hi_NcParsers_SoftNcRunner_MazakNcRunner" data-uid="Hi.NcParsers.SoftNcRunner.MazakNcRunner">
MazakNcRunner
</h3>
<div class="markdown level1 summary"><p>Brand preset for Mazak — composes a <a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a> whose
<a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_NcSyntaxList">NcSyntaxList</a> comes from <a class="xref" href="Hi.NcParsers.Syntaxs.MazakSyntaxUtil.html#Hi_NcParsers_Syntaxs_MazakSyntaxUtil_DefaultSyntaxList">DefaultSyntaxList</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SoftNcRunner MazakNcRunner { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a></dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_SoftNcRunner_NcDependencyList_" data-uid="Hi.NcParsers.SoftNcRunner.NcDependencyList*"></a>
<h3 id="Hi_NcParsers_SoftNcRunner_NcDependencyList" data-uid="Hi.NcParsers.SoftNcRunner.NcDependencyList">
NcDependencyList
</h3>
<div class="markdown level1 summary"><p>External configuration providers consumed by syntaxes/semantics
(machine axes, tool offsets, coordinate tables, block-skip flags, etc.).</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;INcDependency&gt; NcDependencyList { 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.collections.generic.list-1">List</a>&lt;<a class="xref" href="Hi.NcParsers.Dependencys.INcDependency.html">INcDependency</a>&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_SoftNcRunner_NcInitializationList_" data-uid="Hi.NcParsers.SoftNcRunner.NcInitializationList*"></a>
<h3 id="Hi_NcParsers_SoftNcRunner_NcInitializationList" data-uid="Hi.NcParsers.SoftNcRunner.NcInitializationList">
NcInitializationList
</h3>
<div class="markdown level1 summary"><p>Seeds the initial <a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a> JSON state (e.g. home position, defaults).</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;INcInitializer&gt; NcInitializationList { 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.collections.generic.list-1">List</a>&lt;<a class="xref" href="Hi.NcParsers.Initializers.INcInitializer.html">INcInitializer</a>&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_SoftNcRunner_NcSemanticList_" data-uid="Hi.NcParsers.SoftNcRunner.NcSemanticList*"></a>
<h3 id="Hi_NcParsers_SoftNcRunner_NcSemanticList" data-uid="Hi.NcParsers.SoftNcRunner.NcSemanticList">
NcSemanticList
</h3>
<div class="markdown level1 summary"><p>Final-stage semantics that turn the last syntax layer into
<a class="xref" href="Hi.Numerical.SourcedActEntry.html">SourcedActEntry</a> records consumed by the runtime.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;INcSemantic&gt; NcSemanticList { 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.collections.generic.list-1">List</a>&lt;<a class="xref" href="Hi.NcParsers.Semantics.INcSemantic.html">INcSemantic</a>&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_SoftNcRunner_NcSyntaxList_" data-uid="Hi.NcParsers.SoftNcRunner.NcSyntaxList*"></a>
<h3 id="Hi_NcParsers_SoftNcRunner_NcSyntaxList" data-uid="Hi.NcParsers.SoftNcRunner.NcSyntaxList">
NcSyntaxList
</h3>
<div class="markdown level1 summary"><p>Ordered syntax pipeline. Each entry consumes the previous layer's
<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a> stream and emits the next layer.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;INcSyntax&gt; NcSyntaxList { 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.collections.generic.list-1">List</a>&lt;<a class="xref" href="Hi.NcParsers.Syntaxs.INcSyntax.html">INcSyntax</a>&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_SoftNcRunner_Segmenter_" data-uid="Hi.NcParsers.SoftNcRunner.Segmenter*"></a>
<h3 id="Hi_NcParsers_SoftNcRunner_Segmenter" data-uid="Hi.NcParsers.SoftNcRunner.Segmenter">
Segmenter
</h3>
<div class="markdown level1 summary"><p>Splits raw NC text into <a class="xref" href="Hi.NcParsers.Sentence.html">Sentence</a> blocks.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ISegmenter Segmenter { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.NcParsers.Segmenters.ISegmenter.html">ISegmenter</a></dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_SoftNcRunner_SiemensNcRunner_" data-uid="Hi.NcParsers.SoftNcRunner.SiemensNcRunner*"></a>
<h3 id="Hi_NcParsers_SoftNcRunner_SiemensNcRunner" data-uid="Hi.NcParsers.SoftNcRunner.SiemensNcRunner">
SiemensNcRunner
</h3>
<div class="markdown level1 summary"><p>Brand preset for Siemens — composes a <a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a> whose
<a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_NcSyntaxList">NcSyntaxList</a> comes from <a class="xref" href="Hi.NcParsers.Syntaxs.SiemensSyntaxUtil.html#Hi_NcParsers_Syntaxs_SiemensSyntaxUtil_DefaultSyntaxList">DefaultSyntaxList</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SoftNcRunner SiemensNcRunner { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a></dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_SoftNcRunner_SyntecNcRunner_" data-uid="Hi.NcParsers.SoftNcRunner.SyntecNcRunner*"></a>
<h3 id="Hi_NcParsers_SoftNcRunner_SyntecNcRunner" data-uid="Hi.NcParsers.SoftNcRunner.SyntecNcRunner">
SyntecNcRunner
</h3>
<div class="markdown level1 summary"><p>Brand preset for Syntec — composes a <a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a> whose
<a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_NcSyntaxList">NcSyntaxList</a> comes from <a class="xref" href="Hi.NcParsers.Syntaxs.SyntecSyntaxUtil.html#Hi_NcParsers_Syntaxs_SyntecSyntaxUtil_DefaultSyntaxList">DefaultSyntaxList</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SoftNcRunner SyntecNcRunner { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a></dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_SoftNcRunner_XName_" data-uid="Hi.NcParsers.SoftNcRunner.XName*"></a>
<h3 id="Hi_NcParsers_SoftNcRunner_XName" data-uid="Hi.NcParsers.SoftNcRunner.XName">
XName
</h3>
<div class="markdown level1 summary"><p>XML element name for <a class="xref" href="Hi.Common.XmlUtils.XFactory.html#Hi_Common_XmlUtils_XFactory_Generators">Generators</a> registration.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string XName { get; }</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>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_NcParsers_SoftNcRunner_ConfigureByMachiningChain_" data-uid="Hi.NcParsers.SoftNcRunner.ConfigureByMachiningChain*"></a>
<h3 id="Hi_NcParsers_SoftNcRunner_ConfigureByMachiningChain_Hi_Mech_IMachiningChain_" data-uid="Hi.NcParsers.SoftNcRunner.ConfigureByMachiningChain(Hi.Mech.IMachiningChain)">
ConfigureByMachiningChain(IMachiningChain)
</h3>
<div class="markdown level1 summary"><p>Configures this <a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a> to match the kinematic
<code class="paramref">chain</code> of a machine tool. Registers every axis
present on the chain into the <a class="xref" href="Hi.NcParsers.Dependencys.IMachineAxisConfig.html">IMachineAxisConfig</a> in
<a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_NcDependencyList">NcDependencyList</a> (linear or rotary, derived from
whether the chain's transformer implements
<a class="xref" href="Hi.Mech.Topo.IDynamicRotation.html">IDynamicRotation</a>). When the chain carries any rotary
axis, a <a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.html">NcKinematicsDependency</a> is appended so that
downstream syntaxes / semantics (e.g. <code>G53.1</code>, <code>G68.2</code>,
<a class="xref" href="Hi.NcParsers.Semantics.McLinearMotionSemantic.html">McLinearMotionSemantic</a>) can resolve
orientation; its <a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.html#Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_KinematicsProvider">KinematicsProvider</a>
is intentionally left null — the owning project service wires it up
after the solver instance is available (see
<code>LocalProjectService.BuildCoordinateConverter</code>).</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void ConfigureByMachiningChain(IMachiningChain chain)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>chain</code> <a class="xref" href="Hi.Mech.IMachiningChain.html">IMachiningChain</a></dt>
<dd><p>The machining chain whose axes and kinematics
the runner should match. No-op when null.</p>
</dd>
</dl>
<a id="Hi_NcParsers_SoftNcRunner_EnumerateSnapshotSyntaxs_" data-uid="Hi.NcParsers.SoftNcRunner.EnumerateSnapshotSyntaxs*"></a>
<h3 id="Hi_NcParsers_SoftNcRunner_EnumerateSnapshotSyntaxs" data-uid="Hi.NcParsers.SoftNcRunner.EnumerateSnapshotSyntaxs">
EnumerateSnapshotSyntaxs()
</h3>
<div class="markdown level1 summary"><p>Enumerates every <a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html">SnapshotSyntax</a> reachable from
<a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_NcSyntaxList">NcSyntaxList</a>, including those nested inside any
top-level <a class="xref" href="Hi.NcParsers.Syntaxs.BundleSyntax.html">BundleSyntax</a>'s inner list.
Yields in pipeline-execution order: each top-level slot in turn,
and within a bundle slot the bundle's <code>SyntaxList</code> order.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IEnumerable&lt;SnapshotSyntax&gt; EnumerateSnapshotSyntaxs()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html">SnapshotSyntax</a>&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_SoftNcRunner_FromLegacyNcEnvXml_" data-uid="Hi.NcParsers.SoftNcRunner.FromLegacyNcEnvXml*"></a>
<h3 id="Hi_NcParsers_SoftNcRunner_FromLegacyNcEnvXml_System_Xml_Linq_XElement_Hi_Mech_IMachiningChain_" data-uid="Hi.NcParsers.SoftNcRunner.FromLegacyNcEnvXml(System.Xml.Linq.XElement,Hi.Mech.IMachiningChain)">
FromLegacyNcEnvXml(XElement, IMachiningChain)
</h3>
<div class="markdown level1 summary"><p>Creates a <a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a> from legacy <code>HardNcEnv</code> XML.
Picks the brand-specific runner by the <code>CncBrand</code> element and
populates dependencies from the legacy XML values. When a
<code class="paramref">chain</code> is provided, also calls
<a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_ConfigureByMachiningChain_Hi_Mech_IMachiningChain_">ConfigureByMachiningChain(IMachiningChain)</a> so the runner's axis
configuration and kinematics dependency reflect the machine tool
loaded alongside the legacy project.
Remove this region when <code>HardNcEnv</code> is fully replaced.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SoftNcRunner FromLegacyNcEnvXml(XElement ncEnvXml, IMachiningChain chain = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>ncEnvXml</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
<dd><p>The inner XML element of the legacy <code>HardNcEnv</code>.</p>
</dd>
<dt><code>chain</code> <a class="xref" href="Hi.Mech.IMachiningChain.html">IMachiningChain</a></dt>
<dd><p>Optional machining chain for axis/kinematics configuration.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a></dt>
<dd><p>A configured <a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a>.</p>
</dd>
</dl>
<a id="Hi_NcParsers_SoftNcRunner_GetSourcedActEntrysFromNode_" data-uid="Hi.NcParsers.SoftNcRunner.GetSourcedActEntrysFromNode*"></a>
<h3 id="Hi_NcParsers_SoftNcRunner_GetSourcedActEntrysFromNode_Hi_Common_Collections_LazyLinkedListNode_Hi_NcParsers_Syntaxs_SyntaxPiece__Hi_NcParsers_NcDiagnosticProgress_System_Threading_CancellationToken_" data-uid="Hi.NcParsers.SoftNcRunner.GetSourcedActEntrysFromNode(Hi.Common.Collections.LazyLinkedListNode{Hi.NcParsers.Syntaxs.SyntaxPiece},Hi.NcParsers.NcDiagnosticProgress,System.Threading.CancellationToken)">
GetSourcedActEntrysFromNode(LazyLinkedListNode&lt;SyntaxPiece&gt;, NcDiagnosticProgress, CancellationToken)
</h3>
<div class="markdown level1 summary"><p>Drives the <a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_NcSemanticList">NcSemanticList</a> over the post-syntax
<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a> stream starting at <code class="paramref">startNode</code>,
yielding a <a class="xref" href="Hi.Numerical.SourcedActEntry.html">SourcedActEntry</a> for each emitted <a class="xref" href="Hi.Numerical.Acts.IAct.html">IAct</a>
(or a single null-act entry when a semantic produces no acts but still
updates the source <a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a>).</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IEnumerable&lt;SourcedActEntry&gt; GetSourcedActEntrysFromNode(LazyLinkedListNode&lt;SyntaxPiece&gt; startNode, NcDiagnosticProgress ncDiagnosticProgress, CancellationToken cancellationToken)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>startNode</code> <a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html">LazyLinkedListNode</a>&lt;<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a>&gt;</dt>
<dd><p>First node to evaluate; iteration walks <a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html#Hi_Common_Collections_LazyLinkedListNode_1_Next">Next</a>.</p>
</dd>
<dt><code>ncDiagnosticProgress</code> <a class="xref" href="Hi.NcParsers.NcDiagnosticProgress.html">NcDiagnosticProgress</a></dt>
<dd><p>Sink for semantic exceptions.</p>
</dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd><p>Cancellation token (checked between blocks).</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Hi.Numerical.SourcedActEntry.html">SourcedActEntry</a>&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_SoftNcRunner_MakeXmlSource_" data-uid="Hi.NcParsers.SoftNcRunner.MakeXmlSource*"></a>
<h3 id="Hi_NcParsers_SoftNcRunner_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.SoftNcRunner.MakeXmlSource(System.String,System.String,System.Boolean)">
MakeXmlSource(string, string, bool)
</h3>
<div class="markdown level1 summary"><p>Creates an XML representation of the object.
This method may also generate additional resources such as related files.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The base directory for resolving relative paths</p>
</dd>
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The relative file path for the XML source</p>
</dd>
<dt><code>exhibitionOnly</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>if true, the extended file creation is suppressed.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
<dd><p>An XML element representing the object's state</p>
</dd>
</dl>
<h4 class="section" id="Hi_NcParsers_SoftNcRunner_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
Since the folder can be moving with the configuration file.</p>
</div>
<a id="Hi_NcParsers_SoftNcRunner_RunControlLines_" data-uid="Hi.NcParsers.SoftNcRunner.RunControlLines*"></a>
<h3 id="Hi_NcParsers_SoftNcRunner_RunControlLines_System_String_System_Collections_Generic_IEnumerable_System_String__Hi_MachiningProcs_MachiningSession_Hi_MachiningProcs_SessionProgress_System_Threading_CancellationToken_" data-uid="Hi.NcParsers.SoftNcRunner.RunControlLines(System.String,System.Collections.Generic.IEnumerable{System.String},Hi.MachiningProcs.MachiningSession,Hi.MachiningProcs.SessionProgress,System.Threading.CancellationToken)">
RunControlLines(string, IEnumerable&lt;string&gt;, MachiningSession, SessionProgress, CancellationToken)
</h3>
<div class="markdown level1 summary"><p>Runs raw Control lines and yields source sentence and Act pairs.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IEnumerable&lt;SourcedActEntry&gt; RunControlLines(string relFilePath, IEnumerable&lt;string&gt; lines, MachiningSession machiningSession, SessionProgress sessionProgress, CancellationToken cancellationToken)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>relFilePath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The relative path of the control file</p>
</dd>
<dt><code>lines</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd><p>The enumerable collection of command (control code) lines</p>
</dd>
<dt><code>machiningSession</code> <a class="xref" href="Hi.MachiningProcs.MachiningSession.html">MachiningSession</a></dt>
<dd><p>Session-scoped state shared across multiple
<a class="xref" href="Hi.Numerical.IControlRunner.html#Hi_Numerical_IControlRunner_RunControlLines_System_String_System_Collections_Generic_IEnumerable_System_String__Hi_MachiningProcs_MachiningSession_Hi_MachiningProcs_SessionProgress_System_Threading_CancellationToken_">RunControlLines(string, IEnumerable&lt;string&gt;, MachiningSession, SessionProgress, CancellationToken)</a> calls (e.g. lazy-initialized pipeline state,
file-index counter).</p>
</dd>
<dt><code>sessionProgress</code> <a class="xref" href="Hi.MachiningProcs.SessionProgress.html">SessionProgress</a></dt>
<dd></dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd><p>Cancellation token to cancel the operation</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Hi.Numerical.SourcedActEntry.html">SourcedActEntry</a>&gt;</dt>
<dd><p>Enumerable of source sentence and Act pairs</p>
</dd>
</dl>
<a id="Hi_NcParsers_SoftNcRunner_SetAllSnapshotSyntaxEnabled_" data-uid="Hi.NcParsers.SoftNcRunner.SetAllSnapshotSyntaxEnabled*"></a>
<h3 id="Hi_NcParsers_SoftNcRunner_SetAllSnapshotSyntaxEnabled_System_Boolean_" data-uid="Hi.NcParsers.SoftNcRunner.SetAllSnapshotSyntaxEnabled(System.Boolean)">
SetAllSnapshotSyntaxEnabled(bool)
</h3>
<div class="markdown level1 summary"><p>Sets <a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_IsEnabled">IsEnabled</a> on every
<a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html">SnapshotSyntax</a> reachable from <a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_NcSyntaxList">NcSyntaxList</a>
(including those nested inside top-level
<a class="xref" href="Hi.NcParsers.Syntaxs.BundleSyntax.html">BundleSyntax</a>) to <code class="paramref">isEnabled</code>.
Callers that need finer control (per-section toggling, instance
inspection) should iterate <a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_EnumerateSnapshotSyntaxs">EnumerateSnapshotSyntaxs()</a>
directly.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void SetAllSnapshotSyntaxEnabled(bool isEnabled)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>isEnabled</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</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>
Reference in New Issue View Git Blame Copy Permalink