Archived
555 lines
23 KiB
HTML
555 lines
23 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Class HeidenhainToolChangeSyntax | HiAPI-C# 2025 </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Class HeidenhainToolChangeSyntax | HiAPI-C# 2025 ">
|
|
|
|
<meta name="description" content="Heidenhain-specific: consumes the Parsing[&ldquo;TOOL CALL&rdquo;] record (written by ) into the shared section so fires the tooling act. A klartext TOOL CALL always performs the change — no separate M06 trigger exists — so is always true with Term = &ldquo;TOOL CALL&rdquo;. The spindle-speed word (S) is relocated to the root of so the shared — which must run after this syntax in the Logic bundle — records it modally. Numeric tool ids are written as ints (the act chain is int-keyed); non-numeric ids stay strings and resolve (or warn) at the semantic layer. P0 limits recorded as diagnostics: non-Z tool axis (ToolChange--AxisUnsupported), non-zero DL/DR deltas (ToolChange--DeltaUnsupported; zero deltas are consumed silently, and a delta that is not a literal value is ignored as ToolChange--DeltaNotLiteral), and a TOOL CALL without a tool id (ToolChange--MissingToolId, e.g. a variable tool number the parser could not capture). Known P2 limitation: a quoted tool NAME that happens to spell a Q token (TOOL CALL "Q1" Z) loses its quotes at capture, so the evaluator substitutes the Q parameter's value and the numeric branch below treats it as a tool number. Corpus-zero (real names are "B40R"-style); fixing it needs the capture to preserve the quoted-ness, which would change the P0-pinned record shape.">
|
|
<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 "{query}"">
|
|
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
|
<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.Heidenhain.HeidenhainToolChangeSyntax">
|
|
|
|
|
|
|
|
<h1 id="Hi_NcParsers_LogicSyntaxs_Heidenhain_HeidenhainToolChangeSyntax" data-uid="Hi.NcParsers.LogicSyntaxs.Heidenhain.HeidenhainToolChangeSyntax" class="text-break">
|
|
Class HeidenhainToolChangeSyntax
|
|
</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.Heidenhain.html">Heidenhain</a></dd></dl>
|
|
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
|
</div>
|
|
|
|
<div class="markdown summary"><p>Heidenhain-specific: consumes the <code>Parsing[“TOOL CALL”]</code> record
|
|
(written by <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.Heidenhain.HeidenhainToolCallSyntax.html">HeidenhainToolCallSyntax</a>)
|
|
into the shared <a class="xref" href="Hi.NcParsers.LogicSyntaxs.ToolChangeSyntax.html#Hi_NcParsers_LogicSyntaxs_ToolChangeSyntax_SectionName">SectionName</a> section so
|
|
<a class="xref" href="Hi.NcParsers.Semantics.ToolChangeSemantic.html">ToolChangeSemantic</a> fires the tooling act. A
|
|
klartext <code>TOOL CALL</code> always performs the change — no separate M06
|
|
trigger exists — so <a class="xref" href="Hi.NcParsers.LogicSyntaxs.ToolChangeSyntax.html#Hi_NcParsers_LogicSyntaxs_ToolChangeSyntax_IsChangeKey">IsChangeKey</a> is always
|
|
<code>true</code> with <code>Term = “TOOL CALL”</code>.</p>
|
|
<p>
|
|
The spindle-speed word (<code>S</code>) is relocated to the root of
|
|
<a class="xref" href="Hi.NcParsers.Keywords.IParsingDef.html#Hi_NcParsers_Keywords_IParsingDef_Parsing">Parsing</a> so the shared
|
|
<a class="xref" href="Hi.NcParsers.LogicSyntaxs.SpindleSpeedSyntax.html">SpindleSpeedSyntax</a> — which must run after this syntax in
|
|
the Logic bundle — records it modally. Numeric tool ids are written as
|
|
ints (the act chain is int-keyed); non-numeric ids stay strings and
|
|
resolve (or warn) at the semantic layer.
|
|
</p>
|
|
<p>
|
|
P0 limits recorded as diagnostics: non-Z tool axis
|
|
(<code>ToolChange--AxisUnsupported</code>), non-zero DL/DR deltas
|
|
(<code>ToolChange--DeltaUnsupported</code>; zero deltas are consumed
|
|
silently, and a delta that is not a literal value is ignored as
|
|
<code>ToolChange--DeltaNotLiteral</code>), and a TOOL CALL without a tool id
|
|
(<code>ToolChange--MissingToolId</code>, e.g. a variable tool number the
|
|
parser could not capture).
|
|
</p>
|
|
<p>
|
|
Known P2 limitation: a quoted tool NAME that happens to spell a Q
|
|
token (<code>TOOL CALL "Q1" Z</code>) loses its quotes at capture, so the
|
|
evaluator substitutes the Q parameter's value and the numeric branch
|
|
below treats it as a tool number. Corpus-zero (real names are
|
|
<code>"B40R"</code>-style); fixing it needs the capture to preserve the
|
|
quoted-ness, which would change the P0-pinned record shape.
|
|
</p>
|
|
</div>
|
|
<div class="markdown conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class HeidenhainToolChangeSyntax : 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">HeidenhainToolChangeSyntax</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<TSelf>(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<TSrc>(TSrc, Action<TSrc>)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)</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_Heidenhain_HeidenhainToolChangeSyntax_examples">Examples</h2>
|
|
<p>Numeric tool call — id becomes an int, S is relocated to the Parsing
|
|
root for the shared spindle syntax:
|
|
#BeforeBuild:</p>
|
|
<pre><code class="lang-csharp">{ "Parsing": { "TOOL CALL": { "Axis": "Z", "S": "4000", "T": "2" } } }</code></pre>
|
|
<p>#AfterBuild:</p>
|
|
<pre><code class="lang-csharp">{
|
|
"Parsing": { "S": 4000 },
|
|
"ToolChange": { "ToolId": 2, "IsChange": true, "Term": "TOOL CALL" }
|
|
}</code></pre>
|
|
<p>Named tool with zero deltas — the name carries as a string ToolId;
|
|
literal DL/DR ride in the section (DL feeds the length compensation;
|
|
a non-zero DR would warn):
|
|
#BeforeBuild:</p>
|
|
<pre><code class="lang-csharp">{ "Parsing": { "TOOL CALL": { "Axis": "Z", "S": "1200", "DL": "+0.0", "DR": "+0.0", "T": "B40R" } } }</code></pre>
|
|
<p>#AfterBuild:</p>
|
|
<pre><code class="lang-csharp">{
|
|
"Parsing": { "S": 1200 },
|
|
"ToolChange": { "ToolId": "B40R", "IsChange": true, "Term": "TOOL CALL", "DL": 0, "DR": 0 }
|
|
}</code></pre>
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="constructors">Constructors
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_NcParsers_LogicSyntaxs_Heidenhain_HeidenhainToolChangeSyntax__ctor_" data-uid="Hi.NcParsers.LogicSyntaxs.Heidenhain.HeidenhainToolChangeSyntax.#ctor*"></a>
|
|
|
|
<h3 id="Hi_NcParsers_LogicSyntaxs_Heidenhain_HeidenhainToolChangeSyntax__ctor" data-uid="Hi.NcParsers.LogicSyntaxs.Heidenhain.HeidenhainToolChangeSyntax.#ctor">
|
|
HeidenhainToolChangeSyntax()
|
|
|
|
</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 HeidenhainToolChangeSyntax()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_NcParsers_LogicSyntaxs_Heidenhain_HeidenhainToolChangeSyntax__ctor_" data-uid="Hi.NcParsers.LogicSyntaxs.Heidenhain.HeidenhainToolChangeSyntax.#ctor*"></a>
|
|
|
|
<h3 id="Hi_NcParsers_LogicSyntaxs_Heidenhain_HeidenhainToolChangeSyntax__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.LogicSyntaxs.Heidenhain.HeidenhainToolChangeSyntax.#ctor(System.Xml.Linq.XElement)">
|
|
HeidenhainToolChangeSyntax(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 HeidenhainToolChangeSyntax(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_Heidenhain_HeidenhainToolChangeSyntax_Term" data-uid="Hi.NcParsers.LogicSyntaxs.Heidenhain.HeidenhainToolChangeSyntax.Term">
|
|
Term
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Value written to <a class="xref" href="Hi.NcParsers.LogicSyntaxs.ToolChangeSyntax.html#Hi_NcParsers_LogicSyntaxs_ToolChangeSyntax_TermKey">TermKey</a> for klartext tool calls.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public const string Term = "TOOL CALL"</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_Heidenhain_HeidenhainToolChangeSyntax_Name_" data-uid="Hi.NcParsers.LogicSyntaxs.Heidenhain.HeidenhainToolChangeSyntax.Name*"></a>
|
|
|
|
<h3 id="Hi_NcParsers_LogicSyntaxs_Heidenhain_HeidenhainToolChangeSyntax_Name" data-uid="Hi.NcParsers.LogicSyntaxs.Heidenhain.HeidenhainToolChangeSyntax.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_Heidenhain_HeidenhainToolChangeSyntax_XName_" data-uid="Hi.NcParsers.LogicSyntaxs.Heidenhain.HeidenhainToolChangeSyntax.XName*"></a>
|
|
|
|
<h3 id="Hi_NcParsers_LogicSyntaxs_Heidenhain_HeidenhainToolChangeSyntax_XName" data-uid="Hi.NcParsers.LogicSyntaxs.Heidenhain.HeidenhainToolChangeSyntax.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_Heidenhain_HeidenhainToolChangeSyntax_Build_" data-uid="Hi.NcParsers.LogicSyntaxs.Heidenhain.HeidenhainToolChangeSyntax.Build*"></a>
|
|
|
|
<h3 id="Hi_NcParsers_LogicSyntaxs_Heidenhain_HeidenhainToolChangeSyntax_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.Heidenhain.HeidenhainToolChangeSyntax.Build(Hi.Common.Collections.LazyLinkedListNode{Hi.NcParsers.Syntaxs.SyntaxPiece},System.Collections.Generic.List{Hi.NcParsers.Dependencys.INcDependency},Hi.NcParsers.NcDiagnosticProgress)">
|
|
Build(LazyLinkedListNode<SyntaxPiece>, List<INcDependency>, 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<SyntaxPiece> syntaxPieceNode, List<INcDependency> 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><<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a>></dt>
|
|
<dd></dd>
|
|
<dt><code>ncDependencyList</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a><<a class="xref" href="Hi.NcParsers.Dependencys.INcDependency.html">INcDependency</a>></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_Heidenhain_HeidenhainToolChangeSyntax_MakeXmlSource_" data-uid="Hi.NcParsers.LogicSyntaxs.Heidenhain.HeidenhainToolChangeSyntax.MakeXmlSource*"></a>
|
|
|
|
<h3 id="Hi_NcParsers_LogicSyntaxs_Heidenhain_HeidenhainToolChangeSyntax_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.LogicSyntaxs.Heidenhain.HeidenhainToolChangeSyntax.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_Heidenhain_HeidenhainToolChangeSyntax_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_Heidenhain_HeidenhainToolChangeSyntax_Reg_" data-uid="Hi.NcParsers.LogicSyntaxs.Heidenhain.HeidenhainToolChangeSyntax.Reg*"></a>
|
|
|
|
<h3 id="Hi_NcParsers_LogicSyntaxs_Heidenhain_HeidenhainToolChangeSyntax_Reg_Hi_Common_XmlUtils_XFactory_" data-uid="Hi.NcParsers.LogicSyntaxs.Heidenhain.HeidenhainToolChangeSyntax.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>
|