Archived
557 lines
23 KiB
HTML
557 lines
23 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Class SiemensLoopIterationDependency | HiAPI-C# 2025 </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Class SiemensLoopIterationDependency | HiAPI-C# 2025 ">
|
|
|
|
<meta name="description" content="Watchdog shared by all four Siemens loop constructs (WHILE/ENDWHILE, FOR/ENDFOR, REPEAT/UNTIL, LOOP/ENDLOOP) — construct-neutral by design, unlike the Fanuc sibling () which only has WHILE to guard. Same &ldquo;soft-cap + runtime counter + session-init &rdquo; shape. Siemens loop constructs carry no LoopId, so the counter key is (FileName, BeginLineNo) — the loop-entry line recorded in the active frame identifies the construct uniquely within its file, and the file path isolates identically-numbered lines across files (and across inlined subprograms). The consuming syntax () counts at the back-jump step (the loop terminator / falsy UNTIL), so a loop whose condition is false from the outset consumes zero iterations. Above the terminator warns SiemensLoop--IterationLimitExceeded, pops the frame and falls through. A missing dependency disables the cap for the condition-bearing constructs (Fanuc parity) but hard-blocks the ENDLOOP back-jump — LOOP has no exit condition, so an uncapped back-jump would hang the pipeline deterministically.">
|
|
<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.Dependencys.Siemens.SiemensLoopIterationDependency">
|
|
|
|
|
|
|
|
<h1 id="Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency" data-uid="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency" class="text-break">
|
|
Class SiemensLoopIterationDependency
|
|
</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.Dependencys.html">Dependencys</a>.<a class="xref" href="Hi.NcParsers.Dependencys.Siemens.html">Siemens</a></dd></dl>
|
|
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
|
</div>
|
|
|
|
<div class="markdown summary"><p>Watchdog shared by all four Siemens loop constructs
|
|
(<code>WHILE/ENDWHILE</code>, <code>FOR/ENDFOR</code>, <code>REPEAT/UNTIL</code>,
|
|
<code>LOOP/ENDLOOP</code>) — construct-neutral by design, unlike the Fanuc
|
|
sibling (<a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.FanucWhileDoIterationDependency.html">FanucWhileDoIterationDependency</a>) which
|
|
only has WHILE to guard. Same “soft-cap + runtime counter +
|
|
session-init <a class="xref" href="Hi.NcParsers.ISessionResettable.html">ISessionResettable</a>” shape.</p>
|
|
<p>
|
|
Siemens loop constructs carry no LoopId, so the counter key is
|
|
<code>(FileName, BeginLineNo)</code> — the loop-entry line recorded in the
|
|
active frame identifies the construct uniquely within its file, and
|
|
the file path isolates identically-numbered lines across files (and
|
|
across inlined subprograms).
|
|
</p>
|
|
<p>
|
|
The consuming syntax
|
|
(<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Siemens.SiemensLoopSyntax.html">SiemensLoopSyntax</a>) counts at
|
|
the back-jump step (the loop terminator / falsy <code>UNTIL</code>), so a
|
|
loop whose condition is false from the outset consumes zero
|
|
iterations. Above <a class="xref" href="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.html#Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency_MaxIterationsPerLoop">MaxIterationsPerLoop</a> the terminator
|
|
warns <code>SiemensLoop--IterationLimitExceeded</code>, pops the frame and
|
|
falls through. A missing dependency disables the cap for the
|
|
condition-bearing constructs (Fanuc parity) but hard-blocks the
|
|
<code>ENDLOOP</code> back-jump — <code>LOOP</code> has no exit condition, so an
|
|
uncapped back-jump would hang the pipeline deterministically.
|
|
</p>
|
|
</div>
|
|
<div class="markdown conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class SiemensLoopIterationDependency : INcDependency, IMakeXmlSource, ISessionResettable</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">SiemensLoopIterationDependency</span></div>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl class="typelist implements">
|
|
<dt>Implements</dt>
|
|
<dd>
|
|
<div><a class="xref" href="Hi.NcParsers.Dependencys.INcDependency.html">INcDependency</a></div>
|
|
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
|
<div><a class="xref" href="Hi.NcParsers.ISessionResettable.html">ISessionResettable</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 class="section" id="constructors">Constructors
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency__ctor_" data-uid="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.#ctor*"></a>
|
|
|
|
<h3 id="Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency__ctor" data-uid="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.#ctor">
|
|
SiemensLoopIterationDependency()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Initializes a new instance with the default limit and an empty counter.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public SiemensLoopIterationDependency()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency__ctor_" data-uid="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.#ctor*"></a>
|
|
|
|
<h3 id="Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.#ctor(System.Xml.Linq.XElement)">
|
|
SiemensLoopIterationDependency(XElement)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Loads <a class="xref" href="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.html#Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency_MaxIterationsPerLoop">MaxIterationsPerLoop</a> from XML produced by <a class="xref" href="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.html#Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency_MakeXmlSource_System_String_System_String_System_Boolean_">MakeXmlSource(string, string, bool)</a>; absent element falls back to <a class="xref" href="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.html#Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency_DefaultMaxIterationsPerLoop">DefaultMaxIterationsPerLoop</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public SiemensLoopIterationDependency(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>Root element named <a class="xref" href="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.html#Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency_XName">XName</a>.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="fields">Fields
|
|
</h2>
|
|
|
|
|
|
|
|
<h3 id="Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency_DefaultMaxIterationsPerLoop" data-uid="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.DefaultMaxIterationsPerLoop">
|
|
DefaultMaxIterationsPerLoop
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Default for <a class="xref" href="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.html#Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency_MaxIterationsPerLoop">MaxIterationsPerLoop</a> — matches the Fanuc
|
|
WHILE default: loops are the legitimate iteration primitive
|
|
(drill grids, calibration sweeps), so the cap is generous while
|
|
still catching runaways in a tractable time.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public const int DefaultMaxIterationsPerLoop = 10000</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Field Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="properties">Properties
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency_CountByLoop_" data-uid="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.CountByLoop*"></a>
|
|
|
|
<h3 id="Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency_CountByLoop" data-uid="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.CountByLoop">
|
|
CountByLoop
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Per-loop hit counter keyed by <code>(FileName, BeginLineNo)</code>.
|
|
Runtime-only; not serialised. Cleared by <a class="xref" href="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.html#Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency_OnSessionReset">OnSessionReset()</a>
|
|
on the session-init edge.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Dictionary<(string FileName, int BeginLineNo), int> CountByLoop { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.dictionary-2">Dictionary</a><(<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.valuetuple-system.string,system.int32-.filename">FileName</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.valuetuple-system.string,system.int32-.targetn">TargetN</a>), <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency_MaxIterationsPerLoop_" data-uid="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.MaxIterationsPerLoop*"></a>
|
|
|
|
<h3 id="Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency_MaxIterationsPerLoop" data-uid="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.MaxIterationsPerLoop">
|
|
MaxIterationsPerLoop
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Soft cap on back-jumps for any single <code>(FileName, BeginLineNo)</code>
|
|
pair. Above this the terminator block emits
|
|
<code>SiemensLoop–IterationLimitExceeded</code>, pops the frame and
|
|
falls through.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public int MaxIterationsPerLoop { 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.int32">int</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency_XName_" data-uid="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.XName*"></a>
|
|
|
|
<h3 id="Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency_XName" data-uid="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.XName">
|
|
XName
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>XML element name used to register this dependency 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_Dependencys_Siemens_SiemensLoopIterationDependency_MakeXmlSource_" data-uid="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.MakeXmlSource*"></a>
|
|
|
|
<h3 id="Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.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_Dependencys_Siemens_SiemensLoopIterationDependency_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_Dependencys_Siemens_SiemensLoopIterationDependency_OnSessionReset_" data-uid="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.OnSessionReset*"></a>
|
|
|
|
<h3 id="Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency_OnSessionReset" data-uid="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.OnSessionReset">
|
|
OnSessionReset()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Clears <a class="xref" href="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.html#Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency_CountByLoop">CountByLoop</a>; leaves <a class="xref" href="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.html#Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency_MaxIterationsPerLoop">MaxIterationsPerLoop</a> untouched.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void OnSessionReset()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency_Reg_" data-uid="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.Reg*"></a>
|
|
|
|
<h3 id="Hi_NcParsers_Dependencys_Siemens_SiemensLoopIterationDependency_Reg_Hi_Common_XmlUtils_XFactory_" data-uid="Hi.NcParsers.Dependencys.Siemens.SiemensLoopIterationDependency.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>
|