HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.html
2026-01-22 02:28:01 +08:00

608 lines
20 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class NcSyntaxUtil | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class NcSyntaxUtil | HiAPI-C# 2025 ">
<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.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil">
<h1 id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil" class="text-break">
Class NcSyntaxUtil
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Numerical.html">Numerical</a>.<a class="xref" href="Hi.Numerical.SoftParsers.html">SoftParsers</a>.<a class="xref" href="Hi.Numerical.SoftParsers.Syntaxs.html">Syntaxs</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static class NcSyntaxUtil</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">NcSyntaxUtil</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>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_AxisTagList_" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.AxisTagList*"></a>
<h3 id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_AxisTagList" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.AxisTagList">
AxisTagList
</h3>
<div class="markdown level1 summary"><p>tag list for the motion axis tags.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static List&lt;string&gt; AxisTagList { 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="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd></dd>
</dl>
<h4 class="section" id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_AxisTagList_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Must be initialized before MixedNcSyntaxList to avoid static initialization cycle.</p>
</div>
<a id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_FanucCommentSyntax_" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.FanucCommentSyntax*"></a>
<h3 id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_FanucCommentSyntax" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.FanucCommentSyntax">
FanucCommentSyntax
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SequencialNcSyntax FanucCommentSyntax { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Numerical.SoftParsers.SyntaxBased.SequencialNcSyntax.html">SequencialNcSyntax</a></dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_FloatTagList_" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.FloatTagList*"></a>
<h3 id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_FloatTagList" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.FloatTagList">
FloatTagList
</h3>
<div class="markdown level1 summary"><p>tag list for the float number tags.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static List&lt;string&gt; FloatTagList { 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="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd></dd>
</dl>
<h4 class="section" id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_FloatTagList_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Must be initialized before MixedNcSyntaxList to avoid static initialization cycle.</p>
</div>
<a id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_HeidenhainCommentSyntax_" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.HeidenhainCommentSyntax*"></a>
<h3 id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_HeidenhainCommentSyntax" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.HeidenhainCommentSyntax">
HeidenhainCommentSyntax
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SequencialNcSyntax HeidenhainCommentSyntax { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Numerical.SoftParsers.SyntaxBased.SequencialNcSyntax.html">SequencialNcSyntax</a></dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_MazakCommentSyntax_" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.MazakCommentSyntax*"></a>
<h3 id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_MazakCommentSyntax" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.MazakCommentSyntax">
MazakCommentSyntax
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SequencialNcSyntax MazakCommentSyntax { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Numerical.SoftParsers.SyntaxBased.SequencialNcSyntax.html">SequencialNcSyntax</a></dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_MixedCommentSyntax_" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.MixedCommentSyntax*"></a>
<h3 id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_MixedCommentSyntax" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.MixedCommentSyntax">
MixedCommentSyntax
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SequencialNcSyntax MixedCommentSyntax { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Numerical.SoftParsers.SyntaxBased.SequencialNcSyntax.html">SequencialNcSyntax</a></dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_MixedIndexNoteSyntax_" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.MixedIndexNoteSyntax*"></a>
<h3 id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_MixedIndexNoteSyntax" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.MixedIndexNoteSyntax">
MixedIndexNoteSyntax
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SequencialNcSyntax MixedIndexNoteSyntax { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Numerical.SoftParsers.SyntaxBased.SequencialNcSyntax.html">SequencialNcSyntax</a></dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_MixedNcSyntaxList_" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.MixedNcSyntaxList*"></a>
<h3 id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_MixedNcSyntaxList" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.MixedNcSyntaxList">
MixedNcSyntaxList
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static List&lt;INcSyntax&gt; MixedNcSyntaxList { 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.collections.generic.list-1">List</a>&lt;<a class="xref" href="Hi.Numerical.SoftParsers.Syntaxs.INcSyntax.html">INcSyntax</a>&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_SiemensCommentSyntax_" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.SiemensCommentSyntax*"></a>
<h3 id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_SiemensCommentSyntax" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.SiemensCommentSyntax">
SiemensCommentSyntax
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SequencialNcSyntax SiemensCommentSyntax { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Numerical.SoftParsers.SyntaxBased.SequencialNcSyntax.html">SequencialNcSyntax</a></dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_SyntecCommentSyntax_" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.SyntecCommentSyntax*"></a>
<h3 id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_SyntecCommentSyntax" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.SyntecCommentSyntax">
SyntecCommentSyntax
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SequencialNcSyntax SyntecCommentSyntax { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Numerical.SoftParsers.SyntaxBased.SequencialNcSyntax.html">SequencialNcSyntax</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_GrabTagAssignment_" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.GrabTagAssignment*"></a>
<h3 id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_GrabTagAssignment_System_String__System_Collections_Generic_IEnumerable_System_String__System_String_System_Collections_Generic_IEnumerable_System_String__" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.GrabTagAssignment(System.String@,System.Collections.Generic.IEnumerable{System.String},System.String,System.Collections.Generic.IEnumerable{System.String})">
GrabTagAssignment(ref string, IEnumerable&lt;string&gt;, string, IEnumerable&lt;string&gt;)
</h3>
<div class="markdown level1 summary"><p>Get Tag Assignments with = sign.
ex.
Siemens: R1=100.5, Z=V1+V2, Z=V1 - V3 * V2 F200
Heidenhain: Q1 = Q2 + 100
Fanuc: #1=#2+#3</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static List&lt;TagSetup&gt; GrabTagAssignment(ref string unManagedText, IEnumerable&lt;string&gt; targetTags, string varPrefix, IEnumerable&lt;string&gt; terminateWords = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>unManagedText</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The NC text to parse and modify.</p>
</dd>
<dt><code>targetTags</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>candidate target tags that to be setup value</p>
</dd>
<dt><code>varPrefix</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>variable index code prefix.</p>
</dd>
<dt><code>terminateWords</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>words that terminate expression (e.g., F, G, M, S).
These are different from varPrefix - they signal end of expression, not variables.</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.list-1">List</a>&lt;<a class="xref" href="Hi.Numerical.SoftParsers.Syntaxs.TagSetup.html">TagSetup</a>&gt;</dt>
<dd><p>List of extracted tag assignments.</p>
</dd>
</dl>
<a id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_GrabTagSetup_" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.GrabTagSetup*"></a>
<h3 id="Hi_Numerical_SoftParsers_Syntaxs_NcSyntaxUtil_GrabTagSetup_System_String__System_Collections_Generic_IEnumerable_System_String__System_String_" data-uid="Hi.Numerical.SoftParsers.Syntaxs.NcSyntaxUtil.GrabTagSetup(System.String@,System.Collections.Generic.IEnumerable{System.String},System.String)">
GrabTagSetup(ref string, IEnumerable&lt;string&gt;, string)
</h3>
<div class="markdown level1 summary"><p>Get Tag Setups.
Concatenated tag setup syntax.
The syntax is for assignment with space or no splition assignment.
The syntax is not for assignment sign (=) syntax.
ex.
Heidenhain: L X Q2 Y33.4 FQ1
Heidenhain: L X Q2 Y33.4 F+Q1
ISO: X100.3Y3.3
Fanuc Macro: X[#1+#2] Y[#1*2+100]</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static List&lt;TagSetup&gt; GrabTagSetup(ref string unManagedText, IEnumerable&lt;string&gt; targetTags, string varPrefix)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>unManagedText</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The NC text to parse and modify.</p>
</dd>
<dt><code>targetTags</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>candidate target tags that to be setup value</p>
</dd>
<dt><code>varPrefix</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>variable index code prefix. ex. Fanuc # for #123; Heidenhain Q for Q123.</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.list-1">List</a>&lt;<a class="xref" href="Hi.Numerical.SoftParsers.Syntaxs.TagSetup.html">TagSetup</a>&gt;</dt>
<dd><p>List of extracted tag setups.</p>
</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>