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.ParsingSyntaxs.Siemens.SiemensFrameStatementSyntax.html
T

669 lines
26 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class SiemensFrameStatementSyntax | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class SiemensFrameStatementSyntax | HiAPI-C# 2025 ">
<meta name="description" content="Captures a whole Siemens frame statement (TRANS/ATRANS/ROT/AROT/ ROTS/AROTS/CROTS/SCALE/ASCALE/MIRROR/AMIRROR, bare or with arguments) into a Parsing.&amp;lt;keyword&amp;gt; sub-object. Sinumerik requires frame instructions in a block of their own, so the whole remaining line belongs to the statement. The consumed keywords (TRANS/ATRANS/ROT/AROT/ROTS/AROTS — see ) are captured structured: each argument token becomes a sub-key — glued axis words (X0, Y90.) and equals forms (RPL=45, Z=R5) both supported. Literal values are stored as JSON numbers; non-literal right-hand sides stay strings so resolves them in the Evaluation stage (AROT Z=R5 → Parsing.AROT = { &quot;Z&quot;: &quot;R5&quot; }). A token outside the modeled grammar makes the whole statement fall back to the verbatim capture — never a half-consumed line. The remaining keywords (CROTS/SCALE/ASCALE/MIRROR/AMIRROR — zero corpus occurrences, no simulation) keep the verbatim { &quot;Statement&quot;: &quot;&amp;lt;args&amp;gt;&quot; } quarantine; the Logic consumer reports them as recognized-but-not-simulated. Either way the axis words are kept out of reach of the quote/context-blind tag-value syntaxes below, which would otherwise mint them into Parsing.X/Y/Z and let turn a frame statement into a very real ghost rapid. Deferred-but-unmodeled must mean &quot;no transform yet&quot;, never &quot;extra motion&quot;. Must be placed early in the Parsing bundle — after , before every assignment / tag-value syntax (the ROT RPL=45 shape would otherwise feed ).">
<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.ParsingSyntaxs.Siemens.SiemensFrameStatementSyntax">
<h1 id="Hi_NcParsers_ParsingSyntaxs_Siemens_SiemensFrameStatementSyntax" data-uid="Hi.NcParsers.ParsingSyntaxs.Siemens.SiemensFrameStatementSyntax" class="text-break">
Class SiemensFrameStatementSyntax
</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.ParsingSyntaxs.html">ParsingSyntaxs</a>.<a class="xref" href="Hi.NcParsers.ParsingSyntaxs.Siemens.html">Siemens</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>Captures a whole Siemens frame statement (<code>TRANS/ATRANS/ROT/AROT/
ROTS/AROTS/CROTS/SCALE/ASCALE/MIRROR/AMIRROR</code>, bare or with
arguments) into a <code>Parsing.&lt;keyword&gt;</code> sub-object.
Sinumerik requires frame instructions in a block of their own, so
the whole remaining line belongs to the statement.</p>
<p>
The consumed keywords (<code>TRANS/ATRANS/ROT/AROT/ROTS/AROTS</code> — see
<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Siemens.SiemensProgrammableFrameSyntax.html">SiemensProgrammableFrameSyntax</a>)
are captured <b>structured</b>: each argument token becomes a
sub-key — glued axis words (<code>X0</code>, <code>Y90.</code>) and equals forms
(<code>RPL=45</code>, <code>Z=R5</code>) both supported. Literal values are
stored as JSON numbers; non-literal right-hand sides stay strings so
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax</a> resolves them
in the Evaluation stage (<code>AROT Z=R5</code> →
<code>Parsing.AROT = { "Z": "R5" }</code>). A token outside the modeled
grammar makes the <b>whole statement</b> fall back to the verbatim
<a class="xref" href="Hi.NcParsers.ParsingSyntaxs.Siemens.SiemensFrameStatementSyntax.html#Hi_NcParsers_ParsingSyntaxs_Siemens_SiemensFrameStatementSyntax_StatementKey">StatementKey</a> capture — never a half-consumed line.
</p>
<p>
The remaining keywords (<code>CROTS/SCALE/ASCALE/MIRROR/AMIRROR</code>
— zero corpus occurrences, no simulation) keep the verbatim
<code>{ "Statement": "&lt;args&gt;" }</code> quarantine; the Logic consumer
reports them as recognized-but-not-simulated. Either way the axis
words are kept out of reach of the quote/context-blind tag-value
syntaxes below, which would otherwise mint them into
<code>Parsing.X/Y/Z</code> and let <a class="xref" href="Hi.NcParsers.LogicSyntaxs.ProgramXyzSyntax.html">ProgramXyzSyntax</a>
turn a frame statement into a very real ghost rapid.
Deferred-but-unmodeled must mean "no transform yet", never
"extra motion".
</p>
<p>
Must be placed early in the Parsing bundle — after
<a class="xref" href="Hi.NcParsers.ParsingSyntaxs.BlockSkipSyntax.html">BlockSkipSyntax</a>, before every assignment / tag-value
syntax (the <code>ROT RPL=45</code> shape would otherwise feed
<a class="xref" href="Hi.NcParsers.ParsingSyntaxs.NamedVarAssignmentSyntax.html">NamedVarAssignmentSyntax</a>).
</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class SiemensFrameStatementSyntax : 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">SiemensFrameStatementSyntax</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_ParsingSyntaxs_Siemens_SiemensFrameStatementSyntax_examples">Examples</h2>
<p>Translation with arguments — structured capture, literal axis words
become JSON numbers:
#BeforeBuild.UnparsedText: <code>TRANS X0 Y0 Z0</code>
#AfterBuild:</p>
<pre><code class="lang-csharp">{
"Parsing": { "TRANS": { "X": 0, "Y": 0, "Z": 0 } }
}</code></pre>
<p>Bare cancel form — marker instead of an empty sub-object (empty
sub-objects would be swept by intermediate <code>CleanupParsing</code>
calls, silently dropping the cancel signal):
#BeforeBuild.UnparsedText: <code>ROT</code>
#AfterBuild:</p>
<pre><code class="lang-csharp">{
"Parsing": { "ROT": { "Bare": true } }
}</code></pre>
<p>Additive rotation — corpus shape:
#BeforeBuild.UnparsedText: <code>AROT Y90.</code>
#AfterBuild:</p>
<pre><code class="lang-csharp">{
"Parsing": { "AROT": { "Y": 90 } }
}</code></pre>
<p>In-plane rotation via the equals form:
#BeforeBuild.UnparsedText: <code>ROT RPL=45</code>
#AfterBuild:</p>
<pre><code class="lang-csharp">{
"Parsing": { "ROT": { "RPL": 45 } }
}</code></pre>
<p>Non-literal right-hand side stays a string for the Evaluation-stage
variable evaluator:
#BeforeBuild.UnparsedText: <code>AROT Z=R5</code>
#AfterBuild:</p>
<pre><code class="lang-csharp">{
"Parsing": { "AROT": { "Z": "R5" } }
}</code></pre>
<p>Unmodeled keyword keeps the verbatim quarantine (record-only):
#BeforeBuild.UnparsedText: <code>SCALE X2 Y2</code>
#AfterBuild:</p>
<pre><code class="lang-csharp">{
"Parsing": { "SCALE": { "Statement": "X2 Y2" } }
}</code></pre>
<p>A token outside the modeled grammar (here an unknown key) makes the
whole statement fall back to the verbatim capture — no axis is
half-consumed and the residue stays visible:
#BeforeBuild.UnparsedText: <code>TRANS X10 CFINE=2</code>
#AfterBuild:</p>
<pre><code class="lang-csharp">{
"Parsing": { "TRANS": { "Statement": "X10 CFINE=2" } }
}</code></pre>
<p>Solid-angle rotation — structured like the plain rotation family
(the pair orients a plane; the Logic consumer owns the pair math):
#BeforeBuild.UnparsedText: <code>ROTS X30 Y40</code>
#AfterBuild:</p>
<pre><code class="lang-csharp">{
"Parsing": { "ROTS": { "X": 30, "Y": 40 } }
}</code></pre>
<p><code>CROTS</code> (database-frame reference, not simulated) is captured
but stays on the verbatim quarantine:
#BeforeBuild.UnparsedText: <code>CROTS X30 Y40</code>
#AfterBuild:</p>
<pre><code class="lang-csharp">{
"Parsing": { "CROTS": { "Statement": "X30 Y40" } }
}</code></pre>
<h2 class="section" id="constructors">Constructors
</h2>
<a id="Hi_NcParsers_ParsingSyntaxs_Siemens_SiemensFrameStatementSyntax__ctor_" data-uid="Hi.NcParsers.ParsingSyntaxs.Siemens.SiemensFrameStatementSyntax.#ctor*"></a>
<h3 id="Hi_NcParsers_ParsingSyntaxs_Siemens_SiemensFrameStatementSyntax__ctor" data-uid="Hi.NcParsers.ParsingSyntaxs.Siemens.SiemensFrameStatementSyntax.#ctor">
SiemensFrameStatementSyntax()
</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 SiemensFrameStatementSyntax()</code></pre>
</div>
<a id="Hi_NcParsers_ParsingSyntaxs_Siemens_SiemensFrameStatementSyntax__ctor_" data-uid="Hi.NcParsers.ParsingSyntaxs.Siemens.SiemensFrameStatementSyntax.#ctor*"></a>
<h3 id="Hi_NcParsers_ParsingSyntaxs_Siemens_SiemensFrameStatementSyntax__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.ParsingSyntaxs.Siemens.SiemensFrameStatementSyntax.#ctor(System.Xml.Linq.XElement)">
SiemensFrameStatementSyntax(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 SiemensFrameStatementSyntax(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_ParsingSyntaxs_Siemens_SiemensFrameStatementSyntax_BareKey" data-uid="Hi.NcParsers.ParsingSyntaxs.Siemens.SiemensFrameStatementSyntax.BareKey">
BareKey
</h3>
<div class="markdown level1 summary"><p>Marker key for the bare (argument-less, i.e. cancel) form — keeps
the sub-object non-empty so intermediate <code>CleanupParsing</code>
sweeps cannot drop the signal.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string BareKey = &quot;Bare&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>
<h3 id="Hi_NcParsers_ParsingSyntaxs_Siemens_SiemensFrameStatementSyntax_StatementKey" data-uid="Hi.NcParsers.ParsingSyntaxs.Siemens.SiemensFrameStatementSyntax.StatementKey">
StatementKey
</h3>
<div class="markdown level1 summary"><p>Sub-object key holding the verbatim statement arguments (fallback / record-only shape).</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string StatementKey = &quot;Statement&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>
<h3 id="Hi_NcParsers_ParsingSyntaxs_Siemens_SiemensFrameStatementSyntax_StructuredKeywords" data-uid="Hi.NcParsers.ParsingSyntaxs.Siemens.SiemensFrameStatementSyntax.StructuredKeywords">
StructuredKeywords
</h3>
<div class="markdown level1 summary"><p>Keywords whose arguments are captured structured (axis sub-keys)
because <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Siemens.SiemensProgrammableFrameSyntax.html">SiemensProgrammableFrameSyntax</a>
consumes them. The remaining <span class="xref">Hi.NcParsers.ParsingSyntaxs.Siemens.SiemensFrameStatementSyntax.FrameRegex</span> keywords stay
on the verbatim <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.Siemens.SiemensFrameStatementSyntax.html#Hi_NcParsers_ParsingSyntaxs_Siemens_SiemensFrameStatementSyntax_StatementKey">StatementKey</a> capture (record-only).</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static readonly string[] StructuredKeywords</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_ParsingSyntaxs_Siemens_SiemensFrameStatementSyntax_Name_" data-uid="Hi.NcParsers.ParsingSyntaxs.Siemens.SiemensFrameStatementSyntax.Name*"></a>
<h3 id="Hi_NcParsers_ParsingSyntaxs_Siemens_SiemensFrameStatementSyntax_Name" data-uid="Hi.NcParsers.ParsingSyntaxs.Siemens.SiemensFrameStatementSyntax.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_ParsingSyntaxs_Siemens_SiemensFrameStatementSyntax_XName_" data-uid="Hi.NcParsers.ParsingSyntaxs.Siemens.SiemensFrameStatementSyntax.XName*"></a>
<h3 id="Hi_NcParsers_ParsingSyntaxs_Siemens_SiemensFrameStatementSyntax_XName" data-uid="Hi.NcParsers.ParsingSyntaxs.Siemens.SiemensFrameStatementSyntax.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_ParsingSyntaxs_Siemens_SiemensFrameStatementSyntax_Build_" data-uid="Hi.NcParsers.ParsingSyntaxs.Siemens.SiemensFrameStatementSyntax.Build*"></a>
<h3 id="Hi_NcParsers_ParsingSyntaxs_Siemens_SiemensFrameStatementSyntax_Build_Hi_Common_Collections_LazyLinkedListNode_Hi_NcParsers_Syntaxs_SyntaxPiece__System_Collections_Generic_List_Hi_NcParsers_Dependencys_INcDependency__Hi_NcParsers_NcDiagnosticProgress_" data-uid="Hi.NcParsers.ParsingSyntaxs.Siemens.SiemensFrameStatementSyntax.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_ParsingSyntaxs_Siemens_SiemensFrameStatementSyntax_MakeXmlSource_" data-uid="Hi.NcParsers.ParsingSyntaxs.Siemens.SiemensFrameStatementSyntax.MakeXmlSource*"></a>
<h3 id="Hi_NcParsers_ParsingSyntaxs_Siemens_SiemensFrameStatementSyntax_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.ParsingSyntaxs.Siemens.SiemensFrameStatementSyntax.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_ParsingSyntaxs_Siemens_SiemensFrameStatementSyntax_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_ParsingSyntaxs_Siemens_SiemensFrameStatementSyntax_Reg_" data-uid="Hi.NcParsers.ParsingSyntaxs.Siemens.SiemensFrameStatementSyntax.Reg*"></a>
<h3 id="Hi_NcParsers_ParsingSyntaxs_Siemens_SiemensFrameStatementSyntax_Reg_Hi_Common_XmlUtils_XFactory_" data-uid="Hi.NcParsers.ParsingSyntaxs.Siemens.SiemensFrameStatementSyntax.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>