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

697 lines
31 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class SiemensProgrammableFrameSyntax | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class SiemensProgrammableFrameSyntax | HiAPI-C# 2025 ">
<meta name="description" content="Siemens programmable frame (TRANS/ATRANS/ROT/AROT incl. RPL=, plus the solid-angle forms ROTS/AROTS): consumes the structured Parsing.&amp;lt;keyword&amp;gt; sub-objects captured by , accumulates the programmable-frame matrix across blocks, and composes it into as the shared entry — the same Source CYCLE800 writes, so the two stay mutually exclusive via AddOrReplaceTransform&#39;s in-place replacement (on a real Sinumerik, CYCLE800 itself writes the programmable frame chain, so single ownership mirrors the control). Semantics follow the Sinumerik programmable-frame rules (HardNc reference: HardNcLine.ParseSiemensFrameTransform + NcArgSiemensFrame): the absolute forms TRANS/ROT reset the whole programmable frame and set only their own component; the additive forms ATRANS/AROT compose onto the current frame with the new operation applied first (M = M_op &#183; M_prev, row-vector convention — an AROT after a TRANS rotates inside the translated frame). A bare keyword (any of the four) resets the programmable frame entirely — written as the shared inactive sentinel Term = &quot;G69&quot; plus an identity chain entry (the same convention HardNc&#39;s CYCLE800 reset uses). Multi-axis rotation in one statement applies the Sinumerik RPY order (intrinsic Z → Y′ → X″, i.e. row-vector Rx&#183;Ry&#183;Rz); RPL rotates about the active G17/G18/G19 plane normal and composes after the axis angles. The solid-angle forms ROTS/AROTS follow the Sinumerik rules (Programming Manual Fundamentals 03/2010 &#167;12.5, &quot;ROTS and AROTS behave in the same way as ROT and AROT&quot;): at most two solid angles orient a plane, composed first-named axis first with the second rotation about the original (extrinsic) axis — the pair X,Y keeps the new X axis in the old Z/X plane (row-vector Rx&#183;Ry), Y,Z keeps the new Y axis in the old X/Y plane (Ry&#183;Rz), Z,X keeps the new Z axis in the old Y/Z plane (Rz&#183;Rx). A single angle is identical to ROT/AROT; RPL= alone rotates in the active plane. Three angles, or RPL mixed with axis angles, fall outside the documented grammar: the statement is left unapplied with a SiemensFrame--SolidAngleInvalid warning plus the visible Parsing--Unconsumed residue — never a guessed frame. CROTS/SCALE/ASCALE/MIRROR/AMIRROR (zero corpus occurrences; CROTS references the control&#39;s frame database which has no offline counterpart, SCALE/MIRROR would inject non-rigid matrices whose remaining breakages are the radius-compensation magnitude, the program-space path length feeding durations, and the writeback Euler decomposition) are consumed recognized-but-not-simulated with a SiemensFrame--Unsupported warning and zero transform effect. A structured keyword whose capture fell back to the verbatim Statement shape, or whose value is an unevaluated variable expression, is left in Parsing — the VariableExpression--Unevaluated diagnostic plus the visible Parsing--Unconsumed residue is the correct fail-soft (P2 acceptance doctrine); the frame is not partially applied. Must run after (this syntax owns the once-per-block modal carry: it carries only when no earlier syntax authored the section on this block) and before the coordinate-offset syntaxes, so the frame entry lands ahead of CoordinateOffset in the chain (McXyz = ProgramXyz &#183; M_frame &#183; M_offset &#183; … — the programmable frame applies to program coordinates first, then the settable G54 frame, matching the Sinumerik frame chain).">
<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.Siemens.SiemensProgrammableFrameSyntax">
<h1 id="Hi_NcParsers_LogicSyntaxs_Siemens_SiemensProgrammableFrameSyntax" data-uid="Hi.NcParsers.LogicSyntaxs.Siemens.SiemensProgrammableFrameSyntax" class="text-break">
Class SiemensProgrammableFrameSyntax
</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>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Siemens.html">Siemens</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>Siemens programmable frame (<code>TRANS/ATRANS/ROT/AROT</code> incl.
<code>RPL=</code>, plus the solid-angle forms <code>ROTS/AROTS</code>): consumes
the structured
<code>Parsing.&lt;keyword&gt;</code> sub-objects captured by
<a class="xref" href="Hi.NcParsers.ParsingSyntaxs.Siemens.SiemensFrameStatementSyntax.html">SiemensFrameStatementSyntax</a>, accumulates the
programmable-frame matrix across blocks, and composes it into
<a class="xref" href="Hi.NcParsers.Keywords.ITransformationDef.html#Hi_NcParsers_Keywords_ITransformationDef_ProgramToMcTransform">ProgramToMcTransform</a> as the shared
<a class="xref" href="Hi.NcParsers.LogicSyntaxs.TiltTransformUtil.html#Hi_NcParsers_LogicSyntaxs_TiltTransformUtil_TransformSource">TransformSource</a> entry — the same
Source CYCLE800 writes, so the two stay mutually exclusive via
<code>AddOrReplaceTransform</code>'s in-place replacement (on a real
Sinumerik, CYCLE800 itself writes the programmable frame chain, so
single ownership mirrors the control).</p>
<p>
Semantics follow the Sinumerik programmable-frame rules (HardNc
reference: <code>HardNcLine.ParseSiemensFrameTransform</code> +
<code>NcArgSiemensFrame</code>): the absolute forms <code>TRANS</code>/<code>ROT</code>
reset the <b>whole</b> programmable frame and set only their own
component; the additive forms <code>ATRANS</code>/<code>AROT</code> compose onto
the current frame with the new operation applied first
(<code>M = M_op · M_prev</code>, row-vector convention — an <code>AROT</code>
after a <code>TRANS</code> rotates inside the translated frame). A bare
keyword (any of the four) resets the programmable frame entirely —
written as the shared inactive sentinel <code>Term = "G69"</code> plus an
identity chain entry (the same convention HardNc's CYCLE800 reset
uses). Multi-axis rotation in one statement applies the Sinumerik
RPY order (intrinsic Z → Y′ → X″, i.e. row-vector
<code>Rx·Ry·Rz</code>); <code>RPL</code> rotates about the active G17/G18/G19
plane normal and composes after the axis angles.
</p>
<p>
The solid-angle forms <code>ROTS</code>/<code>AROTS</code> follow the Sinumerik
rules (Programming Manual Fundamentals 03/2010 §12.5, "ROTS and
AROTS behave in the same way as ROT and AROT"): at most two solid
angles orient a plane, composed first-named axis first with the
second rotation about the <b>original</b> (extrinsic) axis — the
pair X,Y keeps the new X axis in the old Z/X plane (row-vector
<code>Rx·Ry</code>), Y,Z keeps the new Y axis in the old X/Y plane
(<code>Ry·Rz</code>), Z,X keeps the new Z axis in the old Y/Z plane
(<code>Rz·Rx</code>). A single angle is identical to <code>ROT</code>/<code>AROT</code>;
<code>RPL=</code> alone rotates in the active plane. Three angles, or
<code>RPL</code> mixed with axis angles, fall outside the documented
grammar: the statement is left unapplied with a
<code>SiemensFrame--SolidAngleInvalid</code> warning plus the visible
<code>Parsing--Unconsumed</code> residue — never a guessed frame.
</p>
<p>
<code>CROTS/SCALE/ASCALE/MIRROR/AMIRROR</code> (zero corpus occurrences;
CROTS references the control's frame database which has no offline
counterpart, SCALE/MIRROR would inject non-rigid matrices whose
remaining breakages are the radius-compensation magnitude, the
program-space path length feeding durations, and the writeback Euler
decomposition) are consumed recognized-but-not-simulated with a
<code>SiemensFrame--Unsupported</code> warning and zero transform effect.
A structured keyword whose capture fell back to the verbatim
<code>Statement</code> shape, or whose value is an unevaluated variable
expression, is left in <code>Parsing</code> — the
<code>VariableExpression--Unevaluated</code> diagnostic plus the visible
<code>Parsing--Unconsumed</code> residue is the correct fail-soft (P2
acceptance doctrine); the frame is not partially applied.
</p>
<p>
Must run <b>after</b> <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Siemens.SiemensCycle800TiltSyntax.html">SiemensCycle800TiltSyntax</a> (this
syntax owns the once-per-block <a class="xref" href="Hi.NcParsers.Keywords.TiltTransform.html">TiltTransform</a> modal
carry: it carries only when no earlier syntax authored the section
on this block) and <b>before</b> the coordinate-offset syntaxes, so
the frame entry lands ahead of
<code>CoordinateOffset</code> in the chain
(<code>McXyz = ProgramXyz · M_frame · M_offset · …</code> — the
programmable frame applies to program coordinates first, then the
settable G54 frame, matching the Sinumerik frame chain).
</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class SiemensProgrammableFrameSyntax : 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">SiemensProgrammableFrameSyntax</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_Siemens_SiemensProgrammableFrameSyntax_examples">Examples</h2>
<p>Bare cancel — programmable frame reset to the shared inactive
sentinel (identity entry overwrites any previously composed frame):
#BeforeBuild:</p>
<pre><code class="lang-csharp">{ "Parsing": { "ROT": { "Bare": true } } }</code></pre>
<p>#AfterBuild:</p>
<pre><code class="lang-csharp">{
"TiltTransform": { "Term": "G69" },
"ProgramToMcTransform": [
{
"Source": "TiltTransform",
"Kind": "Static",
"Mat4d": [1,0,0,0, 0,1,0,0, 0,0,1,0, 0,0,0,1]
}
]
}</code></pre>
<p>Absolute translation — corpus reset idiom
(<code>TRANS X10 Y20 Z-5</code> arrives structured from the Parsing
stage):
#BeforeBuild:</p>
<pre><code class="lang-csharp">{ "Parsing": { "TRANS": { "X": 10, "Y": 20, "Z": -5 } } }</code></pre>
<p>#AfterBuild:</p>
<pre><code class="lang-csharp">{
"TiltTransform": { "Term": "TRANS", "X": 10, "Y": 20, "Z": -5 },
"ProgramToMcTransform": [
{
"Source": "TiltTransform",
"Kind": "Static",
"Mat4d": [1,0,0,0, 0,1,0,0, 0,0,1,0, 10,20,-5,1]
}
]
}</code></pre>
<p>Additive rotation onto a previous translation —
<code>M = Rx(30°) · T(10,0,0)</code>: the rotation applies first
(inside the translated frame), the translation column survives:
#Previous:</p>
<pre><code class="lang-csharp">{
"TiltTransform": { "Term": "TRANS", "X": 10 },
"ProgramToMcTransform": [
{
"Source": "TiltTransform",
"Kind": "Static",
"Mat4d": [1,0,0,0, 0,1,0,0, 0,0,1,0, 10,0,0,1]
}
]
}</code></pre>
<p>#BeforeBuild:</p>
<pre><code class="lang-csharp">{ "Parsing": { "AROT": { "X": 30 } } }</code></pre>
<p>#AfterBuild:</p>
<pre><code class="lang-csharp">{
"TiltTransform": { "Term": "AROT", "X": 30 },
"ProgramToMcTransform": [
{
"Source": "TiltTransform",
"Kind": "Static",
"Mat4d": [
1, 0, 0, 0,
0, 0.8660254037844387, 0.49999999999999994, 0,
0, -0.49999999999999994, 0.8660254037844387, 0,
10, 0, 0, 1
]
}
]
}</code></pre>
<p>In-plane rotation — no <code>PlaneSelect</code> section on the block, so
the default XY plane (Z normal) applies:
#BeforeBuild:</p>
<pre><code class="lang-csharp">{ "Parsing": { "ROT": { "RPL": 30 } } }</code></pre>
<p>#AfterBuild:</p>
<pre><code class="lang-csharp">{
"TiltTransform": { "Term": "ROT", "RPL": 30 },
"ProgramToMcTransform": [
{
"Source": "TiltTransform",
"Kind": "Static",
"Mat4d": [
0.8660254037844387, 0.49999999999999994, 0, 0,
-0.49999999999999994, 0.8660254037844387, 0, 0,
0, 0, 1, 0,
0, 0, 0, 1
]
}
]
}</code></pre>
<p>Recognized-but-not-simulated keyword — consumed with a
<code>SiemensFrame&ndash;Unsupported</code> warning, zero transform effect
(the JSON shape shows only the consumption; no chain entry, no
section beyond the first-block default):
#BeforeBuild:</p>
<pre><code class="lang-csharp">{ "Parsing": { "SCALE": { "Statement": "X2 Y2" } } }</code></pre>
<p>#AfterBuild:</p>
<pre><code class="lang-csharp">{ "TiltTransform": { "Term": "G69" } }</code></pre>
<p>Solid-angle pair X,Y — <code>ROTS X30 Y40</code> applies X first, then Y
about the original axis (row-vector <code>Rx·Ry</code>); the resulting
first row (the new X axis) has a zero Y component — the manual's
&ldquo;the new X axis lies in the old Z/X plane&rdquo;:
#BeforeBuild:</p>
<pre><code class="lang-csharp">{ "Parsing": { "ROTS": { "X": 30, "Y": 40 } } }</code></pre>
<p>#AfterBuild:</p>
<pre><code class="lang-csharp">{
"TiltTransform": { "Term": "ROTS", "X": 30, "Y": 40 },
"ProgramToMcTransform": [
{
"Source": "TiltTransform",
"Kind": "Static",
"Mat4d": [
0.766044443118978, 0, -0.6427876096865393, 0,
0.32139380484326957, 0.8660254037844387, 0.38302222155948895, 0,
0.5566703992264194, -0.49999999999999994, 0.6634139481689384, 0,
0, 0, 0, 1
]
}
]
}</code></pre>
<p>Solid-angle pair Y,Z additively composed onto a previous
translation — <code>M = (Ry(20°)·Rz(50°)) · T(10,0,0)</code>: the second
row (the new Y axis) has a zero Z component — &ldquo;the new Y axis lies
in the old X/Y plane&rdquo; — and the translation column survives:
#Previous:</p>
<pre><code class="lang-csharp">{
"TiltTransform": { "Term": "TRANS", "X": 10 },
"ProgramToMcTransform": [
{
"Source": "TiltTransform",
"Kind": "Static",
"Mat4d": [1,0,0,0, 0,1,0,0, 0,0,1,0, 10,0,0,1]
}
]
}</code></pre>
<p>#BeforeBuild:</p>
<pre><code class="lang-csharp">{ "Parsing": { "AROTS": { "Y": 20, "Z": 50 } } }</code></pre>
<p>#AfterBuild:</p>
<pre><code class="lang-csharp">{
"TiltTransform": { "Term": "AROTS", "Y": 20, "Z": 50 },
"ProgramToMcTransform": [
{
"Source": "TiltTransform",
"Kind": "Static",
"Mat4d": [
0.6040227735550537, 0.7198463103929542, -0.3420201433256687, 0,
-0.766044443118978, 0.6427876096865394, 0, 0,
0.2198463103929542, 0.2620026302293849, 0.9396926207859084, 0,
10, 0, 0, 1
]
}
]
}</code></pre>
<p>Three solid angles fall outside the documented grammar (&ldquo;up to 2
solid angles may be programmed&rdquo;) — the statement is left unapplied
with a <code>SiemensFrame&ndash;SolidAngleInvalid</code> warning and the
residue stays visible for the <code>Parsing&ndash;Unconsumed</code> report:
#BeforeBuild:</p>
<pre><code class="lang-csharp">{ "Parsing": { "ROTS": { "X": 10, "Y": 20, "Z": 30 } } }</code></pre>
<p>#AfterBuild:</p>
<pre><code class="lang-csharp">{
"Parsing": { "ROTS": { "X": 10, "Y": 20, "Z": 30 } },
"TiltTransform": { "Term": "G69" }
}</code></pre>
<h2 class="section" id="constructors">Constructors
</h2>
<a id="Hi_NcParsers_LogicSyntaxs_Siemens_SiemensProgrammableFrameSyntax__ctor_" data-uid="Hi.NcParsers.LogicSyntaxs.Siemens.SiemensProgrammableFrameSyntax.#ctor*"></a>
<h3 id="Hi_NcParsers_LogicSyntaxs_Siemens_SiemensProgrammableFrameSyntax__ctor" data-uid="Hi.NcParsers.LogicSyntaxs.Siemens.SiemensProgrammableFrameSyntax.#ctor">
SiemensProgrammableFrameSyntax()
</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 SiemensProgrammableFrameSyntax()</code></pre>
</div>
<a id="Hi_NcParsers_LogicSyntaxs_Siemens_SiemensProgrammableFrameSyntax__ctor_" data-uid="Hi.NcParsers.LogicSyntaxs.Siemens.SiemensProgrammableFrameSyntax.#ctor*"></a>
<h3 id="Hi_NcParsers_LogicSyntaxs_Siemens_SiemensProgrammableFrameSyntax__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.LogicSyntaxs.Siemens.SiemensProgrammableFrameSyntax.#ctor(System.Xml.Linq.XElement)">
SiemensProgrammableFrameSyntax(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 SiemensProgrammableFrameSyntax(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="properties">Properties
</h2>
<a id="Hi_NcParsers_LogicSyntaxs_Siemens_SiemensProgrammableFrameSyntax_Name_" data-uid="Hi.NcParsers.LogicSyntaxs.Siemens.SiemensProgrammableFrameSyntax.Name*"></a>
<h3 id="Hi_NcParsers_LogicSyntaxs_Siemens_SiemensProgrammableFrameSyntax_Name" data-uid="Hi.NcParsers.LogicSyntaxs.Siemens.SiemensProgrammableFrameSyntax.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_Siemens_SiemensProgrammableFrameSyntax_XName_" data-uid="Hi.NcParsers.LogicSyntaxs.Siemens.SiemensProgrammableFrameSyntax.XName*"></a>
<h3 id="Hi_NcParsers_LogicSyntaxs_Siemens_SiemensProgrammableFrameSyntax_XName" data-uid="Hi.NcParsers.LogicSyntaxs.Siemens.SiemensProgrammableFrameSyntax.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_Siemens_SiemensProgrammableFrameSyntax_Build_" data-uid="Hi.NcParsers.LogicSyntaxs.Siemens.SiemensProgrammableFrameSyntax.Build*"></a>
<h3 id="Hi_NcParsers_LogicSyntaxs_Siemens_SiemensProgrammableFrameSyntax_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.Siemens.SiemensProgrammableFrameSyntax.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_Siemens_SiemensProgrammableFrameSyntax_MakeXmlSource_" data-uid="Hi.NcParsers.LogicSyntaxs.Siemens.SiemensProgrammableFrameSyntax.MakeXmlSource*"></a>
<h3 id="Hi_NcParsers_LogicSyntaxs_Siemens_SiemensProgrammableFrameSyntax_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.LogicSyntaxs.Siemens.SiemensProgrammableFrameSyntax.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_Siemens_SiemensProgrammableFrameSyntax_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_Siemens_SiemensProgrammableFrameSyntax_Reg_" data-uid="Hi.NcParsers.LogicSyntaxs.Siemens.SiemensProgrammableFrameSyntax.Reg*"></a>
<h3 id="Hi_NcParsers_LogicSyntaxs_Siemens_SiemensProgrammableFrameSyntax_Reg_Hi_Common_XmlUtils_XFactory_" data-uid="Hi.NcParsers.LogicSyntaxs.Siemens.SiemensProgrammableFrameSyntax.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>