This repository has been archived on 2026-10-11. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.NcParsers.LogicSyntaxs.PolarInterpolationSyntax.html
T

632 lines
26 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class PolarInterpolationSyntax | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class PolarInterpolationSyntax | HiAPI-C# 2025 ">
<meta name="description" content="Maintains the modal Polar Coordinate Interpolation valve section () for Fanuc G12.1/G13.1. On a G12.1 block: consumes the flag, reads the block&#39;s own X/C words as the anchor (; the X word is a diameter and is halved), converts the previous program position (program X/Z + machine C angle) onto the polar hypothetical plane via , and writes both the state section and the entry position. Mirrors HardNc HardNcLine case 12_100. On a G13.1 block: consumes the flag and stops carrying the state — the block itself is already Cartesian, matching HardNc case 13_100. On other blocks: re-materializes the previous block&#39;s state section (single-step lookback carry, the pattern), and warns FanucPolar--IncompatibleGCode for G-codes outside the Fanuc polar-mode whitelist (mirrors HardNc IsGCodePolarModeCompatible). Must be placed before so the downstream can consume the hypothetical C word before it is interpreted as a rotary machine axis.">
<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.LogicSyntaxs.PolarInterpolationSyntax">
<h1 id="Hi_NcParsers_LogicSyntaxs_PolarInterpolationSyntax" data-uid="Hi.NcParsers.LogicSyntaxs.PolarInterpolationSyntax" class="text-break">
Class PolarInterpolationSyntax
</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.LogicSyntaxs.html">LogicSyntaxs</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>Maintains the modal Polar Coordinate Interpolation valve section
(<a class="xref" href="Hi.NcParsers.Keywords.IPolarInterpolationDef.html#Hi_NcParsers_Keywords_IPolarInterpolationDef_PolarInterpolationState">PolarInterpolationState</a>) for Fanuc
G12.1/G13.1.</p>
<p>
On a G12.1 block: consumes the flag, reads the block's own X/C words as
the anchor (<a class="xref" href="Hi.NcParsers.Keywords.PolarInterpolation.html#Hi_NcParsers_Keywords_PolarInterpolation_InitRxcz">InitRxcz</a>; the X word is a
diameter and is halved), converts the previous program position
(program X/Z + machine C angle) onto the polar hypothetical plane via
<a class="xref" href="Hi.Numerical.MechNcUtil.html#Hi_Numerical_MechNcUtil_GetProgramPolarRxczByOrdinaryProgramXcz_Hi_Geom_Vec3d_">GetProgramPolarRxczByOrdinaryProgramXcz(Vec3d)</a>, and
writes both the state section and the entry
<a class="xref" href="Hi.NcParsers.Keywords.IPolarInterpolationDef.html#Hi_NcParsers_Keywords_IPolarInterpolationDef_ProgramPolarRxcz">ProgramPolarRxcz</a> position.
Mirrors HardNc <code>HardNcLine</code> case <code>12_100</code>.
</p>
<p>
On a G13.1 block: consumes the flag and stops carrying the state — the
block itself is already Cartesian, matching HardNc case <code>13_100</code>.
</p>
<p>
On other blocks: re-materializes the previous block's state section
(single-step lookback carry, the <a class="xref" href="Hi.NcParsers.LogicSyntaxs.PositioningSyntax.html">PositioningSyntax</a> pattern),
and warns <code>FanucPolar--IncompatibleGCode</code> for G-codes outside the
Fanuc polar-mode whitelist (mirrors HardNc
<code>IsGCodePolarModeCompatible</code>).
</p>
Must be placed <b>before</b> <a class="xref" href="Hi.NcParsers.LogicSyntaxs.McAbcSyntax.html">McAbcSyntax</a> so the downstream
<a class="xref" href="Hi.NcParsers.LogicSyntaxs.ProgramRxczSyntax.html">ProgramRxczSyntax</a> can consume the hypothetical C word before
it is interpreted as a rotary machine axis.
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class PolarInterpolationSyntax : ISituNcSyntax, INcSyntax, 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">PolarInterpolationSyntax</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="Hi.NcParsers.Syntaxs.ISituNcSyntax.html">ISituNcSyntax</a></div>
<div><a class="xref" href="Hi.NcParsers.Syntaxs.INcSyntax.html">INcSyntax</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 id="Hi_NcParsers_LogicSyntaxs_PolarInterpolationSyntax_examples">Examples</h2>
<p>Bare <code>G12.1</code> entry — anchor words absent so
<code>InitRxcz</code> is zero; the entry position is the previous stored
program position (program X/Z with the previous machine C angle) mapped
onto the hypothetical plane:
#Previous:</p>
<pre><code class="lang-csharp">{ "ProgramXyz": { "X": 58, "Y": 0, "Z": 25 }, "MachineCoordinateState": { "X": 58, "Y": 0, "Z": 25, "C": 0 } }</code></pre>
<p>#BeforeBuild:</p>
<pre><code class="lang-csharp">{ "Parsing": { "Flags": ["G12.1"] } }</code></pre>
<p>#AfterBuild:</p>
<pre><code class="lang-csharp">{
"PolarInterpolationState": { "Dir": "XC", "InitRxcz": { "X": 0, "Y": 0, "Z": 0 } },
"ProgramPolarRxcz": { "X": 58, "Y": 0, "Z": 25 }
}</code></pre>
<p><code>G12.1 X10 C0</code> — the block's own words anchor <code>InitRxcz</code>
(X diameter 10 → radius 5) and the entry position is stored relative to
that anchor:
#Previous:</p>
<pre><code class="lang-csharp">{ "ProgramXyz": { "X": 58, "Y": 0, "Z": 25 }, "MachineCoordinateState": { "X": 58, "Y": 0, "Z": 25, "C": 0 } }</code></pre>
<p>#BeforeBuild:</p>
<pre><code class="lang-csharp">{ "Parsing": { "X": 10, "C": 0, "Flags": ["G12.1"] } }</code></pre>
<p>#AfterBuild:</p>
<pre><code class="lang-csharp">{
"PolarInterpolationState": { "Dir": "XC", "InitRxcz": { "X": 5, "Y": 0, "Z": 0 } },
"ProgramPolarRxcz": { "X": 53, "Y": 0, "Z": 25 }
}</code></pre>
<p>Carry — no G12.1/G13.1 edge on the block, previous block is in polar
mode, so the state section is re-materialized; other parsing content is
untouched (G01 is polar-compatible, no diagnostic):
#Previous:</p>
<pre><code class="lang-csharp">{ "PolarInterpolationState": { "Dir": "XC", "InitRxcz": { "X": 0, "Y": 0, "Z": 0 } } }</code></pre>
<p>#BeforeBuild:</p>
<pre><code class="lang-csharp">{ "Parsing": { "Flags": ["G01"] } }</code></pre>
<p>#AfterBuild:</p>
<pre><code class="lang-csharp">{
"Parsing": { "Flags": ["G01"] },
"PolarInterpolationState": { "Dir": "XC", "InitRxcz": { "X": 0, "Y": 0, "Z": 0 } }
}</code></pre>
<p><code>G13.1</code> — the flag is consumed and the state is not carried; the
block is already Cartesian:
#Previous:</p>
<pre><code class="lang-csharp">{ "PolarInterpolationState": { "Dir": "XC", "InitRxcz": { "X": 0, "Y": 0, "Z": 0 } } }</code></pre>
<p>#BeforeBuild:</p>
<pre><code class="lang-csharp">{ "Parsing": { "Flags": ["G13.1"] } }</code></pre>
<p>#AfterBuild:</p>
<pre><code class="lang-csharp">{}</code></pre>
<p><code>G12.1</code> repeated while polar mode is already active — HardNc keeps
the old anchor (the modal flag does not change), so the state is
carried unchanged and the block's axis words are left for
<a class="xref" href="Hi.NcParsers.LogicSyntaxs.ProgramRxczSyntax.html">ProgramRxczSyntax</a> to treat as plain polar motion:
#Previous:</p>
<pre><code class="lang-csharp">{ "PolarInterpolationState": { "Dir": "XC", "InitRxcz": { "X": 0, "Y": 0, "Z": 0 } } }</code></pre>
<p>#BeforeBuild:</p>
<pre><code class="lang-csharp">{ "Parsing": { "X": 20, "Flags": ["G12.1"] } }</code></pre>
<p>#AfterBuild:</p>
<pre><code class="lang-csharp">{
"Parsing": { "X": 20 },
"PolarInterpolationState": { "Dir": "XC", "InitRxcz": { "X": 0, "Y": 0, "Z": 0 } }
}</code></pre>
<h2 class="section" id="constructors">Constructors
</h2>
<a id="Hi_NcParsers_LogicSyntaxs_PolarInterpolationSyntax__ctor_" data-uid="Hi.NcParsers.LogicSyntaxs.PolarInterpolationSyntax.#ctor*"></a>
<h3 id="Hi_NcParsers_LogicSyntaxs_PolarInterpolationSyntax__ctor" data-uid="Hi.NcParsers.LogicSyntaxs.PolarInterpolationSyntax.#ctor">
PolarInterpolationSyntax()
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance with default settings.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public PolarInterpolationSyntax()</code></pre>
</div>
<a id="Hi_NcParsers_LogicSyntaxs_PolarInterpolationSyntax__ctor_" data-uid="Hi.NcParsers.LogicSyntaxs.PolarInterpolationSyntax.#ctor*"></a>
<h3 id="Hi_NcParsers_LogicSyntaxs_PolarInterpolationSyntax__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.LogicSyntaxs.PolarInterpolationSyntax.#ctor(System.Xml.Linq.XElement)">
PolarInterpolationSyntax(XElement)
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance by deserializing from the given XML element.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public PolarInterpolationSyntax(XElement src)</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>Source XML element.</p>
</dd>
</dl>
<h2 class="section" id="fields">Fields
</h2>
<h3 id="Hi_NcParsers_LogicSyntaxs_PolarInterpolationSyntax_IncompatibleDiagId" data-uid="Hi.NcParsers.LogicSyntaxs.PolarInterpolationSyntax.IncompatibleDiagId">
IncompatibleDiagId
</h3>
<div class="markdown level1 summary"><p>Diagnostic id for G-codes that Fanuc disallows during polar
coordinate interpolation (per the Fanuc manual whitelist). Emitted by
<a class="xref" href="Hi.NcParsers.LogicSyntaxs.PolarGCodeCheckSyntax.html">PolarGCodeCheckSyntax</a>, which runs at the FRONT of the
Logic bundle so mode/plane/offset codes (G17-G19, G20/G21, G49, ...)
are still visible in <code>Parsing.Flags</code> when the scan runs; see its
doc for the residual parameterized-code blind spot.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string IncompatibleDiagId = &quot;FanucPolar--IncompatibleGCode&quot;</code></pre>
</div>
<h4 class="section">Field 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="properties">Properties
</h2>
<a id="Hi_NcParsers_LogicSyntaxs_PolarInterpolationSyntax_Name_" data-uid="Hi.NcParsers.LogicSyntaxs.PolarInterpolationSyntax.Name*"></a>
<h3 id="Hi_NcParsers_LogicSyntaxs_PolarInterpolationSyntax_Name" data-uid="Hi.NcParsers.LogicSyntaxs.PolarInterpolationSyntax.Name">
Name
</h3>
<div class="markdown level1 summary"><p>Syntax kind name (typically the concrete type name).</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Name { 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>
<a id="Hi_NcParsers_LogicSyntaxs_PolarInterpolationSyntax_Pair_" data-uid="Hi.NcParsers.LogicSyntaxs.PolarInterpolationSyntax.Pair*"></a>
<h3 id="Hi_NcParsers_LogicSyntaxs_PolarInterpolationSyntax_Pair" data-uid="Hi.NcParsers.LogicSyntaxs.PolarInterpolationSyntax.Pair">
Pair
</h3>
<div class="markdown level1 summary"><p>The polar axis pair this machine runs G12.1 with —
<a class="xref" href="Hi.NcParsers.Keywords.PolarInterpolation.html#Hi_NcParsers_Keywords_PolarInterpolation_DirXC">DirXC</a> (default),
<a class="xref" href="Hi.NcParsers.Keywords.PolarInterpolation.html#Hi_NcParsers_Keywords_PolarInterpolation_DirYA">DirYA</a> or
<a class="xref" href="Hi.NcParsers.Keywords.PolarInterpolation.html#Hi_NcParsers_Keywords_PolarInterpolation_DirZB">DirZB</a>. Machine configuration (Fanuc
selects the pair by parameters, not by NC words), carried per
project through this syntax's XML. Written into the state section's
<a class="xref" href="Hi.NcParsers.Keywords.PolarInterpolation.html#Hi_NcParsers_Keywords_PolarInterpolation_Dir">Dir</a> for every downstream reader.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Pair { 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_LogicSyntaxs_PolarInterpolationSyntax_XName_" data-uid="Hi.NcParsers.LogicSyntaxs.PolarInterpolationSyntax.XName*"></a>
<h3 id="Hi_NcParsers_LogicSyntaxs_PolarInterpolationSyntax_XName" data-uid="Hi.NcParsers.LogicSyntaxs.PolarInterpolationSyntax.XName">
XName
</h3>
<div class="markdown level1 summary"><p>XML element name used to register this syntax with <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 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_LogicSyntaxs_PolarInterpolationSyntax_Build_" data-uid="Hi.NcParsers.LogicSyntaxs.PolarInterpolationSyntax.Build*"></a>
<h3 id="Hi_NcParsers_LogicSyntaxs_PolarInterpolationSyntax_Build_Hi_Common_Collections_LazyLinkedListNode_Hi_NcParsers_Syntaxs_SyntaxPiece__System_Collections_Generic_List_Hi_NcParsers_Dependencys_INcDependency__Hi_NcParsers_NcDiagnosticProgress_" data-uid="Hi.NcParsers.LogicSyntaxs.PolarInterpolationSyntax.Build(Hi.Common.Collections.LazyLinkedListNode{Hi.NcParsers.Syntaxs.SyntaxPiece},System.Collections.Generic.List{Hi.NcParsers.Dependencys.INcDependency},Hi.NcParsers.NcDiagnosticProgress)">
Build(LazyLinkedListNode&lt;SyntaxPiece&gt;, List&lt;INcDependency&gt;, NcDiagnosticProgress)
</h3>
<div class="markdown level1 summary"><p>Build syntax arrangement into the
<code class="paramref">syntaxPieceNode</code> in-place.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Build(LazyLinkedListNode&lt;SyntaxPiece&gt; syntaxPieceNode, List&lt;INcDependency&gt; ncDependencyList, NcDiagnosticProgress ncDiagnosticProgress)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>syntaxPieceNode</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></dd>
<dt><code>ncDependencyList</code> <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>
<dt><code>ncDiagnosticProgress</code> <a class="xref" href="Hi.NcParsers.NcDiagnosticProgress.html">NcDiagnosticProgress</a></dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_LogicSyntaxs_PolarInterpolationSyntax_MakeXmlSource_" data-uid="Hi.NcParsers.LogicSyntaxs.PolarInterpolationSyntax.MakeXmlSource*"></a>
<h3 id="Hi_NcParsers_LogicSyntaxs_PolarInterpolationSyntax_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.LogicSyntaxs.PolarInterpolationSyntax.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_LogicSyntaxs_PolarInterpolationSyntax_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_LogicSyntaxs_PolarInterpolationSyntax_Reg_" data-uid="Hi.NcParsers.LogicSyntaxs.PolarInterpolationSyntax.Reg*"></a>
<h3 id="Hi_NcParsers_LogicSyntaxs_PolarInterpolationSyntax_Reg_Hi_Common_XmlUtils_XFactory_" data-uid="Hi.NcParsers.LogicSyntaxs.PolarInterpolationSyntax.Reg(Hi.Common.XmlUtils.XFactory)">
Reg(XFactory)
</h3>
<div class="markdown level1 summary"><p>Registers this type's deserializer with the given <a class="xref" href="Hi.Common.XmlUtils.XFactory.html">XFactory</a>
(or <a class="xref" href="Hi.Common.XmlUtils.XFactory.html#Hi_Common_XmlUtils_XFactory_Default">Default</a> when <code class="paramref">factory</code> is
<code>null</code>). Idempotent.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void Reg(XFactory factory = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>factory</code> <a class="xref" href="Hi.Common.XmlUtils.XFactory.html">XFactory</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>