fix SoftNcRunner GM code normalization.
This commit is contained in:
@@ -192,8 +192,8 @@ including both defect data and visualization drawings.</p>
|
||||
|
||||
<a id="Hi_Cbtr_ConstructionDefectDisplayee__ctor_" data-uid="Hi.Cbtr.ConstructionDefectDisplayee.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Cbtr_ConstructionDefectDisplayee__ctor_System_Collections_Generic_List_Hi_Cbtr_CubeTree_DefectNodeInfo__" data-uid="Hi.Cbtr.ConstructionDefectDisplayee.#ctor(System.Collections.Generic.List{Hi.Cbtr.CubeTree.DefectNodeInfo})">
|
||||
ConstructionDefectDisplayee(List<DefectNodeInfo>)
|
||||
<h3 id="Hi_Cbtr_ConstructionDefectDisplayee__ctor_System_Collections_Generic_List_Hi_Cbtr_CubeTree_DefectNodeInfo__System_IProgress_System_Object__" data-uid="Hi.Cbtr.ConstructionDefectDisplayee.#ctor(System.Collections.Generic.List{Hi.Cbtr.CubeTree.DefectNodeInfo},System.IProgress{System.Object})">
|
||||
ConstructionDefectDisplayee(List<DefectNodeInfo>, IProgress<object>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -202,13 +202,16 @@ including both defect data and visualization drawings.</p>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ConstructionDefectDisplayee(List<CubeTree.DefectNodeInfo> defectNodeInfos)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public ConstructionDefectDisplayee(List<CubeTree.DefectNodeInfo> defectNodeInfos, IProgress<object> progress = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>defectNodeInfos</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a><<a class="xref" href="Hi.Cbtr.CubeTree.html">CubeTree</a>.<a class="xref" href="Hi.Cbtr.CubeTree.DefectNodeInfo.html">DefectNodeInfo</a>></dt>
|
||||
<dd><p>Defect node infos from cube tree construction.</p>
|
||||
</dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd><p>Progress reporter for user-facing messages.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -102,7 +102,7 @@ Class CubeTreeFile
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class CubeTreeFile : IMakeXmlSource, ISourceFile</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class CubeTreeFile : IMakeXmlSource, ISourceFile, IToPresentDto</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -121,6 +121,7 @@ Class CubeTreeFile
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
||||
<div><a class="xref" href="Hi.Common.ISourceFile.html">ISourceFile</a></div>
|
||||
<div><a class="xref" href="Hi.Common.IToPresentDto.html">IToPresentDto</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -470,6 +471,40 @@ Since the folder can be moving with the configuration file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Cbtr_CubeTreeFile_ToPresentDto_" data-uid="Hi.Cbtr.CubeTreeFile.ToPresentDto*"></a>
|
||||
|
||||
<h3 id="Hi_Cbtr_CubeTreeFile_ToPresentDto" data-uid="Hi.Cbtr.CubeTreeFile.ToPresentDto">
|
||||
ToPresentDto()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Convert to presentation DTO (Data Transfer Object) for JSON serialization.
|
||||
The returned object includes type metadata for web API presentation.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public object ToPresentDto()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd><p>DTO object with type and object properties</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
|
||||
@@ -255,8 +255,8 @@ Class AnchoredCollidablePair
|
||||
|
||||
<a id="Hi_Collision_AnchoredCollidablePair__ctor_" data-uid="Hi.Collision.AnchoredCollidablePair.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Collision_AnchoredCollidablePair__ctor_System_Xml_Linq_XElement_System_String_System_Object___" data-uid="Hi.Collision.AnchoredCollidablePair.#ctor(System.Xml.Linq.XElement,System.String,System.Object[])">
|
||||
AnchoredCollidablePair(XElement, string, params object[])
|
||||
<h3 id="Hi_Collision_AnchoredCollidablePair__ctor_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__System_Object___" data-uid="Hi.Collision.AnchoredCollidablePair.#ctor(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object},System.Object[])">
|
||||
AnchoredCollidablePair(XElement, string, IProgress<object>, object[])
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -265,7 +265,7 @@ Class AnchoredCollidablePair
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public AnchoredCollidablePair(XElement src, string baseDirectory, params object[] res)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public AnchoredCollidablePair(XElement src, string baseDirectory, IProgress<object> progress, object[] res)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -276,6 +276,8 @@ Class AnchoredCollidablePair
|
||||
<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>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional resources for initialization.</p>
|
||||
</dd>
|
||||
|
||||
@@ -216,8 +216,8 @@ Class CollisionIndexPair
|
||||
|
||||
<a id="Hi_Collision_CollisionIndexPair__ctor_" data-uid="Hi.Collision.CollisionIndexPair.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Collision_CollisionIndexPair__ctor_System_Xml_Linq_XElement_System_String_System_Object___" data-uid="Hi.Collision.CollisionIndexPair.#ctor(System.Xml.Linq.XElement,System.String,System.Object[])">
|
||||
CollisionIndexPair(XElement, string, params object[])
|
||||
<h3 id="Hi_Collision_CollisionIndexPair__ctor_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__System_Object___" data-uid="Hi.Collision.CollisionIndexPair.#ctor(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object},System.Object[])">
|
||||
CollisionIndexPair(XElement, string, IProgress<object>, object[])
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -226,7 +226,7 @@ Class CollisionIndexPair
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public CollisionIndexPair(XElement src, string baseDirectory, params object[] res)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public CollisionIndexPair(XElement src, string baseDirectory, IProgress<object> progress, object[] res)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -237,6 +237,8 @@ Class CollisionIndexPair
|
||||
<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>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional resources for initialization.</p>
|
||||
</dd>
|
||||
|
||||
@@ -248,8 +248,8 @@ Class DictionaryColorGuide
|
||||
|
||||
<a id="Hi_Coloring_DictionaryColorGuide__ctor_" data-uid="Hi.Coloring.DictionaryColorGuide.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Coloring_DictionaryColorGuide__ctor_System_Xml_Linq_XElement_System_String_System_Collections_Generic_Dictionary_System_String_System_Object__" data-uid="Hi.Coloring.DictionaryColorGuide.#ctor(System.Xml.Linq.XElement,System.String,System.Collections.Generic.Dictionary{System.String,System.Object})">
|
||||
DictionaryColorGuide(XElement, string, Dictionary<string, object>)
|
||||
<h3 id="Hi_Coloring_DictionaryColorGuide__ctor_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__System_Collections_Generic_Dictionary_System_String_System_Object__" data-uid="Hi.Coloring.DictionaryColorGuide.#ctor(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object},System.Collections.Generic.Dictionary{System.String,System.Object})">
|
||||
DictionaryColorGuide(XElement, string, IProgress<object>, Dictionary<string, object>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -258,7 +258,7 @@ Class DictionaryColorGuide
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public DictionaryColorGuide(XElement src, string baseDirectory, Dictionary<string, object> colorGuideCtorArgDictionary)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public DictionaryColorGuide(XElement src, string baseDirectory, IProgress<object> progress, Dictionary<string, object> colorGuideCtorArgDictionary)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -269,6 +269,8 @@ Class DictionaryColorGuide
|
||||
<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>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>colorGuideCtorArgDictionary</code> <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.object">object</a>></dt>
|
||||
<dd><p>Dictionary containing constructor arguments for color guides.</p>
|
||||
</dd>
|
||||
|
||||
@@ -215,8 +215,8 @@ Class FilteredColorGuide
|
||||
|
||||
<a id="Hi_Coloring_FilteredColorGuide__ctor_" data-uid="Hi.Coloring.FilteredColorGuide.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Coloring_FilteredColorGuide__ctor_System_Xml_Linq_XElement_System_String_System_Collections_Generic_Dictionary_System_String_System_Object__" data-uid="Hi.Coloring.FilteredColorGuide.#ctor(System.Xml.Linq.XElement,System.String,System.Collections.Generic.Dictionary{System.String,System.Object})">
|
||||
FilteredColorGuide(XElement, string, Dictionary<string, object>)
|
||||
<h3 id="Hi_Coloring_FilteredColorGuide__ctor_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__System_Collections_Generic_Dictionary_System_String_System_Object__" data-uid="Hi.Coloring.FilteredColorGuide.#ctor(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object},System.Collections.Generic.Dictionary{System.String,System.Object})">
|
||||
FilteredColorGuide(XElement, string, IProgress<object>, Dictionary<string, object>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -225,7 +225,7 @@ Class FilteredColorGuide
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FilteredColorGuide(XElement src, string baseDirectory, Dictionary<string, object> colorGuideCtorArgDictionary)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public FilteredColorGuide(XElement src, string baseDirectory, IProgress<object> progress, Dictionary<string, object> colorGuideCtorArgDictionary)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -236,6 +236,8 @@ Class FilteredColorGuide
|
||||
<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>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>colorGuideCtorArgDictionary</code> <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.object">object</a>></dt>
|
||||
<dd><p>Dictionary containing constructor arguments for color guides.</p>
|
||||
</dd>
|
||||
|
||||
@@ -308,6 +308,41 @@ or <a class="xref" href="Hi.Common.Collections.LazyLinkedList-1.html#Hi_Common_C
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_Collections_LazyLinkedList_1_ExhaustedLast_" data-uid="Hi.Common.Collections.LazyLinkedList`1.ExhaustedLast*"></a>
|
||||
|
||||
<h3 id="Hi_Common_Collections_LazyLinkedList_1_ExhaustedLast" data-uid="Hi.Common.Collections.LazyLinkedList`1.ExhaustedLast">
|
||||
ExhaustedLast
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Forces full materialization of the lazy source and returns the last node.
|
||||
Walks the source to completion (no-op if already exhausted), then returns
|
||||
<a class="xref" href="Hi.Common.Collections.LazyLinkedList-1.html#Hi_Common_Collections_LazyLinkedList_1_Last">Last</a>. Use when callers need the definitive tail at this point
|
||||
in time (e.g. as a stable predecessor before <a class="xref" href="Hi.Common.Collections.LazyLinkedList-1.html#Hi_Common_Collections_LazyLinkedList_1_AppendSource_System_Collections_Generic_IEnumerable__0__">AppendSource(IEnumerable<T>)</a>).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public LazyLinkedListNode<T> ExhaustedLast { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html">LazyLinkedListNode</a><T></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_Collections_LazyLinkedList_1_First_" data-uid="Hi.Common.Collections.LazyLinkedList`1.First*"></a>
|
||||
|
||||
<h3 id="Hi_Common_Collections_LazyLinkedList_1_First" data-uid="Hi.Common.Collections.LazyLinkedList`1.First">
|
||||
@@ -448,6 +483,44 @@ or <a class="xref" href="Hi.Common.Collections.LazyLinkedList-1.html#Hi_Common_C
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_Collections_LazyLinkedList_1_AppendSource_" data-uid="Hi.Common.Collections.LazyLinkedList`1.AppendSource*"></a>
|
||||
|
||||
<h3 id="Hi_Common_Collections_LazyLinkedList_1_AppendSource_System_Collections_Generic_IEnumerable__0__" data-uid="Hi.Common.Collections.LazyLinkedList`1.AppendSource(System.Collections.Generic.IEnumerable{`0})">
|
||||
AppendSource(IEnumerable<T>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Appends a new lazy source after the current source. The existing source's
|
||||
remaining items (if any) are drained first, then the new source is yielded.
|
||||
Re-opens the list for further on-demand materialization, so calling
|
||||
<a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html#Hi_Common_Collections_LazyLinkedListNode_1_Next">Next</a> on the prior tail materializes the
|
||||
next item and links <a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html#Hi_Common_Collections_LazyLinkedListNode_1_Previous">Previous</a> across the
|
||||
boundary.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void AppendSource(IEnumerable<T> 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.collections.generic.ienumerable-1">IEnumerable</a><T></dt>
|
||||
<dd><p>The new source to append.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_Collections_LazyLinkedList_1_Dispose_" data-uid="Hi.Common.Collections.LazyLinkedList`1.Dispose*"></a>
|
||||
|
||||
<h3 id="Hi_Common_Collections_LazyLinkedList_1_Dispose" data-uid="Hi.Common.Collections.LazyLinkedList`1.Dispose">
|
||||
|
||||
@@ -0,0 +1,949 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class FileLineCharIndex | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class FileLineCharIndex | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Represents a character-level position within a file by file index, line index, and character index. All indices are 0-based.">
|
||||
<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.Common.FileLines.FileLineCharIndex">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_Common_FileLines_FileLineCharIndex" data-uid="Hi.Common.FileLines.FileLineCharIndex" class="text-break">
|
||||
Class FileLineCharIndex
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Common.html">Common</a>.<a class="xref" href="Hi.Common.FileLines.html">FileLines</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Represents a character-level position within a file by file index, line index, and character index.
|
||||
All indices are 0-based.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class FileLineCharIndex : IFileLineCharIndex, IFileLineIndex, IGetFileLineIndex, IComparable<FileLineCharIndex>, IEquatable<FileLineCharIndex></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">FileLineCharIndex</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.Common.FileLines.IFileLineCharIndex.html">IFileLineCharIndex</a></div>
|
||||
<div><a class="xref" href="Hi.Common.FileLines.IFileLineIndex.html">IFileLineIndex</a></div>
|
||||
<div><a class="xref" href="Hi.Common.FileLines.IGetFileLineIndex.html">IGetFileLineIndex</a></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.icomparable-1">IComparable</a><<a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a>></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</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-system-object)">object.Equals(object, object)</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>
|
||||
</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.Geom.MathUtil.html#Hi_Geom_MathUtil_Clamp__1___0___0___0_">MathUtil.Clamp<T>(T, T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.FileLines.FileLineUtil.html#Hi_Common_FileLines_FileLineUtil_GetFileNo_Hi_Common_FileLines_IFileLineIndex_">FileLineUtil.GetFileNo(IFileLineIndex)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.FileLines.FileLineUtil.html#Hi_Common_FileLines_FileLineUtil_GetLineNo_Hi_Common_FileLines_IFileLineIndex_">FileLineUtil.GetLineNo(IFileLineIndex)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.FileLines.FileLineUtil.html#Hi_Common_FileLines_FileLineUtil_MixedIndex_Hi_Common_FileLines_IFileLineIndex_">FileLineUtil.MixedIndex(IFileLineIndex)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.FileLines.FileLineUtil.html#Hi_Common_FileLines_FileLineUtil_MixedIndex_Hi_Common_FileLines_IGetFileLineIndex_">FileLineUtil.MixedIndex(IGetFileLineIndex)</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_Common_FileLines_FileLineCharIndex__ctor_" data-uid="Hi.Common.FileLines.FileLineCharIndex.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndex__ctor" data-uid="Hi.Common.FileLines.FileLineCharIndex.#ctor">
|
||||
FileLineCharIndex()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a> class.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FileLineCharIndex()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndex__ctor_" data-uid="Hi.Common.FileLines.FileLineCharIndex.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndex__ctor_Hi_Common_FileLines_IFileLineCharIndex_" data-uid="Hi.Common.FileLines.FileLineCharIndex.#ctor(Hi.Common.FileLines.IFileLineCharIndex)">
|
||||
FileLineCharIndex(IFileLineCharIndex)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a> class by copying another instance.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FileLineCharIndex(IFileLineCharIndex src)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>src</code> <a class="xref" href="Hi.Common.FileLines.IFileLineCharIndex.html">IFileLineCharIndex</a></dt>
|
||||
<dd><p>The source to copy from.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndex__ctor_" data-uid="Hi.Common.FileLines.FileLineCharIndex.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndex__ctor_System_Int32_System_Int32_System_Int32_" data-uid="Hi.Common.FileLines.FileLineCharIndex.#ctor(System.Int32,System.Int32,System.Int32)">
|
||||
FileLineCharIndex(int, int, int)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a> class with specified indices.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FileLineCharIndex(int fileIndex, int lineIndex, int charIndex)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>fileIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The zero-based file index.</p>
|
||||
</dd>
|
||||
<dt><code>lineIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The zero-based line index.</p>
|
||||
</dd>
|
||||
<dt><code>charIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The zero-based character index within the line.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndex_CharIndex_" data-uid="Hi.Common.FileLines.FileLineCharIndex.CharIndex*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndex_CharIndex" data-uid="Hi.Common.FileLines.FileLineCharIndex.CharIndex">
|
||||
CharIndex
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Character index within the line. 0-based.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int CharIndex { 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_Common_FileLines_FileLineCharIndex_FileIndex_" data-uid="Hi.Common.FileLines.FileLineCharIndex.FileIndex*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndex_FileIndex" data-uid="Hi.Common.FileLines.FileLineCharIndex.FileIndex">
|
||||
FileIndex
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>File Index.
|
||||
Start on 0.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int FileIndex { 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_Common_FileLines_FileLineCharIndex_LineIndex_" data-uid="Hi.Common.FileLines.FileLineCharIndex.LineIndex*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndex_LineIndex" data-uid="Hi.Common.FileLines.FileLineCharIndex.LineIndex">
|
||||
LineIndex
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Line Index.
|
||||
Start on 0.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int LineIndex { 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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndex_AtLineBegin_" data-uid="Hi.Common.FileLines.FileLineCharIndex.AtLineBegin*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndex_AtLineBegin_System_Int32_System_Int32_" data-uid="Hi.Common.FileLines.FileLineCharIndex.AtLineBegin(System.Int32,System.Int32)">
|
||||
AtLineBegin(int, int)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Creates a <a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a> at the beginning of a line (CharIndex = 0).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static FileLineCharIndex AtLineBegin(int fileIndex, int lineIndex)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>fileIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The zero-based file index.</p>
|
||||
</dd>
|
||||
<dt><code>lineIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The zero-based line index.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndex_CompareTo_" data-uid="Hi.Common.FileLines.FileLineCharIndex.CompareTo*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndex_CompareTo_Hi_Common_FileLines_FileLineCharIndex_" data-uid="Hi.Common.FileLines.FileLineCharIndex.CompareTo(Hi.Common.FileLines.FileLineCharIndex)">
|
||||
CompareTo(FileLineCharIndex)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int CompareTo(FileLineCharIndex other)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>other</code> <a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a></dt>
|
||||
<dd><p>An object to compare with this instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>A value that indicates the relative order of the objects being compared. The return value has these meanings:</p>
|
||||
<table><thead><tr><th class="term"> Value</th><th class="description"> Meaning</th></tr></thead><tbody><tr><td class="term"> Less than zero</td><td class="description"> This instance precedes <code class="paramref">other</code> in the sort order.</td></tr><tr><td class="term"> Zero</td><td class="description"> This instance occurs in the same position in the sort order as <code class="paramref">other</code>.</td></tr><tr><td class="term"> Greater than zero</td><td class="description"> This instance follows <code class="paramref">other</code> in the sort order.</td></tr></tbody></table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndex_Equals_" data-uid="Hi.Common.FileLines.FileLineCharIndex.Equals*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndex_Equals_Hi_Common_FileLines_FileLineCharIndex_" data-uid="Hi.Common.FileLines.FileLineCharIndex.Equals(Hi.Common.FileLines.FileLineCharIndex)">
|
||||
Equals(FileLineCharIndex)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Indicates whether the current object is equal to another object of the same type.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool Equals(FileLineCharIndex other)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>other</code> <a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a></dt>
|
||||
<dd><p>An object to compare with this object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the current object is equal to the <code class="paramref">other</code> parameter; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndex_Equals_" data-uid="Hi.Common.FileLines.FileLineCharIndex.Equals*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndex_Equals_System_Object_" data-uid="Hi.Common.FileLines.FileLineCharIndex.Equals(System.Object)">
|
||||
Equals(object)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Determines whether the specified object is equal to the current object.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public override bool Equals(object obj)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd><p>The object to compare with the current object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the specified object is equal to the current object; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndex_GetFileLineIndex_" data-uid="Hi.Common.FileLines.FileLineCharIndex.GetFileLineIndex*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndex_GetFileLineIndex" data-uid="Hi.Common.FileLines.FileLineCharIndex.GetFileLineIndex">
|
||||
GetFileLineIndex()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Get <a class="xref" href="Hi.Common.FileLines.FileLineIndex.html">FileLineIndex</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FileLineIndex GetFileLineIndex()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.Common.FileLines.FileLineIndex.html">FileLineIndex</a></dt>
|
||||
<dd><p><a class="xref" href="Hi.Common.FileLines.FileLineIndex.html">FileLineIndex</a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndex_GetHashCode_" data-uid="Hi.Common.FileLines.FileLineCharIndex.GetHashCode*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndex_GetHashCode" data-uid="Hi.Common.FileLines.FileLineCharIndex.GetHashCode">
|
||||
GetHashCode()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Serves as the default hash function.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public override int GetHashCode()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>A hash code for the current object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndex_ToString_" data-uid="Hi.Common.FileLines.FileLineCharIndex.ToString*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndex_ToString" data-uid="Hi.Common.FileLines.FileLineCharIndex.ToString">
|
||||
ToString()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Returns a string that represents the current object.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A string that represents the current object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndex_ToUserString_" data-uid="Hi.Common.FileLines.FileLineCharIndex.ToUserString*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndex_ToUserString" data-uid="Hi.Common.FileLines.FileLineCharIndex.ToUserString">
|
||||
ToUserString()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Returns a user-friendly string representation.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string ToUserString()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</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="operators">Operators
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndex_op_Equality_" data-uid="Hi.Common.FileLines.FileLineCharIndex.op_Equality*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndex_op_Equality_Hi_Common_FileLines_FileLineCharIndex_Hi_Common_FileLines_FileLineCharIndex_" data-uid="Hi.Common.FileLines.FileLineCharIndex.op_Equality(Hi.Common.FileLines.FileLineCharIndex,Hi.Common.FileLines.FileLineCharIndex)">
|
||||
operator ==(FileLineCharIndex, FileLineCharIndex)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static bool operator ==(FileLineCharIndex left, FileLineCharIndex right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndex_op_GreaterThan_" data-uid="Hi.Common.FileLines.FileLineCharIndex.op_GreaterThan*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndex_op_GreaterThan_Hi_Common_FileLines_FileLineCharIndex_Hi_Common_FileLines_FileLineCharIndex_" data-uid="Hi.Common.FileLines.FileLineCharIndex.op_GreaterThan(Hi.Common.FileLines.FileLineCharIndex,Hi.Common.FileLines.FileLineCharIndex)">
|
||||
operator >(FileLineCharIndex, FileLineCharIndex)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static bool operator >(FileLineCharIndex left, FileLineCharIndex right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndex_op_GreaterThanOrEqual_" data-uid="Hi.Common.FileLines.FileLineCharIndex.op_GreaterThanOrEqual*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndex_op_GreaterThanOrEqual_Hi_Common_FileLines_FileLineCharIndex_Hi_Common_FileLines_FileLineCharIndex_" data-uid="Hi.Common.FileLines.FileLineCharIndex.op_GreaterThanOrEqual(Hi.Common.FileLines.FileLineCharIndex,Hi.Common.FileLines.FileLineCharIndex)">
|
||||
operator >=(FileLineCharIndex, FileLineCharIndex)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static bool operator >=(FileLineCharIndex left, FileLineCharIndex right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndex_op_Inequality_" data-uid="Hi.Common.FileLines.FileLineCharIndex.op_Inequality*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndex_op_Inequality_Hi_Common_FileLines_FileLineCharIndex_Hi_Common_FileLines_FileLineCharIndex_" data-uid="Hi.Common.FileLines.FileLineCharIndex.op_Inequality(Hi.Common.FileLines.FileLineCharIndex,Hi.Common.FileLines.FileLineCharIndex)">
|
||||
operator !=(FileLineCharIndex, FileLineCharIndex)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static bool operator !=(FileLineCharIndex left, FileLineCharIndex right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndex_op_LessThan_" data-uid="Hi.Common.FileLines.FileLineCharIndex.op_LessThan*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndex_op_LessThan_Hi_Common_FileLines_FileLineCharIndex_Hi_Common_FileLines_FileLineCharIndex_" data-uid="Hi.Common.FileLines.FileLineCharIndex.op_LessThan(Hi.Common.FileLines.FileLineCharIndex,Hi.Common.FileLines.FileLineCharIndex)">
|
||||
operator <(FileLineCharIndex, FileLineCharIndex)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static bool operator <(FileLineCharIndex left, FileLineCharIndex right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndex_op_LessThanOrEqual_" data-uid="Hi.Common.FileLines.FileLineCharIndex.op_LessThanOrEqual*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndex_op_LessThanOrEqual_Hi_Common_FileLines_FileLineCharIndex_Hi_Common_FileLines_FileLineCharIndex_" data-uid="Hi.Common.FileLines.FileLineCharIndex.op_LessThanOrEqual(Hi.Common.FileLines.FileLineCharIndex,Hi.Common.FileLines.FileLineCharIndex)">
|
||||
operator <=(FileLineCharIndex, FileLineCharIndex)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static bool operator <=(FileLineCharIndex left, FileLineCharIndex right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</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>
|
||||
@@ -0,0 +1,611 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class FileLineCharIndexSegment | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class FileLineCharIndexSegment | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Represents a character-level segment within file(s). is inclusive, is exclusive: [Begin, End).">
|
||||
<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.Common.FileLines.FileLineCharIndexSegment">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_Common_FileLines_FileLineCharIndexSegment" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment" class="text-break">
|
||||
Class FileLineCharIndexSegment
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Common.html">Common</a>.<a class="xref" href="Hi.Common.FileLines.html">FileLines</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Represents a character-level segment within file(s).
|
||||
<a class="xref" href="Hi.Common.FileLines.FileLineCharIndexSegment.html#Hi_Common_FileLines_FileLineCharIndexSegment_Begin">Begin</a> is inclusive, <a class="xref" href="Hi.Common.FileLines.FileLineCharIndexSegment.html#Hi_Common_FileLines_FileLineCharIndexSegment_End">End</a> is exclusive: [Begin, End).</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class FileLineCharIndexSegment : IEquatable<FileLineCharIndexSegment></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">FileLineCharIndexSegment</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.Common.FileLines.FileLineCharIndexSegment.html">FileLineCharIndexSegment</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-system-object)">object.Equals(object, object)</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>
|
||||
</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_Common_FileLines_FileLineCharIndexSegment__ctor_" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndexSegment__ctor" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment.#ctor">
|
||||
FileLineCharIndexSegment()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Common.FileLines.FileLineCharIndexSegment.html">FileLineCharIndexSegment</a> class.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FileLineCharIndexSegment()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndexSegment__ctor_" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndexSegment__ctor_Hi_Common_FileLines_FileLineCharIndex_Hi_Common_FileLines_FileLineCharIndex_" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment.#ctor(Hi.Common.FileLines.FileLineCharIndex,Hi.Common.FileLines.FileLineCharIndex)">
|
||||
FileLineCharIndexSegment(FileLineCharIndex, FileLineCharIndex)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Common.FileLines.FileLineCharIndexSegment.html">FileLineCharIndexSegment</a> class
|
||||
with specified begin and end positions.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FileLineCharIndexSegment(FileLineCharIndex begin, FileLineCharIndex end)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>begin</code> <a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a></dt>
|
||||
<dd><p>The beginning position (inclusive).</p>
|
||||
</dd>
|
||||
<dt><code>end</code> <a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a></dt>
|
||||
<dd><p>The ending position (exclusive).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndexSegment__ctor_" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndexSegment__ctor_Hi_Common_FileLines_FileLineCharIndexSegment_" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment.#ctor(Hi.Common.FileLines.FileLineCharIndexSegment)">
|
||||
FileLineCharIndexSegment(FileLineCharIndexSegment)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Common.FileLines.FileLineCharIndexSegment.html">FileLineCharIndexSegment</a> class by copying another instance.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FileLineCharIndexSegment(FileLineCharIndexSegment src)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>src</code> <a class="xref" href="Hi.Common.FileLines.FileLineCharIndexSegment.html">FileLineCharIndexSegment</a></dt>
|
||||
<dd><p>The source to copy from.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndexSegment__ctor_" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndexSegment__ctor_Hi_Common_FileLines_IIndexedFileLine_" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment.#ctor(Hi.Common.FileLines.IIndexedFileLine)">
|
||||
FileLineCharIndexSegment(IIndexedFileLine)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FileLineCharIndexSegment(IIndexedFileLine indexedFileLine)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>indexedFileLine</code> <a class="xref" href="Hi.Common.FileLines.IIndexedFileLine.html">IIndexedFileLine</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndexSegment_Begin_" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment.Begin*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndexSegment_Begin" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment.Begin">
|
||||
Begin
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Beginning position (inclusive).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FileLineCharIndex Begin { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndexSegment_End_" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment.End*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndexSegment_End" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment.End">
|
||||
End
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Ending position (exclusive).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FileLineCharIndex End { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndexSegment_IsMultiLine_" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment.IsMultiLine*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndexSegment_IsMultiLine" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment.IsMultiLine">
|
||||
IsMultiLine
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Whether the segment spans multiple lines.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool IsMultiLine { 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.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndexSegment_Any_" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment.Any*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndexSegment_Any" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment.Any">
|
||||
Any()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Whether this segment contains any characters (End > Begin).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool Any()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndexSegment_Equals_" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment.Equals*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndexSegment_Equals_Hi_Common_FileLines_FileLineCharIndexSegment_" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment.Equals(Hi.Common.FileLines.FileLineCharIndexSegment)">
|
||||
Equals(FileLineCharIndexSegment)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Indicates whether the current object is equal to another object of the same type.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool Equals(FileLineCharIndexSegment other)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>other</code> <a class="xref" href="Hi.Common.FileLines.FileLineCharIndexSegment.html">FileLineCharIndexSegment</a></dt>
|
||||
<dd><p>An object to compare with this object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the current object is equal to the <code class="paramref">other</code> parameter; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndexSegment_Equals_" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment.Equals*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndexSegment_Equals_System_Object_" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment.Equals(System.Object)">
|
||||
Equals(object)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Determines whether the specified object is equal to the current object.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public override bool Equals(object obj)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd><p>The object to compare with the current object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the specified object is equal to the current object; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndexSegment_GetHashCode_" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment.GetHashCode*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndexSegment_GetHashCode" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment.GetHashCode">
|
||||
GetHashCode()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Serves as the default hash function.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public override int GetHashCode()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>A hash code for the current object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_FileLineCharIndexSegment_ToString_" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment.ToString*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_FileLineCharIndexSegment_ToString" data-uid="Hi.Common.FileLines.FileLineCharIndexSegment.ToString">
|
||||
ToString()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Returns a string that represents the current object.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A string that represents the current object.</p>
|
||||
</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>
|
||||
@@ -0,0 +1,231 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Interface IFileLineCharIndex | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Interface IFileLineCharIndex | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Interface for a character-level position within a file: file, line, and character index. All indices are 0-based.">
|
||||
<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.Common.FileLines.IFileLineCharIndex">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_Common_FileLines_IFileLineCharIndex" data-uid="Hi.Common.FileLines.IFileLineCharIndex" class="text-break">
|
||||
Interface IFileLineCharIndex
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Common.html">Common</a>.<a class="xref" href="Hi.Common.FileLines.html">FileLines</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Interface for a character-level position within a file: file, line, and character index.
|
||||
All indices are 0-based.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public interface IFileLineCharIndex : IFileLineIndex, IGetFileLineIndex</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.FileLines.IFileLineIndex.html#Hi_Common_FileLines_IFileLineIndex_FileIndex">IFileLineIndex.FileIndex</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.FileLines.IFileLineIndex.html#Hi_Common_FileLines_IFileLineIndex_LineIndex">IFileLineIndex.LineIndex</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.FileLines.IGetFileLineIndex.html#Hi_Common_FileLines_IGetFileLineIndex_GetFileLineIndex">IGetFileLineIndex.GetFileLineIndex()</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.Common.FileLines.FileLineUtil.html#Hi_Common_FileLines_FileLineUtil_GetFileNo_Hi_Common_FileLines_IFileLineIndex_">FileLineUtil.GetFileNo(IFileLineIndex)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.FileLines.FileLineUtil.html#Hi_Common_FileLines_FileLineUtil_GetLineNo_Hi_Common_FileLines_IFileLineIndex_">FileLineUtil.GetLineNo(IFileLineIndex)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.FileLines.FileLineUtil.html#Hi_Common_FileLines_FileLineUtil_MixedIndex_Hi_Common_FileLines_IFileLineIndex_">FileLineUtil.MixedIndex(IFileLineIndex)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.FileLines.FileLineUtil.html#Hi_Common_FileLines_FileLineUtil_MixedIndex_Hi_Common_FileLines_IGetFileLineIndex_">FileLineUtil.MixedIndex(IGetFileLineIndex)</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="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_IFileLineCharIndex_CharIndex_" data-uid="Hi.Common.FileLines.IFileLineCharIndex.CharIndex*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_IFileLineCharIndex_CharIndex" data-uid="Hi.Common.FileLines.IFileLineCharIndex.CharIndex">
|
||||
CharIndex
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Character index within the line. 0-based.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">int CharIndex { 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.int32">int</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>
|
||||
@@ -0,0 +1,736 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class IndexedFileLineChar | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class IndexedFileLineChar | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Represents a character-level position within a file, with associated file path context. Analogous to but at character granularity.">
|
||||
<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.Common.FileLines.IndexedFileLineChar">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_Common_FileLines_IndexedFileLineChar" data-uid="Hi.Common.FileLines.IndexedFileLineChar" class="text-break">
|
||||
Class IndexedFileLineChar
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Common.html">Common</a>.<a class="xref" href="Hi.Common.FileLines.html">FileLines</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Represents a character-level position within a file, with associated file path context.
|
||||
Analogous to <a class="xref" href="Hi.Common.FileLines.IndexedFileLine.html">IndexedFileLine</a> but at character granularity.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class IndexedFileLineChar : IFileLineCharIndex, IFileLineIndex, IGetFileLineIndex, IEquatable<IndexedFileLineChar></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">IndexedFileLineChar</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.Common.FileLines.IFileLineCharIndex.html">IFileLineCharIndex</a></div>
|
||||
<div><a class="xref" href="Hi.Common.FileLines.IFileLineIndex.html">IFileLineIndex</a></div>
|
||||
<div><a class="xref" href="Hi.Common.FileLines.IGetFileLineIndex.html">IGetFileLineIndex</a></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.Common.FileLines.IndexedFileLineChar.html">IndexedFileLineChar</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-system-object)">object.Equals(object, object)</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>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.FileLines.FileLineUtil.html#Hi_Common_FileLines_FileLineUtil_GetFileNo_Hi_Common_FileLines_IFileLineIndex_">FileLineUtil.GetFileNo(IFileLineIndex)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.FileLines.FileLineUtil.html#Hi_Common_FileLines_FileLineUtil_GetLineNo_Hi_Common_FileLines_IFileLineIndex_">FileLineUtil.GetLineNo(IFileLineIndex)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.FileLines.FileLineUtil.html#Hi_Common_FileLines_FileLineUtil_MixedIndex_Hi_Common_FileLines_IFileLineIndex_">FileLineUtil.MixedIndex(IFileLineIndex)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.FileLines.FileLineUtil.html#Hi_Common_FileLines_FileLineUtil_MixedIndex_Hi_Common_FileLines_IGetFileLineIndex_">FileLineUtil.MixedIndex(IGetFileLineIndex)</a>
|
||||
</div>
|
||||
<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_Common_FileLines_IndexedFileLineChar__ctor_" data-uid="Hi.Common.FileLines.IndexedFileLineChar.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_IndexedFileLineChar__ctor" data-uid="Hi.Common.FileLines.IndexedFileLineChar.#ctor">
|
||||
IndexedFileLineChar()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Common.FileLines.IndexedFileLineChar.html">IndexedFileLineChar</a> class.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IndexedFileLineChar()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_IndexedFileLineChar__ctor_" data-uid="Hi.Common.FileLines.IndexedFileLineChar.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_IndexedFileLineChar__ctor_Hi_Common_FileLines_IndexedFileLine_System_Int32_" data-uid="Hi.Common.FileLines.IndexedFileLineChar.#ctor(Hi.Common.FileLines.IndexedFileLine,System.Int32)">
|
||||
IndexedFileLineChar(IndexedFileLine, int)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Creates an <a class="xref" href="Hi.Common.FileLines.IndexedFileLineChar.html">IndexedFileLineChar</a> from an <a class="xref" href="Hi.Common.FileLines.IndexedFileLine.html">IndexedFileLine</a>
|
||||
at the specified character index.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IndexedFileLineChar(IndexedFileLine src, int charIndex)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>src</code> <a class="xref" href="Hi.Common.FileLines.IndexedFileLine.html">IndexedFileLine</a></dt>
|
||||
<dd><p>The source indexed file line.</p>
|
||||
</dd>
|
||||
<dt><code>charIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The zero-based character index within the line.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_IndexedFileLineChar__ctor_" data-uid="Hi.Common.FileLines.IndexedFileLineChar.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_IndexedFileLineChar__ctor_Hi_Common_FileLines_IndexedFileLineChar_" data-uid="Hi.Common.FileLines.IndexedFileLineChar.#ctor(Hi.Common.FileLines.IndexedFileLineChar)">
|
||||
IndexedFileLineChar(IndexedFileLineChar)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Common.FileLines.IndexedFileLineChar.html">IndexedFileLineChar</a> class by copying another instance.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IndexedFileLineChar(IndexedFileLineChar src)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>src</code> <a class="xref" href="Hi.Common.FileLines.IndexedFileLineChar.html">IndexedFileLineChar</a></dt>
|
||||
<dd><p>The source to copy from.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_IndexedFileLineChar__ctor_" data-uid="Hi.Common.FileLines.IndexedFileLineChar.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_IndexedFileLineChar__ctor_System_Int32_System_String_System_Int32_System_Int32_" data-uid="Hi.Common.FileLines.IndexedFileLineChar.#ctor(System.Int32,System.String,System.Int32,System.Int32)">
|
||||
IndexedFileLineChar(int, string, int, int)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Common.FileLines.IndexedFileLineChar.html">IndexedFileLineChar</a> class with specified values.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IndexedFileLineChar(int fileIndex, string filePath, int lineIndex, int charIndex)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>fileIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The zero-based file index.</p>
|
||||
</dd>
|
||||
<dt><code>filePath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The file path.</p>
|
||||
</dd>
|
||||
<dt><code>lineIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The zero-based line index.</p>
|
||||
</dd>
|
||||
<dt><code>charIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The zero-based character index within the line.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_IndexedFileLineChar_CharIndex_" data-uid="Hi.Common.FileLines.IndexedFileLineChar.CharIndex*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_IndexedFileLineChar_CharIndex" data-uid="Hi.Common.FileLines.IndexedFileLineChar.CharIndex">
|
||||
CharIndex
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Character index within the line. 0-based.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int CharIndex { 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_Common_FileLines_IndexedFileLineChar_FileIndex_" data-uid="Hi.Common.FileLines.IndexedFileLineChar.FileIndex*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_IndexedFileLineChar_FileIndex" data-uid="Hi.Common.FileLines.IndexedFileLineChar.FileIndex">
|
||||
FileIndex
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>File Index.
|
||||
Start on 0.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int FileIndex { 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_Common_FileLines_IndexedFileLineChar_FilePath_" data-uid="Hi.Common.FileLines.IndexedFileLineChar.FilePath*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_IndexedFileLineChar_FilePath" data-uid="Hi.Common.FileLines.IndexedFileLineChar.FilePath">
|
||||
FilePath
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>File path.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string FilePath { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_IndexedFileLineChar_LineIndex_" data-uid="Hi.Common.FileLines.IndexedFileLineChar.LineIndex*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_IndexedFileLineChar_LineIndex" data-uid="Hi.Common.FileLines.IndexedFileLineChar.LineIndex">
|
||||
LineIndex
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Line Index.
|
||||
Start on 0.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int LineIndex { 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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_IndexedFileLineChar_Equals_" data-uid="Hi.Common.FileLines.IndexedFileLineChar.Equals*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_IndexedFileLineChar_Equals_Hi_Common_FileLines_IndexedFileLineChar_" data-uid="Hi.Common.FileLines.IndexedFileLineChar.Equals(Hi.Common.FileLines.IndexedFileLineChar)">
|
||||
Equals(IndexedFileLineChar)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Indicates whether the current object is equal to another object of the same type.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool Equals(IndexedFileLineChar other)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>other</code> <a class="xref" href="Hi.Common.FileLines.IndexedFileLineChar.html">IndexedFileLineChar</a></dt>
|
||||
<dd><p>An object to compare with this object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the current object is equal to the <code class="paramref">other</code> parameter; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_IndexedFileLineChar_Equals_" data-uid="Hi.Common.FileLines.IndexedFileLineChar.Equals*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_IndexedFileLineChar_Equals_System_Object_" data-uid="Hi.Common.FileLines.IndexedFileLineChar.Equals(System.Object)">
|
||||
Equals(object)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Determines whether the specified object is equal to the current object.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public override bool Equals(object obj)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd><p>The object to compare with the current object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the specified object is equal to the current object; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_IndexedFileLineChar_GetFileLineIndex_" data-uid="Hi.Common.FileLines.IndexedFileLineChar.GetFileLineIndex*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_IndexedFileLineChar_GetFileLineIndex" data-uid="Hi.Common.FileLines.IndexedFileLineChar.GetFileLineIndex">
|
||||
GetFileLineIndex()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Get <a class="xref" href="Hi.Common.FileLines.FileLineIndex.html">FileLineIndex</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FileLineIndex GetFileLineIndex()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.Common.FileLines.FileLineIndex.html">FileLineIndex</a></dt>
|
||||
<dd><p><a class="xref" href="Hi.Common.FileLines.FileLineIndex.html">FileLineIndex</a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_IndexedFileLineChar_GetHashCode_" data-uid="Hi.Common.FileLines.IndexedFileLineChar.GetHashCode*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_IndexedFileLineChar_GetHashCode" data-uid="Hi.Common.FileLines.IndexedFileLineChar.GetHashCode">
|
||||
GetHashCode()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Serves as the default hash function.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public override int GetHashCode()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>A hash code for the current object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_IndexedFileLineChar_ToFileLineCharIndex_" data-uid="Hi.Common.FileLines.IndexedFileLineChar.ToFileLineCharIndex*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_IndexedFileLineChar_ToFileLineCharIndex" data-uid="Hi.Common.FileLines.IndexedFileLineChar.ToFileLineCharIndex">
|
||||
ToFileLineCharIndex()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Converts to a <a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a> (without file path context).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FileLineCharIndex ToFileLineCharIndex()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_FileLines_IndexedFileLineChar_ToHumanString_" data-uid="Hi.Common.FileLines.IndexedFileLineChar.ToHumanString*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_IndexedFileLineChar_ToHumanString" data-uid="Hi.Common.FileLines.IndexedFileLineChar.ToHumanString">
|
||||
ToHumanString()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Returns a human-readable string representation.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string ToHumanString()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</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_Common_FileLines_IndexedFileLineChar_ToString_" data-uid="Hi.Common.FileLines.IndexedFileLineChar.ToString*"></a>
|
||||
|
||||
<h3 id="Hi_Common_FileLines_IndexedFileLineChar_ToString" data-uid="Hi.Common.FileLines.IndexedFileLineChar.ToString">
|
||||
ToString()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Returns a string that represents the current object.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A string that represents the current object.</p>
|
||||
</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>
|
||||
@@ -105,13 +105,20 @@ Classes
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.FileLines.FileLineIndex.html">FileLineIndex</a></dt>
|
||||
<dd><p>Represents a location in a file by its file index and line number.</p>
|
||||
<dt><a class="xref" href="Hi.Common.FileLines.FileLineCharIndex.html">FileLineCharIndex</a></dt>
|
||||
<dd><p>Represents a character-level position within a file by file index, line index, and character index.
|
||||
All indices are 0-based.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.FileLines.FileLinePipingKit.html">FileLinePipingKit</a></dt>
|
||||
<dd><p>Perform lines piping to a file by another thread.</p>
|
||||
<dt><a class="xref" href="Hi.Common.FileLines.FileLineCharIndexSegment.html">FileLineCharIndexSegment</a></dt>
|
||||
<dd><p>Represents a character-level segment within file(s).
|
||||
<a class="xref" href="Hi.Common.FileLines.FileLineCharIndexSegment.html#Hi_Common_FileLines_FileLineCharIndexSegment_Begin">Begin</a> is inclusive, <a class="xref" href="Hi.Common.FileLines.FileLineCharIndexSegment.html#Hi_Common_FileLines_FileLineCharIndexSegment_End">End</a> is exclusive: [Begin, End).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.FileLines.FileLineIndex.html">FileLineIndex</a></dt>
|
||||
<dd><p>Represents a location in a file by its file index and line number.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
@@ -132,6 +139,12 @@ Classes
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.FileLines.IndexedFileLine.html">IndexedFileLine</a></dt>
|
||||
<dd><p>Represents a line of text from a file with associated file and line information.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.FileLines.IndexedFileLineChar.html">IndexedFileLineChar</a></dt>
|
||||
<dd><p>Represents a character-level position within a file, with associated file path context.
|
||||
Analogous to <a class="xref" href="Hi.Common.FileLines.IndexedFileLine.html">IndexedFileLine</a> but at character granularity.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
@@ -155,6 +168,12 @@ Interfaces
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.FileLines.IFileLine.html">IFileLine</a></dt>
|
||||
<dd><p>Interface of file line.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.FileLines.IFileLineCharIndex.html">IFileLineCharIndex</a></dt>
|
||||
<dd><p>Interface for a character-level position within a file: file, line, and character index.
|
||||
All indices are 0-based.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
|
||||
@@ -194,9 +194,6 @@ Used to indicate programming errors or unexpected states that require developer
|
||||
<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.Common.ExceptionUtil.html#Hi_Common_ExceptionUtil_ShowException_System_Exception_System_Object_">ExceptionUtil.ShowException(Exception, object)</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>
|
||||
|
||||
@@ -319,6 +319,47 @@ Creates missing intermediate objects as needed.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_JsonUtil_ToLeafCompactJsonString_" data-uid="Hi.Common.JsonUtil.ToLeafCompactJsonString*"></a>
|
||||
|
||||
<h3 id="Hi_Common_JsonUtil_ToLeafCompactJsonString_System_Text_Json_Nodes_JsonNode_System_Text_Json_JsonSerializerOptions_" data-uid="Hi.Common.JsonUtil.ToLeafCompactJsonString(System.Text.Json.Nodes.JsonNode,System.Text.Json.JsonSerializerOptions)">
|
||||
ToLeafCompactJsonString(JsonNode, JsonSerializerOptions)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Serializes a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.json.nodes.jsonnode">JsonNode</a> so that stem containers are indented
|
||||
but leaf containers (all children are primitive values) are written on a
|
||||
single compact line. Supports NaN / Infinity / -Infinity.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string ToLeafCompactJsonString(this JsonNode src, JsonSerializerOptions options = null)</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.text.json.nodes.jsonnode">JsonNode</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>options</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.json.jsonserializeroptions">JsonSerializerOptions</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</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_Common_JsonUtil_WritePartialJson_" data-uid="Hi.Common.JsonUtil.WritePartialJson*"></a>
|
||||
|
||||
<h3 id="Hi_Common_JsonUtil_WritePartialJson__1_System_String_System_String___0_" data-uid="Hi.Common.JsonUtil.WritePartialJson``1(System.String,System.String,``0)">
|
||||
|
||||
@@ -187,8 +187,44 @@ Only the most recent action is executed and previous pending actions are discard
|
||||
|
||||
<a id="Hi_Common_LooseRunner__ctor_" data-uid="Hi.Common.LooseRunner.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Common_LooseRunner__ctor_System_Nullable_System_Threading_CancellationToken__" data-uid="Hi.Common.LooseRunner.#ctor(System.Nullable{System.Threading.CancellationToken})">
|
||||
LooseRunner(CancellationToken?)
|
||||
<h3 id="Hi_Common_LooseRunner__ctor_Microsoft_Extensions_Logging_ILogger_System_Nullable_System_Threading_CancellationToken__" data-uid="Hi.Common.LooseRunner.#ctor(Microsoft.Extensions.Logging.ILogger,System.Nullable{System.Threading.CancellationToken})">
|
||||
LooseRunner(ILogger, CancellationToken?)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Common.LooseRunner.html">LooseRunner</a> class with an <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.ilogger">ILogger</a> for exception reporting.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public LooseRunner(ILogger logger, CancellationToken? cancellationToken = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>logger</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.ilogger">ILogger</a></dt>
|
||||
<dd><p>The logger used to report exceptions.</p>
|
||||
</dd>
|
||||
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a>?</dt>
|
||||
<dd><p>Optional cancellation token to control the lifetime of the runner.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_LooseRunner__ctor_" data-uid="Hi.Common.LooseRunner.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Common_LooseRunner__ctor_System_Action_System_Exception__System_Nullable_System_Threading_CancellationToken__" data-uid="Hi.Common.LooseRunner.#ctor(System.Action{System.Exception},System.Nullable{System.Threading.CancellationToken})">
|
||||
LooseRunner(Action<Exception>, CancellationToken?)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -197,11 +233,14 @@ Only the most recent action is executed and previous pending actions are discard
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public LooseRunner(CancellationToken? cancellationToken = null)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public LooseRunner(Action<Exception> exceptionAction = null, CancellationToken? cancellationToken = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>exceptionAction</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a>></dt>
|
||||
<dd><p>Optional action invoked when an exception occurs. If null, exceptions are silently ignored.</p>
|
||||
</dd>
|
||||
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a>?</dt>
|
||||
<dd><p>Optional cancellation token to control the lifetime of the runner. If not provided, a new token will be created.</p>
|
||||
</dd>
|
||||
|
||||
@@ -268,8 +268,8 @@ Class ManualUtil
|
||||
|
||||
<a id="Hi_Common_ManualUtil_GetTitle_" data-uid="Hi.Common.ManualUtil.GetTitle*"></a>
|
||||
|
||||
<h3 id="Hi_Common_ManualUtil_GetTitle_System_String_" data-uid="Hi.Common.ManualUtil.GetTitle(System.String)">
|
||||
GetTitle(string)
|
||||
<h3 id="Hi_Common_ManualUtil_GetTitle_System_String_Microsoft_Extensions_Logging_ILogger_" data-uid="Hi.Common.ManualUtil.GetTitle(System.String,Microsoft.Extensions.Logging.ILogger)">
|
||||
GetTitle(string, ILogger)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -278,13 +278,16 @@ Class ManualUtil
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string GetTitle(string urlTemplate)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public static string GetTitle(string urlTemplate, ILogger logger)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>urlTemplate</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>URL template containing culture placeholder.</p>
|
||||
</dd>
|
||||
<dt><code>logger</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.ilogger">ILogger</a></dt>
|
||||
<dd><p>The logger instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -0,0 +1,325 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class ActionProgress<T> | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class ActionProgress<T> | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Lightweight that delegates to an . Unlike , does not capture and invokes the handler synchronously on the caller's thread.">
|
||||
<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.Common.Messages.ActionProgress`1">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_Common_Messages_ActionProgress_1" data-uid="Hi.Common.Messages.ActionProgress`1" class="text-break">
|
||||
Class ActionProgress<T>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Common.html">Common</a>.<a class="xref" href="Hi.Common.Messages.html">Messages</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Lightweight <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress<T></a> that delegates to an <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action<T></a>.
|
||||
Unlike <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.progress-1">Progress<T></a>, does not capture
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.synchronizationcontext">SynchronizationContext</a>
|
||||
and invokes the handler synchronously on the caller's thread.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ActionProgress<T> : IProgress<T></code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<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">ActionProgress<T></span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><T></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_Common_Messages_ActionProgress_1__ctor_" data-uid="Hi.Common.Messages.ActionProgress`1.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Common_Messages_ActionProgress_1__ctor_System_Action__0__" data-uid="Hi.Common.Messages.ActionProgress`1.#ctor(System.Action{`0})">
|
||||
ActionProgress(Action<T>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ActionProgress(Action<T> handler)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>handler</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a><T></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_Common_Messages_ActionProgress_1_FromLogger_" data-uid="Hi.Common.Messages.ActionProgress`1.FromLogger*"></a>
|
||||
|
||||
<h3 id="Hi_Common_Messages_ActionProgress_1_FromLogger_Microsoft_Extensions_Logging_ILogger_" data-uid="Hi.Common.Messages.ActionProgress`1.FromLogger(Microsoft.Extensions.Logging.ILogger)">
|
||||
FromLogger(ILogger)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Creates an <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress<T></a> that routes
|
||||
<a class="xref" href="Hi.Common.Messages.MultiTagMessage.html">MultiTagMessage</a> to the appropriate <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.ilogger">ILogger</a> level.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static IProgress<object> FromLogger(ILogger logger)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>logger</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.ilogger">ILogger</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_Messages_ActionProgress_1_Report_" data-uid="Hi.Common.Messages.ActionProgress`1.Report*"></a>
|
||||
|
||||
<h3 id="Hi_Common_Messages_ActionProgress_1_Report__0_" data-uid="Hi.Common.Messages.ActionProgress`1.Report(`0)">
|
||||
Report(T)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Reports a progress update.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void Report(T value)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>value</code> <span class="xref">T</span></dt>
|
||||
<dd><p>The value of the updated progress.</p>
|
||||
</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>
|
||||
+37
-37
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.Common.DebugUtil">
|
||||
<article data-uid="Hi.Common.Messages.DebugUtil">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_Common_DebugUtil" data-uid="Hi.Common.DebugUtil" class="text-break">
|
||||
<h1 id="Hi_Common_Messages_DebugUtil" data-uid="Hi.Common.Messages.DebugUtil" class="text-break">
|
||||
Class DebugUtil
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Common.html">Common</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Common.html">Common</a>.<a class="xref" href="Hi.Common.Messages.html">Messages</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -153,16 +153,16 @@ Class DebugUtil
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_Common_DebugUtil_Count_" data-uid="Hi.Common.DebugUtil.Count*"></a>
|
||||
<a id="Hi_Common_Messages_DebugUtil_Count_" data-uid="Hi.Common.Messages.DebugUtil.Count*"></a>
|
||||
|
||||
<h3 id="Hi_Common_DebugUtil_Count" data-uid="Hi.Common.DebugUtil.Count">
|
||||
<h3 id="Hi_Common_Messages_DebugUtil_Count" data-uid="Hi.Common.Messages.DebugUtil.Count">
|
||||
Count
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Count of calling <a class="xref" href="Hi.Common.DebugUtil.html#Hi_Common_DebugUtil_C">C()</a>.
|
||||
The Count is shown by <a class="xref" href="Hi.Common.DebugUtil.html#Hi_Common_DebugUtil_S_System_String_">S(string)</a>.
|
||||
The Count helps to trigger pause by <a class="xref" href="Hi.Common.DebugUtil.html#Hi_Common_DebugUtil_P_System_Int32_">P(int)</a>.</p>
|
||||
<div class="markdown level1 summary"><p>Count of calling <a class="xref" href="Hi.Common.Messages.DebugUtil.html#Hi_Common_Messages_DebugUtil_C">C()</a>.
|
||||
The Count is shown by <a class="xref" href="Hi.Common.Messages.DebugUtil.html#Hi_Common_Messages_DebugUtil_S_System_String_">S(string)</a>.
|
||||
The Count helps to trigger pause by <a class="xref" href="Hi.Common.Messages.DebugUtil.html#Hi_Common_Messages_DebugUtil_P_System_Int32_">P(int)</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -187,9 +187,9 @@ The Count helps to trigger pause by <a class="xref" href="Hi.Common.DebugUtil.ht
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_DebugUtil_Data_" data-uid="Hi.Common.DebugUtil.Data*"></a>
|
||||
<a id="Hi_Common_Messages_DebugUtil_Data_" data-uid="Hi.Common.Messages.DebugUtil.Data*"></a>
|
||||
|
||||
<h3 id="Hi_Common_DebugUtil_Data" data-uid="Hi.Common.DebugUtil.Data">
|
||||
<h3 id="Hi_Common_Messages_DebugUtil_Data" data-uid="Hi.Common.Messages.DebugUtil.Data">
|
||||
Data
|
||||
|
||||
</h3>
|
||||
@@ -219,9 +219,9 @@ The Count helps to trigger pause by <a class="xref" href="Hi.Common.DebugUtil.ht
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_DebugUtil_Debugee_" data-uid="Hi.Common.DebugUtil.Debugee*"></a>
|
||||
<a id="Hi_Common_Messages_DebugUtil_Debugee_" data-uid="Hi.Common.Messages.DebugUtil.Debugee*"></a>
|
||||
|
||||
<h3 id="Hi_Common_DebugUtil_Debugee" data-uid="Hi.Common.DebugUtil.Debugee">
|
||||
<h3 id="Hi_Common_Messages_DebugUtil_Debugee" data-uid="Hi.Common.Messages.DebugUtil.Debugee">
|
||||
Debugee
|
||||
|
||||
</h3>
|
||||
@@ -251,9 +251,9 @@ The Count helps to trigger pause by <a class="xref" href="Hi.Common.DebugUtil.ht
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_DebugUtil_NativeDebugVar_" data-uid="Hi.Common.DebugUtil.NativeDebugVar*"></a>
|
||||
<a id="Hi_Common_Messages_DebugUtil_NativeDebugVar_" data-uid="Hi.Common.Messages.DebugUtil.NativeDebugVar*"></a>
|
||||
|
||||
<h3 id="Hi_Common_DebugUtil_NativeDebugVar" data-uid="Hi.Common.DebugUtil.NativeDebugVar">
|
||||
<h3 id="Hi_Common_Messages_DebugUtil_NativeDebugVar" data-uid="Hi.Common.Messages.DebugUtil.NativeDebugVar">
|
||||
NativeDebugVar
|
||||
|
||||
</h3>
|
||||
@@ -283,9 +283,9 @@ The Count helps to trigger pause by <a class="xref" href="Hi.Common.DebugUtil.ht
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_DebugUtil_WriteLineAction_" data-uid="Hi.Common.DebugUtil.WriteLineAction*"></a>
|
||||
<a id="Hi_Common_Messages_DebugUtil_WriteLineAction_" data-uid="Hi.Common.Messages.DebugUtil.WriteLineAction*"></a>
|
||||
|
||||
<h3 id="Hi_Common_DebugUtil_WriteLineAction" data-uid="Hi.Common.DebugUtil.WriteLineAction">
|
||||
<h3 id="Hi_Common_Messages_DebugUtil_WriteLineAction" data-uid="Hi.Common.Messages.DebugUtil.WriteLineAction">
|
||||
WriteLineAction
|
||||
|
||||
</h3>
|
||||
@@ -319,9 +319,9 @@ The Count helps to trigger pause by <a class="xref" href="Hi.Common.DebugUtil.ht
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_Common_DebugUtil_C_" data-uid="Hi.Common.DebugUtil.C*"></a>
|
||||
<a id="Hi_Common_Messages_DebugUtil_C_" data-uid="Hi.Common.Messages.DebugUtil.C*"></a>
|
||||
|
||||
<h3 id="Hi_Common_DebugUtil_C" data-uid="Hi.Common.DebugUtil.C">
|
||||
<h3 id="Hi_Common_Messages_DebugUtil_C" data-uid="Hi.Common.Messages.DebugUtil.C">
|
||||
C()
|
||||
|
||||
</h3>
|
||||
@@ -352,14 +352,14 @@ The Count helps to trigger pause by <a class="xref" href="Hi.Common.DebugUtil.ht
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_DebugUtil_CPS_" data-uid="Hi.Common.DebugUtil.CPS*"></a>
|
||||
<a id="Hi_Common_Messages_DebugUtil_CPS_" data-uid="Hi.Common.Messages.DebugUtil.CPS*"></a>
|
||||
|
||||
<h3 id="Hi_Common_DebugUtil_CPS_System_Int32_System_String_" data-uid="Hi.Common.DebugUtil.CPS(System.Int32,System.String)">
|
||||
<h3 id="Hi_Common_Messages_DebugUtil_CPS_System_Int32_System_String_" data-uid="Hi.Common.Messages.DebugUtil.CPS(System.Int32,System.String)">
|
||||
CPS(int, string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Execute <a class="xref" href="Hi.Common.DebugUtil.html#Hi_Common_DebugUtil_C">C()</a>. Pause and execute <a class="xref" href="Hi.Common.DebugUtil.html#Hi_Common_DebugUtil_S_System_String_">S(string)</a> if count >= p.</p>
|
||||
<div class="markdown level1 summary"><p>Execute <a class="xref" href="Hi.Common.Messages.DebugUtil.html#Hi_Common_Messages_DebugUtil_C">C()</a>. Pause and execute <a class="xref" href="Hi.Common.Messages.DebugUtil.html#Hi_Common_Messages_DebugUtil_S_System_String_">S(string)</a> if count >= p.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -394,14 +394,14 @@ The Count helps to trigger pause by <a class="xref" href="Hi.Common.DebugUtil.ht
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_DebugUtil_CS_" data-uid="Hi.Common.DebugUtil.CS*"></a>
|
||||
<a id="Hi_Common_Messages_DebugUtil_CS_" data-uid="Hi.Common.Messages.DebugUtil.CS*"></a>
|
||||
|
||||
<h3 id="Hi_Common_DebugUtil_CS_System_String_" data-uid="Hi.Common.DebugUtil.CS(System.String)">
|
||||
<h3 id="Hi_Common_Messages_DebugUtil_CS_System_String_" data-uid="Hi.Common.Messages.DebugUtil.CS(System.String)">
|
||||
CS(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Call <a class="xref" href="Hi.Common.DebugUtil.html#Hi_Common_DebugUtil_C">C()</a> and then call <a class="xref" href="Hi.Common.DebugUtil.html#Hi_Common_DebugUtil_S_System_String_">S(string)</a>.</p>
|
||||
<div class="markdown level1 summary"><p>Call <a class="xref" href="Hi.Common.Messages.DebugUtil.html#Hi_Common_Messages_DebugUtil_C">C()</a> and then call <a class="xref" href="Hi.Common.Messages.DebugUtil.html#Hi_Common_Messages_DebugUtil_S_System_String_">S(string)</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -433,14 +433,14 @@ The Count helps to trigger pause by <a class="xref" href="Hi.Common.DebugUtil.ht
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_DebugUtil_CSP_" data-uid="Hi.Common.DebugUtil.CSP*"></a>
|
||||
<a id="Hi_Common_Messages_DebugUtil_CSP_" data-uid="Hi.Common.Messages.DebugUtil.CSP*"></a>
|
||||
|
||||
<h3 id="Hi_Common_DebugUtil_CSP_System_Int32_System_String_" data-uid="Hi.Common.DebugUtil.CSP(System.Int32,System.String)">
|
||||
<h3 id="Hi_Common_Messages_DebugUtil_CSP_System_Int32_System_String_" data-uid="Hi.Common.Messages.DebugUtil.CSP(System.Int32,System.String)">
|
||||
CSP(int, string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Execute the functions in sequence: <a class="xref" href="Hi.Common.DebugUtil.html#Hi_Common_DebugUtil_C">C()</a>, <a class="xref" href="Hi.Common.DebugUtil.html#Hi_Common_DebugUtil_S_System_String_">S(string)</a>, <a class="xref" href="Hi.Common.DebugUtil.html#Hi_Common_DebugUtil_P_System_Int32_">P(int)</a>.</p>
|
||||
<div class="markdown level1 summary"><p>Execute the functions in sequence: <a class="xref" href="Hi.Common.Messages.DebugUtil.html#Hi_Common_Messages_DebugUtil_C">C()</a>, <a class="xref" href="Hi.Common.Messages.DebugUtil.html#Hi_Common_Messages_DebugUtil_S_System_String_">S(string)</a>, <a class="xref" href="Hi.Common.Messages.DebugUtil.html#Hi_Common_Messages_DebugUtil_P_System_Int32_">P(int)</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -475,9 +475,9 @@ The Count helps to trigger pause by <a class="xref" href="Hi.Common.DebugUtil.ht
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_DebugUtil_P_" data-uid="Hi.Common.DebugUtil.P*"></a>
|
||||
<a id="Hi_Common_Messages_DebugUtil_P_" data-uid="Hi.Common.Messages.DebugUtil.P*"></a>
|
||||
|
||||
<h3 id="Hi_Common_DebugUtil_P_System_Int32_" data-uid="Hi.Common.DebugUtil.P(System.Int32)">
|
||||
<h3 id="Hi_Common_Messages_DebugUtil_P_System_Int32_" data-uid="Hi.Common.Messages.DebugUtil.P(System.Int32)">
|
||||
P(int)
|
||||
|
||||
</h3>
|
||||
@@ -514,9 +514,9 @@ The Count helps to trigger pause by <a class="xref" href="Hi.Common.DebugUtil.ht
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_DebugUtil_S_" data-uid="Hi.Common.DebugUtil.S*"></a>
|
||||
<a id="Hi_Common_Messages_DebugUtil_S_" data-uid="Hi.Common.Messages.DebugUtil.S*"></a>
|
||||
|
||||
<h3 id="Hi_Common_DebugUtil_S_System_String_" data-uid="Hi.Common.DebugUtil.S(System.String)">
|
||||
<h3 id="Hi_Common_Messages_DebugUtil_S_System_String_" data-uid="Hi.Common.Messages.DebugUtil.S(System.String)">
|
||||
S(string)
|
||||
|
||||
</h3>
|
||||
@@ -553,14 +553,14 @@ The Count helps to trigger pause by <a class="xref" href="Hi.Common.DebugUtil.ht
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_DebugUtil_SP_" data-uid="Hi.Common.DebugUtil.SP*"></a>
|
||||
<a id="Hi_Common_Messages_DebugUtil_SP_" data-uid="Hi.Common.Messages.DebugUtil.SP*"></a>
|
||||
|
||||
<h3 id="Hi_Common_DebugUtil_SP_System_Int32_System_String_" data-uid="Hi.Common.DebugUtil.SP(System.Int32,System.String)">
|
||||
<h3 id="Hi_Common_Messages_DebugUtil_SP_System_Int32_System_String_" data-uid="Hi.Common.Messages.DebugUtil.SP(System.Int32,System.String)">
|
||||
SP(int, string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Call <a class="xref" href="Hi.Common.DebugUtil.html#Hi_Common_DebugUtil_S_System_String_">S(string)</a> and then call <a class="xref" href="Hi.Common.DebugUtil.html#Hi_Common_DebugUtil_P_System_Int32_">P(int)</a>.</p>
|
||||
<div class="markdown level1 summary"><p>Call <a class="xref" href="Hi.Common.Messages.DebugUtil.html#Hi_Common_Messages_DebugUtil_S_System_String_">S(string)</a> and then call <a class="xref" href="Hi.Common.Messages.DebugUtil.html#Hi_Common_Messages_DebugUtil_P_System_Int32_">P(int)</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -594,14 +594,14 @@ The Count helps to trigger pause by <a class="xref" href="Hi.Common.DebugUtil.ht
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_DebugUtil_WriteLine_" data-uid="Hi.Common.DebugUtil.WriteLine*"></a>
|
||||
<a id="Hi_Common_Messages_DebugUtil_WriteLine_" data-uid="Hi.Common.Messages.DebugUtil.WriteLine*"></a>
|
||||
|
||||
<h3 id="Hi_Common_DebugUtil_WriteLine_System_String_" data-uid="Hi.Common.DebugUtil.WriteLine(System.String)">
|
||||
<h3 id="Hi_Common_Messages_DebugUtil_WriteLine_System_String_" data-uid="Hi.Common.Messages.DebugUtil.WriteLine(System.String)">
|
||||
WriteLine(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Writes a line of text with the current count. This is an alias for <a class="xref" href="Hi.Common.DebugUtil.html#Hi_Common_DebugUtil_S_System_String_">S(string)</a>.</p>
|
||||
<div class="markdown level1 summary"><p>Writes a line of text with the current count. This is an alias for <a class="xref" href="Hi.Common.Messages.DebugUtil.html#Hi_Common_Messages_DebugUtil_S_System_String_">S(string)</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
+65
-265
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.Common.ExceptionUtil">
|
||||
<article data-uid="Hi.Common.Messages.ExceptionUtil">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_Common_ExceptionUtil" data-uid="Hi.Common.ExceptionUtil" class="text-break">
|
||||
<h1 id="Hi_Common_Messages_ExceptionUtil" data-uid="Hi.Common.Messages.ExceptionUtil" class="text-break">
|
||||
Class ExceptionUtil
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Common.html">Common</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Common.html">Common</a>.<a class="xref" href="Hi.Common.Messages.html">Messages</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -153,284 +153,84 @@ Class ExceptionUtil
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_Common_ExceptionUtil_CatchWithSilentPass_" data-uid="Hi.Common.ExceptionUtil.CatchWithSilentPass*"></a>
|
||||
<a id="Hi_Common_Messages_ExceptionUtil_CatchExceptions_" data-uid="Hi.Common.Messages.ExceptionUtil.CatchExceptions*"></a>
|
||||
|
||||
<h3 id="Hi_Common_ExceptionUtil_CatchWithSilentPass_System_Threading_Tasks_Task_System_Object_System_Type___" data-uid="Hi.Common.ExceptionUtil.CatchWithSilentPass(System.Threading.Tasks.Task,System.Object,System.Type[])">
|
||||
CatchWithSilentPass(Task, object, params Type[])
|
||||
<h3 id="Hi_Common_Messages_ExceptionUtil_CatchExceptions_System_Threading_Tasks_Task_System_Action_System_Exception__" data-uid="Hi.Common.Messages.ExceptionUtil.CatchExceptions(System.Threading.Tasks.Task,System.Action{System.Exception})">
|
||||
CatchExceptions(Task, Action<Exception>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Continues the task and silently passes specified exception types.</p>
|
||||
<div class="markdown level1 summary"><p>Continues the task and reports any exception via <code class="paramref">onException</code>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static Task CatchWithSilentPass(this Task task, object sender, params Type[] silentPassTypes)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public static Task CatchExceptions(this Task task, Action<Exception> onException)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>task</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
|
||||
<dd><p>The task to continue.</p>
|
||||
</dd>
|
||||
<dt><code>sender</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd><p>The sender object.</p>
|
||||
</dd>
|
||||
<dt><code>silentPassTypes</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.type">Type</a>[]</dt>
|
||||
<dd><p>The exception types to silently pass.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
|
||||
<dd><p>A task that represents the continuation.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_ExceptionUtil_Default_OnShown_" data-uid="Hi.Common.ExceptionUtil.Default_OnShown*"></a>
|
||||
|
||||
<h3 id="Hi_Common_ExceptionUtil_Default_OnShown_System_Object_System_Exception_" data-uid="Hi.Common.ExceptionUtil.Default_OnShown(System.Object,System.Exception)">
|
||||
Default_OnShown(object, Exception)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Default handler invoked when an exception is shown.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static void Default_OnShown(object sender, Exception e)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>sender</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd><p>The source that raised the exception.</p>
|
||||
</dd>
|
||||
<dt><code>e</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a></dt>
|
||||
<dd><p>The exception instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_ExceptionUtil_ShowException_" data-uid="Hi.Common.ExceptionUtil.ShowException*"></a>
|
||||
|
||||
<h3 id="Hi_Common_ExceptionUtil_ShowException_System_Exception_System_Object_" data-uid="Hi.Common.ExceptionUtil.ShowException(System.Exception,System.Object)">
|
||||
ShowException(Exception, object)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Shows the exception by invoking the OnShown event.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static void ShowException(this Exception exception, object sender)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>exception</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a></dt>
|
||||
<dd><p>The exception to show.</p>
|
||||
</dd>
|
||||
<dt><code>sender</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd><p>The sender object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_ExceptionUtil_ShowIfCatched_" data-uid="Hi.Common.ExceptionUtil.ShowIfCatched*"></a>
|
||||
|
||||
<h3 id="Hi_Common_ExceptionUtil_ShowIfCatched_System_Threading_Tasks_Task_System_Object_" data-uid="Hi.Common.ExceptionUtil.ShowIfCatched(System.Threading.Tasks.Task,System.Object)">
|
||||
ShowIfCatched(Task, object)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Continues the task and shows any exception that occurs.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static Task ShowIfCatched(this Task task, object sender)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>task</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
|
||||
<dd><p>The task to continue.</p>
|
||||
</dd>
|
||||
<dt><code>sender</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd><p>The sender object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
|
||||
<dd><p>A task that represents the continuation.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_ExceptionUtil_ShowIfCatched_" data-uid="Hi.Common.ExceptionUtil.ShowIfCatched*"></a>
|
||||
|
||||
<h3 id="Hi_Common_ExceptionUtil_ShowIfCatched__1_System_Action_System_Object_" data-uid="Hi.Common.ExceptionUtil.ShowIfCatched``1(System.Action,System.Object)">
|
||||
ShowIfCatched<T>(Action, object)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Executes the specified action and shows any exception that occurs.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static void ShowIfCatched<T>(this Action action, object sender = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>action</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action">Action</a></dt>
|
||||
<dd><p>The action to execute.</p>
|
||||
</dd>
|
||||
<dt><code>sender</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd><p>The sender object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>The type of the action.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_ExceptionUtil_ShowIfCatched_" data-uid="Hi.Common.ExceptionUtil.ShowIfCatched*"></a>
|
||||
|
||||
<h3 id="Hi_Common_ExceptionUtil_ShowIfCatched__1_System_Func___0__System_Object_" data-uid="Hi.Common.ExceptionUtil.ShowIfCatched``1(System.Func{``0},System.Object)">
|
||||
ShowIfCatched<T>(Func<T>, object)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Executes the specified function and shows any exception that occurs.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static T ShowIfCatched<T>(this Func<T> func, object sender = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>func</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><T></dt>
|
||||
<dd><p>The function to execute.</p>
|
||||
</dd>
|
||||
<dt><code>sender</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd><p>The sender object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">T</span></dt>
|
||||
<dd><p>The result of the function, or default(T) if an exception occurs.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>The return type of the function.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="events">Events
|
||||
</h2>
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_Common_ExceptionUtil_OnShown" data-uid="Hi.Common.ExceptionUtil.OnShown">
|
||||
OnShown
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>On Catched or handled.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static event EventHandler<Exception> OnShown</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.eventhandler-1">EventHandler</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>onException</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_Messages_ExceptionUtil_CatchExceptions_" data-uid="Hi.Common.Messages.ExceptionUtil.CatchExceptions*"></a>
|
||||
|
||||
<h3 id="Hi_Common_Messages_ExceptionUtil_CatchExceptions__1_System_Threading_Tasks_Task_System_Action_System_Exception__" data-uid="Hi.Common.Messages.ExceptionUtil.CatchExceptions``1(System.Threading.Tasks.Task,System.Action{System.Exception})">
|
||||
CatchExceptions<TSilent>(Task, Action<Exception>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Continues the task and reports exceptions via <code class="paramref">onException</code>,
|
||||
silently ignoring <code class="typeparamref">TSilent</code>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static Task CatchExceptions<TSilent>(this Task task, Action<Exception> onException) where TSilent : Exception</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>task</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>onException</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>TSilent</code></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,484 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class MessageUtil | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class MessageUtil | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Provides utility methods for handling messages.">
|
||||
<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.Common.Messages.MessageUtil">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_Common_Messages_MessageUtil" data-uid="Hi.Common.Messages.MessageUtil" class="text-break">
|
||||
Class MessageUtil
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Common.html">Common</a>.<a class="xref" href="Hi.Common.Messages.html">Messages</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Provides utility methods for handling messages.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static class MessageUtil</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">MessageUtil</span></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_Common_Messages_MessageUtil_Default_" data-uid="Hi.Common.Messages.MessageUtil.Default*"></a>
|
||||
|
||||
<h3 id="Hi_Common_Messages_MessageUtil_Default" data-uid="Hi.Common.Messages.MessageUtil.Default">
|
||||
Default
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the default MessageKit instance.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static Progress<object> Default { 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.progress-1">Progress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_Common_Messages_MessageUtil_Default_ProgressChanged_" data-uid="Hi.Common.Messages.MessageUtil.Default_ProgressChanged*"></a>
|
||||
|
||||
<h3 id="Hi_Common_Messages_MessageUtil_Default_ProgressChanged_System_Object_System_Object_" data-uid="Hi.Common.Messages.MessageUtil.Default_ProgressChanged(System.Object,System.Object)">
|
||||
Default_ProgressChanged(object, object)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Default handler for progress changes that writes the argument to the console.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static void Default_ProgressChanged(object sender, object arg)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>sender</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd><p>The event sender.</p>
|
||||
</dd>
|
||||
<dt><code>arg</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd><p>The progress argument to display.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_Messages_MessageUtil_ReportError_" data-uid="Hi.Common.Messages.MessageUtil.ReportError*"></a>
|
||||
|
||||
<h3 id="Hi_Common_Messages_MessageUtil_ReportError_System_String_" data-uid="Hi.Common.Messages.MessageUtil.ReportError(System.String)">
|
||||
ReportError(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Adds an error message to the default message kit.
|
||||
Apply <a class="xref" href="Hi.Common.ExceptionUtil.html">ExceptionUtil</a>.<a class="xref" href="Hi.Common.ExceptionUtil.html#Hi_Common_ExceptionUtil_ShowException_System_Exception_System_Object_">ShowException(Exception, object)</a> if the error message comes from exception for better treatment.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static void ReportError(string message)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>message</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The message to write.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_Messages_MessageUtil_ReportException_" data-uid="Hi.Common.Messages.MessageUtil.ReportException*"></a>
|
||||
|
||||
<h3 id="Hi_Common_Messages_MessageUtil_ReportException_System_Exception_" data-uid="Hi.Common.Messages.MessageUtil.ReportException(System.Exception)">
|
||||
ReportException(Exception)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Adds an exception to the default message kit.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static void ReportException(Exception exception)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>exception</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a></dt>
|
||||
<dd><p>The exception to add.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_Messages_MessageUtil_ReportInfo_" data-uid="Hi.Common.Messages.MessageUtil.ReportInfo*"></a>
|
||||
|
||||
<h3 id="Hi_Common_Messages_MessageUtil_ReportInfo_System_String_" data-uid="Hi.Common.Messages.MessageUtil.ReportInfo(System.String)">
|
||||
ReportInfo(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Adds an info message to the default message kit.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static void ReportInfo(string message)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>message</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The message to write.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_Messages_MessageUtil_ReportMessage_" data-uid="Hi.Common.Messages.MessageUtil.ReportMessage*"></a>
|
||||
|
||||
<h3 id="Hi_Common_Messages_MessageUtil_ReportMessage_System_String_" data-uid="Hi.Common.Messages.MessageUtil.ReportMessage(System.String)">
|
||||
ReportMessage(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Adds a plain message to the default message kit.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static void ReportMessage(string message)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>message</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The message to write.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_Messages_MessageUtil_ReportProgress_" data-uid="Hi.Common.Messages.MessageUtil.ReportProgress*"></a>
|
||||
|
||||
<h3 id="Hi_Common_Messages_MessageUtil_ReportProgress_System_String_" data-uid="Hi.Common.Messages.MessageUtil.ReportProgress(System.String)">
|
||||
ReportProgress(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Adds a progress message to the default message kit.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static void ReportProgress(string message)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>message</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The message to write.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_Messages_MessageUtil_ReportSuccess_" data-uid="Hi.Common.Messages.MessageUtil.ReportSuccess*"></a>
|
||||
|
||||
<h3 id="Hi_Common_Messages_MessageUtil_ReportSuccess_System_String_" data-uid="Hi.Common.Messages.MessageUtil.ReportSuccess(System.String)">
|
||||
ReportSuccess(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Adds a success message to the default message kit.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static void ReportSuccess(string message)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>message</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The message to write.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_Messages_MessageUtil_ReportWarning_" data-uid="Hi.Common.Messages.MessageUtil.ReportWarning*"></a>
|
||||
|
||||
<h3 id="Hi_Common_Messages_MessageUtil_ReportWarning_System_String_" data-uid="Hi.Common.Messages.MessageUtil.ReportWarning(System.String)">
|
||||
ReportWarning(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Adds a warning message to the default message kit.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static void ReportWarning(string message)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>message</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The message to write.</p>
|
||||
</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>
|
||||
@@ -95,13 +95,26 @@
|
||||
Classes
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.Messages.MessageBoardUtil.html">MessageBoardUtil</a></dt>
|
||||
<dd><p>Utility class for displaying messages on a message board.</p>
|
||||
<dt><a class="xref" href="Hi.Common.Messages.ActionProgress-1.html">ActionProgress<T></a></dt>
|
||||
<dd><p>Lightweight <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress<T></a> that delegates to an <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action<T></a>.
|
||||
Unlike <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.progress-1">Progress<T></a>, does not capture
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.synchronizationcontext">SynchronizationContext</a>
|
||||
and invokes the handler synchronously on the caller's thread.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.Messages.MessageUtil.html">MessageUtil</a></dt>
|
||||
<dd><p>Provides utility methods for handling messages.</p>
|
||||
<dt><a class="xref" href="Hi.Common.Messages.DebugUtil.html">DebugUtil</a></dt>
|
||||
<dd><p>Debug utility provides functions: pause process, count execution time and show the count.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.Messages.ExceptionUtil.html">ExceptionUtil</a></dt>
|
||||
<dd><p>Provides utility methods for handling exceptions.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.Messages.MessageBoardUtil.html">MessageBoardUtil</a></dt>
|
||||
<dd><p>Utility class for displaying messages on a message board.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
|
||||
@@ -180,6 +180,41 @@ Class PacePlayer
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_Common_PacePlayer__ctor_" data-uid="Hi.Common.PacePlayer.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Common_PacePlayer__ctor_Microsoft_Extensions_Logging_ILogger_" data-uid="Hi.Common.PacePlayer.#ctor(Microsoft.Extensions.Logging.ILogger)">
|
||||
PacePlayer(ILogger)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public PacePlayer(ILogger logger)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>logger</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.ilogger">ILogger</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
@@ -315,6 +350,38 @@ The property is true if a task started and the task has not yet finished and <a
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_PacePlayer_Logger_" data-uid="Hi.Common.PacePlayer.Logger*"></a>
|
||||
|
||||
<h3 id="Hi_Common_PacePlayer_Logger" data-uid="Hi.Common.PacePlayer.Logger">
|
||||
Logger
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Logger for reporting exceptions during task execution.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ILogger Logger { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.ilogger">ILogger</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_PacePlayer_MainAction_" data-uid="Hi.Common.PacePlayer.MainAction*"></a>
|
||||
|
||||
<h3 id="Hi_Common_PacePlayer_MainAction" data-uid="Hi.Common.PacePlayer.MainAction">
|
||||
|
||||
@@ -193,8 +193,8 @@ Manages reading data in parallel with forward and backward caching to optimize p
|
||||
|
||||
<a id="Hi_Common_ParallelBulkUtils_ParallelBulkReader_1__ctor_" data-uid="Hi.Common.ParallelBulkUtils.ParallelBulkReader`1.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Common_ParallelBulkUtils_ParallelBulkReader_1__ctor_System_Int32_System_Int32_System_Int32_Hi_Common_ParallelBulkUtils_ReadBulkDelegate__0__System_Func__0_System_Nullable_System_Int32___System_Func_System_Int32__" data-uid="Hi.Common.ParallelBulkUtils.ParallelBulkReader`1.#ctor(System.Int32,System.Int32,System.Int32,Hi.Common.ParallelBulkUtils.ReadBulkDelegate{`0},System.Func{`0,System.Nullable{System.Int32}},System.Func{System.Int32})">
|
||||
ParallelBulkReader(int, int, int, ReadBulkDelegate<TData>, Func<TData, int?>, Func<int>)
|
||||
<h3 id="Hi_Common_ParallelBulkUtils_ParallelBulkReader_1__ctor_System_Int32_System_Int32_System_Int32_Hi_Common_ParallelBulkUtils_ReadBulkDelegate__0__System_Func__0_System_Nullable_System_Int32___System_Func_System_Int32__System_Action_System_Exception__" data-uid="Hi.Common.ParallelBulkUtils.ParallelBulkReader`1.#ctor(System.Int32,System.Int32,System.Int32,Hi.Common.ParallelBulkUtils.ReadBulkDelegate{`0},System.Func{`0,System.Nullable{System.Int32}},System.Func{System.Int32},System.Action{System.Exception})">
|
||||
ParallelBulkReader(int, int, int, ReadBulkDelegate<TData>, Func<TData, int?>, Func<int>, Action<Exception>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -203,7 +203,7 @@ Manages reading data in parallel with forward and backward caching to optimize p
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ParallelBulkReader(int cacheBackwardDistance, int cacheForwardDistance, int cacheQueueLimit, ReadBulkDelegate<TData> readBulkFunc, Func<TData, int?> getIndexFunc, Func<int> countFunc)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public ParallelBulkReader(int cacheBackwardDistance, int cacheForwardDistance, int cacheQueueLimit, ReadBulkDelegate<TData> readBulkFunc, Func<TData, int?> getIndexFunc, Func<int> countFunc, Action<Exception> exceptionAction = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -225,6 +225,9 @@ Manages reading data in parallel with forward and backward caching to optimize p
|
||||
</dd>
|
||||
<dt><code>countFunc</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>></dt>
|
||||
<dd><p>The function that returns the total count of available data items.</p>
|
||||
</dd>
|
||||
<dt><code>exceptionAction</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a>></dt>
|
||||
<dd><p>Optional action invoked when an exception occurs in cache operations.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -0,0 +1,317 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class ProjectApiVersion | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class ProjectApiVersion | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Carries the API version read from a project file's XML attribute through the deserialization pipeline via the object[] res parameter. Consumers retrieve it with res?.OfType&lt;ProjectApiVersion&gt;().FirstOrDefault().">
|
||||
<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.Common.XmlUtils.ProjectApiVersion">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_Common_XmlUtils_ProjectApiVersion" data-uid="Hi.Common.XmlUtils.ProjectApiVersion" class="text-break">
|
||||
Class ProjectApiVersion
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Common.html">Common</a>.<a class="xref" href="Hi.Common.XmlUtils.html">XmlUtils</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Carries the API version read from a project file's XML attribute
|
||||
through the <a class="xref" href="Hi.Common.XmlUtils.XFactory.html">XFactory</a> deserialization pipeline via the
|
||||
<code>object[] res</code> parameter.
|
||||
Consumers retrieve it with <code>res?.OfType<ProjectApiVersion>().FirstOrDefault()</code>.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ProjectApiVersion</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">ProjectApiVersion</span></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_Common_XmlUtils_ProjectApiVersion__ctor_" data-uid="Hi.Common.XmlUtils.ProjectApiVersion.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Common_XmlUtils_ProjectApiVersion__ctor_System_Version_" data-uid="Hi.Common.XmlUtils.ProjectApiVersion.#ctor(System.Version)">
|
||||
ProjectApiVersion(Version)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ProjectApiVersion(Version version)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>version</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.version">Version</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_Common_XmlUtils_ProjectApiVersion_Version_" data-uid="Hi.Common.XmlUtils.ProjectApiVersion.Version*"></a>
|
||||
|
||||
<h3 id="Hi_Common_XmlUtils_ProjectApiVersion_Version" data-uid="Hi.Common.XmlUtils.ProjectApiVersion.Version">
|
||||
Version
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Version Version { 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.version">Version</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_Common_XmlUtils_ProjectApiVersion_IsOlderThan_" data-uid="Hi.Common.XmlUtils.ProjectApiVersion.IsOlderThan*"></a>
|
||||
|
||||
<h3 id="Hi_Common_XmlUtils_ProjectApiVersion_IsOlderThan_System_Version_" data-uid="Hi.Common.XmlUtils.ProjectApiVersion.IsOlderThan(System.Version)">
|
||||
IsOlderThan(Version)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Returns true if the source file was saved by an API version
|
||||
older than <code class="paramref">version</code>.
|
||||
Returns false when the source version is unknown (null).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool IsOlderThan(Version version)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>version</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.version">Version</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</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>
|
||||
+4
-1
@@ -102,7 +102,7 @@ Delegate XFactory.GenByXElementDelegate
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public delegate object XFactory.GenByXElementDelegate(XElement src, string baseDirectory, string relFile, object[] res)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public delegate object XFactory.GenByXElementDelegate(XElement src, string baseDirectory, string relFile, IProgress<object> progress, object[] res)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -115,6 +115,9 @@ Delegate XFactory.GenByXElementDelegate
|
||||
</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</p>
|
||||
</dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd><p>Progress reporter for the XML parsing chain</p>
|
||||
</dd>
|
||||
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional parameters for generation</p>
|
||||
|
||||
@@ -194,48 +194,44 @@ Class XFactory
|
||||
|
||||
<a id="Hi_Common_XmlUtils_XFactory_GenByChild_" data-uid="Hi.Common.XmlUtils.XFactory.GenByChild*"></a>
|
||||
|
||||
<h3 id="Hi_Common_XmlUtils_XFactory_GenByChild__1_System_Xml_Linq_XElement_System_String_Hi_Common_XmlUtils_GenMode_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.GenByChild``1(System.Xml.Linq.XElement,System.String,Hi.Common.XmlUtils.GenMode,System.Object[])">
|
||||
GenByChild<T>(XElement, string, GenMode, params object[])
|
||||
<h3 id="Hi_Common_XmlUtils_XFactory_GenByChild__1_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__System_Boolean_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.GenByChild``1(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object},System.Boolean,System.Object[])">
|
||||
GenByChild<T>(XElement, string, IProgress<object>, bool, object[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Generates an object of type T from a child element of the provided XML element.
|
||||
<div class="markdown level1 summary"><p>Generates an object of type T from the first child element of the provided XML element.
|
||||
This overload discards the relative file path output.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static T GenByChild<T>(XElement src, string baseDirectory, GenMode genMode, params object[] res) where T : class</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public static T GenByChild<T>(XElement src, string baseDirectory, IProgress<object> progress, bool enableRebase = true, object[] res = null) where T : class</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>The parent XML element containing the child to process</p>
|
||||
</dd>
|
||||
<dd></dd>
|
||||
<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 paths</p>
|
||||
</dd>
|
||||
<dt><code>genMode</code> <a class="xref" href="Hi.Common.XmlUtils.GenMode.html">GenMode</a></dt>
|
||||
<dd><p>The generation mode to use</p>
|
||||
</dd>
|
||||
<dd></dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>enableRebase</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional parameters for generation</p>
|
||||
</dd>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">T</span></dt>
|
||||
<dd><p>The generated object of type T, or null if generation fails</p>
|
||||
</dd>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>The type of object to generate</p>
|
||||
</dd>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -249,17 +245,17 @@ This overload discards the relative file path output.</p>
|
||||
|
||||
<a id="Hi_Common_XmlUtils_XFactory_GenByChild_" data-uid="Hi.Common.XmlUtils.XFactory.GenByChild*"></a>
|
||||
|
||||
<h3 id="Hi_Common_XmlUtils_XFactory_GenByChild__1_System_Xml_Linq_XElement_System_String_System_String__Hi_Common_XmlUtils_GenMode_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.GenByChild``1(System.Xml.Linq.XElement,System.String,System.String@,Hi.Common.XmlUtils.GenMode,System.Object[])">
|
||||
GenByChild<T>(XElement, string, out string, GenMode, params object[])
|
||||
<h3 id="Hi_Common_XmlUtils_XFactory_GenByChild__1_System_Xml_Linq_XElement_System_String_System_String__System_IProgress_System_Object__System_Boolean_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.GenByChild``1(System.Xml.Linq.XElement,System.String,System.String@,System.IProgress{System.Object},System.Boolean,System.Object[])">
|
||||
GenByChild<T>(XElement, string, out string, IProgress<object>, bool, object[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Generates an object of type T from a child element of the provided XML element.</p>
|
||||
<div class="markdown level1 summary"><p>Generates an object of type T from the first child element of the provided XML element.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static T GenByChild<T>(XElement src, string baseDirectory, out string relFile, GenMode genMode, params object[] res) where T : class</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public static T GenByChild<T>(XElement src, string baseDirectory, out string relFile, IProgress<object> progress, bool enableRebase = true, object[] res = null) where T : class</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -273,8 +269,11 @@ This overload discards the relative file path output.</p>
|
||||
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>Output parameter that receives the relative file path if src is a file reference, or null otherwise</p>
|
||||
</dd>
|
||||
<dt><code>genMode</code> <a class="xref" href="Hi.Common.XmlUtils.GenMode.html">GenMode</a></dt>
|
||||
<dd><p>The generation mode to use</p>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd><p>Progress reporter for the XML parsing chain</p>
|
||||
</dd>
|
||||
<dt><code>enableRebase</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p>Whether to rebase the directory to the file's location</p>
|
||||
</dd>
|
||||
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional parameters for generation</p>
|
||||
@@ -284,7 +283,7 @@ This overload discards the relative file path output.</p>
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">T</span></dt>
|
||||
<dd><p>The generated object of type T, or null if generation fails</p>
|
||||
<dd><p>The generated object of type T, or null if src is null</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -306,8 +305,8 @@ This overload discards the relative file path output.</p>
|
||||
|
||||
<a id="Hi_Common_XmlUtils_XFactory_GenByFile_" data-uid="Hi.Common.XmlUtils.XFactory.GenByFile*"></a>
|
||||
|
||||
<h3 id="Hi_Common_XmlUtils_XFactory_GenByFile__1_System_String_System_String_Hi_Common_XmlUtils_GenMode_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.GenByFile``1(System.String,System.String,Hi.Common.XmlUtils.GenMode,System.Object[])">
|
||||
GenByFile<T>(string, string, GenMode, params object[])
|
||||
<h3 id="Hi_Common_XmlUtils_XFactory_GenByFile__1_System_String_System_String_System_IProgress_System_Object__System_Boolean_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.GenByFile``1(System.String,System.String,System.IProgress{System.Object},System.Boolean,System.Object[])">
|
||||
GenByFile<T>(string, string, IProgress<object>, bool, object[])
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -316,7 +315,7 @@ This overload discards the relative file path output.</p>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static T GenByFile<T>(string baseDirectory, string relFile, GenMode genMode, params object[] res) where T : class</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public static T GenByFile<T>(string baseDirectory, string relFile, IProgress<object> progress, bool enableRebase = true, object[] res = null) where T : class</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -327,8 +326,11 @@ This overload discards the relative file path output.</p>
|
||||
<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 to the XML file</p>
|
||||
</dd>
|
||||
<dt><code>genMode</code> <a class="xref" href="Hi.Common.XmlUtils.GenMode.html">GenMode</a></dt>
|
||||
<dd><p>The generation mode to use</p>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd><p>Progress reporter for the XML parsing chain</p>
|
||||
</dd>
|
||||
<dt><code>enableRebase</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p>Whether to rebase the directory to the file's location</p>
|
||||
</dd>
|
||||
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional parameters for generation</p>
|
||||
@@ -338,7 +340,7 @@ This overload discards the relative file path output.</p>
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">T</span></dt>
|
||||
<dd><p>The generated object of type T, or null if generation fails</p>
|
||||
<dd><p>The generated object of type T, or null if relFile is null</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -360,47 +362,43 @@ This overload discards the relative file path output.</p>
|
||||
|
||||
<a id="Hi_Common_XmlUtils_XFactory_GenFileRefSourceByChild_" data-uid="Hi.Common.XmlUtils.XFactory.GenFileRefSourceByChild*"></a>
|
||||
|
||||
<h3 id="Hi_Common_XmlUtils_XFactory_GenFileRefSourceByChild__1_System_Xml_Linq_XElement_System_String_Hi_Common_XmlUtils_GenMode_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.GenFileRefSourceByChild``1(System.Xml.Linq.XElement,System.String,Hi.Common.XmlUtils.GenMode,System.Object[])">
|
||||
GenFileRefSourceByChild<T>(XElement, string, GenMode, params object[])
|
||||
<h3 id="Hi_Common_XmlUtils_XFactory_GenFileRefSourceByChild__1_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__System_Boolean_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.GenFileRefSourceByChild``1(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object},System.Boolean,System.Object[])">
|
||||
GenFileRefSourceByChild<T>(XElement, string, IProgress<object>, bool, object[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Generates an XML source and file object of type T from the first child element of the provided XML element.</p>
|
||||
<div class="markdown level1 summary"><p>Generates a <a class="xref" href="Hi.Common.XmlUtils.FileRefSource-1.html">FileRefSource<T></a> from the first child element of the provided XML element.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static FileRefSource<T> GenFileRefSourceByChild<T>(XElement src, string baseDirectory, GenMode genMode, params object[] res) where T : class, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public static FileRefSource<T> GenFileRefSourceByChild<T>(XElement src, string baseDirectory, IProgress<object> progress, bool enableRebase = true, object[] res = null) where T : class, IMakeXmlSource</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>The parent XML element containing the child to process</p>
|
||||
</dd>
|
||||
<dd></dd>
|
||||
<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 paths</p>
|
||||
</dd>
|
||||
<dt><code>genMode</code> <a class="xref" href="Hi.Common.XmlUtils.GenMode.html">GenMode</a></dt>
|
||||
<dd><p>The generation mode to use</p>
|
||||
</dd>
|
||||
<dd></dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>enableRebase</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional parameters for generation</p>
|
||||
</dd>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.Common.XmlUtils.FileRefSource-1.html">FileRefSource</a><T></dt>
|
||||
<dd><p>An XmlSourceAndFile object containing the generated object and its file path</p>
|
||||
</dd>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>The type of object to generate, must implement IMakeXmlSource</p>
|
||||
</dd>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -414,47 +412,43 @@ This overload discards the relative file path output.</p>
|
||||
|
||||
<a id="Hi_Common_XmlUtils_XFactory_GenFileRefSourceByFile_" data-uid="Hi.Common.XmlUtils.XFactory.GenFileRefSourceByFile*"></a>
|
||||
|
||||
<h3 id="Hi_Common_XmlUtils_XFactory_GenFileRefSourceByFile__1_System_String_System_String_Hi_Common_XmlUtils_GenMode_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.GenFileRefSourceByFile``1(System.String,System.String,Hi.Common.XmlUtils.GenMode,System.Object[])">
|
||||
GenFileRefSourceByFile<T>(string, string, GenMode, params object[])
|
||||
<h3 id="Hi_Common_XmlUtils_XFactory_GenFileRefSourceByFile__1_System_String_System_String_System_IProgress_System_Object__System_Boolean_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.GenFileRefSourceByFile``1(System.String,System.String,System.IProgress{System.Object},System.Boolean,System.Object[])">
|
||||
GenFileRefSourceByFile<T>(string, string, IProgress<object>, bool, object[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Generates an XML source and file object of type T from an XML file.</p>
|
||||
<div class="markdown level1 summary"><p>Generates a <a class="xref" href="Hi.Common.XmlUtils.FileRefSource-1.html">FileRefSource<T></a> from an XML file.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static FileRefSource<T> GenFileRefSourceByFile<T>(string baseDirectory, string relFile, GenMode genMode, params object[] res) where T : class, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public static FileRefSource<T> GenFileRefSourceByFile<T>(string baseDirectory, string relFile, IProgress<object> progress, bool enableRebase = true, object[] res = null) where T : class, IMakeXmlSource</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 paths</p>
|
||||
</dd>
|
||||
<dd></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 to the XML file</p>
|
||||
</dd>
|
||||
<dt><code>genMode</code> <a class="xref" href="Hi.Common.XmlUtils.GenMode.html">GenMode</a></dt>
|
||||
<dd><p>The generation mode to use</p>
|
||||
</dd>
|
||||
<dd></dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>enableRebase</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional parameters for generation</p>
|
||||
</dd>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.Common.XmlUtils.FileRefSource-1.html">FileRefSource</a><T></dt>
|
||||
<dd><p>An XmlSourceAndFile object containing the generated object and its file path</p>
|
||||
</dd>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>The type of object to generate, must implement IMakeXmlSource</p>
|
||||
</dd>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -468,47 +462,43 @@ This overload discards the relative file path output.</p>
|
||||
|
||||
<a id="Hi_Common_XmlUtils_XFactory_GenFileRefSource_" data-uid="Hi.Common.XmlUtils.XFactory.GenFileRefSource*"></a>
|
||||
|
||||
<h3 id="Hi_Common_XmlUtils_XFactory_GenFileRefSource__1_System_Xml_Linq_XElement_System_String_Hi_Common_XmlUtils_GenMode_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.GenFileRefSource``1(System.Xml.Linq.XElement,System.String,Hi.Common.XmlUtils.GenMode,System.Object[])">
|
||||
GenFileRefSource<T>(XElement, string, GenMode, params object[])
|
||||
<h3 id="Hi_Common_XmlUtils_XFactory_GenFileRefSource__1_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__System_Boolean_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.GenFileRefSource``1(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object},System.Boolean,System.Object[])">
|
||||
GenFileRefSource<T>(XElement, string, IProgress<object>, bool, object[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Generates an XML source and file object of type T from an XML element.</p>
|
||||
<div class="markdown level1 summary"><p>Generates a <a class="xref" href="Hi.Common.XmlUtils.FileRefSource-1.html">FileRefSource<T></a> from an XML element.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static FileRefSource<T> GenFileRefSource<T>(XElement src, string baseDirectory, GenMode genMode, params object[] res) where T : class, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public static FileRefSource<T> GenFileRefSource<T>(XElement src, string baseDirectory, IProgress<object> progress, bool enableRebase = true, object[] res = null) where T : class, IMakeXmlSource</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>The source XML element</p>
|
||||
</dd>
|
||||
<dd></dd>
|
||||
<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 paths</p>
|
||||
</dd>
|
||||
<dt><code>genMode</code> <a class="xref" href="Hi.Common.XmlUtils.GenMode.html">GenMode</a></dt>
|
||||
<dd><p>The generation mode to use</p>
|
||||
</dd>
|
||||
<dd></dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>enableRebase</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional parameters for generation</p>
|
||||
</dd>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.Common.XmlUtils.FileRefSource-1.html">FileRefSource</a><T></dt>
|
||||
<dd><p>An XmlSourceAndFile object containing the generated object and its file path</p>
|
||||
</dd>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>The type of object to generate, must implement IMakeXmlSource</p>
|
||||
</dd>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -522,18 +512,18 @@ This overload discards the relative file path output.</p>
|
||||
|
||||
<a id="Hi_Common_XmlUtils_XFactory_Gen_" data-uid="Hi.Common.XmlUtils.XFactory.Gen*"></a>
|
||||
|
||||
<h3 id="Hi_Common_XmlUtils_XFactory_Gen__1_System_Xml_Linq_XElement_System_String_Hi_Common_XmlUtils_GenMode_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.Gen``1(System.Xml.Linq.XElement,System.String,Hi.Common.XmlUtils.GenMode,System.Object[])">
|
||||
Gen<T>(XElement, string, GenMode, params object[])
|
||||
<h3 id="Hi_Common_XmlUtils_XFactory_Gen__1_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__System_Boolean_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.Gen``1(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object},System.Boolean,System.Object[])">
|
||||
Gen<T>(XElement, string, IProgress<object>, bool, object[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Generates an object of type T from an XML element with specified generation mode.
|
||||
<div class="markdown level1 summary"><p>Generates an object of type T from an XML element.
|
||||
This overload discards the relative file path output.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static T Gen<T>(XElement src, string baseDirectory, GenMode mode, params object[] res) where T : class</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public static T Gen<T>(XElement src, string baseDirectory, IProgress<object> progress, bool enableRebase = true, object[] res = null) where T : class</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -544,8 +534,11 @@ This overload discards the relative file path output.</p>
|
||||
<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 paths</p>
|
||||
</dd>
|
||||
<dt><code>mode</code> <a class="xref" href="Hi.Common.XmlUtils.GenMode.html">GenMode</a></dt>
|
||||
<dd><p>The generation mode to use</p>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd><p>Progress reporter for the XML parsing chain</p>
|
||||
</dd>
|
||||
<dt><code>enableRebase</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p>Whether to rebase the directory to the file's location</p>
|
||||
</dd>
|
||||
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional parameters for generation</p>
|
||||
@@ -555,7 +548,7 @@ This overload discards the relative file path output.</p>
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">T</span></dt>
|
||||
<dd><p>The generated object of type T, or null if generation fails</p>
|
||||
<dd><p>The generated object of type T</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -577,17 +570,17 @@ This overload discards the relative file path output.</p>
|
||||
|
||||
<a id="Hi_Common_XmlUtils_XFactory_Gen_" data-uid="Hi.Common.XmlUtils.XFactory.Gen*"></a>
|
||||
|
||||
<h3 id="Hi_Common_XmlUtils_XFactory_Gen__1_System_Xml_Linq_XElement_System_String_System_String__Hi_Common_XmlUtils_GenMode_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.Gen``1(System.Xml.Linq.XElement,System.String,System.String@,Hi.Common.XmlUtils.GenMode,System.Object[])">
|
||||
Gen<T>(XElement, string, out string, GenMode, params object[])
|
||||
<h3 id="Hi_Common_XmlUtils_XFactory_Gen__1_System_Xml_Linq_XElement_System_String_System_String__System_IProgress_System_Object__System_Boolean_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.Gen``1(System.Xml.Linq.XElement,System.String,System.String@,System.IProgress{System.Object},System.Boolean,System.Object[])">
|
||||
Gen<T>(XElement, string, out string, IProgress<object>, bool, object[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Generates an object of type T from an XML element with specified generation mode.</p>
|
||||
<div class="markdown level1 summary"><p>Generates an object of type T from an XML element.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static T Gen<T>(XElement src, string baseDirectory, out string relFile, GenMode mode, params object[] res) where T : class</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public static T Gen<T>(XElement src, string baseDirectory, out string relFile, IProgress<object> progress, bool enableRebase = true, object[] res = null) where T : class</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -601,8 +594,11 @@ This overload discards the relative file path output.</p>
|
||||
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>Output parameter that receives the relative file path if src is a file reference, or null otherwise</p>
|
||||
</dd>
|
||||
<dt><code>mode</code> <a class="xref" href="Hi.Common.XmlUtils.GenMode.html">GenMode</a></dt>
|
||||
<dd><p>The generation mode to use</p>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd><p>Progress reporter for the XML parsing chain</p>
|
||||
</dd>
|
||||
<dt><code>enableRebase</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p>Whether to rebase the directory to the file's location</p>
|
||||
</dd>
|
||||
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional parameters for generation</p>
|
||||
@@ -612,7 +608,7 @@ This overload discards the relative file path output.</p>
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">T</span></dt>
|
||||
<dd><p>The generated object of type T, or null if generation fails</p>
|
||||
<dd><p>The generated object of type T</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -221,8 +221,8 @@ Class XmlUtil
|
||||
|
||||
<a id="Hi_Common_XmlUtils_XmlUtil_GetDictionaryByXmlSource_" data-uid="Hi.Common.XmlUtils.XmlUtil.GetDictionaryByXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_Common_XmlUtils_XmlUtil_GetDictionaryByXmlSource__1_System_Xml_Linq_XElement_System_String_Hi_Common_XmlUtils_GenMode_" data-uid="Hi.Common.XmlUtils.XmlUtil.GetDictionaryByXmlSource``1(System.Xml.Linq.XElement,System.String,Hi.Common.XmlUtils.GenMode)">
|
||||
GetDictionaryByXmlSource<T>(XElement, string, GenMode)
|
||||
<h3 id="Hi_Common_XmlUtils_XmlUtil_GetDictionaryByXmlSource__1_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__System_Boolean_" data-uid="Hi.Common.XmlUtils.XmlUtil.GetDictionaryByXmlSource``1(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object},System.Boolean)">
|
||||
GetDictionaryByXmlSource<T>(XElement, string, IProgress<object>, bool)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -231,7 +231,7 @@ Class XmlUtil
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static Dictionary<string, T> GetDictionaryByXmlSource<T>(this XElement src, string baseDirectory, GenMode genMode) where T : class</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public static Dictionary<string, T> GetDictionaryByXmlSource<T>(this XElement src, string baseDirectory, IProgress<object> progress, bool enableRebase = true) where T : class</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -242,8 +242,11 @@ Class XmlUtil
|
||||
<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 paths</p>
|
||||
</dd>
|
||||
<dt><code>genMode</code> <a class="xref" href="Hi.Common.XmlUtils.GenMode.html">GenMode</a></dt>
|
||||
<dd><p>The generation mode to use for deserialization</p>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd><p>Optional progress reporter for the XML parsing chain</p>
|
||||
</dd>
|
||||
<dt><code>enableRebase</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p>Whether to rebase the directory to the file's location</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -97,6 +97,14 @@ Classes
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.XmlUtils.FileRefSource-1.html">FileRefSource<T></a></dt>
|
||||
<dd><p>A class that combines an XML-serializable data object with its source file path.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.XmlUtils.ProjectApiVersion.html">ProjectApiVersion</a></dt>
|
||||
<dd><p>Carries the API version read from a project file's XML attribute
|
||||
through the <a class="xref" href="Hi.Common.XmlUtils.XFactory.html">XFactory</a> deserialization pipeline via the
|
||||
<code>object[] res</code> parameter.
|
||||
Consumers retrieve it with <code>res?.OfType<ProjectApiVersion>().FirstOrDefault()</code>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
@@ -121,14 +129,6 @@ Interfaces
|
||||
<dt><a class="xref" href="Hi.Common.XmlUtils.IToXElement.html">IToXElement</a></dt>
|
||||
<dd><p>Interface of <a class="xref" href="Hi.Common.XmlUtils.IToXElement.html#Hi_Common_XmlUtils_IToXElement_ToXElement">ToXElement()</a>.
|
||||
Which can be represented by a single <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<h3 id="enums">
|
||||
Enums
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.XmlUtils.GenMode.html">GenMode</a></dt>
|
||||
<dd><p>Enumeration of generation modes for XML factory operations.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<h3 id="delegates">
|
||||
|
||||
@@ -135,11 +135,6 @@ If the execution time is over the <a class="xref" href="Hi.Common.BlockingTimer.
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.CultureUtil.html">CultureUtil</a></dt>
|
||||
<dd><p>Utility class for managing culture and localization settings.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.DebugUtil.html">DebugUtil</a></dt>
|
||||
<dd><p>Debug utility provides functions: pause process, count execution time and show the count.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
@@ -155,11 +150,6 @@ If the execution time is over the <a class="xref" href="Hi.Common.BlockingTimer.
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.EnumerablePlayer.html">EnumerablePlayer</a></dt>
|
||||
<dd><p>Run enumerable with <a class="xref" href="Hi.Common.EnumerablePlayer.html#Hi_Common_EnumerablePlayer_Pause">Pause()</a>, <a class="xref" href="Hi.Common.EnumerablePlayer.html#Hi_Common_EnumerablePlayer_Resume">Resume()</a> and etc. functions.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.ExceptionUtil.html">ExceptionUtil</a></dt>
|
||||
<dd><p>Provides utility methods for handling exceptions.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
@@ -248,11 +238,6 @@ Only the most recent action is executed and previous pending actions are discard
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.RoutineBlocker.html">RoutineBlocker</a></dt>
|
||||
<dd><p>Block the thread to the given delay from the previous block.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.RoutineBlocker0.html">RoutineBlocker0</a></dt>
|
||||
<dd><p>Block the thread to the given delay from the previous block.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
|
||||
@@ -231,6 +231,37 @@ This class manages the display and interaction of cutter location points and lin
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_CutterLocations_ClStrips_ClStrip_InternalMachiningStepSelected" data-uid="Hi.CutterLocations.ClStrips.ClStrip.InternalMachiningStepSelected">
|
||||
InternalMachiningStepSelected
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Host wiring hook invoked when a strip position selects a machining step (low-level; prefer <a class="xref" href="Hi.CutterLocations.ClStrips.ClStrip.html#Hi_CutterLocations_ClStrips_ClStrip_MachiningStepSelected">MachiningStepSelected</a> for UI).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Action<MachiningStep> InternalMachiningStepSelected</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Field Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a><<a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_CutterLocations_ClStrips_ClStrip_slice_distance" data-uid="Hi.CutterLocations.ClStrips.ClStrip.slice_distance">
|
||||
slice_distance
|
||||
|
||||
|
||||
@@ -183,8 +183,8 @@ Class DispEngine
|
||||
<div class="markdown level0 remarks"><p>The <code>DispEngine</code> is the core rendering and interaction engine for HiAPI applications.</p>
|
||||
<h2 id="related-documentation">Related Documentation</h2>
|
||||
<ul>
|
||||
<li><a href="../dev-doc/basic/rendering/rendering-canvas/index.html">Using RenderingCanvas with DispEngine</a></li>
|
||||
<li><a href="../dev-doc/basic/rendering/rendering-canvas/custom-implementation.html">Building Your Own Rendering Canvas</a></li>
|
||||
<li><a href="../fundamentals/rendering/rendering-canvas/index.html">Using RenderingCanvas with DispEngine</a></li>
|
||||
<li><a href="../fundamentals/rendering/rendering-canvas/custom-implementation.html">Building Your Own Rendering Canvas</a></li>
|
||||
</ul>
|
||||
<p>The DispEngine provides a unified API for handling rendering, user interaction, and touch gestures across different UI frameworks.</p>
|
||||
</div>
|
||||
@@ -595,8 +595,7 @@ The <a class="xref" href="Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_SetViewToHo
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Get or Set to Enable Suppress Default Logo.
|
||||
The set take no effect if the license <a class="xref" href="Hi.Licenses.AuthFeature.html#Hi_Licenses_AuthFeature_SuppressDefaultLogo">SuppressDefaultLogo</a> is not login.</p>
|
||||
<div class="markdown level1 summary"><p>Get or Set to Enable Suppress Default Logo.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -618,6 +617,12 @@ The set take no effect if the license <a class="xref" href="Hi.Licenses.AuthFeat
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Exceptions</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidoperationexception">InvalidOperationException</a></dt>
|
||||
<dd><p>Thrown when <a class="xref" href="Hi.Licenses.AuthFeature.html#Hi_Licenses_AuthFeature_SuppressDefaultLogo">SuppressDefaultLogo</a> license is not logged in.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -261,8 +261,8 @@ Class GeomCombination
|
||||
|
||||
<a id="Hi_Geom_GeomCombination__ctor_" data-uid="Hi.Geom.GeomCombination.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Geom_GeomCombination__ctor_System_Xml_Linq_XElement_System_String_System_String_" data-uid="Hi.Geom.GeomCombination.#ctor(System.Xml.Linq.XElement,System.String,System.String)">
|
||||
GeomCombination(XElement, string, string)
|
||||
<h3 id="Hi_Geom_GeomCombination__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_System_Object__" data-uid="Hi.Geom.GeomCombination.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{System.Object})">
|
||||
GeomCombination(XElement, string, string, IProgress<object>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -271,7 +271,7 @@ Class GeomCombination
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public GeomCombination(XElement src, string baseDirectory, string relFile)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public GeomCombination(XElement src, string baseDirectory, string relFile, IProgress<object> progress)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -284,6 +284,9 @@ Class GeomCombination
|
||||
</dd>
|
||||
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>Relative file path</p>
|
||||
</dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd><p>Optional progress reporter for the XML parsing chain</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -307,8 +307,8 @@ If base directory is provided, the STL will be loaded immediately.</p>
|
||||
|
||||
<a id="Hi_Geom_StlFile__ctor_" data-uid="Hi.Geom.StlFile.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Geom_StlFile__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.Geom.StlFile.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
StlFile(XElement, string)
|
||||
<h3 id="Hi_Geom_StlFile__ctor_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__" data-uid="Hi.Geom.StlFile.#ctor(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object})">
|
||||
StlFile(XElement, string, IProgress<object>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -317,7 +317,7 @@ If base directory is provided, the STL will be loaded immediately.</p>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public StlFile(XElement src, string baseDirectory)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public StlFile(XElement src, string baseDirectory, IProgress<object> progress)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -328,6 +328,8 @@ If base directory is provided, the STL will be loaded immediately.</p>
|
||||
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>Base directory path</p>
|
||||
</dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
@@ -268,8 +268,8 @@ This class combines a transformer with a target geometry to produce transformed
|
||||
|
||||
<a id="Hi_Geom_TransformationGeom__ctor_" data-uid="Hi.Geom.TransformationGeom.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Geom_TransformationGeom__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.Geom.TransformationGeom.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
TransformationGeom(XElement, string)
|
||||
<h3 id="Hi_Geom_TransformationGeom__ctor_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__" data-uid="Hi.Geom.TransformationGeom.#ctor(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object})">
|
||||
TransformationGeom(XElement, string, IProgress<object>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -278,7 +278,7 @@ This class combines a transformer with a target geometry to produce transformed
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public TransformationGeom(XElement src, string baseDirectory)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public TransformationGeom(XElement src, string baseDirectory, IProgress<object> progress)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -289,6 +289,8 @@ This class combines a transformer with a target geometry to produce transformed
|
||||
<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>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -298,7 +300,7 @@ This class combines a transformer with a target geometry to produce transformed
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_Geom_TransformationGeom__ctor_System_Xml_Linq_XElement_System_String__remarks">Remarks</h4>
|
||||
<h4 class="section" id="Hi_Geom_TransformationGeom__ctor_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object___remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>This constructor deserializes both the transformer and geometry data from the provided XML.
|
||||
If either element is missing or invalid, the corresponding property will be null.</p>
|
||||
</div>
|
||||
|
||||
@@ -187,8 +187,8 @@ Host class for HiNC functionality that provides project management, path resolut
|
||||
|
||||
<a id="Hi_HiNcKits_HiNcHost__ctor_" data-uid="Hi.HiNcKits.HiNcHost.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_HiNcKits_HiNcHost__ctor_Hi_MachiningProcs_ProxyProjectService_" data-uid="Hi.HiNcKits.HiNcHost.#ctor(Hi.MachiningProcs.ProxyProjectService)">
|
||||
HiNcHost(ProxyProjectService)
|
||||
<h3 id="Hi_HiNcKits_HiNcHost__ctor_Hi_MachiningProcs_ProxyProjectService_Microsoft_Extensions_Logging_ILogger_" data-uid="Hi.HiNcKits.HiNcHost.#ctor(Hi.MachiningProcs.ProxyProjectService,Microsoft.Extensions.Logging.ILogger)">
|
||||
HiNcHost(ProxyProjectService, ILogger)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -197,7 +197,7 @@ Host class for HiNC functionality that provides project management, path resolut
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public HiNcHost(ProxyProjectService proxyProjectService)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public HiNcHost(ProxyProjectService proxyProjectService, ILogger logger = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -205,41 +205,8 @@ Host class for HiNC functionality that provides project management, path resolut
|
||||
<dt><code>proxyProjectService</code> <a class="xref" href="Hi.MachiningProcs.ProxyProjectService.html">ProxyProjectService</a></dt>
|
||||
<dd><p>The proxy project service to use.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_HiNcKits_HiNcHost__ctor_" data-uid="Hi.HiNcKits.HiNcHost.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_HiNcKits_HiNcHost__ctor_System_String_System_String_" data-uid="Hi.HiNcKits.HiNcHost.#ctor(System.String,System.String)">
|
||||
HiNcHost(string, string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.HiNcKits.HiNcHost.html">HiNcHost</a> class.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public HiNcHost(string adminDirectory, string displayEngineFontFile)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>adminDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The admin directory path.</p>
|
||||
</dd>
|
||||
<dt><code>displayEngineFontFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The default value will be alternative if the value is null.</p>
|
||||
<dt><code>logger</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.ilogger">ILogger</a></dt>
|
||||
<dd><p>Optional logger instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -226,8 +226,8 @@ Class LocalApp
|
||||
|
||||
<a id="Hi_HiNcKits_LocalApp_AppBegin_" data-uid="Hi.HiNcKits.LocalApp.AppBegin*"></a>
|
||||
|
||||
<h3 id="Hi_HiNcKits_LocalApp_AppBegin_Hi_HiNcKits_LocalAppConfig_" data-uid="Hi.HiNcKits.LocalApp.AppBegin(Hi.HiNcKits.LocalAppConfig)">
|
||||
AppBegin(LocalAppConfig)
|
||||
<h3 id="Hi_HiNcKits_LocalApp_AppBegin_Hi_HiNcKits_LocalAppConfig_Microsoft_Extensions_Logging_ILogger_" data-uid="Hi.HiNcKits.LocalApp.AppBegin(Hi.HiNcKits.LocalAppConfig,Microsoft.Extensions.Logging.ILogger)">
|
||||
AppBegin(LocalAppConfig, ILogger)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -236,13 +236,16 @@ Class LocalApp
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static void AppBegin(LocalAppConfig localAppConfig)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public static void AppBegin(LocalAppConfig localAppConfig, ILogger logger)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>localAppConfig</code> <a class="xref" href="Hi.HiNcKits.LocalAppConfig.html">LocalAppConfig</a></dt>
|
||||
<dd><p>The local application configuration.</p>
|
||||
</dd>
|
||||
<dt><code>logger</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.ilogger">ILogger</a></dt>
|
||||
<dd><p>Logger used for startup diagnostics.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -259,8 +262,8 @@ Class LocalApp
|
||||
|
||||
<a id="Hi_HiNcKits_LocalApp_AppBegin_" data-uid="Hi.HiNcKits.LocalApp.AppBegin*"></a>
|
||||
|
||||
<h3 id="Hi_HiNcKits_LocalApp_AppBegin_System_String_" data-uid="Hi.HiNcKits.LocalApp.AppBegin(System.String)">
|
||||
AppBegin(string)
|
||||
<h3 id="Hi_HiNcKits_LocalApp_AppBegin_Microsoft_Extensions_Logging_ILogger_System_String_" data-uid="Hi.HiNcKits.LocalApp.AppBegin(Microsoft.Extensions.Logging.ILogger,System.String)">
|
||||
AppBegin(ILogger, string)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -269,11 +272,14 @@ Class LocalApp
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static void AppBegin(string cacheDbPath = null)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public static void AppBegin(ILogger logger, string cacheDbPath = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>logger</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.ilogger">ILogger</a></dt>
|
||||
<dd><p>Logger instance for startup diagnostics.</p>
|
||||
</dd>
|
||||
<dt><code>cacheDbPath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The path to the SQLite cache database. If null, uses default path.</p>
|
||||
</dd>
|
||||
@@ -292,8 +298,8 @@ Class LocalApp
|
||||
|
||||
<a id="Hi_HiNcKits_LocalApp_AppBeginWithConfigFile_" data-uid="Hi.HiNcKits.LocalApp.AppBeginWithConfigFile*"></a>
|
||||
|
||||
<h3 id="Hi_HiNcKits_LocalApp_AppBeginWithConfigFile_System_String_" data-uid="Hi.HiNcKits.LocalApp.AppBeginWithConfigFile(System.String)">
|
||||
AppBeginWithConfigFile(string)
|
||||
<h3 id="Hi_HiNcKits_LocalApp_AppBeginWithConfigFile_Microsoft_Extensions_Logging_ILogger_System_String_" data-uid="Hi.HiNcKits.LocalApp.AppBeginWithConfigFile(Microsoft.Extensions.Logging.ILogger,System.String)">
|
||||
AppBeginWithConfigFile(ILogger, string)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -302,11 +308,14 @@ Class LocalApp
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static void AppBeginWithConfigFile(string hostConfigPath = null)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public static void AppBeginWithConfigFile(ILogger logger, string hostConfigPath = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>logger</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.ilogger">ILogger</a></dt>
|
||||
<dd><p>Logger used when loading configuration and initializing caches.</p>
|
||||
</dd>
|
||||
<dt><code>hostConfigPath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>Path to the host configuration file. Uses default path if null.</p>
|
||||
</dd>
|
||||
|
||||
@@ -0,0 +1,692 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class PlayerDivConfig | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class PlayerDivConfig | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Per-user visibility flags for the Player page's divisions (charts and info panels). Mirrors the HiNcRcl PlayerDivConfig + PlayerDivFlag pair, flattened into a single all-boolean config so the webservice (which has no HiNcHost / HiNcUser) can persist the whole layout through alone.">
|
||||
<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.HiNcKits.PlayerDivConfig">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_HiNcKits_PlayerDivConfig" data-uid="Hi.HiNcKits.PlayerDivConfig" class="text-break">
|
||||
Class PlayerDivConfig
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.HiNcKits.html">HiNcKits</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Per-user visibility flags for the Player page's divisions (charts and
|
||||
info panels). Mirrors the HiNcRcl <code>PlayerDivConfig</code> + <code>PlayerDivFlag</code>
|
||||
pair, flattened into a single all-boolean config so the webservice
|
||||
(which has no <code>HiNcHost</code> / <code>HiNcUser</code>) can persist the whole
|
||||
layout through <a class="xref" href="Hi.HiNcKits.UserConfig.html">UserConfig</a> alone.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class PlayerDivConfig : 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">PlayerDivConfig</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<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_HiNcKits_PlayerDivConfig_remarks">Remarks</h2>
|
||||
<div class="markdown level0 remarks"><p>Defaults are tuned for a first-time user: the two info panels
|
||||
(<a class="xref" href="Hi.HiNcKits.PlayerDivConfig.html#Hi_HiNcKits_PlayerDivConfig_EnableStepDiv">EnableStepDiv</a> and <a class="xref" href="Hi.HiNcKits.PlayerDivConfig.html#Hi_HiNcKits_PlayerDivConfig_MessageTable">MessageTable</a>) are ON
|
||||
so the Player page looks populated without having to open the
|
||||
Division Visibility dropdown; every chart toggle starts OFF.</p>
|
||||
</div>
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_HiNcKits_PlayerDivConfig__ctor_" data-uid="Hi.HiNcKits.PlayerDivConfig.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_HiNcKits_PlayerDivConfig__ctor" data-uid="Hi.HiNcKits.PlayerDivConfig.#ctor">
|
||||
PlayerDivConfig()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Default constructor.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public PlayerDivConfig()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_HiNcKits_PlayerDivConfig__ctor_" data-uid="Hi.HiNcKits.PlayerDivConfig.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_HiNcKits_PlayerDivConfig__ctor_System_Xml_Linq_XElement_" data-uid="Hi.HiNcKits.PlayerDivConfig.#ctor(System.Xml.Linq.XElement)">
|
||||
PlayerDivConfig(XElement)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.HiNcKits.PlayerDivConfig.html">PlayerDivConfig</a> class from XML data.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public PlayerDivConfig(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>XML element containing player-div data.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_HiNcKits_PlayerDivConfig_ColorIndexTimeChart_" data-uid="Hi.HiNcKits.PlayerDivConfig.ColorIndexTimeChart*"></a>
|
||||
|
||||
<h3 id="Hi_HiNcKits_PlayerDivConfig_ColorIndexTimeChart" data-uid="Hi.HiNcKits.PlayerDivConfig.ColorIndexTimeChart">
|
||||
ColorIndexTimeChart
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Color-index strip chart (single-strip timeline coloured by arbitrary numeric/bool aspect).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool ColorIndexTimeChart { 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.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_HiNcKits_PlayerDivConfig_DynamometerForceCycleLineDiv_" data-uid="Hi.HiNcKits.PlayerDivConfig.DynamometerForceCycleLineDiv*"></a>
|
||||
|
||||
<h3 id="Hi_HiNcKits_PlayerDivConfig_DynamometerForceCycleLineDiv" data-uid="Hi.HiNcKits.PlayerDivConfig.DynamometerForceCycleLineDiv">
|
||||
DynamometerForceCycleLineDiv
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Cycle-line chart of sensor-measured force from an external dynamometer.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool DynamometerForceCycleLineDiv { 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.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_HiNcKits_PlayerDivConfig_EnableDetailDiv0_" data-uid="Hi.HiNcKits.PlayerDivConfig.EnableDetailDiv0*"></a>
|
||||
|
||||
<h3 id="Hi_HiNcKits_PlayerDivConfig_EnableDetailDiv0" data-uid="Hi.HiNcKits.PlayerDivConfig.EnableDetailDiv0">
|
||||
EnableDetailDiv0
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Developer-only raw step-property dump panel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool EnableDetailDiv0 { 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.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_HiNcKits_PlayerDivConfig_EnableStepDiv_" data-uid="Hi.HiNcKits.PlayerDivConfig.EnableStepDiv*"></a>
|
||||
|
||||
<h3 id="Hi_HiNcKits_PlayerDivConfig_EnableStepDiv" data-uid="Hi.HiNcKits.PlayerDivConfig.EnableStepDiv">
|
||||
EnableStepDiv
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Full / condensed step information panel (Selected Step Info).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool EnableStepDiv { 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.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_HiNcKits_PlayerDivConfig_EnableStripAvailabilityChart_" data-uid="Hi.HiNcKits.PlayerDivConfig.EnableStripAvailabilityChart*"></a>
|
||||
|
||||
<h3 id="Hi_HiNcKits_PlayerDivConfig_EnableStripAvailabilityChart" data-uid="Hi.HiNcKits.PlayerDivConfig.EnableStripAvailabilityChart">
|
||||
EnableStripAvailabilityChart
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Availability strip chart (per-step timeline coloured by availability aspect).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool EnableStripAvailabilityChart { 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.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_HiNcKits_PlayerDivConfig_EnableStripRoughnessChart_" data-uid="Hi.HiNcKits.PlayerDivConfig.EnableStripRoughnessChart*"></a>
|
||||
|
||||
<h3 id="Hi_HiNcKits_PlayerDivConfig_EnableStripRoughnessChart" data-uid="Hi.HiNcKits.PlayerDivConfig.EnableStripRoughnessChart">
|
||||
EnableStripRoughnessChart
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Surface-roughness strip chart (per-step timeline coloured by surface-roughness aspect).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool EnableStripRoughnessChart { 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.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_HiNcKits_PlayerDivConfig_ForceCycleLineDiv_" data-uid="Hi.HiNcKits.PlayerDivConfig.ForceCycleLineDiv*"></a>
|
||||
|
||||
<h3 id="Hi_HiNcKits_PlayerDivConfig_ForceCycleLineDiv" data-uid="Hi.HiNcKits.PlayerDivConfig.ForceCycleLineDiv">
|
||||
ForceCycleLineDiv
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Cycle-line chart of cutting force along the step's rotation cycle.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool ForceCycleLineDiv { 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.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_HiNcKits_PlayerDivConfig_MessageTable_" data-uid="Hi.HiNcKits.PlayerDivConfig.MessageTable*"></a>
|
||||
|
||||
<h3 id="Hi_HiNcKits_PlayerDivConfig_MessageTable" data-uid="Hi.HiNcKits.PlayerDivConfig.MessageTable">
|
||||
MessageTable
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Session messages panel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool MessageTable { 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.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_HiNcKits_PlayerDivConfig_SensorSpindleMomentCycleLineDiv_" data-uid="Hi.HiNcKits.PlayerDivConfig.SensorSpindleMomentCycleLineDiv*"></a>
|
||||
|
||||
<h3 id="Hi_HiNcKits_PlayerDivConfig_SensorSpindleMomentCycleLineDiv" data-uid="Hi.HiNcKits.PlayerDivConfig.SensorSpindleMomentCycleLineDiv">
|
||||
SensorSpindleMomentCycleLineDiv
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Cycle-line chart of sensor-measured spindle moment (overlay on sim moment).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool SensorSpindleMomentCycleLineDiv { 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.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_HiNcKits_PlayerDivConfig_SimSpindleMomentCycleLineDiv_" data-uid="Hi.HiNcKits.PlayerDivConfig.SimSpindleMomentCycleLineDiv*"></a>
|
||||
|
||||
<h3 id="Hi_HiNcKits_PlayerDivConfig_SimSpindleMomentCycleLineDiv" data-uid="Hi.HiNcKits.PlayerDivConfig.SimSpindleMomentCycleLineDiv">
|
||||
SimSpindleMomentCycleLineDiv
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Cycle-line chart of simulation-derived spindle moment on spindle-rotation coordinate.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool SimSpindleMomentCycleLineDiv { 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.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_HiNcKits_PlayerDivConfig_XName_" data-uid="Hi.HiNcKits.PlayerDivConfig.XName*"></a>
|
||||
|
||||
<h3 id="Hi_HiNcKits_PlayerDivConfig_XName" data-uid="Hi.HiNcKits.PlayerDivConfig.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Name for XML IO.</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_HiNcKits_PlayerDivConfig_MakeXmlSource_" data-uid="Hi.HiNcKits.PlayerDivConfig.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_HiNcKits_PlayerDivConfig_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.HiNcKits.PlayerDivConfig.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_HiNcKits_PlayerDivConfig_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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
@@ -509,6 +509,40 @@ Not used yet.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_HiNcKits_UserConfig_PlayerDivConfig_" data-uid="Hi.HiNcKits.UserConfig.PlayerDivConfig*"></a>
|
||||
|
||||
<h3 id="Hi_HiNcKits_UserConfig_PlayerDivConfig" data-uid="Hi.HiNcKits.UserConfig.PlayerDivConfig">
|
||||
PlayerDivConfig
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Per-user visibility flags for the Player page's divisions (charts and info panels).
|
||||
Used by the webservice Division Visibility dropdown; persisted alongside the rest of
|
||||
this <a class="xref" href="Hi.HiNcKits.UserConfig.html">UserConfig</a> so the layout survives a page refresh.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public PlayerDivConfig PlayerDivConfig { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.HiNcKits.PlayerDivConfig.html">PlayerDivConfig</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_HiNcKits_UserConfig_ShowPhysicsOptions_" data-uid="Hi.HiNcKits.UserConfig.ShowPhysicsOptions*"></a>
|
||||
|
||||
<h3 id="Hi_HiNcKits_UserConfig_ShowPhysicsOptions" data-uid="Hi.HiNcKits.UserConfig.ShowPhysicsOptions">
|
||||
|
||||
@@ -186,19 +186,28 @@ Class UserService
|
||||
|
||||
<a id="Hi_HiNcKits_UserService__ctor_" data-uid="Hi.HiNcKits.UserService.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_HiNcKits_UserService__ctor" data-uid="Hi.HiNcKits.UserService.#ctor">
|
||||
UserService()
|
||||
<h3 id="Hi_HiNcKits_UserService__ctor_Hi_HiNcKits_UserConfig_Microsoft_Extensions_Logging_ILogger_" data-uid="Hi.HiNcKits.UserService.#ctor(Hi.HiNcKits.UserConfig,Microsoft.Extensions.Logging.ILogger)">
|
||||
UserService(UserConfig, ILogger)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.HiNcKits.UserService.html">UserService</a> class.</p>
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.HiNcKits.UserService.html">UserService</a> class with the specified configuration.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public UserService()</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public UserService(UserConfig appConfig, ILogger logger)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>appConfig</code> <a class="xref" href="Hi.HiNcKits.UserConfig.html">UserConfig</a></dt>
|
||||
<dd><p>The application configuration.</p>
|
||||
</dd>
|
||||
<dt><code>logger</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.ilogger">ILogger</a></dt>
|
||||
<dd><p>The logger instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
@@ -213,23 +222,23 @@ Class UserService
|
||||
|
||||
<a id="Hi_HiNcKits_UserService__ctor_" data-uid="Hi.HiNcKits.UserService.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_HiNcKits_UserService__ctor_Hi_HiNcKits_UserConfig_" data-uid="Hi.HiNcKits.UserService.#ctor(Hi.HiNcKits.UserConfig)">
|
||||
UserService(UserConfig)
|
||||
<h3 id="Hi_HiNcKits_UserService__ctor_Microsoft_Extensions_Logging_ILogger_" data-uid="Hi.HiNcKits.UserService.#ctor(Microsoft.Extensions.Logging.ILogger)">
|
||||
UserService(ILogger)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.HiNcKits.UserService.html">UserService</a> class with the specified configuration.</p>
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.HiNcKits.UserService.html">UserService</a> class.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public UserService(UserConfig appConfig)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public UserService(ILogger logger)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>appConfig</code> <a class="xref" href="Hi.HiNcKits.UserConfig.html">UserConfig</a></dt>
|
||||
<dd><p>The application configuration.</p>
|
||||
<dt><code>logger</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.ilogger">ILogger</a></dt>
|
||||
<dd><p>The logger instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -108,6 +108,15 @@ Host class for HiNC functionality that provides project management, path resolut
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.HiNcKits.LocalAppConfig.html">LocalAppConfig</a></dt>
|
||||
<dd><p>Configuration for host-related settings.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.HiNcKits.PlayerDivConfig.html">PlayerDivConfig</a></dt>
|
||||
<dd><p>Per-user visibility flags for the Player page's divisions (charts and
|
||||
info panels). Mirrors the HiNcRcl <code>PlayerDivConfig</code> + <code>PlayerDivFlag</code>
|
||||
pair, flattened into a single all-boolean config so the webservice
|
||||
(which has no <code>HiNcHost</code> / <code>HiNcUser</code>) can persist the whole
|
||||
layout through <a class="xref" href="Hi.HiNcKits.UserConfig.html">UserConfig</a> alone.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
|
||||
@@ -496,8 +496,8 @@ Class License
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_Licenses_License_AbortEventHandler" data-uid="Hi.Licenses.License.AbortEventHandler">
|
||||
AbortEventHandler
|
||||
<h3 id="Hi_Licenses_License_AbortMessageAction" data-uid="Hi.Licenses.License.AbortMessageAction">
|
||||
AbortMessageAction
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -506,7 +506,7 @@ Class License
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static event EventHandler<string> AbortEventHandler</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public static event Action<string> AbortMessageAction</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -516,7 +516,7 @@ Class License
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.eventhandler-1">EventHandler</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -266,8 +266,8 @@ and topology bricks for both the noble and shaper parts.</p>
|
||||
|
||||
<a id="Hi_Machining_FreeformRemover__ctor_" data-uid="Hi.Machining.FreeformRemover.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Machining_FreeformRemover__ctor_System_Xml_Linq_XElement_System_String_System_String_System_Object___" data-uid="Hi.Machining.FreeformRemover.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.Object[])">
|
||||
FreeformRemover(XElement, string, string, params object[])
|
||||
<h3 id="Hi_Machining_FreeformRemover__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_System_Object__System_Object___" data-uid="Hi.Machining.FreeformRemover.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{System.Object},System.Object[])">
|
||||
FreeformRemover(XElement, string, string, IProgress<object>, object[])
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -276,7 +276,7 @@ and topology bricks for both the noble and shaper parts.</p>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FreeformRemover(XElement src, string baseDirectory, string relFile, params object[] res)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public FreeformRemover(XElement src, string baseDirectory, string relFile, IProgress<object> progress, object[] res)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -290,6 +290,8 @@ and topology bricks for both the noble and shaper parts.</p>
|
||||
<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 resolving references.</p>
|
||||
</dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional resources for initialization.</p>
|
||||
</dd>
|
||||
|
||||
+34
-2
@@ -159,10 +159,10 @@ Interface IMachiningEquipment
|
||||
<a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_GetIsoCoordinatePosition_Hi_Machining_MachiningEquipmentUtils_IMachiningEquipment_Hi_Geom_Vec3d_">MachiningEquipmentUtil.GetIsoCoordinatePosition(IMachiningEquipment, Vec3d)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_GetMcXyz_AttacherAtProgramZero_Hi_Machining_MachiningEquipmentUtils_IMachiningEquipment_">MachiningEquipmentUtil.GetMcXyz_AttacherAtProgramZero(IMachiningEquipment)</a>
|
||||
<a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_GetMachinePositionAtProgramZero_Hi_Machining_MachiningEquipmentUtils_IMachiningEquipment_">MachiningEquipmentUtil.GetMachinePositionAtProgramZero(IMachiningEquipment)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_GetMcXyz_AttacherAtTableBuckleZero_Hi_Machining_MachiningEquipmentUtils_IMachiningEquipment_">MachiningEquipmentUtil.GetMcXyz_AttacherAtTableBuckleZero(IMachiningEquipment)</a>
|
||||
<a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_GetMachinePositionAtTableBuckleZero_Hi_Machining_MachiningEquipmentUtils_IMachiningEquipment_">MachiningEquipmentUtil.GetMachinePositionAtTableBuckleZero(IMachiningEquipment)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Mech.Topo.TopoUtil.html#Hi_Mech_Topo_TopoUtil_Display_Hi_Mech_Topo_IGetAnchor_Hi_Disp_Bind_System_Collections_Generic_Dictionary_Hi_Mech_Topo_Anchor_Hi_Geom_Mat4d__">TopoUtil.Display(IGetAnchor, Bind, Dictionary<Anchor, Mat4d>)</a>
|
||||
@@ -320,6 +320,38 @@ Interface IMachiningEquipment
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Machining_MachiningEquipmentUtils_IMachiningEquipment_WorkpieceDisplayee_" data-uid="Hi.Machining.MachiningEquipmentUtils.IMachiningEquipment.WorkpieceDisplayee*"></a>
|
||||
|
||||
<h3 id="Hi_Machining_MachiningEquipmentUtils_IMachiningEquipment_WorkpieceDisplayee" data-uid="Hi.Machining.MachiningEquipmentUtils.IMachiningEquipment.WorkpieceDisplayee">
|
||||
WorkpieceDisplayee
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Displayee for workpiece rendering. Set by the runtime service layer.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">IDisplayee WorkpieceDisplayee { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.Disp.IDisplayee.html">IDisplayee</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
|
||||
+39
-5
@@ -170,10 +170,10 @@ Class MachiningEquipment
|
||||
<a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_GetIsoCoordinatePosition_Hi_Machining_MachiningEquipmentUtils_IMachiningEquipment_Hi_Geom_Vec3d_">MachiningEquipmentUtil.GetIsoCoordinatePosition(IMachiningEquipment, Vec3d)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_GetMcXyz_AttacherAtProgramZero_Hi_Machining_MachiningEquipmentUtils_IMachiningEquipment_">MachiningEquipmentUtil.GetMcXyz_AttacherAtProgramZero(IMachiningEquipment)</a>
|
||||
<a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_GetMachinePositionAtProgramZero_Hi_Machining_MachiningEquipmentUtils_IMachiningEquipment_">MachiningEquipmentUtil.GetMachinePositionAtProgramZero(IMachiningEquipment)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_GetMcXyz_AttacherAtTableBuckleZero_Hi_Machining_MachiningEquipmentUtils_IMachiningEquipment_">MachiningEquipmentUtil.GetMcXyz_AttacherAtTableBuckleZero(IMachiningEquipment)</a>
|
||||
<a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_GetMachinePositionAtTableBuckleZero_Hi_Machining_MachiningEquipmentUtils_IMachiningEquipment_">MachiningEquipmentUtil.GetMachinePositionAtTableBuckleZero(IMachiningEquipment)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])</a>
|
||||
@@ -241,8 +241,8 @@ Class MachiningEquipment
|
||||
|
||||
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment__ctor_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment__ctor_System_Xml_Linq_XElement_System_String_System_String_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.#ctor(System.Xml.Linq.XElement,System.String,System.String)">
|
||||
MachiningEquipment(XElement, string, string)
|
||||
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_System_Object__" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{System.Object})">
|
||||
MachiningEquipment(XElement, string, string, IProgress<object>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -251,7 +251,7 @@ Class MachiningEquipment
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MachiningEquipment(XElement src, string baseDirectory, string relFile)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public MachiningEquipment(XElement src, string baseDirectory, string relFile, IProgress<object> progress)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -265,6 +265,8 @@ Class MachiningEquipment
|
||||
<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 XML serialization.</p>
|
||||
</dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -675,6 +677,38 @@ If <a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_WorkpieceDisplayee_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.WorkpieceDisplayee*"></a>
|
||||
|
||||
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_WorkpieceDisplayee" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.WorkpieceDisplayee">
|
||||
WorkpieceDisplayee
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Displayee for workpiece rendering. Set by the runtime service layer.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IDisplayee WorkpieceDisplayee { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.Disp.IDisplayee.html">IDisplayee</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_XName_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.XName*"></a>
|
||||
|
||||
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_XName" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.XName">
|
||||
|
||||
+32
@@ -434,6 +434,38 @@ When set, updates the component anchor and collidable based on the equipment's s
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentCollisionIndex_WorkpieceRuntimeGeomGetter_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndex.WorkpieceRuntimeGeomGetter*"></a>
|
||||
|
||||
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentCollisionIndex_WorkpieceRuntimeGeomGetter" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndex.WorkpieceRuntimeGeomGetter">
|
||||
WorkpieceRuntimeGeomGetter
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Getter for runtime geometry of the workpiece. Set by the service layer.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Func<CubeTree> WorkpieceRuntimeGeomGetter { 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.func-1">Func</a><<a class="xref" href="Hi.Cbtr.CubeTree.html">CubeTree</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
+8
-50
@@ -153,48 +153,6 @@ Class MachiningEquipmentUtil
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_GetFuncAnchoredCollidable_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.GetFuncAnchoredCollidable*"></a>
|
||||
|
||||
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_GetFuncAnchoredCollidable_System_Func_Hi_Machining_MachiningEquipmentUtils_IMachiningEquipment__Hi_Machining_MachiningEquipmentUtils_CollidableComponentEnum_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.GetFuncAnchoredCollidable(System.Func{Hi.Machining.MachiningEquipmentUtils.IMachiningEquipment},Hi.Machining.MachiningEquipmentUtils.CollidableComponentEnum)">
|
||||
GetFuncAnchoredCollidable(Func<IMachiningEquipment>, CollidableComponentEnum)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets a function-based anchored collidable for a specific component of the machining equipment.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static FuncAnchoredCollidable GetFuncAnchoredCollidable(this Func<IMachiningEquipment> millingEquipmentGetter, CollidableComponentEnum compIndex)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>millingEquipmentGetter</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a class="xref" href="Hi.Machining.MachiningEquipmentUtils.IMachiningEquipment.html">IMachiningEquipment</a>></dt>
|
||||
<dd><p>Function to get the machining equipment.</p>
|
||||
</dd>
|
||||
<dt><code>compIndex</code> <a class="xref" href="Hi.Machining.MachiningEquipmentUtils.CollidableComponentEnum.html">CollidableComponentEnum</a></dt>
|
||||
<dd><p>The component to get the collidable for.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.Collision.FuncAnchoredCollidable.html">FuncAnchoredCollidable</a></dt>
|
||||
<dd><p>A function-based anchored collidable for the specified component.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_GetIsoCoordinatePosition_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.GetIsoCoordinatePosition*"></a>
|
||||
|
||||
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_GetIsoCoordinatePosition_Hi_Machining_MachiningEquipmentUtils_IMachiningEquipment_Hi_Geom_Vec3d_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.GetIsoCoordinatePosition(Hi.Machining.MachiningEquipmentUtils.IMachiningEquipment,Hi.Geom.Vec3d)">
|
||||
@@ -234,10 +192,10 @@ Class MachiningEquipmentUtil
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_GetMcXyz_AttacherAtProgramZero_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.GetMcXyz_AttacherAtProgramZero*"></a>
|
||||
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_GetMachinePositionAtProgramZero_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.GetMachinePositionAtProgramZero*"></a>
|
||||
|
||||
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_GetMcXyz_AttacherAtProgramZero_Hi_Machining_MachiningEquipmentUtils_IMachiningEquipment_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.GetMcXyz_AttacherAtProgramZero(Hi.Machining.MachiningEquipmentUtils.IMachiningEquipment)">
|
||||
GetMcXyz_AttacherAtProgramZero(IMachiningEquipment)
|
||||
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_GetMachinePositionAtProgramZero_Hi_Machining_MachiningEquipmentUtils_IMachiningEquipment_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.GetMachinePositionAtProgramZero(Hi.Machining.MachiningEquipmentUtils.IMachiningEquipment)">
|
||||
GetMachinePositionAtProgramZero(IMachiningEquipment)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -247,7 +205,7 @@ The machine coordinate are all assumed to be zero.</p>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static Vec3d GetMcXyz_AttacherAtProgramZero(this IMachiningEquipment equipment)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public static Vec3d GetMachinePositionAtProgramZero(this IMachiningEquipment equipment)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -274,10 +232,10 @@ The machine coordinate are all assumed to be zero.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_GetMcXyz_AttacherAtTableBuckleZero_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.GetMcXyz_AttacherAtTableBuckleZero*"></a>
|
||||
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_GetMachinePositionAtTableBuckleZero_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.GetMachinePositionAtTableBuckleZero*"></a>
|
||||
|
||||
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_GetMcXyz_AttacherAtTableBuckleZero_Hi_Machining_MachiningEquipmentUtils_IMachiningEquipment_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.GetMcXyz_AttacherAtTableBuckleZero(Hi.Machining.MachiningEquipmentUtils.IMachiningEquipment)">
|
||||
GetMcXyz_AttacherAtTableBuckleZero(IMachiningEquipment)
|
||||
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_GetMachinePositionAtTableBuckleZero_Hi_Machining_MachiningEquipmentUtils_IMachiningEquipment_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.GetMachinePositionAtTableBuckleZero(Hi.Machining.MachiningEquipmentUtils.IMachiningEquipment)">
|
||||
GetMachinePositionAtTableBuckleZero(IMachiningEquipment)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -286,7 +244,7 @@ The machine coordinate are all assumed to be zero.</p>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static Vec3d GetMcXyz_AttacherAtTableBuckleZero(this IMachiningEquipment equipment)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public static Vec3d GetMachinePositionAtTableBuckleZero(this IMachiningEquipment equipment)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
|
||||
@@ -303,8 +303,8 @@ Class MachiningToolHouse
|
||||
|
||||
<a id="Hi_Machining_MachiningToolHouse__ctor_" data-uid="Hi.Machining.MachiningToolHouse.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Machining_MachiningToolHouse__ctor_System_Xml_Linq_XElement_System_String_System_String_" data-uid="Hi.Machining.MachiningToolHouse.#ctor(System.Xml.Linq.XElement,System.String,System.String)">
|
||||
MachiningToolHouse(XElement, string, string)
|
||||
<h3 id="Hi_Machining_MachiningToolHouse__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_System_Object__" data-uid="Hi.Machining.MachiningToolHouse.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{System.Object})">
|
||||
MachiningToolHouse(XElement, string, string, IProgress<object>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -313,7 +313,7 @@ Class MachiningToolHouse
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MachiningToolHouse(XElement src, string baseDirectory, string relFile)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public MachiningToolHouse(XElement src, string baseDirectory, string relFile, IProgress<object> progress)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -326,6 +326,9 @@ Class MachiningToolHouse
|
||||
</dd>
|
||||
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>Relative file path</p>
|
||||
</dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd><p>The progress reporter.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
+38
-8
@@ -186,8 +186,8 @@ Class MachiningVolumeRemovalProc.StepMotionSnapshot
|
||||
|
||||
<a id="Hi_Machining_MachiningVolumeRemovalProc_StepMotionSnapshot__ctor_" data-uid="Hi.Machining.MachiningVolumeRemovalProc.StepMotionSnapshot.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Machining_MachiningVolumeRemovalProc_StepMotionSnapshot__ctor_Hi_Geom_DVec3d_Hi_Geom_DVec3d_Hi_Common_SeqPair_Hi_Geom_Mat4d__System_Collections_Generic_Dictionary_Hi_Mech_Topo_Anchor_Hi_Geom_Mat4d__System_Double___System_Boolean_Hi_Machining_IMachiningTool_Hi_NcMech_Workpieces_Workpiece_System_Double_Hi_Physics_CoolantHeatCondition_System_Collections_Generic_SortedList_System_Double_System_Double__" data-uid="Hi.Machining.MachiningVolumeRemovalProc.StepMotionSnapshot.#ctor(Hi.Geom.DVec3d,Hi.Geom.DVec3d,Hi.Common.SeqPair{Hi.Geom.Mat4d},System.Collections.Generic.Dictionary{Hi.Mech.Topo.Anchor,Hi.Geom.Mat4d},System.Double[],System.Boolean,Hi.Machining.IMachiningTool,Hi.NcMech.Workpieces.Workpiece,System.Double,Hi.Physics.CoolantHeatCondition,System.Collections.Generic.SortedList{System.Double,System.Double})">
|
||||
StepMotionSnapshot(DVec3d, DVec3d, SeqPair<Mat4d>, Dictionary<Anchor, Mat4d>, double[], bool, IMachiningTool, Workpiece, double, CoolantHeatCondition, SortedList<double, double>)
|
||||
<h3 id="Hi_Machining_MachiningVolumeRemovalProc_StepMotionSnapshot__ctor_Hi_Geom_DVec3d_Hi_Geom_DVec3d_Hi_Common_SeqPair_Hi_Geom_Mat4d__System_Collections_Generic_Dictionary_Hi_Mech_Topo_Anchor_Hi_Geom_Mat4d__System_Double___System_Boolean_Hi_Machining_IMachiningTool_Hi_NcMech_Workpieces_WorkpieceService_System_Double_Hi_Physics_CoolantHeatCondition_System_Collections_Generic_SortedList_System_Double_System_Double__" data-uid="Hi.Machining.MachiningVolumeRemovalProc.StepMotionSnapshot.#ctor(Hi.Geom.DVec3d,Hi.Geom.DVec3d,Hi.Common.SeqPair{Hi.Geom.Mat4d},System.Collections.Generic.Dictionary{Hi.Mech.Topo.Anchor,Hi.Geom.Mat4d},System.Double[],System.Boolean,Hi.Machining.IMachiningTool,Hi.NcMech.Workpieces.WorkpieceService,System.Double,Hi.Physics.CoolantHeatCondition,System.Collections.Generic.SortedList{System.Double,System.Double})">
|
||||
StepMotionSnapshot(DVec3d, DVec3d, SeqPair<Mat4d>, Dictionary<Anchor, Mat4d>, double[], bool, IMachiningTool, WorkpieceService, double, CoolantHeatCondition, SortedList<double, double>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -196,7 +196,7 @@ Class MachiningVolumeRemovalProc.StepMotionSnapshot
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public StepMotionSnapshot(DVec3d GeomCl, DVec3d ProgramCl, SeqPair<Mat4d> Seq, Dictionary<Anchor, Mat4d> AnchorTransformDictionary, double[] McValues, bool EnableSweeping, IMachiningTool MachiningTool, Workpiece Workpiece, double BackgroundTemperature_K, CoolantHeatCondition CoolantHeatCondition, SortedList<double, double> FluteZToDzList)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public StepMotionSnapshot(DVec3d GeomCl, DVec3d ProgramCl, SeqPair<Mat4d> Seq, Dictionary<Anchor, Mat4d> AnchorTransformDictionary, double[] McValues, bool EnableSweeping, IMachiningTool MachiningTool, WorkpieceService WorkpieceService, double BackgroundTemperature_K, CoolantHeatCondition CoolantHeatCondition, SortedList<double, double> FluteZToDzList)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -222,9 +222,8 @@ Class MachiningVolumeRemovalProc.StepMotionSnapshot
|
||||
<dt><code>MachiningTool</code> <a class="xref" href="Hi.Machining.IMachiningTool.html">IMachiningTool</a></dt>
|
||||
<dd><p>The machining tool being used.</p>
|
||||
</dd>
|
||||
<dt><code>Workpiece</code> <a class="xref" href="Hi.NcMech.Workpieces.Workpiece.html">Workpiece</a></dt>
|
||||
<dd><p>The workpiece being machined.</p>
|
||||
</dd>
|
||||
<dt><code>WorkpieceService</code> <a class="xref" href="Hi.NcMech.Workpieces.WorkpieceService.html">WorkpieceService</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>BackgroundTemperature_K</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd><p>Background temperature in Kelvin.</p>
|
||||
</dd>
|
||||
@@ -578,12 +577,12 @@ Class MachiningVolumeRemovalProc.StepMotionSnapshot
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>The workpiece being machined.</p>
|
||||
<div class="markdown level1 summary"><p>The workpiece data model.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Workpiece Workpiece { get; init; }</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public Workpiece Workpiece { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -603,6 +602,37 @@ Class MachiningVolumeRemovalProc.StepMotionSnapshot
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Machining_MachiningVolumeRemovalProc_StepMotionSnapshot_WorkpieceService_" data-uid="Hi.Machining.MachiningVolumeRemovalProc.StepMotionSnapshot.WorkpieceService*"></a>
|
||||
|
||||
<h3 id="Hi_Machining_MachiningVolumeRemovalProc_StepMotionSnapshot_WorkpieceService" data-uid="Hi.Machining.MachiningVolumeRemovalProc.StepMotionSnapshot.WorkpieceService">
|
||||
WorkpieceService
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public WorkpieceService WorkpieceService { get; init; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.NcMech.Workpieces.WorkpieceService.html">WorkpieceService</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
|
||||
@@ -180,8 +180,8 @@ Class MachiningVolumeRemovalProc
|
||||
|
||||
<a id="Hi_Machining_MachiningVolumeRemovalProc__ctor_" data-uid="Hi.Machining.MachiningVolumeRemovalProc.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Machining_MachiningVolumeRemovalProc__ctor_System_Func_Hi_Machining_MachiningEquipmentUtils_MachiningEquipment__" data-uid="Hi.Machining.MachiningVolumeRemovalProc.#ctor(System.Func{Hi.Machining.MachiningEquipmentUtils.MachiningEquipment})">
|
||||
MachiningVolumeRemovalProc(Func<MachiningEquipment>)
|
||||
<h3 id="Hi_Machining_MachiningVolumeRemovalProc__ctor_System_Func_Hi_Machining_MachiningEquipmentUtils_MachiningEquipment__System_Func_Hi_NcMech_Workpieces_WorkpieceService__" data-uid="Hi.Machining.MachiningVolumeRemovalProc.#ctor(System.Func{Hi.Machining.MachiningEquipmentUtils.MachiningEquipment},System.Func{Hi.NcMech.Workpieces.WorkpieceService})">
|
||||
MachiningVolumeRemovalProc(Func<MachiningEquipment>, Func<WorkpieceService>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -190,13 +190,15 @@ Class MachiningVolumeRemovalProc
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MachiningVolumeRemovalProc(Func<MachiningEquipment> machiningEquipmentGetter)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public MachiningVolumeRemovalProc(Func<MachiningEquipment> machiningEquipmentGetter, Func<WorkpieceService> workpieceServiceGetter)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>machiningEquipmentGetter</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html">MachiningEquipment</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>workpieceServiceGetter</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a class="xref" href="Hi.NcMech.Workpieces.WorkpieceService.html">WorkpieceService</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -279,8 +281,8 @@ Class MachiningVolumeRemovalProc
|
||||
|
||||
<a id="Hi_Machining_MachiningVolumeRemovalProc_StepAssignDummyAttach_" data-uid="Hi.Machining.MachiningVolumeRemovalProc.StepAssignDummyAttach*"></a>
|
||||
|
||||
<h3 id="Hi_Machining_MachiningVolumeRemovalProc_StepAssignDummyAttach_Hi_NcMech_Workpieces_Workpiece_Hi_CutterLocations_ClStrips_ClStrip_Hi_Geom_DVec3d_" data-uid="Hi.Machining.MachiningVolumeRemovalProc.StepAssignDummyAttach(Hi.NcMech.Workpieces.Workpiece,Hi.CutterLocations.ClStrips.ClStrip,Hi.Geom.DVec3d)">
|
||||
StepAssignDummyAttach(Workpiece, ClStrip, DVec3d)
|
||||
<h3 id="Hi_Machining_MachiningVolumeRemovalProc_StepAssignDummyAttach_Hi_NcMech_Workpieces_WorkpieceService_Hi_CutterLocations_ClStrips_ClStrip_Hi_Geom_DVec3d_" data-uid="Hi.Machining.MachiningVolumeRemovalProc.StepAssignDummyAttach(Hi.NcMech.Workpieces.WorkpieceService,Hi.CutterLocations.ClStrips.ClStrip,Hi.Geom.DVec3d)">
|
||||
StepAssignDummyAttach(WorkpieceService, ClStrip, DVec3d)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -289,14 +291,13 @@ Class MachiningVolumeRemovalProc
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static ClStripPos StepAssignDummyAttach(Workpiece workpiece, ClStrip clStrip, DVec3d programCl)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public static ClStripPos StepAssignDummyAttach(WorkpieceService workpieceService, ClStrip clStrip, DVec3d programCl)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>workpiece</code> <a class="xref" href="Hi.NcMech.Workpieces.Workpiece.html">Workpiece</a></dt>
|
||||
<dd><p>The workpiece to attach to.</p>
|
||||
</dd>
|
||||
<dt><code>workpieceService</code> <a class="xref" href="Hi.NcMech.Workpieces.WorkpieceService.html">WorkpieceService</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>clStrip</code> <a class="xref" href="Hi.CutterLocations.ClStrips.ClStrip.html">ClStrip</a></dt>
|
||||
<dd><p>The CL strip to add the attachment to.</p>
|
||||
</dd>
|
||||
|
||||
@@ -193,9 +193,6 @@ Class ToolNotFoundException
|
||||
<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.Common.ExceptionUtil.html#Hi_Common_ExceptionUtil_ShowException_System_Exception_System_Object_">ExceptionUtil.ShowException(Exception, object)</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>
|
||||
|
||||
@@ -193,33 +193,6 @@ Compare to <a class="xref" href="Hi.MachiningProcs.MachiningProject.html">Machin
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_LocalProjectService__ctor_" data-uid="Hi.MachiningProcs.LocalProjectService.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_LocalProjectService__ctor" data-uid="Hi.MachiningProcs.LocalProjectService.#ctor">
|
||||
LocalProjectService()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Ctor.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public LocalProjectService()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_LocalProjectService__ctor_" data-uid="Hi.MachiningProcs.LocalProjectService.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_LocalProjectService__ctor_Hi_HiNcKits_UserService_Microsoft_Extensions_Logging_ILogger_Hi_MachiningProcs_LocalProjectService__" data-uid="Hi.MachiningProcs.LocalProjectService.#ctor(Hi.HiNcKits.UserService,Microsoft.Extensions.Logging.ILogger{Hi.MachiningProcs.LocalProjectService})">
|
||||
@@ -256,10 +229,75 @@ Compare to <a class="xref" href="Hi.MachiningProcs.MachiningProject.html">Machin
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_LocalProjectService__ctor_" data-uid="Hi.MachiningProcs.LocalProjectService.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_LocalProjectService__ctor_Microsoft_Extensions_Logging_ILogger_Hi_MachiningProcs_LocalProjectService__" data-uid="Hi.MachiningProcs.LocalProjectService.#ctor(Microsoft.Extensions.Logging.ILogger{Hi.MachiningProcs.LocalProjectService})">
|
||||
LocalProjectService(ILogger<LocalProjectService>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Ctor.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public LocalProjectService(ILogger<LocalProjectService> logger = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>logger</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.ilogger-1">ILogger</a><<a class="xref" href="Hi.MachiningProcs.LocalProjectService.html">LocalProjectService</a>></dt>
|
||||
<dd><p>Optional logger instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_LocalProjectService_ActiveNcRunner_" data-uid="Hi.MachiningProcs.LocalProjectService.ActiveNcRunner*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_LocalProjectService_ActiveNcRunner" data-uid="Hi.MachiningProcs.LocalProjectService.ActiveNcRunner">
|
||||
ActiveNcRunner
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the active NC runner based on <a class="xref" href="Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_EnableSoftNcRunner">EnableSoftNcRunner</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IControlRunner ActiveNcRunner { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.Numerical.IControlRunner.html">IControlRunner</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_LocalProjectService_BoundSelectorHost_" data-uid="Hi.MachiningProcs.LocalProjectService.BoundSelectorHost*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_LocalProjectService_BoundSelectorHost" data-uid="Hi.MachiningProcs.LocalProjectService.BoundSelectorHost">
|
||||
@@ -421,6 +459,40 @@ When set to true, initializes collision detection mechanism.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_LocalProjectService_EnableSoftNcRunner_" data-uid="Hi.MachiningProcs.LocalProjectService.EnableSoftNcRunner*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_LocalProjectService_EnableSoftNcRunner" data-uid="Hi.MachiningProcs.LocalProjectService.EnableSoftNcRunner">
|
||||
EnableSoftNcRunner
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Workaround flag to switch between <a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a> and <a class="xref" href="Hi.Numerical.FilePlayers.HardNcRunner.html">HardNcRunner</a>.
|
||||
When true and <a class="xref" href="Hi.MachiningProcs.MachiningProject.html#Hi_MachiningProcs_MachiningProject_SoftNcRunner">SoftNcRunner</a> is available, uses <a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a>.
|
||||
Will be removed when <a class="xref" href="Hi.Numerical.FilePlayers.HardNcRunner.html">HardNcRunner</a> is fully replaced.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool EnableSoftNcRunner { 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.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_LocalProjectService_EnableStrokeLimitCheck_" data-uid="Hi.MachiningProcs.LocalProjectService.EnableStrokeLimitCheck*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_LocalProjectService_EnableStrokeLimitCheck" data-uid="Hi.MachiningProcs.LocalProjectService.EnableStrokeLimitCheck">
|
||||
@@ -1007,7 +1079,7 @@ Updates related components when changed.</p>
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the NC runner responsible for executing NC programs.</p>
|
||||
<div class="markdown level1 summary"><p>Gets the legacy NC runner.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -1289,6 +1361,38 @@ Ensures proper initialization of workpiece properties.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_LocalProjectService_WorkpieceService_" data-uid="Hi.MachiningProcs.LocalProjectService.WorkpieceService*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_LocalProjectService_WorkpieceService" data-uid="Hi.MachiningProcs.LocalProjectService.WorkpieceService">
|
||||
WorkpieceService
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the workpiece runtime service.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public WorkpieceService WorkpieceService { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.NcMech.Workpieces.WorkpieceService.html">WorkpieceService</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
@@ -1784,6 +1888,45 @@ Clear the state from previous session (if existed).</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_LocalProjectService_PowerReset_" data-uid="Hi.MachiningProcs.LocalProjectService.PowerReset*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_LocalProjectService_PowerReset" data-uid="Hi.MachiningProcs.LocalProjectService.PowerReset">
|
||||
PowerReset()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Performs a controller power reset, modelling a power-off / power-on cycle:</p>
|
||||
<ul><li>Every <a class="xref" href="Hi.NcParsers.Dependencys.IPowerResettable.html">IPowerResettable</a> dependency clears its volatile
|
||||
subset. Persistent dependency state (controller parameters,
|
||||
Fanuc <code>#500-#999</code>, etc.) is left intact.</li><li>The active <a class="xref" href="Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_MachiningSession">MachiningSession</a>'s
|
||||
<a class="xref" href="Hi.MachiningProcs.NcRunnerSessionState.html">NcRunnerSessionState</a> is reset so the per-layer
|
||||
<code>SyntaxPiece</code> dataflow — including <code>Vars.Volatile</code>, modal
|
||||
carries, and the init seed — is dropped. The next
|
||||
<a class="xref" href="Hi.Numerical.IControlRunner.html#Hi_Numerical_IControlRunner_RunControlLines_System_String_System_Collections_Generic_IEnumerable_System_String__Hi_MachiningProcs_MachiningSession_Hi_MachiningProcs_SessionProgress_System_Threading_CancellationToken_">RunControlLines(string, IEnumerable<string>, MachiningSession, SessionProgress, CancellationToken)</a> call re-initialises
|
||||
everything from scratch.</li></ul>
|
||||
Without the second step, calling <code>PowerReset</code> while a project is
|
||||
loaded would leave volatile commons alive across the supposed power
|
||||
cycle (they live in the SyntaxPiece JSON dataflow rather than in any
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.IPowerResettable.html">IPowerResettable</a> dependency).
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void PowerReset()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_LocalProjectService_ProcAct_" data-uid="Hi.MachiningProcs.LocalProjectService.ProcAct*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_LocalProjectService_ProcAct_Hi_Numerical_Acts_IAct_Hi_NcParsers_IGetSentence_System_Nullable_System_Threading_CancellationToken__" data-uid="Hi.MachiningProcs.LocalProjectService.ProcAct(Hi.Numerical.Acts.IAct,Hi.NcParsers.IGetSentence,System.Nullable{System.Threading.CancellationToken})">
|
||||
@@ -2074,6 +2217,33 @@ Clear the state from previous session (if existed).</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_LocalProjectService_RunToLineEnd_" data-uid="Hi.MachiningProcs.LocalProjectService.RunToLineEnd*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_LocalProjectService_RunToLineEnd" data-uid="Hi.MachiningProcs.LocalProjectService.RunToLineEnd">
|
||||
RunToLineEnd()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Advances the player by one NC/CSV line and pauses.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void RunToLineEnd()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_LocalProjectService_SaveAsProject_" data-uid="Hi.MachiningProcs.LocalProjectService.SaveAsProject*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_LocalProjectService_SaveAsProject_System_String_" data-uid="Hi.MachiningProcs.LocalProjectService.SaveAsProject(System.String)">
|
||||
@@ -2398,17 +2568,17 @@ The previous step is null if no previous step exists.</p>
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_MachiningProcs_LocalProjectService_OnRanNcBlock" data-uid="Hi.MachiningProcs.LocalProjectService.OnRanNcBlock">
|
||||
OnRanNcBlock
|
||||
<h3 id="Hi_MachiningProcs_LocalProjectService_OnNcFileRan" data-uid="Hi.MachiningProcs.LocalProjectService.OnNcFileRan">
|
||||
OnNcFileRan
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Event triggered after an NC block is executed.</p>
|
||||
<div class="markdown level1 summary"><p>Event triggered after an NC file is executed.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public event Action OnRanNcBlock</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public event Action OnNcFileRan</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -2429,6 +2599,68 @@ The previous step is null if no previous step exists.</p>
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_MachiningProcs_LocalProjectService_OnSourcedActEntry" data-uid="Hi.MachiningProcs.LocalProjectService.OnSourcedActEntry">
|
||||
OnSourcedActEntry
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>App-lifetime event triggered for each <a class="xref" href="Hi.Numerical.SourcedActEntry.html">SourcedActEntry</a> produced during NC/CSV execution.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public event Action<SourcedActEntry> OnSourcedActEntry</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a><<a class="xref" href="Hi.Numerical.SourcedActEntry.html">SourcedActEntry</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_MachiningProcs_LocalProjectService_OnSyntaxPieceRan" data-uid="Hi.MachiningProcs.LocalProjectService.OnSyntaxPieceRan">
|
||||
OnSyntaxPieceRan
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Raised after each <a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a> has been run during NC execution (app lifetime).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public event Action<SyntaxPiece> OnSyntaxPieceRan</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a><<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_MachiningProcs_LocalProjectService_OnUpdatedInspectingQuantityFunc" data-uid="Hi.MachiningProcs.LocalProjectService.OnUpdatedInspectingQuantityFunc">
|
||||
OnUpdatedInspectingQuantityFunc
|
||||
|
||||
|
||||
@@ -186,8 +186,8 @@ Class MachiningActRunner
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningActRunner__ctor_" data-uid="Hi.MachiningProcs.MachiningActRunner.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningActRunner__ctor_Hi_MachiningProcs_SessionProgress_System_Action_System_Collections_Generic_IEnumerable_Hi_MillingSteps_MillingStepLuggage___System_Func_Hi_Machining_MachiningToolHouse__System_Func_Hi_Machining_MachiningEquipmentUtils_MachiningEquipment__System_Action_Hi_ScriptApiUtils_ICsScriptApi_Hi_MachiningProcs_MachiningActRunnerConfig_" data-uid="Hi.MachiningProcs.MachiningActRunner.#ctor(Hi.MachiningProcs.SessionProgress,System.Action{System.Collections.Generic.IEnumerable{Hi.MillingSteps.MillingStepLuggage}},System.Func{Hi.Machining.MachiningToolHouse},System.Func{Hi.Machining.MachiningEquipmentUtils.MachiningEquipment},System.Action,Hi.ScriptApiUtils.ICsScriptApi,Hi.MachiningProcs.MachiningActRunnerConfig)">
|
||||
MachiningActRunner(SessionProgress, Action<IEnumerable<MillingStepLuggage>>, Func<MachiningToolHouse>, Func<MachiningEquipment>, Action, ICsScriptApi, MachiningActRunnerConfig)
|
||||
<h3 id="Hi_MachiningProcs_MachiningActRunner__ctor_Hi_MachiningProcs_SessionProgress_System_Action_System_Collections_Generic_IEnumerable_Hi_MillingSteps_MillingStepLuggage___System_Func_Hi_Machining_MachiningToolHouse__System_Func_Hi_Machining_MachiningEquipmentUtils_MachiningEquipment__System_Func_Hi_NcMech_Workpieces_WorkpieceService__System_Action_Hi_ScriptApiUtils_ICsScriptApi_" data-uid="Hi.MachiningProcs.MachiningActRunner.#ctor(Hi.MachiningProcs.SessionProgress,System.Action{System.Collections.Generic.IEnumerable{Hi.MillingSteps.MillingStepLuggage}},System.Func{Hi.Machining.MachiningToolHouse},System.Func{Hi.Machining.MachiningEquipmentUtils.MachiningEquipment},System.Func{Hi.NcMech.Workpieces.WorkpieceService},System.Action,Hi.ScriptApiUtils.ICsScriptApi)">
|
||||
MachiningActRunner(SessionProgress, Action<IEnumerable<MillingStepLuggage>>, Func<MachiningToolHouse>, Func<MachiningEquipment>, Func<WorkpieceService>, Action, ICsScriptApi)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -196,12 +196,12 @@ Class MachiningActRunner
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MachiningActRunner(SessionProgress messageHost, Action<IEnumerable<MillingStepLuggage>> stepStorageWriter, Func<MachiningToolHouse> machiningToolHouseGetter, Func<MachiningEquipment> machiningEquipmentGetter, Action resetMillingStepLuggageDbAction, ICsScriptApi shellApi, MachiningActRunnerConfig config = null)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public MachiningActRunner(SessionProgress sessionProgress, Action<IEnumerable<MillingStepLuggage>> stepStorageWriter, Func<MachiningToolHouse> machiningToolHouseGetter, Func<MachiningEquipment> machiningEquipmentGetter, Func<WorkpieceService> workpieceServiceGetter, Action resetMillingStepLuggageDbAction, ICsScriptApi shellApi)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>messageHost</code> <a class="xref" href="Hi.MachiningProcs.SessionProgress.html">SessionProgress</a></dt>
|
||||
<dt><code>sessionProgress</code> <a class="xref" href="Hi.MachiningProcs.SessionProgress.html">SessionProgress</a></dt>
|
||||
<dd><p>The milling message host.</p>
|
||||
</dd>
|
||||
<dt><code>stepStorageWriter</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><<a class="xref" href="Hi.MillingSteps.MillingStepLuggage.html">MillingStepLuggage</a>>></dt>
|
||||
@@ -212,15 +212,15 @@ Class MachiningActRunner
|
||||
</dd>
|
||||
<dt><code>machiningEquipmentGetter</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html">MachiningEquipment</a>></dt>
|
||||
<dd><p>The getter function for the machining equipment.</p>
|
||||
</dd>
|
||||
<dt><code>workpieceServiceGetter</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a class="xref" href="Hi.NcMech.Workpieces.WorkpieceService.html">WorkpieceService</a>></dt>
|
||||
<dd><p>The getter function for the workpiece runtime service.</p>
|
||||
</dd>
|
||||
<dt><code>resetMillingStepLuggageDbAction</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action">Action</a></dt>
|
||||
<dd><p>Action to reset the milling step luggage database.</p>
|
||||
</dd>
|
||||
<dt><code>shellApi</code> <a class="xref" href="Hi.ScriptApiUtils.ICsScriptApi.html">ICsScriptApi</a></dt>
|
||||
<dd><p>The C# script API for the milling session.</p>
|
||||
</dd>
|
||||
<dt><code>config</code> <a class="xref" href="Hi.MachiningProcs.MachiningActRunnerConfig.html">MachiningActRunnerConfig</a></dt>
|
||||
<dd><p>Optional configuration for the milling act runner.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -235,6 +235,41 @@ Class MachiningActRunner
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="fields">Fields
|
||||
</h2>
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningActRunner_InternalMachiningStepBuilt" data-uid="Hi.MachiningProcs.MachiningActRunner.InternalMachiningStepBuilt">
|
||||
InternalMachiningStepBuilt
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Internal callback fired when a step is built (same timing as <a class="xref" href="Hi.MachiningProcs.MachiningActRunner.html#Hi_MachiningProcs_MachiningActRunner_MachiningStepBuilt">MachiningStepBuilt</a>); used by host services before UI subscribers.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MachiningActRunner.MachiningStepBuiltDelegate InternalMachiningStepBuilt</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Field Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.MachiningProcs.MachiningActRunner.html">MachiningActRunner</a>.<a class="xref" href="Hi.MachiningProcs.MachiningActRunner.MachiningStepBuiltDelegate.html">MachiningStepBuiltDelegate</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
@@ -800,7 +835,7 @@ This property is provided as a member value getter and should not be modified.</
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<object> ProcAct(IAct act, MachiningSession millingSession, IMachiningStepHost host, IGetSentence sourceCommand, CancellationToken cancellationToken)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<object> ProcAct(IAct act, MachiningSession machiningSession, IMachiningStepHost host, IGetSentence sourceCommand, CancellationToken cancellationToken)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -808,7 +843,7 @@ This property is provided as a member value getter and should not be modified.</
|
||||
<dt><code>act</code> <a class="xref" href="Hi.Numerical.Acts.IAct.html">IAct</a></dt>
|
||||
<dd><p>The act to process.</p>
|
||||
</dd>
|
||||
<dt><code>millingSession</code> <a class="xref" href="Hi.MachiningProcs.MachiningSession.html">MachiningSession</a></dt>
|
||||
<dt><code>machiningSession</code> <a class="xref" href="Hi.MachiningProcs.MachiningSession.html">MachiningSession</a></dt>
|
||||
<dd><p>The milling session.</p>
|
||||
</dd>
|
||||
<dt><code>host</code> <a class="xref" href="Hi.MachiningSteps.IMachiningStepHost.html">IMachiningStepHost</a></dt>
|
||||
|
||||
@@ -214,8 +214,8 @@ Provides settings for physics simulation, evaluation, and temperature control.</
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningActRunnerConfig__ctor_" data-uid="Hi.MachiningProcs.MachiningActRunnerConfig.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningActRunnerConfig__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.MachiningProcs.MachiningActRunnerConfig.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
MachiningActRunnerConfig(XElement, string)
|
||||
<h3 id="Hi_MachiningProcs_MachiningActRunnerConfig__ctor_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__" data-uid="Hi.MachiningProcs.MachiningActRunnerConfig.#ctor(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object})">
|
||||
MachiningActRunnerConfig(XElement, string, IProgress<object>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -224,7 +224,7 @@ Provides settings for physics simulation, evaluation, and temperature control.</
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MachiningActRunnerConfig(XElement src, string baseDirectory)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public MachiningActRunnerConfig(XElement src, string baseDirectory, IProgress<object> progress)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -235,6 +235,8 @@ Provides settings for physics simulation, evaluation, and temperature control.</
|
||||
<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>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -325,7 +327,7 @@ Note: This feature is pending testing.</p>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Enable Pause On Failure Detected.
|
||||
Only take effect if the <a class="xref" href="Hi.MachiningProcs.MachiningActRunnerConfig.html#Hi_MachiningProcs_MachiningActRunnerConfig_EnableStrokeLimitCheck">EnableStrokeLimitCheck</a> or <a class="xref" href="Hi.MachiningProcs.MachiningActRunnerConfig.html#Hi_MachiningProcs_MachiningActRunnerConfig_EnableCollisionDetection">EnableCollisionDetection</a> is enabled.</p>
|
||||
Only take effect if the <a class="xref" href="Hi.MachiningProcs.MachiningActRunnerConfig.html#Hi_MachiningProcs_MachiningActRunnerConfig_EnableStrokeLimitCheck">EnableStrokeLimitCheck</a> or <a class="xref" href="Hi.MachiningProcs.MachiningActRunnerConfig.html#Hi_MachiningProcs_MachiningActRunnerConfig_EnableCollisionDetection">EnableCollisionDetection</a> is enabled.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -513,6 +515,39 @@ The temperature is initialized when a working session is restarted or a new sess
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningActRunnerConfig_IsIdealOffsetDependentOnToolHouse_" data-uid="Hi.MachiningProcs.MachiningActRunnerConfig.IsIdealOffsetDependentOnToolHouse*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningActRunnerConfig_IsIdealOffsetDependentOnToolHouse" data-uid="Hi.MachiningProcs.MachiningActRunnerConfig.IsIdealOffsetDependentOnToolHouse">
|
||||
IsIdealOffsetDependentOnToolHouse
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets or sets whether the ideal tool offset is automatically populated
|
||||
from the tool house geometry before simulation.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool IsIdealOffsetDependentOnToolHouse { 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.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningActRunnerConfig_XName_" data-uid="Hi.MachiningProcs.MachiningActRunnerConfig.XName*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningActRunnerConfig_XName" data-uid="Hi.MachiningProcs.MachiningActRunnerConfig.XName">
|
||||
|
||||
@@ -221,8 +221,8 @@ Class MachiningProject
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningProject__ctor_" data-uid="Hi.MachiningProcs.MachiningProject.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningProject__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.MachiningProcs.MachiningProject.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
MachiningProject(XElement, string)
|
||||
<h3 id="Hi_MachiningProcs_MachiningProject__ctor_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__" data-uid="Hi.MachiningProcs.MachiningProject.#ctor(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object})">
|
||||
MachiningProject(XElement, string, IProgress<object>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -231,7 +231,7 @@ Class MachiningProject
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MachiningProject(XElement src, string baseDirectory)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public MachiningProject(XElement src, string baseDirectory, IProgress<object> progress)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -241,6 +241,9 @@ Class MachiningProject
|
||||
</dd>
|
||||
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>Base directory for resolving relative paths</p>
|
||||
</dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd><p>Progress reporter for XML deserialization.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -266,7 +269,7 @@ Class MachiningProject
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the API version from the entry assembly.</p>
|
||||
<div class="markdown level1 summary"><p>Gets the API version from the HiNc assembly (where <a class="xref" href="Hi.MachiningProcs.MachiningProject.html">MachiningProject</a> is defined).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -546,6 +549,38 @@ Class MachiningProject
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningProject_SoftNcRunner_" data-uid="Hi.MachiningProcs.MachiningProject.SoftNcRunner*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningProject_SoftNcRunner" data-uid="Hi.MachiningProcs.MachiningProject.SoftNcRunner">
|
||||
SoftNcRunner
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets or sets the configurable NC runner. When set, replaces the legacy <a class="xref" href="Hi.Numerical.FilePlayers.HardNcRunner.html">HardNcRunner</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public SoftNcRunner SoftNcRunner { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningProject_TimeMapping_" data-uid="Hi.MachiningProcs.MachiningProject.TimeMapping*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningProject_TimeMapping" data-uid="Hi.MachiningProcs.MachiningProject.TimeMapping">
|
||||
@@ -738,8 +773,8 @@ Class MachiningProject
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningProject_LoadFile_" data-uid="Hi.MachiningProcs.MachiningProject.LoadFile*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningProject_LoadFile_System_String_" data-uid="Hi.MachiningProcs.MachiningProject.LoadFile(System.String)">
|
||||
LoadFile(string)
|
||||
<h3 id="Hi_MachiningProcs_MachiningProject_LoadFile_System_String_System_IProgress_System_Object__" data-uid="Hi.MachiningProcs.MachiningProject.LoadFile(System.String,System.IProgress{System.Object})">
|
||||
LoadFile(string, IProgress<object>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -748,13 +783,16 @@ Class MachiningProject
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static MachiningProject LoadFile(string projectFilePath)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public static MachiningProject LoadFile(string projectFilePath, IProgress<object> progress)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>projectFilePath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>Path to the project file to load</p>
|
||||
</dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd><p>Progress reporter for XML deserialization.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class MachiningSession | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Represents a machining session that manages the execution and optimization of machining operations. Provides functionality for controlling the machining process, handling optimization options, and managing session state.">
|
||||
<meta name="description" content="Represents a machining session that manages the execution and optimization of machining operations. Provides functionality for controlling the machining process, handling optimization options, and managing session state. Implements to clean up on session end.">
|
||||
<link rel="icon" href="../img/HiAPI.favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
@@ -99,12 +99,13 @@ Class MachiningSession
|
||||
|
||||
<div class="markdown summary"><p>Represents a machining session that manages the execution and optimization of machining operations.
|
||||
Provides functionality for controlling the machining process, handling optimization options,
|
||||
and managing session state.</p>
|
||||
and managing session state. Implements <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a> to clean up
|
||||
<a class="xref" href="Hi.MachiningProcs.MachiningSession.html#Hi_MachiningProcs_MachiningSession_SessionWriters">SessionWriters</a> on session end.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class MachiningSession</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class MachiningSession : IDisposable</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -118,6 +119,12 @@ and managing session state.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
@@ -244,6 +251,40 @@ and managing session state.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningSession_FileIndexOnRunCommand_" data-uid="Hi.MachiningProcs.MachiningSession.FileIndexOnRunCommand*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningSession_FileIndexOnRunCommand" data-uid="Hi.MachiningProcs.MachiningSession.FileIndexOnRunCommand">
|
||||
FileIndexOnRunCommand
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>File index counter, auto-incremented per <a class="xref" href="Hi.Numerical.IControlRunner.html#Hi_Numerical_IControlRunner_RunControlLines_System_String_System_Collections_Generic_IEnumerable_System_String__Hi_MachiningProcs_MachiningSession_Hi_MachiningProcs_SessionProgress_System_Threading_CancellationToken_">RunControlLines(string, IEnumerable<string>, MachiningSession, SessionProgress, CancellationToken)</a>
|
||||
call within this session. Replaces the previous per-runner counter so that file
|
||||
indices are scoped to a session and reset naturally when a new session begins.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int FileIndexOnRunCommand { 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_MachiningProcs_MachiningSession_IsNcOptOptionListUpdatedByStep_" data-uid="Hi.MachiningProcs.MachiningSession.IsNcOptOptionListUpdatedByStep*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningSession_IsNcOptOptionListUpdatedByStep" data-uid="Hi.MachiningProcs.MachiningSession.IsNcOptOptionListUpdatedByStep">
|
||||
@@ -308,6 +349,40 @@ and managing session state.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningSession_NcRunnerSessionState_" data-uid="Hi.MachiningProcs.MachiningSession.NcRunnerSessionState*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningSession_NcRunnerSessionState" data-uid="Hi.MachiningProcs.MachiningSession.NcRunnerSessionState">
|
||||
NcRunnerSessionState
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Per-session NC pipeline state shared across <a class="xref" href="Hi.Numerical.IControlRunner.html#Hi_Numerical_IControlRunner_RunControlLines_System_String_System_Collections_Generic_IEnumerable_System_String__Hi_MachiningProcs_MachiningSession_Hi_MachiningProcs_SessionProgress_System_Threading_CancellationToken_">RunControlLines(string, IEnumerable<string>, MachiningSession, SessionProgress, CancellationToken)</a>
|
||||
calls. Holds lazy-initialized <a class="xref" href="Hi.NcParsers.NcDiagnosticProgress.html">NcDiagnosticProgress</a> and the per-layer
|
||||
<a class="xref" href="Hi.Common.Collections.LazyLinkedList-1.html">LazyLinkedList<T></a> chain used for cross-file modal continuity.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public NcRunnerSessionState NcRunnerSessionState { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.MachiningProcs.NcRunnerSessionState.html">NcRunnerSessionState</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningSession_PacePlayee_" data-uid="Hi.MachiningProcs.MachiningSession.PacePlayee*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningSession_PacePlayee" data-uid="Hi.MachiningProcs.MachiningSession.PacePlayee">
|
||||
@@ -340,6 +415,109 @@ and managing session state.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningSession_PostBlockScripts_" data-uid="Hi.MachiningProcs.MachiningSession.PostBlockScripts*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningSession_PostBlockScripts" data-uid="Hi.MachiningProcs.MachiningSession.PostBlockScripts">
|
||||
PostBlockScripts
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Per-line scripts injected externally (without modifying NC files).
|
||||
Key: <a class="xref" href="Hi.Common.FileLines.FileLineIndex.html">FileLineIndex</a> of the NC block.
|
||||
Value: C# script text to execute <b>after</b> the NC block.
|
||||
Consumed by <a class="xref" href="Hi.NcParsers.Semantics.CsScriptEndSemantic.html">CsScriptEndSemantic</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Dictionary<FileLineIndex, string> PostBlockScripts { 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="Hi.Common.FileLines.FileLineIndex.html">FileLineIndex</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningSession_PreBlockScripts_" data-uid="Hi.MachiningProcs.MachiningSession.PreBlockScripts*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningSession_PreBlockScripts" data-uid="Hi.MachiningProcs.MachiningSession.PreBlockScripts">
|
||||
PreBlockScripts
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Per-line scripts injected externally (without modifying NC files).
|
||||
Key: <a class="xref" href="Hi.Common.FileLines.FileLineIndex.html">FileLineIndex</a> of the NC block.
|
||||
Value: C# script text to execute <b>before</b> the NC block.
|
||||
Consumed by <a class="xref" href="Hi.NcParsers.Semantics.CsScriptBeginSemantic.html">CsScriptBeginSemantic</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Dictionary<FileLineIndex, string> PreBlockScripts { 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="Hi.Common.FileLines.FileLineIndex.html">FileLineIndex</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningSession_SessionWriters_" data-uid="Hi.MachiningProcs.MachiningSession.SessionWriters*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningSession_SessionWriters" data-uid="Hi.MachiningProcs.MachiningSession.SessionWriters">
|
||||
SessionWriters
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>StreamWriters registered during the session (e.g. by diagnostic output methods).
|
||||
Key: relative output file path. Disposed automatically when the session ends.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Dictionary<string, StreamWriter> SessionWriters { 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.io.streamwriter">StreamWriter</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningSession_StepIndexToNcOptOptionSortedList_" data-uid="Hi.MachiningProcs.MachiningSession.StepIndexToNcOptOptionSortedList*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningSession_StepIndexToNcOptOptionSortedList" data-uid="Hi.MachiningProcs.MachiningSession.StepIndexToNcOptOptionSortedList">
|
||||
@@ -437,6 +615,33 @@ Takes effect during internal optimization process.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningSession_Dispose_" data-uid="Hi.MachiningProcs.MachiningSession.Dispose*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningSession_Dispose" data-uid="Hi.MachiningProcs.MachiningSession.Dispose">
|
||||
Dispose()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningSession_EndPreserve_" data-uid="Hi.MachiningProcs.MachiningSession.EndPreserve*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningSession_EndPreserve" data-uid="Hi.MachiningProcs.MachiningSession.EndPreserve">
|
||||
@@ -491,6 +696,136 @@ Takes effect during internal optimization process.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningSession_RunMachiningStepBuilt_" data-uid="Hi.MachiningProcs.MachiningSession.RunMachiningStepBuilt*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningSession_RunMachiningStepBuilt_Hi_MachiningSteps_MachiningStep_Hi_MachiningSteps_MachiningStep_" data-uid="Hi.MachiningProcs.MachiningSession.RunMachiningStepBuilt(Hi.MachiningSteps.MachiningStep,Hi.MachiningSteps.MachiningStep)">
|
||||
RunMachiningStepBuilt(MachiningStep, MachiningStep)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Internal use only. Invokes <a class="xref" href="Hi.MachiningProcs.MachiningSession.html#Hi_MachiningProcs_MachiningSession_MachiningStepBuilt">MachiningStepBuilt</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void RunMachiningStepBuilt(MachiningStep preStep, MachiningStep curStep)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>preStep</code> <a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>curStep</code> <a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningSession_RunMachiningStepSelected_" data-uid="Hi.MachiningProcs.MachiningSession.RunMachiningStepSelected*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningSession_RunMachiningStepSelected_Hi_MachiningSteps_MachiningStep_" data-uid="Hi.MachiningProcs.MachiningSession.RunMachiningStepSelected(Hi.MachiningSteps.MachiningStep)">
|
||||
RunMachiningStepSelected(MachiningStep)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Internal use only. Invokes <a class="xref" href="Hi.MachiningProcs.MachiningSession.html#Hi_MachiningProcs_MachiningSession_MachiningStepSelected">MachiningStepSelected</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void RunMachiningStepSelected(MachiningStep machiningStep)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>machiningStep</code> <a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningSession_RunSourcedActEntry_" data-uid="Hi.MachiningProcs.MachiningSession.RunSourcedActEntry*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningSession_RunSourcedActEntry_Hi_Numerical_SourcedActEntry_" data-uid="Hi.MachiningProcs.MachiningSession.RunSourcedActEntry(Hi.Numerical.SourcedActEntry)">
|
||||
RunSourcedActEntry(SourcedActEntry)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Internal use only. Invokes <a class="xref" href="Hi.MachiningProcs.MachiningSession.html#Hi_MachiningProcs_MachiningSession_SourcedActEntry">SourcedActEntry</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void RunSourcedActEntry(SourcedActEntry entry)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>entry</code> <a class="xref" href="Hi.Numerical.SourcedActEntry.html">SourcedActEntry</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningSession_RunSyntaxPieceRan_" data-uid="Hi.MachiningProcs.MachiningSession.RunSyntaxPieceRan*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningSession_RunSyntaxPieceRan_Hi_NcParsers_Syntaxs_SyntaxPiece_" data-uid="Hi.MachiningProcs.MachiningSession.RunSyntaxPieceRan(Hi.NcParsers.Syntaxs.SyntaxPiece)">
|
||||
RunSyntaxPieceRan(SyntaxPiece)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Internal use only. Invokes <a class="xref" href="Hi.MachiningProcs.MachiningSession.html#Hi_MachiningProcs_MachiningSession_SyntaxPieceRan">SyntaxPieceRan</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void RunSyntaxPieceRan(SyntaxPiece syntaxPiece)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>syntaxPiece</code> <a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningSession_UpdateNcOptOptionMapIfNeeded_" data-uid="Hi.MachiningProcs.MachiningSession.UpdateNcOptOptionMapIfNeeded*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningSession_UpdateNcOptOptionMapIfNeeded_System_Int32_" data-uid="Hi.MachiningProcs.MachiningSession.UpdateNcOptOptionMapIfNeeded(System.Int32)">
|
||||
@@ -536,6 +871,68 @@ Internal use only.</p>
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningSession_MachiningStepBuilt" data-uid="Hi.MachiningProcs.MachiningSession.MachiningStepBuilt">
|
||||
MachiningStepBuilt
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Event triggered when a machining step is built.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public event MachiningActRunner.MachiningStepBuiltDelegate MachiningStepBuilt</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.MachiningProcs.MachiningActRunner.html">MachiningActRunner</a>.<a class="xref" href="Hi.MachiningProcs.MachiningActRunner.MachiningStepBuiltDelegate.html">MachiningStepBuiltDelegate</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningSession_MachiningStepSelected" data-uid="Hi.MachiningProcs.MachiningSession.MachiningStepSelected">
|
||||
MachiningStepSelected
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Event triggered when a machining step is selected.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public event Action<MachiningStep> MachiningStepSelected</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a><<a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningSession_OnCurrentLineEnd" data-uid="Hi.MachiningProcs.MachiningSession.OnCurrentLineEnd">
|
||||
OnCurrentLineEnd
|
||||
|
||||
@@ -568,6 +965,68 @@ The event buffer is cleared on every line change.</p>
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningSession_SourcedActEntry" data-uid="Hi.MachiningProcs.MachiningSession.SourcedActEntry">
|
||||
SourcedActEntry
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Event triggered for each <a class="xref" href="Hi.MachiningProcs.MachiningSession.html#Hi_MachiningProcs_MachiningSession_SourcedActEntry">SourcedActEntry</a> produced during NC/CSV execution.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public event Action<SourcedActEntry> SourcedActEntry</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a><<a class="xref" href="Hi.Numerical.SourcedActEntry.html">SourcedActEntry</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningSession_SyntaxPieceRan" data-uid="Hi.MachiningProcs.MachiningSession.SyntaxPieceRan">
|
||||
SyntaxPieceRan
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Event triggered when a syntax piece has been executed.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public event Action<SyntaxPiece> SyntaxPieceRan</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a><<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
|
||||
@@ -0,0 +1,382 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class NcRunnerSessionState | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class NcRunnerSessionState | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="NC pipeline state held on a and shared across multiple calls within that session. The per-layer are extended via for each subsequent file so that Previous/Next connectivity (and thus ModalCarrySyntax deep-clone) crosses file boundaries.">
|
||||
<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.MachiningProcs.NcRunnerSessionState">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_MachiningProcs_NcRunnerSessionState" data-uid="Hi.MachiningProcs.NcRunnerSessionState" class="text-break">
|
||||
Class NcRunnerSessionState
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.MachiningProcs.html">MachiningProcs</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>NC pipeline state held on a <a class="xref" href="Hi.MachiningProcs.MachiningSession.html">MachiningSession</a> and shared across multiple
|
||||
<a class="xref" href="Hi.Numerical.IControlRunner.html#Hi_Numerical_IControlRunner_RunControlLines_System_String_System_Collections_Generic_IEnumerable_System_String__Hi_MachiningProcs_MachiningSession_Hi_MachiningProcs_SessionProgress_System_Threading_CancellationToken_">RunControlLines(string, IEnumerable<string>, MachiningSession, SessionProgress, CancellationToken)</a> calls within that session. The per-layer
|
||||
<a class="xref" href="Hi.MachiningProcs.NcRunnerSessionState.html#Hi_MachiningProcs_NcRunnerSessionState_SyntaxPieceLayers">SyntaxPieceLayers</a> are extended via <a class="xref" href="Hi.Common.Collections.LazyLinkedList-1.html#Hi_Common_Collections_LazyLinkedList_1_AppendSource_System_Collections_Generic_IEnumerable__0__">AppendSource(IEnumerable<T>)</a>
|
||||
for each subsequent file so that <code>Previous</code>/<code>Next</code> connectivity (and thus
|
||||
<code>ModalCarrySyntax</code> deep-clone) crosses file boundaries.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public sealed class NcRunnerSessionState : IDisposable</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">NcRunnerSessionState</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</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.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="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_NcRunnerSessionState_IsInitialized_" data-uid="Hi.MachiningProcs.NcRunnerSessionState.IsInitialized*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_NcRunnerSessionState_IsInitialized" data-uid="Hi.MachiningProcs.NcRunnerSessionState.IsInitialized">
|
||||
IsInitialized
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>True after the first call has built the layered pipeline.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool IsInitialized { 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.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_NcRunnerSessionState_NcDiagnosticProgress_" data-uid="Hi.MachiningProcs.NcRunnerSessionState.NcDiagnosticProgress*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_NcRunnerSessionState_NcDiagnosticProgress" data-uid="Hi.MachiningProcs.NcRunnerSessionState.NcDiagnosticProgress">
|
||||
NcDiagnosticProgress
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Session-shared diagnostic sink. Built lazily on the first
|
||||
<a class="xref" href="Hi.Numerical.IControlRunner.html#Hi_Numerical_IControlRunner_RunControlLines_System_String_System_Collections_Generic_IEnumerable_System_String__Hi_MachiningProcs_MachiningSession_Hi_MachiningProcs_SessionProgress_System_Threading_CancellationToken_">RunControlLines(string, IEnumerable<string>, MachiningSession, SessionProgress, CancellationToken)</a> call.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public NcDiagnosticProgress NcDiagnosticProgress { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.NcParsers.NcDiagnosticProgress.html">NcDiagnosticProgress</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_NcRunnerSessionState_SyntaxPieceLayers_" data-uid="Hi.MachiningProcs.NcRunnerSessionState.SyntaxPieceLayers*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_NcRunnerSessionState_SyntaxPieceLayers" data-uid="Hi.MachiningProcs.NcRunnerSessionState.SyntaxPieceLayers">
|
||||
SyntaxPieceLayers
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>One <a class="xref" href="Hi.Common.Collections.LazyLinkedList-1.html">LazyLinkedList<T></a> per pipeline layer.
|
||||
Index 0 is the source layer (init seed + sentence-derived pieces);
|
||||
indices 1..NcSyntaxList.Count are the post-NcSyntax layers.
|
||||
Subsequent <a class="xref" href="Hi.Numerical.IControlRunner.html#Hi_Numerical_IControlRunner_RunControlLines_System_String_System_Collections_Generic_IEnumerable_System_String__Hi_MachiningProcs_MachiningSession_Hi_MachiningProcs_SessionProgress_System_Threading_CancellationToken_">RunControlLines(string, IEnumerable<string>, MachiningSession, SessionProgress, CancellationToken)</a> calls extend each layer
|
||||
in place via <a class="xref" href="Hi.Common.Collections.LazyLinkedList-1.html#Hi_Common_Collections_LazyLinkedList_1_AppendSource_System_Collections_Generic_IEnumerable__0__">AppendSource(IEnumerable<T>)</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public List<LazyLinkedList<SyntaxPiece>> SyntaxPieceLayers { 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.collections.generic.list-1">List</a><<a class="xref" href="Hi.Common.Collections.LazyLinkedList-1.html">LazyLinkedList</a><<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a>>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_NcRunnerSessionState_Dispose_" data-uid="Hi.MachiningProcs.NcRunnerSessionState.Dispose*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_NcRunnerSessionState_Dispose" data-uid="Hi.MachiningProcs.NcRunnerSessionState.Dispose">
|
||||
Dispose()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_NcRunnerSessionState_Reset_" data-uid="Hi.MachiningProcs.NcRunnerSessionState.Reset*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_NcRunnerSessionState_Reset" data-uid="Hi.MachiningProcs.NcRunnerSessionState.Reset">
|
||||
Reset()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Drops the per-layer pipeline state and the cached diagnostic sink so
|
||||
the next <a class="xref" href="Hi.Numerical.IControlRunner.html#Hi_Numerical_IControlRunner_RunControlLines_System_String_System_Collections_Generic_IEnumerable_System_String__Hi_MachiningProcs_MachiningSession_Hi_MachiningProcs_SessionProgress_System_Threading_CancellationToken_">RunControlLines(string, IEnumerable<string>, MachiningSession, SessionProgress, CancellationToken)</a> call re-builds
|
||||
from scratch. Use this for a controller power reset (where in-flight
|
||||
SyntaxPiece JSON dataflow — including <code>Vars.Volatile</code>, modal
|
||||
carries, and the init seed — must vanish) without disposing the
|
||||
owning <a class="xref" href="Hi.MachiningProcs.MachiningSession.html">MachiningSession</a> itself.</p>
|
||||
<p>
|
||||
Idempotent and reusable: after <a class="xref" href="Hi.MachiningProcs.NcRunnerSessionState.html#Hi_MachiningProcs_NcRunnerSessionState_Reset">Reset()</a> the object is in
|
||||
the same lazy-uninitialised state as a freshly constructed instance,
|
||||
so the first subsequent <code>RunControlLines</code> hits the
|
||||
<code>!IsInitialized</code> branch and re-creates everything.
|
||||
</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void Reset()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
@@ -652,6 +652,40 @@ Don't apply this option.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_RuntimeApi_EnableSoftNcRunner_" data-uid="Hi.MachiningProcs.RuntimeApi.EnableSoftNcRunner*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_RuntimeApi_EnableSoftNcRunner" data-uid="Hi.MachiningProcs.RuntimeApi.EnableSoftNcRunner">
|
||||
EnableSoftNcRunner
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Workaround flag to use <a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a> instead of <a class="xref" href="Hi.Numerical.FilePlayers.HardNcRunner.html">HardNcRunner</a>.
|
||||
Will be removed when <a class="xref" href="Hi.Numerical.FilePlayers.HardNcRunner.html">HardNcRunner</a> is fully replaced.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[JsAce(DocContentHtml = "Enable SoftNcRunner instead of legacy HardNcRunner.")]
|
||||
public bool EnableSoftNcRunner { 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.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_RuntimeApi_EnableWearEffect_" data-uid="Hi.MachiningProcs.RuntimeApi.EnableWearEffect*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_RuntimeApi_EnableWearEffect" data-uid="Hi.MachiningProcs.RuntimeApi.EnableWearEffect">
|
||||
@@ -1985,13 +2019,47 @@ public double OptYieldingUtilizationFactor { get; set; }</code></pre>
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Obsolete alias for <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_SessionProgress">SessionProgress</a> (session-scoped progress and messages).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[JsAce]
|
||||
[Obsolete("Use SessionProgress instead.")]
|
||||
public SessionProgress SessionMessageHost { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.MachiningProcs.SessionProgress.html">SessionProgress</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_RuntimeApi_SessionProgress_" data-uid="Hi.MachiningProcs.RuntimeApi.SessionProgress*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_RuntimeApi_SessionProgress" data-uid="Hi.MachiningProcs.RuntimeApi.SessionProgress">
|
||||
SessionProgress
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the session message host for displaying messages.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[JsAce]
|
||||
public SessionProgress SessionMessageHost { get; }</code></pre>
|
||||
public SessionProgress SessionProgress { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -3360,6 +3428,36 @@ public void PlayToolingTeleport(int toolId)</code></pre>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_RuntimeApi_PowerReset_" data-uid="Hi.MachiningProcs.RuntimeApi.PowerReset*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_RuntimeApi_PowerReset" data-uid="Hi.MachiningProcs.RuntimeApi.PowerReset">
|
||||
PowerReset()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Performs a controller power reset: every <a class="xref" href="Hi.NcParsers.Dependencys.IPowerResettable.html">IPowerResettable</a> dependency
|
||||
in the active <code>NcDependencyList</code> clears its volatile subset (e.g. Fanuc
|
||||
common volatile macro variables <code>#100-#499</code>). Persistent state is left intact.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[JsAce("PowerReset();")]
|
||||
public void PowerReset()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_RuntimeApi_Preserve_" data-uid="Hi.MachiningProcs.RuntimeApi.Preserve*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_RuntimeApi_Preserve" data-uid="Hi.MachiningProcs.RuntimeApi.Preserve">
|
||||
@@ -3577,6 +3675,76 @@ public void RegisterStepVariable(string key, string name, string unit, string fo
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_RuntimeApi_RegisterWriteSyntaxPieces_" data-uid="Hi.MachiningProcs.RuntimeApi.RegisterWriteSyntaxPieces*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_RuntimeApi_RegisterWriteSyntaxPieces_System_String_" data-uid="Hi.MachiningProcs.RuntimeApi.RegisterWriteSyntaxPieces(System.String)">
|
||||
RegisterWriteSyntaxPieces(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Registers a text writer so each executed <a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a> is appended to
|
||||
<code class="paramref">relOutputFile</code> under the machining project base directory for debugging.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[JsAce(Snippet = "RegisterWriteSyntaxPieces($1\"Cache/syntax-pieces-output.txt\")")]
|
||||
public void RegisterWriteSyntaxPieces(string relOutputFile)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>relOutputFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>Relative path for the output log file.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_RuntimeApi_RegisterWriteSyntaxPiecesWithActs_" data-uid="Hi.MachiningProcs.RuntimeApi.RegisterWriteSyntaxPiecesWithActs*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_RuntimeApi_RegisterWriteSyntaxPiecesWithActs_System_String_" data-uid="Hi.MachiningProcs.RuntimeApi.RegisterWriteSyntaxPiecesWithActs(System.String)">
|
||||
RegisterWriteSyntaxPiecesWithActs(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Registers a writer that outputs each <a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a> once,
|
||||
followed by its associated <a class="xref" href="Hi.Numerical.Acts.IAct.html">IAct</a> entries (one-to-many).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[JsAce(Snippet = "RegisterWriteSyntaxPiecesWithActs($1\"Cache/syntax-pieces-acts-output.txt\")")]
|
||||
public void RegisterWriteSyntaxPiecesWithActs(string relOutputFile)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>relOutputFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>Output file path relative to <a class="xref" href="Hi.MachiningProcs.MachiningProject.html#Hi_MachiningProcs_MachiningProject_BaseDirectory">BaseDirectory</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_RuntimeApi_RemoveFlyPiece_" data-uid="Hi.MachiningProcs.RuntimeApi.RemoveFlyPiece*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_RuntimeApi_RemoveFlyPiece" data-uid="Hi.MachiningProcs.RuntimeApi.RemoveFlyPiece">
|
||||
@@ -3820,6 +3988,42 @@ public bool? ScanRuntimeGeomInfDefect()</code></pre>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_RuntimeApi_SetAllSnapshotSyntaxEnabled_" data-uid="Hi.MachiningProcs.RuntimeApi.SetAllSnapshotSyntaxEnabled*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_RuntimeApi_SetAllSnapshotSyntaxEnabled_System_Boolean_" data-uid="Hi.MachiningProcs.RuntimeApi.SetAllSnapshotSyntaxEnabled(System.Boolean)">
|
||||
SetAllSnapshotSyntaxEnabled(bool)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Sets <code>IsEnabled</code> on every <code>SnapshotSyntax</code> reachable from the
|
||||
active <a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a>'s <code>NcSyntaxList</code> (top-level slots
|
||||
and inside <code>BundleSyntax</code>). No-op when <a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a>
|
||||
is not the active runner.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[JsAce(DocContentHtml = "Enable or disable every SnapshotSyntax in the active SoftNcRunner pipeline at once.")]
|
||||
public void SetAllSnapshotSyntaxEnabled(bool isEnabled)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>isEnabled</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_RuntimeApi_SetNcResolutionFeedPerCycle_" data-uid="Hi.MachiningProcs.RuntimeApi.SetNcResolutionFeedPerCycle*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_RuntimeApi_SetNcResolutionFeedPerCycle" data-uid="Hi.MachiningProcs.RuntimeApi.SetNcResolutionFeedPerCycle">
|
||||
@@ -4327,13 +4531,14 @@ public void WriteStepFiles(string relFileTemplate = "Output/[NcName].step.c
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets or sets the action to configure steps during execution.
|
||||
The event will be cleared by the calling of <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_ResetRuntime">ResetRuntime()</a>.</p>
|
||||
<div class="markdown level1 summary"><p>Session-scoped event triggered when a machining step is built.
|
||||
Lifetime is bound to <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_MachiningSession">MachiningSession</a>: created by <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_BeginSession">BeginSession()</a>, released by <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_EndSession">EndSession()</a>.
|
||||
For app-lifetime event, use <a class="xref" href="Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_MachiningStepBuilt">MachiningStepBuilt</a> instead.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[JsAce(Snippet = "MachiningStepBuilt+=($1preStep,$2curStep)=>{$3Command};", DocContentHtml = "Runtime Step Configuration action. preStep is the Previous Milling Step; curStep is the Current Milling Step. preStep is null if no previous step existed.")]
|
||||
<pre><code class="lang-csharp hljs">[Obsolete("Use SessionStepBuilt instead.")]
|
||||
public event MachiningActRunner.MachiningStepBuiltDelegate MachiningStepBuilt</code></pre>
|
||||
</div>
|
||||
|
||||
@@ -4360,13 +4565,13 @@ public event MachiningActRunner.MachiningStepBuiltDelegate MachiningStepBuilt</c
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Event that is triggered when a milling step is selected.
|
||||
The event will be cleared by the calling of <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_ResetRuntime">ResetRuntime()</a>.</p>
|
||||
<div class="markdown level1 summary"><p>Session-scoped event triggered when a machining step is selected.
|
||||
Lifetime is bound to <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_MachiningSession">MachiningSession</a>: created by <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_BeginSession">BeginSession()</a>, released by <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_EndSession">EndSession()</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[JsAce(Snippet = "MachiningStepSelected+=($1millingStep)=>{$2Command};")]
|
||||
<pre><code class="lang-csharp hljs">[Obsolete("Use SessionStepSelected instead.")]
|
||||
public event Action<MachiningStep> MachiningStepSelected</code></pre>
|
||||
</div>
|
||||
|
||||
@@ -4388,6 +4593,172 @@ public event Action<MachiningStep> MachiningStepSelected</code></pre>
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_MachiningProcs_RuntimeApi_SessionSourcedActEntry" data-uid="Hi.MachiningProcs.RuntimeApi.SessionSourcedActEntry">
|
||||
SessionSourcedActEntry
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Session-scoped event triggered for each <a class="xref" href="Hi.Numerical.SourcedActEntry.html">SourcedActEntry</a> produced during NC/CSV execution.
|
||||
Lifetime is bound to <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_MachiningSession">MachiningSession</a>: created by <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_BeginSession">BeginSession()</a>, released by <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_EndSession">EndSession()</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[JsAce(Snippet = "SessionSourcedActEntry+=($1entry)=>{$2Command};", DocContentHtml = "Session-scoped event triggered for each SourcedActEntry. entry.SentenceSource is the source sentence; entry.Act is the associated act (may be null).")]
|
||||
public event Action<SourcedActEntry> SessionSourcedActEntry</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a><<a class="xref" href="Hi.Numerical.SourcedActEntry.html">SourcedActEntry</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_MachiningProcs_RuntimeApi_SessionStepBuilt" data-uid="Hi.MachiningProcs.RuntimeApi.SessionStepBuilt">
|
||||
SessionStepBuilt
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Session-scoped event triggered when a machining step is built.
|
||||
Lifetime is bound to <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_MachiningSession">MachiningSession</a>: created by <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_BeginSession">BeginSession()</a>, released by <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_EndSession">EndSession()</a>.
|
||||
For app-lifetime event, use <a class="xref" href="Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_MachiningStepBuilt">MachiningStepBuilt</a> instead.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[JsAce(Snippet = "SessionStepBuilt+=($1preStep,$2curStep)=>{$3Command};", DocContentHtml = "Session-scoped step built event. preStep is the Previous Milling Step; curStep is the Current Milling Step. preStep is null if no previous step existed.")]
|
||||
public event MachiningActRunner.MachiningStepBuiltDelegate SessionStepBuilt</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.MachiningProcs.MachiningActRunner.html">MachiningActRunner</a>.<a class="xref" href="Hi.MachiningProcs.MachiningActRunner.MachiningStepBuiltDelegate.html">MachiningStepBuiltDelegate</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_MachiningProcs_RuntimeApi_SessionStepSelected" data-uid="Hi.MachiningProcs.RuntimeApi.SessionStepSelected">
|
||||
SessionStepSelected
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Session-scoped event triggered when a machining step is selected.
|
||||
Lifetime is bound to <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_MachiningSession">MachiningSession</a>: created by <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_BeginSession">BeginSession()</a>, released by <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_EndSession">EndSession()</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[JsAce(Snippet = "SessionStepSelected+=($1millingStep)=>{$2Command};")]
|
||||
public event Action<MachiningStep> SessionStepSelected</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a><<a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_MachiningProcs_RuntimeApi_SessionSyntaxPieceRan" data-uid="Hi.MachiningProcs.RuntimeApi.SessionSyntaxPieceRan">
|
||||
SessionSyntaxPieceRan
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Session-scoped event triggered when a syntax piece has been executed.
|
||||
Lifetime is bound to <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_MachiningSession">MachiningSession</a>: created by <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_BeginSession">BeginSession()</a>, released by <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_EndSession">EndSession()</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[JsAce(Snippet = "SessionSyntaxPieceRan+=($1syntaxPiece)=>{$2Command};", DocContentHtml = "Session-scoped event triggered after each SyntaxPiece is executed. syntaxPiece may be null if the source command is not a SyntaxPiece.")]
|
||||
public event Action<SyntaxPiece> SessionSyntaxPieceRan</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a><<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_MachiningProcs_RuntimeApi_SyntaxPieceRan" data-uid="Hi.MachiningProcs.RuntimeApi.SyntaxPieceRan">
|
||||
SyntaxPieceRan
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Session-scoped event triggered when a syntax piece has been executed.
|
||||
Lifetime is bound to <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_MachiningSession">MachiningSession</a>: created by <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_BeginSession">BeginSession()</a>, released by <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_EndSession">EndSession()</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[Obsolete("Use SessionSyntaxPieceRan instead.")]
|
||||
public event Action<SyntaxPiece> SyntaxPieceRan</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a><<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
|
||||
@@ -2339,7 +2339,7 @@ public double OptYieldingUtilizationFactor { get; set; }</code></pre>
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p><a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_SessionMessageHost">SessionMessageHost</a></p>
|
||||
<div class="markdown level1 summary"><p><a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_SessionProgress">SessionProgress</a></p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
|
||||
@@ -708,8 +708,8 @@ public class SetupController : ControllerBase</code></pre>
|
||||
|
||||
<a id="Hi_MachiningProcs_SetupController__ctor_" data-uid="Hi.MachiningProcs.SetupController.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_SetupController__ctor_Hi_MachiningProcs_LocalProjectService_" data-uid="Hi.MachiningProcs.SetupController.#ctor(Hi.MachiningProcs.LocalProjectService)">
|
||||
SetupController(LocalProjectService)
|
||||
<h3 id="Hi_MachiningProcs_SetupController__ctor_Hi_MachiningProcs_LocalProjectService_Microsoft_Extensions_Logging_ILogger_Hi_MachiningProcs_SetupController__" data-uid="Hi.MachiningProcs.SetupController.#ctor(Hi.MachiningProcs.LocalProjectService,Microsoft.Extensions.Logging.ILogger{Hi.MachiningProcs.SetupController})">
|
||||
SetupController(LocalProjectService, ILogger<SetupController>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -718,14 +718,15 @@ public class SetupController : ControllerBase</code></pre>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public SetupController(LocalProjectService projectService)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public SetupController(LocalProjectService projectService, ILogger<SetupController> logger)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>projectService</code> <a class="xref" href="Hi.MachiningProcs.LocalProjectService.html">LocalProjectService</a></dt>
|
||||
<dd><p>The project service.</p>
|
||||
</dd>
|
||||
<dd></dd>
|
||||
<dt><code>logger</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.ilogger-1">ILogger</a><<a class="xref" href="Hi.MachiningProcs.SetupController.html">SetupController</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
@@ -211,45 +211,6 @@ Class SpindleSpeedCache
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_SpindleSpeedCache__ctor_" data-uid="Hi.MachiningProcs.SpindleSpeedCache.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_SpindleSpeedCache__ctor_Hi_Milling_SpindleCapability_Hi_MachiningSteps_MachineMotionStep_Hi_MachiningProcs_SpindleSpeedCache_" data-uid="Hi.MachiningProcs.SpindleSpeedCache.#ctor(Hi.Milling.SpindleCapability,Hi.MachiningSteps.MachineMotionStep,Hi.MachiningProcs.SpindleSpeedCache)">
|
||||
SpindleSpeedCache(SpindleCapability, MachineMotionStep, SpindleSpeedCache)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance based on spindle capability and machine motion step.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public SpindleSpeedCache(SpindleCapability spindleCapability, MachineMotionStep machineMotionStep, SpindleSpeedCache preSpindleSpeedCache)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>spindleCapability</code> <a class="xref" href="Hi.Milling.SpindleCapability.html">SpindleCapability</a></dt>
|
||||
<dd><p>The spindle capability information.</p>
|
||||
</dd>
|
||||
<dt><code>machineMotionStep</code> <a class="xref" href="Hi.MachiningSteps.MachineMotionStep.html">MachineMotionStep</a></dt>
|
||||
<dd><p>The machine motion step.</p>
|
||||
</dd>
|
||||
<dt><code>preSpindleSpeedCache</code> <a class="xref" href="Hi.MachiningProcs.SpindleSpeedCache.html">SpindleSpeedCache</a></dt>
|
||||
<dd><p>The previous spindle speed cache, used for optimization.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_SpindleSpeedCache__ctor_" data-uid="Hi.MachiningProcs.SpindleSpeedCache.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_SpindleSpeedCache__ctor_System_Double_System_Double_System_Double_System_Double_System_Double_System_Double_System_Double_System_Double_" data-uid="Hi.MachiningProcs.SpindleSpeedCache.#ctor(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)">
|
||||
@@ -564,6 +525,55 @@ Class SpindleSpeedCache
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_SpindleSpeedCache_Create_" data-uid="Hi.MachiningProcs.SpindleSpeedCache.Create*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_SpindleSpeedCache_Create_Hi_Milling_SpindleCapability_Hi_MachiningSteps_MachineMotionStep_Hi_MachiningProcs_SpindleSpeedCache_System_Action_System_String__" data-uid="Hi.MachiningProcs.SpindleSpeedCache.Create(Hi.Milling.SpindleCapability,Hi.MachiningSteps.MachineMotionStep,Hi.MachiningProcs.SpindleSpeedCache,System.Action{System.String})">
|
||||
Create(SpindleCapability, MachineMotionStep, SpindleSpeedCache, Action<string>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Creates a <a class="xref" href="Hi.MachiningProcs.SpindleSpeedCache.html">SpindleSpeedCache</a> from spindle capability and machine motion step.
|
||||
Returns <code class="paramref">preSpindleSpeedCache</code> if the spindle speed is unchanged
|
||||
or the capability data is incomplete.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static SpindleSpeedCache Create(SpindleCapability spindleCapability, MachineMotionStep machineMotionStep, SpindleSpeedCache preSpindleSpeedCache, Action<string> onWarning)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>spindleCapability</code> <a class="xref" href="Hi.Milling.SpindleCapability.html">SpindleCapability</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>machineMotionStep</code> <a class="xref" href="Hi.MachiningSteps.MachineMotionStep.html">MachineMotionStep</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>preSpindleSpeedCache</code> <a class="xref" href="Hi.MachiningProcs.SpindleSpeedCache.html">SpindleSpeedCache</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>onWarning</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.MachiningProcs.SpindleSpeedCache.html">SpindleSpeedCache</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
|
||||
@@ -141,12 +141,22 @@ such as sweeping, subtraction, force calculation, and physics simulation.</p>
|
||||
<dt><a class="xref" href="Hi.MachiningProcs.MachiningSession.html">MachiningSession</a></dt>
|
||||
<dd><p>Represents a machining session that manages the execution and optimization of machining operations.
|
||||
Provides functionality for controlling the machining process, handling optimization options,
|
||||
and managing session state.</p>
|
||||
and managing session state. Implements <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a> to clean up
|
||||
<a class="xref" href="Hi.MachiningProcs.MachiningSession.html#Hi_MachiningProcs_MachiningSession_SessionWriters">SessionWriters</a> on session end.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.MachiningProcs.MillingUtil.html">MillingUtil</a></dt>
|
||||
<dd><p>Provides utility methods for milling calculations and operations.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.MachiningProcs.NcRunnerSessionState.html">NcRunnerSessionState</a></dt>
|
||||
<dd><p>NC pipeline state held on a <a class="xref" href="Hi.MachiningProcs.MachiningSession.html">MachiningSession</a> and shared across multiple
|
||||
<a class="xref" href="Hi.Numerical.IControlRunner.html#Hi_Numerical_IControlRunner_RunControlLines_System_String_System_Collections_Generic_IEnumerable_System_String__Hi_MachiningProcs_MachiningSession_Hi_MachiningProcs_SessionProgress_System_Threading_CancellationToken_">RunControlLines(string, IEnumerable<string>, MachiningSession, SessionProgress, CancellationToken)</a> calls within that session. The per-layer
|
||||
<a class="xref" href="Hi.MachiningProcs.NcRunnerSessionState.html#Hi_MachiningProcs_NcRunnerSessionState_SyntaxPieceLayers">SyntaxPieceLayers</a> are extended via <a class="xref" href="Hi.Common.Collections.LazyLinkedList-1.html#Hi_Common_Collections_LazyLinkedList_1_AppendSource_System_Collections_Generic_IEnumerable__0__">AppendSource(IEnumerable<T>)</a>
|
||||
for each subsequent file so that <code>Previous</code>/<code>Next</code> connectivity (and thus
|
||||
<code>ModalCarrySyntax</code> deep-clone) crosses file boundaries.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
|
||||
@@ -218,8 +218,8 @@ Note that the spindle information is only for milling behavior.</p>
|
||||
|
||||
<a id="Hi_MachiningSteps_MachineMotionStep__ctor_" data-uid="Hi.MachiningSteps.MachineMotionStep.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningSteps_MachineMotionStep__ctor_System_TimeSpan_System_TimeSpan_System_Double_System_Double___System_Double_System_Double_Hi_Numerical_SpindleDirection_System_Int32_Hi_Geom_Mat4d_Hi_Geom_Mat4d_Hi_Common_SeqPair_Hi_Geom_Mat4d__" data-uid="Hi.MachiningSteps.MachineMotionStep.#ctor(System.TimeSpan,System.TimeSpan,System.Double,System.Double[],System.Double,System.Double,Hi.Numerical.SpindleDirection,System.Int32,Hi.Geom.Mat4d,Hi.Geom.Mat4d,Hi.Common.SeqPair{Hi.Geom.Mat4d})">
|
||||
MachineMotionStep(TimeSpan, TimeSpan, double, double[], double, double, SpindleDirection, int, Mat4d, Mat4d, SeqPair<Mat4d>)
|
||||
<h3 id="Hi_MachiningSteps_MachineMotionStep__ctor_System_TimeSpan_System_TimeSpan_System_Double_System_Double___System_Double_System_Double_Hi_Numerical_SpindleDirection_Hi_Numerical_CoolantMode_System_Int32_Hi_Geom_Mat4d_Hi_Geom_Mat4d_Hi_Common_SeqPair_Hi_Geom_Mat4d__" data-uid="Hi.MachiningSteps.MachineMotionStep.#ctor(System.TimeSpan,System.TimeSpan,System.Double,System.Double[],System.Double,System.Double,Hi.Numerical.SpindleDirection,Hi.Numerical.CoolantMode,System.Int32,Hi.Geom.Mat4d,Hi.Geom.Mat4d,Hi.Common.SeqPair{Hi.Geom.Mat4d})">
|
||||
MachineMotionStep(TimeSpan, TimeSpan, double, double[], double, double, SpindleDirection, CoolantMode, int, Mat4d, Mat4d, SeqPair<Mat4d>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -228,7 +228,7 @@ Note that the spindle information is only for milling behavior.</p>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MachineMotionStep(TimeSpan stepDuration, TimeSpan accumulatedTime, double beginSpindleAngle_rad, double[] mcValues, double feedrate_mmds, double spindleSpeed_radds, SpindleDirection spindleDirection, int toolId, Mat4d programZeroToWorkpieceGeomToMat4d, Mat4d workpieceGeomToProgramZeroMat4d, SeqPair<Mat4d> seqOnWorkpieceGeomCoordinate)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public MachineMotionStep(TimeSpan stepDuration, TimeSpan accumulatedTime, double beginSpindleAngle_rad, double[] mcValues, double feedrate_mmds, double spindleSpeed_radds, SpindleDirection spindleDirection, CoolantMode coolantMode, int toolId, Mat4d programZeroToWorkpieceGeomToMat4d, Mat4d workpieceGeomToProgramZeroMat4d, SeqPair<Mat4d> seqOnWorkpieceGeomCoordinate)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -253,6 +253,9 @@ Note that the spindle information is only for milling behavior.</p>
|
||||
</dd>
|
||||
<dt><code>spindleDirection</code> <a class="xref" href="Hi.Numerical.SpindleDirection.html">SpindleDirection</a></dt>
|
||||
<dd><p>The direction of spindle rotation.</p>
|
||||
</dd>
|
||||
<dt><code>coolantMode</code> <a class="xref" href="Hi.Numerical.CoolantMode.html">CoolantMode</a></dt>
|
||||
<dd><p>The coolant delivery mode active for this step.</p>
|
||||
</dd>
|
||||
<dt><code>toolId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The ID of the tool being used.</p>
|
||||
@@ -572,6 +575,40 @@ The value is <a class="xref" href="Hi.MachiningSteps.MachineMotionStep.html#Hi_M
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningSteps_MachineMotionStep_CoolantMode_" data-uid="Hi.MachiningSteps.MachineMotionStep.CoolantMode*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningSteps_MachineMotionStep_CoolantMode" data-uid="Hi.MachiningSteps.MachineMotionStep.CoolantMode">
|
||||
CoolantMode
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets or sets the coolant delivery mode active for this step.
|
||||
Read by <a class="xref" href="Hi.Physics.SeqPhysicsBrief.html#Hi_Physics_SeqPhysicsBrief_BuildCuttingTemperatureAndWear_Hi_Physics_SeqPhysicsBrief_Hi_MachiningSteps_MachineMotionStep_Hi_MachiningSteps_MachineMotionStep_System_Double_Hi_Milling_SpindleCapability_Hi_Machining_IMachiningTool_Hi_NcMech_Workpieces_Workpiece_System_Int32_Hi_Cbtr_Substraction_Hi_Milling_Engagements_LayerMillingEngagement_Hi_MillingForces_MillingPhysicsBrief_Hi_Physics_CoolantHeatCondition_Hi_Numerical_CoolantMode_System_Boolean_">BuildCuttingTemperatureAndWear(SeqPhysicsBrief, MachineMotionStep, MachineMotionStep, double, SpindleCapability, IMachiningTool, Workpiece, int, Substraction, LayerMillingEngagement, MillingPhysicsBrief, CoolantHeatCondition, CoolantMode, bool)</a>
|
||||
to pick the effective convection coefficient on the temperature FEM.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public CoolantMode CoolantMode { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.Numerical.CoolantMode.html">CoolantMode</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningSteps_MachineMotionStep_CyclePeriod_" data-uid="Hi.MachiningSteps.MachineMotionStep.CyclePeriod*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningSteps_MachineMotionStep_CyclePeriod" data-uid="Hi.MachiningSteps.MachineMotionStep.CyclePeriod">
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class MappingUtil | HiAPI-C# 2025 ">
|
||||
|
||||
|
||||
<meta name="description" content="Shared CSV column tags and physics-related column prefixes for mapping simulator or logged controller data onto rows.">
|
||||
<link rel="icon" href="../img/HiAPI.favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
@@ -97,7 +97,9 @@ Class MappingUtil
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"></div>
|
||||
<div class="markdown summary"><p>Shared CSV column tags and physics-related column prefixes for mapping simulator or
|
||||
logged controller data onto <a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a> rows.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
@@ -314,7 +316,8 @@ The actual time basically obtained by the external data from controller.</p>
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>CSV column prefix for holder moment / torque channels.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
@@ -593,7 +596,8 @@ The time generally obtained by the simulated data.</p>
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>CSV column prefix for tool-side force components (e.g. dynamometer).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
@@ -654,7 +658,8 @@ The time generally obtained by the simulated data.</p>
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>CSV column prefix for workpiece-side force components.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
|
||||
@@ -107,7 +107,9 @@ This class manages the loading and caching of time shot data from measurement fi
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Mapping.MappingUtil.html">MappingUtil</a></dt>
|
||||
<dd></dd>
|
||||
<dd><p>Shared CSV column tags and physics-related column prefixes for mapping simulator or
|
||||
logged controller data onto <a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a> rows.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Mapping.StepTimeShotUtil.html">StepTimeShotUtil</a></dt>
|
||||
|
||||
@@ -240,8 +240,8 @@ Class GeneralMechanism
|
||||
|
||||
<a id="Hi_Mech_GeneralMechanism__ctor_" data-uid="Hi.Mech.GeneralMechanism.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Mech_GeneralMechanism__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.Mech.GeneralMechanism.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
GeneralMechanism(XElement, string)
|
||||
<h3 id="Hi_Mech_GeneralMechanism__ctor_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__" data-uid="Hi.Mech.GeneralMechanism.#ctor(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object})">
|
||||
GeneralMechanism(XElement, string, IProgress<object>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -250,7 +250,7 @@ Class GeneralMechanism
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public GeneralMechanism(XElement src, string baseDirectory)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public GeneralMechanism(XElement src, string baseDirectory, IProgress<object> progress)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -261,6 +261,8 @@ Class GeneralMechanism
|
||||
<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 file paths.</p>
|
||||
</dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
@@ -186,7 +186,8 @@ Interface IGetAnchorToSolidDictionary
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Warms <a class="xref" href="Hi.NcMech.Solids.Solid.html#Hi_NcMech_Solids_Solid_NativeSmoothTopoStl">NativeSmoothTopoStl</a> for every solid returned by <a class="xref" href="Hi.Mech.IGetAnchorToSolidDictionary.html#Hi_Mech_IGetAnchorToSolidDictionary_GetAnchorToSolidDictionary">GetAnchorToSolidDictionary()</a> (parallel).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
|
||||
@@ -536,8 +536,8 @@ Class Asmb
|
||||
|
||||
<a id="Hi_Mech_Topo_Asmb_CallAsmb_" data-uid="Hi.Mech.Topo.Asmb.CallAsmb*"></a>
|
||||
|
||||
<h3 id="Hi_Mech_Topo_Asmb_CallAsmb_System_Xml_Linq_XElement_System_String_System_Collections_Generic_Dictionary_System_Guid_Hi_Mech_Topo_Asmb__System_Collections_Generic_Dictionary_System_Guid_Hi_Mech_Topo_Anchor__System_Collections_Generic_Dictionary_System_Guid_Hi_Mech_Topo_Branch__" data-uid="Hi.Mech.Topo.Asmb.CallAsmb(System.Xml.Linq.XElement,System.String,System.Collections.Generic.Dictionary{System.Guid,Hi.Mech.Topo.Asmb},System.Collections.Generic.Dictionary{System.Guid,Hi.Mech.Topo.Anchor},System.Collections.Generic.Dictionary{System.Guid,Hi.Mech.Topo.Branch})">
|
||||
CallAsmb(XElement, string, Dictionary<Guid, Asmb>, Dictionary<Guid, Anchor>, Dictionary<Guid, Branch>)
|
||||
<h3 id="Hi_Mech_Topo_Asmb_CallAsmb_System_Xml_Linq_XElement_System_String_System_Collections_Generic_Dictionary_System_Guid_Hi_Mech_Topo_Asmb__System_Collections_Generic_Dictionary_System_Guid_Hi_Mech_Topo_Anchor__System_Collections_Generic_Dictionary_System_Guid_Hi_Mech_Topo_Branch__System_IProgress_System_Object__" data-uid="Hi.Mech.Topo.Asmb.CallAsmb(System.Xml.Linq.XElement,System.String,System.Collections.Generic.Dictionary{System.Guid,Hi.Mech.Topo.Asmb},System.Collections.Generic.Dictionary{System.Guid,Hi.Mech.Topo.Anchor},System.Collections.Generic.Dictionary{System.Guid,Hi.Mech.Topo.Branch},System.IProgress{System.Object})">
|
||||
CallAsmb(XElement, string, Dictionary<Guid, Asmb>, Dictionary<Guid, Anchor>, Dictionary<Guid, Branch>, IProgress<object>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -548,7 +548,7 @@ the members will be generated; otherwise, the existed members are applied.</p>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static Asmb CallAsmb(XElement asmbXml, string baseDirectory, Dictionary<Guid, Asmb> asmbs = null, Dictionary<Guid, Anchor> ancs = null, Dictionary<Guid, Branch> brns = null)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public static Asmb CallAsmb(XElement asmbXml, string baseDirectory, Dictionary<Guid, Asmb> asmbs = null, Dictionary<Guid, Anchor> ancs = null, Dictionary<Guid, Branch> brns = null, IProgress<object> progress = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -568,6 +568,8 @@ the members will be generated; otherwise, the existed members are applied.</p>
|
||||
<dt><code>brns</code> <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.guid">Guid</a>, <a class="xref" href="Hi.Mech.Topo.Branch.html">Branch</a>></dt>
|
||||
<dd><p>existed branch map</p>
|
||||
</dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Interface IDynamicRotation | HiAPI-C# 2025 ">
|
||||
|
||||
|
||||
<meta name="description" content="Topology joint that applies a single-axis rotation about by .">
|
||||
<link rel="icon" href="../img/HiAPI.favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
@@ -97,7 +97,8 @@ Interface IDynamicRotation
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"></div>
|
||||
<div class="markdown summary"><p>Topology joint that applies a single-axis rotation about <a class="xref" href="Hi.Mech.Topo.IDynamicRotation.html#Hi_Mech_Topo_IDynamicRotation_Pivot">Pivot</a> by <a class="xref" href="Hi.Mech.Topo.IDynamicRotation.html#Hi_Mech_Topo_IDynamicRotation_Angle_rad">Angle_rad</a>.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
|
||||
@@ -249,8 +249,8 @@ Class StackTransformer
|
||||
|
||||
<a id="Hi_Mech_Topo_StackTransformer__ctor_" data-uid="Hi.Mech.Topo.StackTransformer.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Mech_Topo_StackTransformer__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.Mech.Topo.StackTransformer.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
StackTransformer(XElement, string)
|
||||
<h3 id="Hi_Mech_Topo_StackTransformer__ctor_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__" data-uid="Hi.Mech.Topo.StackTransformer.#ctor(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object})">
|
||||
StackTransformer(XElement, string, IProgress<object>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -259,7 +259,7 @@ Class StackTransformer
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public StackTransformer(XElement src, string baseDirectory)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public StackTransformer(XElement src, string baseDirectory, IProgress<object> progress)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -269,6 +269,9 @@ Class StackTransformer
|
||||
</dd>
|
||||
<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>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd><p>The progress reporter.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -225,7 +225,8 @@ Interfaces
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Mech.Topo.IDynamicRotation.html">IDynamicRotation</a></dt>
|
||||
<dd></dd>
|
||||
<dd><p>Topology joint that applies a single-axis rotation about <a class="xref" href="Hi.Mech.Topo.IDynamicRotation.html#Hi_Mech_Topo_IDynamicRotation_Pivot">Pivot</a> by <a class="xref" href="Hi.Mech.Topo.IDynamicRotation.html#Hi_Mech_Topo_IDynamicRotation_Angle_rad">Angle_rad</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Mech.Topo.IDynamicTransformer.html">IDynamicTransformer</a></dt>
|
||||
|
||||
@@ -269,8 +269,8 @@ This profile uses APT definitions to describe the cutter geometry.</p>
|
||||
|
||||
<a id="Hi_Milling_Cutters_AptProfile__ctor_" data-uid="Hi.Milling.Cutters.AptProfile.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Milling_Cutters_AptProfile__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.Milling.Cutters.AptProfile.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
AptProfile(XElement, string)
|
||||
<h3 id="Hi_Milling_Cutters_AptProfile__ctor_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__" data-uid="Hi.Milling.Cutters.AptProfile.#ctor(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object})">
|
||||
AptProfile(XElement, string, IProgress<object>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -279,7 +279,7 @@ This profile uses APT definitions to describe the cutter geometry.</p>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public AptProfile(XElement src, string baseDirectory)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public AptProfile(XElement src, string baseDirectory, IProgress<object> progress)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -290,6 +290,8 @@ This profile uses APT definitions to describe the cutter geometry.</p>
|
||||
<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>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
@@ -237,8 +237,8 @@ This profile allows for custom geometry to be used as the cutter profile.</p>
|
||||
|
||||
<a id="Hi_Milling_Cutters_CustomSpinningProfile__ctor_" data-uid="Hi.Milling.Cutters.CustomSpinningProfile.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Milling_Cutters_CustomSpinningProfile__ctor_System_Xml_Linq_XElement_System_String_System_Object___" data-uid="Hi.Milling.Cutters.CustomSpinningProfile.#ctor(System.Xml.Linq.XElement,System.String,System.Object[])">
|
||||
CustomSpinningProfile(XElement, string, params object[])
|
||||
<h3 id="Hi_Milling_Cutters_CustomSpinningProfile__ctor_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__System_Object___" data-uid="Hi.Milling.Cutters.CustomSpinningProfile.#ctor(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object},System.Object[])">
|
||||
CustomSpinningProfile(XElement, string, IProgress<object>, object[])
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -247,7 +247,7 @@ This profile allows for custom geometry to be used as the cutter profile.</p>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public CustomSpinningProfile(XElement element, string baseDirectory, params object[] res)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public CustomSpinningProfile(XElement element, string baseDirectory, IProgress<object> progress, object[] res)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -258,6 +258,8 @@ This profile allows for custom geometry to be used as the cutter profile.</p>
|
||||
<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>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional resolution parameters.</p>
|
||||
</dd>
|
||||
|
||||
@@ -266,8 +266,8 @@ Shank and Flute compose the full cutter.</p>
|
||||
|
||||
<a id="Hi_Milling_Cutters_MillingCutter__ctor_" data-uid="Hi.Milling.Cutters.MillingCutter.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Milling_Cutters_MillingCutter__ctor_System_Xml_Linq_XElement_System_String_System_String_System_Object___" data-uid="Hi.Milling.Cutters.MillingCutter.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.Object[])">
|
||||
MillingCutter(XElement, string, string, params object[])
|
||||
<h3 id="Hi_Milling_Cutters_MillingCutter__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_System_Object__System_Object___" data-uid="Hi.Milling.Cutters.MillingCutter.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{System.Object},System.Object[])">
|
||||
MillingCutter(XElement, string, string, IProgress<object>, object[])
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -276,7 +276,7 @@ Shank and Flute compose the full cutter.</p>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MillingCutter(XElement src, string baseDirectory, string relFile, params object[] res)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public MillingCutter(XElement src, string baseDirectory, string relFile, IProgress<object> progress, object[] res)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -290,6 +290,8 @@ Shank and Flute compose the full cutter.</p>
|
||||
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>Relative file path</p>
|
||||
</dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional optional resources</p>
|
||||
</dd>
|
||||
|
||||
@@ -251,8 +251,8 @@ Class FluteContour
|
||||
|
||||
<a id="Hi_Milling_FluteContours_FluteContour__ctor_" data-uid="Hi.Milling.FluteContours.FluteContour.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Milling_FluteContours_FluteContour__ctor_System_Xml_Linq_XElement_System_String_System_Object___" data-uid="Hi.Milling.FluteContours.FluteContour.#ctor(System.Xml.Linq.XElement,System.String,System.Object[])">
|
||||
FluteContour(XElement, string, params object[])
|
||||
<h3 id="Hi_Milling_FluteContours_FluteContour__ctor_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__System_Object___" data-uid="Hi.Milling.FluteContours.FluteContour.#ctor(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object},System.Object[])">
|
||||
FluteContour(XElement, string, IProgress<object>, object[])
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -261,7 +261,7 @@ Class FluteContour
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FluteContour(XElement src, string baseDirectory, params object[] res)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public FluteContour(XElement src, string baseDirectory, IProgress<object> progress, object[] res)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -272,6 +272,8 @@ Class FluteContour
|
||||
<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>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional resources for initialization</p>
|
||||
</dd>
|
||||
|
||||
@@ -226,8 +226,8 @@ Class FreeContourTray
|
||||
|
||||
<a id="Hi_Milling_FluteContours_FreeContourTray__ctor_" data-uid="Hi.Milling.FluteContours.FreeContourTray.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Milling_FluteContours_FreeContourTray__ctor_System_Xml_Linq_XElement_System_String_System_Object___" data-uid="Hi.Milling.FluteContours.FreeContourTray.#ctor(System.Xml.Linq.XElement,System.String,System.Object[])">
|
||||
FreeContourTray(XElement, string, params object[])
|
||||
<h3 id="Hi_Milling_FluteContours_FreeContourTray__ctor_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__System_Object___" data-uid="Hi.Milling.FluteContours.FreeContourTray.#ctor(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object},System.Object[])">
|
||||
FreeContourTray(XElement, string, IProgress<object>, object[])
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -236,7 +236,7 @@ Class FreeContourTray
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FreeContourTray(XElement src, string baseDirectory, params object[] res)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public FreeContourTray(XElement src, string baseDirectory, IProgress<object> progress, object[] res)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -247,6 +247,8 @@ Class FreeContourTray
|
||||
<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>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional resources for initialization</p>
|
||||
</dd>
|
||||
|
||||
@@ -218,8 +218,8 @@ Class UniformContourTray
|
||||
|
||||
<a id="Hi_Milling_FluteContours_UniformContourTray__ctor_" data-uid="Hi.Milling.FluteContours.UniformContourTray.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Milling_FluteContours_UniformContourTray__ctor_System_Xml_Linq_XElement_System_String_System_Object___" data-uid="Hi.Milling.FluteContours.UniformContourTray.#ctor(System.Xml.Linq.XElement,System.String,System.Object[])">
|
||||
UniformContourTray(XElement, string, params object[])
|
||||
<h3 id="Hi_Milling_FluteContours_UniformContourTray__ctor_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__System_Object___" data-uid="Hi.Milling.FluteContours.UniformContourTray.#ctor(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object},System.Object[])">
|
||||
UniformContourTray(XElement, string, IProgress<object>, object[])
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -228,7 +228,7 @@ Class UniformContourTray
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public UniformContourTray(XElement src, string baseDirectory, params object[] res)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public UniformContourTray(XElement src, string baseDirectory, IProgress<object> progress, object[] res)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -239,6 +239,8 @@ Class UniformContourTray
|
||||
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>Base directory path for resolving relative paths</p>
|
||||
</dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional optional resources</p>
|
||||
</dd>
|
||||
|
||||
@@ -244,8 +244,8 @@ Class MillingTool
|
||||
|
||||
<a id="Hi_Milling_MillingTools_MillingTool__ctor_" data-uid="Hi.Milling.MillingTools.MillingTool.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Milling_MillingTools_MillingTool__ctor_System_Xml_Linq_XElement_System_String_System_String_" data-uid="Hi.Milling.MillingTools.MillingTool.#ctor(System.Xml.Linq.XElement,System.String,System.String)">
|
||||
MillingTool(XElement, string, string)
|
||||
<h3 id="Hi_Milling_MillingTools_MillingTool__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_System_Object__" data-uid="Hi.Milling.MillingTools.MillingTool.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{System.Object})">
|
||||
MillingTool(XElement, string, string, IProgress<object>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -254,7 +254,7 @@ Class MillingTool
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MillingTool(XElement src, string baseDirectory, string relFile)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public MillingTool(XElement src, string baseDirectory, string relFile, IProgress<object> progress)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -268,6 +268,8 @@ Class MillingTool
|
||||
<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.</p>
|
||||
</dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
@@ -213,8 +213,8 @@ Class MillingGuide
|
||||
|
||||
<a id="Hi_MillingProcs_MillingGuide__ctor_" data-uid="Hi.MillingProcs.MillingGuide.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_MillingProcs_MillingGuide__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.MillingProcs.MillingGuide.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
MillingGuide(XElement, string)
|
||||
<h3 id="Hi_MillingProcs_MillingGuide__ctor_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__" data-uid="Hi.MillingProcs.MillingGuide.#ctor(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object})">
|
||||
MillingGuide(XElement, string, IProgress<object>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -223,7 +223,7 @@ Class MillingGuide
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MillingGuide(XElement src, string baseDirectory)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public MillingGuide(XElement src, string baseDirectory, IProgress<object> progress)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -233,6 +233,9 @@ Class MillingGuide
|
||||
</dd>
|
||||
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>Base directory for resolving relative paths</p>
|
||||
</dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd><p>Progress reporter for XML deserialization.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -237,8 +237,8 @@ Class Fixture
|
||||
|
||||
<a id="Hi_NcMech_Fixtures_Fixture__ctor_" data-uid="Hi.NcMech.Fixtures.Fixture.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcMech_Fixtures_Fixture__ctor_System_Xml_Linq_XElement_System_String_System_String_" data-uid="Hi.NcMech.Fixtures.Fixture.#ctor(System.Xml.Linq.XElement,System.String,System.String)">
|
||||
Fixture(XElement, string, string)
|
||||
<h3 id="Hi_NcMech_Fixtures_Fixture__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_System_Object__" data-uid="Hi.NcMech.Fixtures.Fixture.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{System.Object})">
|
||||
Fixture(XElement, string, string, IProgress<object>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -247,7 +247,7 @@ Class Fixture
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Fixture(XElement src, string baseDirectory, string relFile)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public Fixture(XElement src, string baseDirectory, string relFile, IProgress<object> progress)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -261,6 +261,8 @@ Class Fixture
|
||||
<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.</p>
|
||||
</dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
@@ -286,8 +286,8 @@ Class CylindroidHolder
|
||||
|
||||
<a id="Hi_NcMech_Holders_CylindroidHolder__ctor_" data-uid="Hi.NcMech.Holders.CylindroidHolder.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcMech_Holders_CylindroidHolder__ctor_System_Xml_Linq_XElement_System_String_System_String_" data-uid="Hi.NcMech.Holders.CylindroidHolder.#ctor(System.Xml.Linq.XElement,System.String,System.String)">
|
||||
CylindroidHolder(XElement, string, string)
|
||||
<h3 id="Hi_NcMech_Holders_CylindroidHolder__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_System_Object__" data-uid="Hi.NcMech.Holders.CylindroidHolder.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{System.Object})">
|
||||
CylindroidHolder(XElement, string, string, IProgress<object>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -296,7 +296,7 @@ Class CylindroidHolder
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public CylindroidHolder(XElement src, string baseDirectory, string relFile)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public CylindroidHolder(XElement src, string baseDirectory, string relFile, IProgress<object> progress)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -310,6 +310,8 @@ Class CylindroidHolder
|
||||
<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.</p>
|
||||
</dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
@@ -286,8 +286,8 @@ Class FreeformHolder
|
||||
|
||||
<a id="Hi_NcMech_Holders_FreeformHolder__ctor_" data-uid="Hi.NcMech.Holders.FreeformHolder.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcMech_Holders_FreeformHolder__ctor_System_Xml_Linq_XElement_System_String_System_String_" data-uid="Hi.NcMech.Holders.FreeformHolder.#ctor(System.Xml.Linq.XElement,System.String,System.String)">
|
||||
FreeformHolder(XElement, string, string)
|
||||
<h3 id="Hi_NcMech_Holders_FreeformHolder__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_System_Object__" data-uid="Hi.NcMech.Holders.FreeformHolder.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{System.Object})">
|
||||
FreeformHolder(XElement, string, string, IProgress<object>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -296,7 +296,7 @@ Class FreeformHolder
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FreeformHolder(XElement src, string baseDirectory, string relFile)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public FreeformHolder(XElement src, string baseDirectory, string relFile, IProgress<object> progress)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -310,6 +310,8 @@ Class FreeformHolder
|
||||
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>Relative file path</p>
|
||||
</dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
@@ -271,8 +271,8 @@ Provides thread-safe access to geometry data and caching mechanisms.</p>
|
||||
|
||||
<a id="Hi_NcMech_Solids_Solid__ctor_" data-uid="Hi.NcMech.Solids.Solid.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcMech_Solids_Solid__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.NcMech.Solids.Solid.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
Solid(XElement, string)
|
||||
<h3 id="Hi_NcMech_Solids_Solid__ctor_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__" data-uid="Hi.NcMech.Solids.Solid.#ctor(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object})">
|
||||
Solid(XElement, string, IProgress<object>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -281,7 +281,7 @@ Provides thread-safe access to geometry data and caching mechanisms.</p>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Solid(XElement src, string baseDirectory)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public Solid(XElement src, string baseDirectory, IProgress<object> progress)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -291,6 +291,9 @@ Provides thread-safe access to geometry data and caching mechanisms.</p>
|
||||
</dd>
|
||||
<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>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd><p>The progress reporter.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -184,6 +184,42 @@ Class WorkpieceEditorDisplayee
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcMech_Workpieces_WorkpieceEditorDisplayee__ctor_" data-uid="Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcMech_Workpieces_WorkpieceEditorDisplayee__ctor_System_IProgress_System_Object__" data-uid="Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.#ctor(System.IProgress{System.Object})">
|
||||
WorkpieceEditorDisplayee(IProgress<object>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public WorkpieceEditorDisplayee(IProgress<object> progress = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd><p>Progress reporter for runtime geometry operations (e.g. defect warnings).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
@@ -316,6 +352,38 @@ Class WorkpieceEditorDisplayee
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcMech_Workpieces_WorkpieceEditorDisplayee_Progress_" data-uid="Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.Progress*"></a>
|
||||
|
||||
<h3 id="Hi_NcMech_Workpieces_WorkpieceEditorDisplayee_Progress" data-uid="Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.Progress">
|
||||
Progress
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Progress reporter for runtime geometry operations.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IProgress<object> Progress { 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.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcMech_Workpieces_WorkpieceEditorDisplayee_RawGeomRenderingMode_" data-uid="Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.RawGeomRenderingMode*"></a>
|
||||
|
||||
<h3 id="Hi_NcMech_Workpieces_WorkpieceEditorDisplayee_RawGeomRenderingMode" data-uid="Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.RawGeomRenderingMode">
|
||||
@@ -380,6 +448,38 @@ Class WorkpieceEditorDisplayee
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcMech_Workpieces_WorkpieceEditorDisplayee_WorkpieceServiceGetter_" data-uid="Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.WorkpieceServiceGetter*"></a>
|
||||
|
||||
<h3 id="Hi_NcMech_Workpieces_WorkpieceEditorDisplayee_WorkpieceServiceGetter" data-uid="Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.WorkpieceServiceGetter">
|
||||
WorkpieceServiceGetter
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets or sets the delegate that provides <span class="xref">Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.WorkpieceService</span>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Func<WorkpieceService> WorkpieceServiceGetter { 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.func-1">Func</a><<a class="xref" href="Hi.NcMech.Workpieces.WorkpieceService.html">WorkpieceService</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
@@ -391,7 +491,7 @@ Class WorkpieceEditorDisplayee
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Clears the ideal geometry cache on workpiece.</p>
|
||||
<div class="markdown level1 summary"><p>Clears the ideal geometry cache on workpiece service.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -418,7 +518,7 @@ Class WorkpieceEditorDisplayee
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Clears the raw geometry cache on workpiece.</p>
|
||||
<div class="markdown level1 summary"><p>Clears the raw geometry cache on workpiece service.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -96,7 +96,7 @@ Classes
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcMech.Workpieces.Workpiece.html">Workpiece</a></dt>
|
||||
<dd><p>Workpiece.</p>
|
||||
<dd><p>Workpiece configuration data model.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
@@ -109,6 +109,11 @@ Classes
|
||||
<dd><p>Configuration settings for workpiece editor display.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcMech.Workpieces.WorkpieceService.html">WorkpieceService</a></dt>
|
||||
<dd><p>Runtime service for <a class="xref" href="Hi.NcMech.Workpieces.WorkpieceService.html#Hi_NcMech_Workpieces_WorkpieceService_Workpiece">Workpiece</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
@@ -285,7 +285,8 @@ Class CodeXyzabcMachineTool
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Builds a machine tool from a compact <a class="xref" href="Hi.Numerical.Xyzabc.CodeXyzabcChain.html">CodeXyzabcChain</a> axis string and vertical/horizontal layout flag.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
@@ -295,9 +296,11 @@ Class CodeXyzabcMachineTool
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>chainCode</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dd><p>Bracket token string consumed by <a class="xref" href="Hi.Numerical.Xyzabc.CodeXyzabcChain.html">CodeXyzabcChain</a> (defaults to a common 5-axis layout).</p>
|
||||
</dd>
|
||||
<dt><code>isVertical</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
<dd><p>Whether the Z column is treated as vertical for the generated chain.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -313,8 +316,8 @@ Class CodeXyzabcMachineTool
|
||||
|
||||
<a id="Hi_NcMech_Xyzabc_CodeXyzabcMachineTool__ctor_" data-uid="Hi.NcMech.Xyzabc.CodeXyzabcMachineTool.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcMech_Xyzabc_CodeXyzabcMachineTool__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.NcMech.Xyzabc.CodeXyzabcMachineTool.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
CodeXyzabcMachineTool(XElement, string)
|
||||
<h3 id="Hi_NcMech_Xyzabc_CodeXyzabcMachineTool__ctor_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__" data-uid="Hi.NcMech.Xyzabc.CodeXyzabcMachineTool.#ctor(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object})">
|
||||
CodeXyzabcMachineTool(XElement, string, IProgress<object>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -323,7 +326,7 @@ Class CodeXyzabcMachineTool
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public CodeXyzabcMachineTool(XElement src, string baseDirectory)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public CodeXyzabcMachineTool(XElement src, string baseDirectory, IProgress<object> progress)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -333,6 +336,9 @@ Class CodeXyzabcMachineTool
|
||||
</dd>
|
||||
<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>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd><p>The progress reporter.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -224,8 +224,8 @@ Class CodeXyzabcMachineToolUri
|
||||
|
||||
<a id="Hi_NcMech_Xyzabc_CodeXyzabcMachineToolUri__ctor_" data-uid="Hi.NcMech.Xyzabc.CodeXyzabcMachineToolUri.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcMech_Xyzabc_CodeXyzabcMachineToolUri__ctor_System_Xml_Linq_XElement_System_String_System_Object___" data-uid="Hi.NcMech.Xyzabc.CodeXyzabcMachineToolUri.#ctor(System.Xml.Linq.XElement,System.String,System.Object[])">
|
||||
CodeXyzabcMachineToolUri(XElement, string, object[])
|
||||
<h3 id="Hi_NcMech_Xyzabc_CodeXyzabcMachineToolUri__ctor_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__System_Object___" data-uid="Hi.NcMech.Xyzabc.CodeXyzabcMachineToolUri.#ctor(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object},System.Object[])">
|
||||
CodeXyzabcMachineToolUri(XElement, string, IProgress<object>, object[])
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -234,7 +234,7 @@ Class CodeXyzabcMachineToolUri
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public CodeXyzabcMachineToolUri(XElement src, string baseDirectory, object[] res)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public CodeXyzabcMachineToolUri(XElement src, string baseDirectory, IProgress<object> progress, object[] res)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -244,6 +244,9 @@ Class CodeXyzabcMachineToolUri
|
||||
</dd>
|
||||
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>Base directory.</p>
|
||||
</dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd><p>Progress reporter passed to <a class="xref" href="Hi.NcMech.Xyzabc.CodeXyzabcMachineToolUri.html#Hi_NcMech_Xyzabc_CodeXyzabcMachineToolUri_LoadFromUri_System_String_System_IProgress_System_Object__System_Object___">LoadFromUri(string, IProgress<object>, object[])</a>.</p>
|
||||
</dd>
|
||||
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional resources.</p>
|
||||
@@ -463,8 +466,8 @@ Class CodeXyzabcMachineToolUri
|
||||
|
||||
<a id="Hi_NcMech_Xyzabc_CodeXyzabcMachineToolUri_LoadFromUri_" data-uid="Hi.NcMech.Xyzabc.CodeXyzabcMachineToolUri.LoadFromUri*"></a>
|
||||
|
||||
<h3 id="Hi_NcMech_Xyzabc_CodeXyzabcMachineToolUri_LoadFromUri_System_String_System_Object___" data-uid="Hi.NcMech.Xyzabc.CodeXyzabcMachineToolUri.LoadFromUri(System.String,System.Object[])">
|
||||
LoadFromUri(string, object[])
|
||||
<h3 id="Hi_NcMech_Xyzabc_CodeXyzabcMachineToolUri_LoadFromUri_System_String_System_IProgress_System_Object__System_Object___" data-uid="Hi.NcMech.Xyzabc.CodeXyzabcMachineToolUri.LoadFromUri(System.String,System.IProgress{System.Object},System.Object[])">
|
||||
LoadFromUri(string, IProgress<object>, object[])
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -473,13 +476,16 @@ Class CodeXyzabcMachineToolUri
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void LoadFromUri(string baseDirectory, object[] res)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public void LoadFromUri(string baseDirectory, IProgress<object> progress, object[] res)</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>Base directory.</p>
|
||||
</dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd><p>Progress reporter for nested XML / factory loading.</p>
|
||||
</dd>
|
||||
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional resources.</p>
|
||||
|
||||
@@ -280,8 +280,8 @@ Class GeneralXyzabcMachineTool
|
||||
|
||||
<a id="Hi_NcMech_Xyzabc_GeneralXyzabcMachineTool__ctor_" data-uid="Hi.NcMech.Xyzabc.GeneralXyzabcMachineTool.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcMech_Xyzabc_GeneralXyzabcMachineTool__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.NcMech.Xyzabc.GeneralXyzabcMachineTool.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
GeneralXyzabcMachineTool(XElement, string)
|
||||
<h3 id="Hi_NcMech_Xyzabc_GeneralXyzabcMachineTool__ctor_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__" data-uid="Hi.NcMech.Xyzabc.GeneralXyzabcMachineTool.#ctor(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object})">
|
||||
GeneralXyzabcMachineTool(XElement, string, IProgress<object>)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -290,7 +290,7 @@ Class GeneralXyzabcMachineTool
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public GeneralXyzabcMachineTool(XElement src, string baseDirectory)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public GeneralXyzabcMachineTool(XElement src, string baseDirectory, IProgress<object> progress)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -300,6 +300,9 @@ Class GeneralXyzabcMachineTool
|
||||
</dd>
|
||||
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>Base directory.</p>
|
||||
</dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd><p>Progress reporter for loading <a class="xref" href="Hi.NcMech.Xyzabc.GeneralXyzabcMachineTool.html#Hi_NcMech_Xyzabc_GeneralXyzabcMachineTool_XyzabcChain">XyzabcChain</a> and related children.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -455,7 +455,7 @@ Since the folder can be moving with the configuration file.</p>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<(HardNcLine SrcNcLine, HardNcLine OptNcLine)> Optimize(ICuttingPara millingPara, MachiningSession machiningSession, LinkedList<HardNcLine> srcNcLines, HardNcEnv ncEnv, List<MachiningStep> machiningSteps, MachiningToolHouse millingToolHouse, IProgress<object> messageHost, CancellationToken cancellationToken, string baseDirectory, string relFileTemplate)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<(HardNcLine SrcNcLine, HardNcLine OptNcLine)> Optimize(ICuttingPara millingPara, MachiningSession machiningSession, LinkedList<HardNcLine> srcNcLines, HardNcEnv ncEnv, List<MachiningStep> machiningSteps, MachiningToolHouse millingToolHouse, IProgress<object> progress, CancellationToken cancellationToken, string baseDirectory, string relFileTemplate)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -478,7 +478,7 @@ Since the folder can be moving with the configuration file.</p>
|
||||
<dt><code>millingToolHouse</code> <a class="xref" href="Hi.Machining.MachiningToolHouse.html">MachiningToolHouse</a></dt>
|
||||
<dd><p>The machining tool house.</p>
|
||||
</dd>
|
||||
<dt><code>messageHost</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd><p>The message host for logging.</p>
|
||||
</dd>
|
||||
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
|
||||
@@ -521,7 +521,7 @@ Since the folder can be moving with the configuration file.</p>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void OptimizeToFiles(ICuttingPara millingPara, MachiningSession machiningSession, LinkedList<HardNcLine> ncLines, HardNcEnv ncEnv, MachiningToolHouse millingToolHouse, ClStrip clStrip, string baseDirectory, IProgress<object> messageHost, CancellationToken cancellationToken, string relFileTemplate = "Output/Opt-[NcName]")</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public void OptimizeToFiles(ICuttingPara millingPara, MachiningSession machiningSession, LinkedList<HardNcLine> ncLines, HardNcEnv ncEnv, MachiningToolHouse millingToolHouse, ClStrip clStrip, string baseDirectory, IProgress<object> progress, CancellationToken cancellationToken, string relFileTemplate = "Output/Opt-[NcName]")</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -547,7 +547,7 @@ Since the folder can be moving with the configuration file.</p>
|
||||
<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 output files</p>
|
||||
</dd>
|
||||
<dt><code>messageHost</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd><p>The message host for logging</p>
|
||||
</dd>
|
||||
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
|
||||
|
||||
@@ -0,0 +1,563 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class CncBrandDependency | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class CncBrandDependency | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Explicit CNC controller brand identifier carried in . Use ncDependencyList.OfType&lt;CncBrandDependency&gt;().FirstOrDefault() to retrieve the brand.">
|
||||
<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.CncBrandDependency">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_Dependencys_CncBrandDependency" data-uid="Hi.NcParsers.Dependencys.CncBrandDependency" class="text-break">
|
||||
Class CncBrandDependency
|
||||
</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></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Explicit CNC controller brand identifier carried in
|
||||
<a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_NcDependencyList">NcDependencyList</a>.
|
||||
Use <code>ncDependencyList.OfType<CncBrandDependency>().FirstOrDefault()</code>
|
||||
to retrieve the brand.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class CncBrandDependency : INcDependency, 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">CncBrandDependency</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>
|
||||
</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_CncBrandDependency__ctor_" data-uid="Hi.NcParsers.Dependencys.CncBrandDependency.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_CncBrandDependency__ctor_System_String_" data-uid="Hi.NcParsers.Dependencys.CncBrandDependency.#ctor(System.String)">
|
||||
CncBrandDependency(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Creates a dependency with the given brand string.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public CncBrandDependency(string brand)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>brand</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>Controller brand name (often one of the <code>public const</code> tokens on this type).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_CncBrandDependency__ctor_" data-uid="Hi.NcParsers.Dependencys.CncBrandDependency.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_CncBrandDependency__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.Dependencys.CncBrandDependency.#ctor(System.Xml.Linq.XElement)">
|
||||
CncBrandDependency(XElement)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Deserializes brand from XML.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public CncBrandDependency(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.CncBrandDependency.html#Hi_NcParsers_Dependencys_CncBrandDependency_XName">XName</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="fields">Fields
|
||||
</h2>
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_CncBrandDependency_Fanuc" data-uid="Hi.NcParsers.Dependencys.CncBrandDependency.Fanuc">
|
||||
Fanuc
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Brand token used when the controller is Fanuc.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const string Fanuc = "Fanuc"</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_Dependencys_CncBrandDependency_Heidenhain" data-uid="Hi.NcParsers.Dependencys.CncBrandDependency.Heidenhain">
|
||||
Heidenhain
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Brand token used when the controller is Heidenhain.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const string Heidenhain = "Heidenhain"</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_Dependencys_CncBrandDependency_Mazak" data-uid="Hi.NcParsers.Dependencys.CncBrandDependency.Mazak">
|
||||
Mazak
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Brand token used when the controller is Mazak.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const string Mazak = "Mazak"</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_Dependencys_CncBrandDependency_Siemens" data-uid="Hi.NcParsers.Dependencys.CncBrandDependency.Siemens">
|
||||
Siemens
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Brand token used when the controller is Siemens.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const string Siemens = "Siemens"</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_Dependencys_CncBrandDependency_Syntec" data-uid="Hi.NcParsers.Dependencys.CncBrandDependency.Syntec">
|
||||
Syntec
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Brand token used when the controller is Syntec.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const string Syntec = "Syntec"</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_Dependencys_CncBrandDependency_Brand_" data-uid="Hi.NcParsers.Dependencys.CncBrandDependency.Brand*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_CncBrandDependency_Brand" data-uid="Hi.NcParsers.Dependencys.CncBrandDependency.Brand">
|
||||
Brand
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>CNC controller brand name (e.g., “Fanuc”, “Siemens”).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Brand { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_CncBrandDependency_XName_" data-uid="Hi.NcParsers.Dependencys.CncBrandDependency.XName*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_CncBrandDependency_XName" data-uid="Hi.NcParsers.Dependencys.CncBrandDependency.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>XML element name for <a class="xref" href="Hi.Common.XmlUtils.XFactory.html#Hi_Common_XmlUtils_XFactory_Regs">Regs</a> registration.</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_CncBrandDependency_MakeXmlSource_" data-uid="Hi.NcParsers.Dependencys.CncBrandDependency.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_CncBrandDependency_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.Dependencys.CncBrandDependency.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_CncBrandDependency_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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
+360
-40
@@ -108,7 +108,7 @@ and derived convenience properties.</li>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public abstract class ControllerParameterTableBase : IHomeMcConfig, IMachineAxisConfig, IRapidFeedrateConfig, INcDependency, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public abstract class ControllerParameterTableBase : IHomeMcConfig, IMachineAxisConfig, IRapidFeedrateConfig, IStrokeLimitConfig, INcDependency, IMakeXmlSource</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -128,6 +128,7 @@ and derived convenience properties.</li>
|
||||
<div><a class="xref" href="Hi.NcParsers.Dependencys.IHomeMcConfig.html">IHomeMcConfig</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.Dependencys.IMachineAxisConfig.html">IMachineAxisConfig</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.Dependencys.IRapidFeedrateConfig.html">IRapidFeedrateConfig</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.Dependencys.IStrokeLimitConfig.html">IStrokeLimitConfig</a></div>
|
||||
<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>
|
||||
</dd>
|
||||
@@ -428,6 +429,72 @@ Null if not defined for this controller brand.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_StrokeLimitNegParamId_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.StrokeLimitNegParamId*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_StrokeLimitNegParamId" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.StrokeLimitNegParamId">
|
||||
StrokeLimitNegParamId
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Parameter/MD/MP number for negative stroke limit per axis.
|
||||
Null if not defined for this controller brand.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected virtual int? StrokeLimitNegParamId { 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.int32">int</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_StrokeLimitPosParamId_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.StrokeLimitPosParamId*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_StrokeLimitPosParamId" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.StrokeLimitPosParamId">
|
||||
StrokeLimitPosParamId
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Parameter/MD/MP number for positive stroke limit per axis.
|
||||
Null if not defined for this controller brand.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected virtual int? StrokeLimitPosParamId { 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.int32">int</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_SystemParams_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.SystemParams*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_SystemParams" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.SystemParams">
|
||||
@@ -543,45 +610,6 @@ Use <a class="xref" href="Hi.NcParsers.Dependencys.ControllerParameterTableBase.
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_GetAxisRapidRate_mmdmin_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.GetAxisRapidRate_mmdmin*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_GetAxisRapidRate_mmdmin_System_String_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.GetAxisRapidRate_mmdmin(System.String)">
|
||||
GetAxisRapidRate_mmdmin(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets rapid traverse feedrate for a specific axis
|
||||
in mm/min (or deg/min for rotary).
|
||||
Returns a default value if the axis is not configured.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public double GetAxisRapidRate_mmdmin(string axisName)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>axisName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_GetHomePosition_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.GetHomePosition*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_GetHomePosition_System_String_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.GetHomePosition(System.String)">
|
||||
@@ -620,6 +648,160 @@ Returns null if the axis has no home position configured.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_GetLinearAxisRapidRate_mmdmin_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.GetLinearAxisRapidRate_mmdmin*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_GetLinearAxisRapidRate_mmdmin_System_String_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.GetLinearAxisRapidRate_mmdmin(System.String)">
|
||||
GetLinearAxisRapidRate_mmdmin(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets rapid traverse feedrate for a linear axis in mm/min.
|
||||
Returns a default value if the axis is not configured.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public double GetLinearAxisRapidRate_mmdmin(string axisName)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>axisName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_GetNegativeLimit_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.GetNegativeLimit*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_GetNegativeLimit_System_String_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.GetNegativeLimit(System.String)">
|
||||
GetNegativeLimit(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the negative stroke limit for a specific axis.
|
||||
Unit is mm for linear axes, deg for rotary axes.
|
||||
Returns null if not configured (no limit).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public double? GetNegativeLimit(string axisName)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>axisName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_GetPositiveLimit_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.GetPositiveLimit*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_GetPositiveLimit_System_String_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.GetPositiveLimit(System.String)">
|
||||
GetPositiveLimit(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the positive stroke limit for a specific axis.
|
||||
Unit is mm for linear axes, deg for rotary axes.
|
||||
Returns null if not configured (no limit).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public double? GetPositiveLimit(string axisName)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>axisName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_GetRotaryAxisRapidRate_degdmin_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.GetRotaryAxisRapidRate_degdmin*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_GetRotaryAxisRapidRate_degdmin_System_String_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.GetRotaryAxisRapidRate_degdmin(System.String)">
|
||||
GetRotaryAxisRapidRate_degdmin(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets rapid traverse feedrate for a rotary axis in deg/min.
|
||||
Returns a default value if the axis is not configured.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public double GetRotaryAxisRapidRate_degdmin(string axisName)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>axisName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_IntAxisParam_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.IntAxisParam*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_IntAxisParam_System_Int32_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.IntAxisParam(System.Int32)">
|
||||
@@ -875,6 +1057,144 @@ Since the folder can be moving with the configuration file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_SetLinearAxisRapidRate_mmdmin_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.SetLinearAxisRapidRate_mmdmin*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_SetLinearAxisRapidRate_mmdmin_System_String_System_Double_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.SetLinearAxisRapidRate_mmdmin(System.String,System.Double)">
|
||||
SetLinearAxisRapidRate_mmdmin(string, double)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Sets rapid traverse feedrate for a linear axis in mm/min.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SetLinearAxisRapidRate_mmdmin(string axisName, double value)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>axisName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>value</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_SetNegativeLimit_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.SetNegativeLimit*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_SetNegativeLimit_System_String_System_Double_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.SetNegativeLimit(System.String,System.Double)">
|
||||
SetNegativeLimit(string, double)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Sets the negative stroke limit for a specific axis.
|
||||
Unit is mm for linear axes, deg for rotary axes.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SetNegativeLimit(string axisName, double value)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>axisName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>value</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_SetPositiveLimit_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.SetPositiveLimit*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_SetPositiveLimit_System_String_System_Double_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.SetPositiveLimit(System.String,System.Double)">
|
||||
SetPositiveLimit(string, double)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Sets the positive stroke limit for a specific axis.
|
||||
Unit is mm for linear axes, deg for rotary axes.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SetPositiveLimit(string axisName, double value)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>axisName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>value</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_SetRotaryAxisRapidRate_degdmin_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.SetRotaryAxisRapidRate_degdmin*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_SetRotaryAxisRapidRate_degdmin_System_String_System_Double_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.SetRotaryAxisRapidRate_degdmin(System.String,System.Double)">
|
||||
SetRotaryAxisRapidRate_degdmin(string, double)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Sets rapid traverse feedrate for a rotary axis in deg/min.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SetRotaryAxisRapidRate_degdmin(string axisName, double value)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>axisName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>value</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_WriteXml_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.WriteXml*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_WriteXml_System_String_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.WriteXml(System.String)">
|
||||
|
||||
+433
-3
@@ -104,7 +104,7 @@ following real Fanuc parameter numbering.</p>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class FanucParameterTable : ControllerParameterTableBase, IHomeMcConfig, IMachineAxisConfig, IRapidFeedrateConfig, ICannedCycleConfig, INcDependency, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class FanucParameterTable : ControllerParameterTableBase, IHomeMcConfig, IMachineAxisConfig, IRapidFeedrateConfig, IStrokeLimitConfig, ICannedCycleConfig, IIsoCoordinateConfig, INcDependency, IMakeXmlSource, IVariableLookup</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -125,9 +125,12 @@ following real Fanuc parameter numbering.</p>
|
||||
<div><a class="xref" href="Hi.NcParsers.Dependencys.IHomeMcConfig.html">IHomeMcConfig</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.Dependencys.IMachineAxisConfig.html">IMachineAxisConfig</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.Dependencys.IRapidFeedrateConfig.html">IRapidFeedrateConfig</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.Dependencys.IStrokeLimitConfig.html">IStrokeLimitConfig</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.Dependencys.ICannedCycleConfig.html">ICannedCycleConfig</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.Dependencys.IIsoCoordinateConfig.html">IIsoCoordinateConfig</a></div>
|
||||
<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.LogicSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -136,7 +139,28 @@ following real Fanuc parameter numbering.</p>
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.ControllerParameterTableBase.html#Hi_NcParsers_Dependencys_ControllerParameterTableBase_GetAxisRapidRate_mmdmin_System_String_">ControllerParameterTableBase.GetAxisRapidRate_mmdmin(string)</a>
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.ControllerParameterTableBase.html#Hi_NcParsers_Dependencys_ControllerParameterTableBase_GetLinearAxisRapidRate_mmdmin_System_String_">ControllerParameterTableBase.GetLinearAxisRapidRate_mmdmin(string)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.ControllerParameterTableBase.html#Hi_NcParsers_Dependencys_ControllerParameterTableBase_GetRotaryAxisRapidRate_degdmin_System_String_">ControllerParameterTableBase.GetRotaryAxisRapidRate_degdmin(string)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.ControllerParameterTableBase.html#Hi_NcParsers_Dependencys_ControllerParameterTableBase_SetLinearAxisRapidRate_mmdmin_System_String_System_Double_">ControllerParameterTableBase.SetLinearAxisRapidRate_mmdmin(string, double)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.ControllerParameterTableBase.html#Hi_NcParsers_Dependencys_ControllerParameterTableBase_SetRotaryAxisRapidRate_degdmin_System_String_System_Double_">ControllerParameterTableBase.SetRotaryAxisRapidRate_degdmin(string, double)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.ControllerParameterTableBase.html#Hi_NcParsers_Dependencys_ControllerParameterTableBase_GetPositiveLimit_System_String_">ControllerParameterTableBase.GetPositiveLimit(string)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.ControllerParameterTableBase.html#Hi_NcParsers_Dependencys_ControllerParameterTableBase_GetNegativeLimit_System_String_">ControllerParameterTableBase.GetNegativeLimit(string)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.ControllerParameterTableBase.html#Hi_NcParsers_Dependencys_ControllerParameterTableBase_SetPositiveLimit_System_String_System_Double_">ControllerParameterTableBase.SetPositiveLimit(string, double)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.ControllerParameterTableBase.html#Hi_NcParsers_Dependencys_ControllerParameterTableBase_SetNegativeLimit_System_String_System_Double_">ControllerParameterTableBase.SetNegativeLimit(string, double)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.ControllerParameterTableBase.html#Hi_NcParsers_Dependencys_ControllerParameterTableBase_SystemParams">ControllerParameterTableBase.SystemParams</a>
|
||||
@@ -299,6 +323,130 @@ following real Fanuc parameter numbering.</p>
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_CoordOffsetMax" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.CoordOffsetMax">
|
||||
CoordOffsetMax
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Inclusive upper bound of the G54-G59 work coordinate offset address range (<code>#5328</code>).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const int CoordOffsetMax = 5328</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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_CoordOffsetMin" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.CoordOffsetMin">
|
||||
CoordOffsetMin
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Inclusive lower bound of the G54-G59 work coordinate offset address range (<code>#5221</code>).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const int CoordOffsetMin = 5221</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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_ExtCoordOffsetMax" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.ExtCoordOffsetMax">
|
||||
ExtCoordOffsetMax
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Inclusive upper bound of the G54.1 P-table extended offset range (<code>#7999</code>).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const int ExtCoordOffsetMax = 7999</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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_ExtCoordOffsetMin" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.ExtCoordOffsetMin">
|
||||
ExtCoordOffsetMin
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Inclusive lower bound of the G54.1 P-table extended offset range (<code>#7001</code>).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const int ExtCoordOffsetMin = 7001</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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_ParamAxisType" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.ParamAxisType">
|
||||
ParamAxisType
|
||||
|
||||
@@ -392,6 +540,72 @@ following real Fanuc parameter numbering.</p>
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_ParamG54OffsetBase" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.ParamG54OffsetBase">
|
||||
ParamG54OffsetBase
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>#5221: Base address (X) of G54 work coordinate offset.
|
||||
G54.Y at +1 (#5222), G54.Z at +2 (#5223). G55..G59 follow at stride 20.
|
||||
See <a class="xref" href="Hi.NcParsers.Dependencys.IsoCoordinateAddressMap.html">IsoCoordinateAddressMap</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const int ParamG54OffsetBase = 5221</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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_ParamG54p1P1OffsetBase" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.ParamG54p1P1OffsetBase">
|
||||
ParamG54p1P1OffsetBase
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>#7001: Base address (X) of G54.1 P1 extended work coordinate offset.
|
||||
G54.1 P2..P48 follow at stride 20.
|
||||
See <a class="xref" href="Hi.NcParsers.Dependencys.IsoCoordinateAddressMap.html">IsoCoordinateAddressMap</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const int ParamG54p1P1OffsetBase = 7001</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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_ParamMaxSpindleSpeed" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.ParamMaxSpindleSpeed">
|
||||
ParamMaxSpindleSpeed
|
||||
|
||||
@@ -656,7 +870,7 @@ See <a class="xref" href="Hi.NcParsers.Dependencys.IHomeMcConfig.html">IHomeMcCo
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>#1420: Rapid traverse rate per axis (mm/min or deg/min).
|
||||
See <a class="xref" href="Hi.NcParsers.Dependencys.IRapidFeedrateConfig.html">IRapidFeedrateConfig</a>. See ControllerParameterTableBase.RapidFeedrate_mmdmin.</p>
|
||||
See <a class="xref" href="Hi.NcParsers.Dependencys.IRapidFeedrateConfig.html">IRapidFeedrateConfig</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -745,6 +959,38 @@ See <a class="xref" href="Hi.NcParsers.Dependencys.IRapidFeedrateConfig.html">IR
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_CoordinateIds_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.CoordinateIds*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_CoordinateIds" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.CoordinateIds">
|
||||
CoordinateIds
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Enumerates the G-code coordinate ids that this provider currently has data for.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<string> CoordinateIds { 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.ienumerable-1">IEnumerable</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_CutterCompType_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.CutterCompType*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_CutterCompType" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.CutterCompType">
|
||||
@@ -1067,6 +1313,72 @@ Null if not defined for this controller brand.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_StrokeLimitNegParamId_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.StrokeLimitNegParamId*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_StrokeLimitNegParamId" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.StrokeLimitNegParamId">
|
||||
StrokeLimitNegParamId
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Parameter/MD/MP number for negative stroke limit per axis.
|
||||
Null if not defined for this controller brand.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected override int? StrokeLimitNegParamId { 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.int32">int</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_StrokeLimitPosParamId_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.StrokeLimitPosParamId*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_StrokeLimitPosParamId" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.StrokeLimitPosParamId">
|
||||
StrokeLimitPosParamId
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Parameter/MD/MP number for positive stroke limit per axis.
|
||||
Null if not defined for this controller brand.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected override int? StrokeLimitPosParamId { 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.int32">int</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_XName_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.XName*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_XName" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.XName">
|
||||
@@ -1102,6 +1414,90 @@ Null if not defined for this controller brand.</p>
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_Get_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.Get*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_Get_System_String_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.Get(System.String)">
|
||||
Get(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Returns the value of the variable identified by <code class="paramref">key</code>
|
||||
(e.g. <code>"#124"</code>), or <code>null</code> if vacant or unknown to this lookup.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public double? Get(string key)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>key</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_Get_System_String__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>Routes Fanuc system-variable reads to SystemParams:
|
||||
<code>#5221-#5328</code> (G54-G59 work coordinate offsets) and
|
||||
<code>#7001-#7999</code> (G54.1 P1-P48 extended offsets) are returned
|
||||
directly by parameter address. Other ranges return <code>null</code> so
|
||||
the evaluator's lookup chain can fall through.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_GetCoordinateOffset_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.GetCoordinateOffset*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_GetCoordinateOffset_System_String_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.GetCoordinateOffset(System.String)">
|
||||
GetCoordinateOffset(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the offset for the given G-code coordinate id.
|
||||
Returns null when no offset is configured for that id by this provider
|
||||
(callers iterate the next provider, or fall back to <a class="xref" href="Hi.Geom.Vec3d.html#Hi_Geom_Vec3d_Zero">Zero</a>).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Vec3d GetCoordinateOffset(string coordId)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>coordId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_MakeXmlSource_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
@@ -1153,6 +1549,40 @@ Since the folder can be moving with the configuration file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_SetCoordinateOffset_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.SetCoordinateOffset*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucParameterTable_SetCoordinateOffset_System_String_Hi_Geom_Vec3d_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.SetCoordinateOffset(System.String,Hi.Geom.Vec3d)">
|
||||
SetCoordinateOffset(string, Vec3d)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Sets the offset for the given G-code coordinate id.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SetCoordinateOffset(string coordId, Vec3d offset)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>coordId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>offset</code> <a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
|
||||
+358
@@ -0,0 +1,358 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class FanucPositionVariableLookup | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class FanucPositionVariableLookup | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Fanuc-style position system variables read from the previous block's runtime-state JSON sections: #5001-#5003Block-end position X/Y/Z (workpiece) → previous block's .#5021-#5023Current machine position X/Y/Z → previous block's .#5041-#5043Current absolute position X/Y/Z → previous block's . Stateless. Configured on VariableEvaluatorSyntax.RuntimeVariableLookups rather than NcDependencyList because the read needs the block node for access — there is no long-lived dependency object that owns this data.">
|
||||
<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.Fanuc.FanucPositionVariableLookup">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_Dependencys_Fanuc_FanucPositionVariableLookup" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucPositionVariableLookup" class="text-break">
|
||||
Class FanucPositionVariableLookup
|
||||
</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.Fanuc.html">Fanuc</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Fanuc-style position system variables read from the previous block's
|
||||
runtime-state JSON sections:</p>
|
||||
<ul><li><span class="term"><code>#5001-#5003</code></span>Block-end position X/Y/Z (workpiece) → previous block's <a class="xref" href="Hi.NcParsers.Keywords.IProgramXyzDef.html#Hi_NcParsers_Keywords_IProgramXyzDef_ProgramXyz">ProgramXyz</a>.</li><li><span class="term"><code>#5021-#5023</code></span>Current machine position X/Y/Z → previous block's <a class="xref" href="Hi.NcParsers.Keywords.MachineCoordinateState.html">MachineCoordinateState</a>.</li><li><span class="term"><code>#5041-#5043</code></span>Current absolute position X/Y/Z → previous block's <a class="xref" href="Hi.NcParsers.Keywords.IProgramXyzDef.html#Hi_NcParsers_Keywords_IProgramXyzDef_ProgramXyz">ProgramXyz</a>.</li></ul>
|
||||
<p>
|
||||
Stateless. Configured on
|
||||
VariableEvaluatorSyntax.RuntimeVariableLookups rather than
|
||||
<code>NcDependencyList</code> because the read needs the block node for
|
||||
<a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html#Hi_Common_Collections_LazyLinkedListNode_1_Previous">Previous</a> access — there is no
|
||||
long-lived dependency object that owns this data.
|
||||
</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public sealed class FanucPositionVariableLookup : IRuntimeVariableLookup</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">FanucPositionVariableLookup</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IRuntimeVariableLookup.html">IRuntimeVariableLookup</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.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="fields">Fields
|
||||
</h2>
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucPositionVariableLookup_AbsoluteXyzBase" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucPositionVariableLookup.AbsoluteXyzBase">
|
||||
AbsoluteXyzBase
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Inclusive lower bound of the absolute XYZ position range (<code>#5041</code>).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const int AbsoluteXyzBase = 5041</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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucPositionVariableLookup_BlockEndXyzBase" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucPositionVariableLookup.BlockEndXyzBase">
|
||||
BlockEndXyzBase
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Inclusive lower bound of the block-end XYZ position range (<code>#5001</code>).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const int BlockEndXyzBase = 5001</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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucPositionVariableLookup_MachineCoordXyzBase" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucPositionVariableLookup.MachineCoordXyzBase">
|
||||
MachineCoordXyzBase
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Inclusive lower bound of the machine-coordinate XYZ position range (<code>#5021</code>).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const int MachineCoordXyzBase = 5021</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="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Fanuc_FanucPositionVariableLookup_Get_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucPositionVariableLookup.Get*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucPositionVariableLookup_Get_System_String_Hi_Common_Collections_LazyLinkedListNode_Hi_NcParsers_Syntaxs_SyntaxPiece__System_Collections_Generic_IReadOnlyList_Hi_NcParsers_Dependencys_INcDependency__" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucPositionVariableLookup.Get(System.String,Hi.Common.Collections.LazyLinkedListNode{Hi.NcParsers.Syntaxs.SyntaxPiece},System.Collections.Generic.IReadOnlyList{Hi.NcParsers.Dependencys.INcDependency})">
|
||||
Get(string, LazyLinkedListNode<SyntaxPiece>, IReadOnlyList<INcDependency>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Returns the value of the variable identified by <code class="paramref">key</code>
|
||||
in the context of <code class="paramref">node</code> and
|
||||
<code class="paramref">dependencies</code>, or <code>null</code> if the key is outside
|
||||
this lookup's range or the value is vacant.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public double? Get(string key, LazyLinkedListNode<SyntaxPiece> node, IReadOnlyList<INcDependency> dependencies)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>key</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>node</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>dependencies</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlylist-1">IReadOnlyList</a><<a class="xref" href="Hi.NcParsers.Dependencys.INcDependency.html">INcDependency</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</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>
|
||||
+546
@@ -0,0 +1,546 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class FanucToolOffsetVariableLookup | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class FanucToolOffsetVariableLookup | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Fanuc-side adapter that exposes a wrapped as an following Fanuc Memory C tool offset addressing: #2001+N → effective height of offset N (geometry − wear). The underlying stays brand-neutral — Heidenhain / Siemens can use the same storage with different addressing by registering their own adapter alongside the table. Holds a reference to the table rather than owning data so writes through the table show up immediately in lookups via this adapter.">
|
||||
<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.Fanuc.FanucToolOffsetVariableLookup">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_Dependencys_Fanuc_FanucToolOffsetVariableLookup" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucToolOffsetVariableLookup" class="text-break">
|
||||
Class FanucToolOffsetVariableLookup
|
||||
</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.Fanuc.html">Fanuc</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Fanuc-side adapter that exposes a wrapped <a class="xref" href="Hi.NcParsers.Dependencys.Generic.ToolOffsetTable.html">ToolOffsetTable</a>
|
||||
as an <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a> following Fanuc Memory C tool offset
|
||||
addressing: <code>#2001+N → effective height of offset N</code>
|
||||
(geometry − wear).</p>
|
||||
<p>
|
||||
The underlying <a class="xref" href="Hi.NcParsers.Dependencys.Generic.ToolOffsetTable.html">ToolOffsetTable</a> stays brand-neutral —
|
||||
Heidenhain / Siemens can use the same storage with different addressing
|
||||
by registering their own adapter alongside the table. Holds a reference
|
||||
to the table rather than owning data so writes through the table show
|
||||
up immediately in lookups via this adapter.
|
||||
</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class FanucToolOffsetVariableLookup : INcDependency, IMakeXmlSource, IVariableLookup</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">FanucToolOffsetVariableLookup</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.LogicSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</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_Fanuc_FanucToolOffsetVariableLookup__ctor_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucToolOffsetVariableLookup.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucToolOffsetVariableLookup__ctor" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucToolOffsetVariableLookup.#ctor">
|
||||
FanucToolOffsetVariableLookup()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Empty constructor for <a class="xref" href="Hi.Common.XmlUtils.XFactory.html">XFactory</a> deserialisation; <a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.FanucToolOffsetVariableLookup.html#Hi_NcParsers_Dependencys_Fanuc_FanucToolOffsetVariableLookup_Table">Table</a> must be set explicitly.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FanucToolOffsetVariableLookup()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Fanuc_FanucToolOffsetVariableLookup__ctor_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucToolOffsetVariableLookup.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucToolOffsetVariableLookup__ctor_Hi_NcParsers_Dependencys_Generic_ToolOffsetTable_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucToolOffsetVariableLookup.#ctor(Hi.NcParsers.Dependencys.Generic.ToolOffsetTable)">
|
||||
FanucToolOffsetVariableLookup(ToolOffsetTable)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Wraps the given <code class="paramref">table</code> so it can serve Fanuc-style <code>#2001+</code> reads.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FanucToolOffsetVariableLookup(ToolOffsetTable table)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>table</code> <a class="xref" href="Hi.NcParsers.Dependencys.Generic.ToolOffsetTable.html">ToolOffsetTable</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Fanuc_FanucToolOffsetVariableLookup__ctor_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucToolOffsetVariableLookup.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucToolOffsetVariableLookup__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucToolOffsetVariableLookup.#ctor(System.Xml.Linq.XElement)">
|
||||
FanucToolOffsetVariableLookup(XElement)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Loads from XML produced by <a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.FanucToolOffsetVariableLookup.html#Hi_NcParsers_Dependencys_Fanuc_FanucToolOffsetVariableLookup_MakeXmlSource_System_String_System_String_System_Boolean_">MakeXmlSource(string, string, bool)</a>; <a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.FanucToolOffsetVariableLookup.html#Hi_NcParsers_Dependencys_Fanuc_FanucToolOffsetVariableLookup_Table">Table</a> is rebound by the runner after deserialisation.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FanucToolOffsetVariableLookup(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></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="fields">Fields
|
||||
</h2>
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucToolOffsetVariableLookup_ToolHeightMax" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucToolOffsetVariableLookup.ToolHeightMax">
|
||||
ToolHeightMax
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Inclusive upper bound of the Fanuc tool height address range (<code>#2200</code>).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const int ToolHeightMax = 2200</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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucToolOffsetVariableLookup_ToolHeightMin" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucToolOffsetVariableLookup.ToolHeightMin">
|
||||
ToolHeightMin
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Inclusive lower bound of the Fanuc tool height address range (<code>#2001</code>).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const int ToolHeightMin = 2001</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_Fanuc_FanucToolOffsetVariableLookup_Table_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucToolOffsetVariableLookup.Table*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucToolOffsetVariableLookup_Table" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucToolOffsetVariableLookup.Table">
|
||||
Table
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Underlying brand-neutral tool offset storage.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ToolOffsetTable Table { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.NcParsers.Dependencys.Generic.ToolOffsetTable.html">ToolOffsetTable</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Fanuc_FanucToolOffsetVariableLookup_XName_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucToolOffsetVariableLookup.XName*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucToolOffsetVariableLookup_XName" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucToolOffsetVariableLookup.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>XML element name for <a class="xref" href="Hi.Common.XmlUtils.XFactory.html#Hi_Common_XmlUtils_XFactory_Regs">Regs</a> registration.</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_Fanuc_FanucToolOffsetVariableLookup_Get_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucToolOffsetVariableLookup.Get*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucToolOffsetVariableLookup_Get_System_String_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucToolOffsetVariableLookup.Get(System.String)">
|
||||
Get(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Returns the value of the variable identified by <code class="paramref">key</code>
|
||||
(e.g. <code>"#124"</code>), or <code>null</code> if vacant or unknown to this lookup.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public double? Get(string key)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>key</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_NcParsers_Dependencys_Fanuc_FanucToolOffsetVariableLookup_Get_System_String__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>Routes <code>#2001-#2200</code> to
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.Generic.ToolOffsetTable.html#Hi_NcParsers_Dependencys_Generic_ToolOffsetTable_GetToolHeightOffset_mm_System_Int32_">GetToolHeightOffset_mm(int)</a>; other
|
||||
keys return <code>null</code> so the evaluator's lookup chain falls through.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Fanuc_FanucToolOffsetVariableLookup_MakeXmlSource_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucToolOffsetVariableLookup.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_FanucToolOffsetVariableLookup_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.Dependencys.Fanuc.FanucToolOffsetVariableLookup.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_Fanuc_FanucToolOffsetVariableLookup_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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
+599
@@ -0,0 +1,599 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class RetainedCommonVariableTable | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class RetainedCommonVariableTable | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Fanuc-style ISO controller common variable table for the retained range #500-#999. These variables survive a power cycle (in real hardware they live in NV-RAM) and are serialised into the project file. Excluded by design: Local #1-#33Call-frame scoped (Fanuc local variables); lives in the SyntaxPiece JSON dataflow, not here.Non-retained common #100-#499Cleared by program-end / power reset; lives in the SyntaxPiece JSON dataflow as well, not in this table.System #1000+Read-only or computed from runtime state; resolved by dedicated reading syntaxes against other dependencies (e.g. , tool offset / WCS tables). Vacant (Fanuc &lt;vacant&gt;) is represented by null: either the dictionary has no entry for the key, or the entry maps to null. Both are treated identically by . Naming rationale: Fanuc official documentation calls #500-#999 "retained common variables" (and #100-#499 "non-retained common variables"). The umbrella term "macro variable" was avoided because it conflicts with Custom Macro B's call-frame concept (G65/G66 push a frame containing the local #1-#33); using RetainedCommonVariableTable reserves "macro" for the call-frame topic.">
|
||||
<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.Fanuc.RetainedCommonVariableTable">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable" data-uid="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable" class="text-break">
|
||||
Class RetainedCommonVariableTable
|
||||
</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.Fanuc.html">Fanuc</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Fanuc-style ISO controller common variable table for the retained range
|
||||
<code>#500-#999</code>. These variables survive a power cycle (in real hardware
|
||||
they live in NV-RAM) and are serialised into the project file.</p>
|
||||
<p>
|
||||
Excluded by design:
|
||||
<ul><li><span class="term">Local <code>#1-#33</code></span>Call-frame scoped (Fanuc local variables); lives in the <code>SyntaxPiece</code> JSON dataflow, not here.</li><li><span class="term">Non-retained common <code>#100-#499</code></span>Cleared by program-end / power reset; lives in the <code>SyntaxPiece</code> JSON dataflow as well, not in this table.</li><li><span class="term">System <code>#1000+</code></span>Read-only or computed from runtime state; resolved by dedicated reading syntaxes against other dependencies (e.g. <a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.html">FanucParameterTable</a>, tool offset / WCS tables).</li></ul>
|
||||
|
||||
<p>
|
||||
Vacant (Fanuc <code><vacant></code>) is represented by <code>null</code>: either the dictionary
|
||||
has no entry for the key, or the entry maps to <code>null</code>. Both are treated identically by <a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.html#Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable_GetVariable_System_Int32_">GetVariable(int)</a>.
|
||||
</p>
|
||||
<p>
|
||||
Naming rationale: Fanuc official documentation calls <code>#500-#999</code> "retained common variables"
|
||||
(and <code>#100-#499</code> "non-retained common variables"). The umbrella term "macro variable" was
|
||||
avoided because it conflicts with Custom Macro B's call-frame concept (G65/G66 push a frame
|
||||
containing the local <code>#1-#33</code>); using <code>RetainedCommonVariableTable</code> reserves "macro"
|
||||
for the call-frame topic.
|
||||
</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class RetainedCommonVariableTable : INcDependency, IMakeXmlSource, IVariableLookup</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">RetainedCommonVariableTable</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.LogicSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</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_Fanuc_RetainedCommonVariableTable__ctor_" data-uid="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable__ctor" data-uid="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.#ctor">
|
||||
RetainedCommonVariableTable()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Empty table.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public RetainedCommonVariableTable()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable__ctor_" data-uid="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.#ctor(System.Xml.Linq.XElement)">
|
||||
RetainedCommonVariableTable(XElement)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Loads from XML produced by <a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.html#Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable_MakeXmlSource_System_String_System_String_System_Boolean_">MakeXmlSource(string, string, bool)</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public RetainedCommonVariableTable(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></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="fields">Fields
|
||||
</h2>
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable_RetainedCommonMax" data-uid="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.RetainedCommonMax">
|
||||
RetainedCommonMax
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Inclusive upper bound of the retained common range (<code>#999</code>).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const int RetainedCommonMax = 999</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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable_RetainedCommonMin" data-uid="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.RetainedCommonMin">
|
||||
RetainedCommonMin
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Inclusive lower bound of the retained common range (<code>#500</code>).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const int RetainedCommonMin = 500</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_Fanuc_RetainedCommonVariableTable_Variables_" data-uid="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.Variables*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable_Variables" data-uid="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.Variables">
|
||||
Variables
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Backing store. Key = variable number (e.g. 500). Value <code>null</code> = vacant.
|
||||
A missing key is also treated as vacant. Keys are constrained to
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.html#Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable_RetainedCommonMin">RetainedCommonMin</a>..<a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.html#Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable_RetainedCommonMax">RetainedCommonMax</a>; out-of-range writes are silently ignored.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Dictionary<int, double?> Variables { 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.collections.generic.dictionary-2">Dictionary</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.double">double</a>?></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable_XName_" data-uid="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.XName*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable_XName" data-uid="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>XML element name.</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_Fanuc_RetainedCommonVariableTable_Get_" data-uid="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.Get*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable_Get_System_String_" data-uid="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.Get(System.String)">
|
||||
Get(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Returns the value of the variable identified by <code class="paramref">key</code>
|
||||
(e.g. <code>"#124"</code>), or <code>null</code> if vacant or unknown to this lookup.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public double? Get(string key)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>key</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable_Get_System_String__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>Routes <code>#500-#999</code> reads to <a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.html#Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable_GetVariable_System_Int32_">GetVariable(int)</a>;
|
||||
other keys return <code>null</code> so the evaluator's lookup chain falls
|
||||
through.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable_GetVariable_" data-uid="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.GetVariable*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable_GetVariable_System_Int32_" data-uid="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.GetVariable(System.Int32)">
|
||||
GetVariable(int)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Reads a retained common variable. Returns <code>null</code> for vacant (either the entry is absent
|
||||
or stored as <code>null</code>).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public double? GetVariable(int id)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>id</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>Variable number in <a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.html#Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable_RetainedCommonMin">RetainedCommonMin</a>..<a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.html#Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable_RetainedCommonMax">RetainedCommonMax</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable_MakeXmlSource_" data-uid="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.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_Fanuc_RetainedCommonVariableTable_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_Fanuc_RetainedCommonVariableTable_SetVariable_" data-uid="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.SetVariable*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable_SetVariable_System_Int32_System_Nullable_System_Double__" data-uid="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.SetVariable(System.Int32,System.Nullable{System.Double})">
|
||||
SetVariable(int, double?)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Writes a retained common variable. Pass <code>null</code> to set vacant.
|
||||
Ignores ids outside <a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.html#Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable_RetainedCommonMin">RetainedCommonMin</a>..<a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.html#Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable_RetainedCommonMax">RetainedCommonMax</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SetVariable(int id, double? value)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>id</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>Variable number.</p>
|
||||
</dd>
|
||||
<dt><code>value</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>?</dt>
|
||||
<dd><p>New value, or <code>null</code> for vacant.</p>
|
||||
</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>
|
||||
@@ -99,6 +99,57 @@ Classes
|
||||
<dd><p>Fanuc controller parameter table.
|
||||
Stores system parameters (single value) and axis parameters (per-axis value)
|
||||
following real Fanuc parameter numbering.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.FanucPositionVariableLookup.html">FanucPositionVariableLookup</a></dt>
|
||||
<dd><p>Fanuc-style position system variables read from the previous block's
|
||||
runtime-state JSON sections:</p>
|
||||
<ul><li><span class="term"><code>#5001-#5003</code></span>Block-end position X/Y/Z (workpiece) → previous block's <a class="xref" href="Hi.NcParsers.Keywords.IProgramXyzDef.html#Hi_NcParsers_Keywords_IProgramXyzDef_ProgramXyz">ProgramXyz</a>.</li><li><span class="term"><code>#5021-#5023</code></span>Current machine position X/Y/Z → previous block's <a class="xref" href="Hi.NcParsers.Keywords.MachineCoordinateState.html">MachineCoordinateState</a>.</li><li><span class="term"><code>#5041-#5043</code></span>Current absolute position X/Y/Z → previous block's <a class="xref" href="Hi.NcParsers.Keywords.IProgramXyzDef.html#Hi_NcParsers_Keywords_IProgramXyzDef_ProgramXyz">ProgramXyz</a>.</li></ul>
|
||||
<p>
|
||||
Stateless. Configured on
|
||||
VariableEvaluatorSyntax.RuntimeVariableLookups rather than
|
||||
<code>NcDependencyList</code> because the read needs the block node for
|
||||
<a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html#Hi_Common_Collections_LazyLinkedListNode_1_Previous">Previous</a> access — there is no
|
||||
long-lived dependency object that owns this data.
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.FanucToolOffsetVariableLookup.html">FanucToolOffsetVariableLookup</a></dt>
|
||||
<dd><p>Fanuc-side adapter that exposes a wrapped <a class="xref" href="Hi.NcParsers.Dependencys.Generic.ToolOffsetTable.html">ToolOffsetTable</a>
|
||||
as an <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a> following Fanuc Memory C tool offset
|
||||
addressing: <code>#2001+N → effective height of offset N</code>
|
||||
(geometry − wear).</p>
|
||||
<p>
|
||||
The underlying <a class="xref" href="Hi.NcParsers.Dependencys.Generic.ToolOffsetTable.html">ToolOffsetTable</a> stays brand-neutral —
|
||||
Heidenhain / Siemens can use the same storage with different addressing
|
||||
by registering their own adapter alongside the table. Holds a reference
|
||||
to the table rather than owning data so writes through the table show
|
||||
up immediately in lookups via this adapter.
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.html">RetainedCommonVariableTable</a></dt>
|
||||
<dd><p>Fanuc-style ISO controller common variable table for the retained range
|
||||
<code>#500-#999</code>. These variables survive a power cycle (in real hardware
|
||||
they live in NV-RAM) and are serialised into the project file.</p>
|
||||
<p>
|
||||
Excluded by design:
|
||||
<ul><li><span class="term">Local <code>#1-#33</code></span>Call-frame scoped (Fanuc local variables); lives in the <code>SyntaxPiece</code> JSON dataflow, not here.</li><li><span class="term">Non-retained common <code>#100-#499</code></span>Cleared by program-end / power reset; lives in the <code>SyntaxPiece</code> JSON dataflow as well, not in this table.</li><li><span class="term">System <code>#1000+</code></span>Read-only or computed from runtime state; resolved by dedicated reading syntaxes against other dependencies (e.g. <a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.html">FanucParameterTable</a>, tool offset / WCS tables).</li></ul>
|
||||
|
||||
<p>
|
||||
Vacant (Fanuc <code><vacant></code>) is represented by <code>null</code>: either the dictionary
|
||||
has no entry for the key, or the entry maps to <code>null</code>. Both are treated identically by <a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.html#Hi_NcParsers_Dependencys_Fanuc_RetainedCommonVariableTable_GetVariable_System_Int32_">GetVariable(int)</a>.
|
||||
</p>
|
||||
<p>
|
||||
Naming rationale: Fanuc official documentation calls <code>#500-#999</code> "retained common variables"
|
||||
(and <code>#100-#499</code> "non-retained common variables"). The umbrella term "macro variable" was
|
||||
avoided because it conflicts with Custom Macro B's call-frame concept (G65/G66 push a frame
|
||||
containing the local <code>#1-#33</code>); using <code>RetainedCommonVariableTable</code> reserves "macro"
|
||||
for the call-frame topic.
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<h3 id="enums">
|
||||
|
||||
+476
@@ -0,0 +1,476 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class GenericBlockSkipConfig | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class GenericBlockSkipConfig | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Default . Mirrors the typical Fanuc factory default: layer 1 (bare / prefix) is ON, other layers are OFF. Each layer can be toggled individually. XML form: &lt;GenericBlockSkipConfig&gt; &lt;EnabledLayers&gt;1,3&lt;/EnabledLayers&gt; &lt;/GenericBlockSkipConfig&gt; When EnabledLayers is absent the default is layer 1 only.">
|
||||
<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.Generic.GenericBlockSkipConfig">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_Dependencys_Generic_GenericBlockSkipConfig" data-uid="Hi.NcParsers.Dependencys.Generic.GenericBlockSkipConfig" class="text-break">
|
||||
Class GenericBlockSkipConfig
|
||||
</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.Generic.html">Generic</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Default <a class="xref" href="Hi.NcParsers.Dependencys.IBlockSkipConfig.html">IBlockSkipConfig</a>. Mirrors the typical Fanuc
|
||||
factory default: layer 1 (bare <code>/</code> prefix) is ON, other layers
|
||||
are OFF. Each layer can be toggled individually.</p>
|
||||
<p>
|
||||
XML form:
|
||||
<pre><code class="lang-csharp"><GenericBlockSkipConfig>
|
||||
<EnabledLayers>1,3</EnabledLayers>
|
||||
</GenericBlockSkipConfig></code></pre>
|
||||
When <code>EnabledLayers</code> is absent the default is layer 1 only.
|
||||
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class GenericBlockSkipConfig : IBlockSkipConfig, INcDependency, 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">GenericBlockSkipConfig</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.NcParsers.Dependencys.IBlockSkipConfig.html">IBlockSkipConfig</a></div>
|
||||
<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>
|
||||
</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_Generic_GenericBlockSkipConfig__ctor_" data-uid="Hi.NcParsers.Dependencys.Generic.GenericBlockSkipConfig.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_GenericBlockSkipConfig__ctor" data-uid="Hi.NcParsers.Dependencys.Generic.GenericBlockSkipConfig.#ctor">
|
||||
GenericBlockSkipConfig()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public GenericBlockSkipConfig()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Generic_GenericBlockSkipConfig__ctor_" data-uid="Hi.NcParsers.Dependencys.Generic.GenericBlockSkipConfig.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_GenericBlockSkipConfig__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.Dependencys.Generic.GenericBlockSkipConfig.#ctor(System.Xml.Linq.XElement)">
|
||||
GenericBlockSkipConfig(XElement)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public GenericBlockSkipConfig(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></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Generic_GenericBlockSkipConfig_EnabledLayers_" data-uid="Hi.NcParsers.Dependencys.Generic.GenericBlockSkipConfig.EnabledLayers*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_GenericBlockSkipConfig_EnabledLayers" data-uid="Hi.NcParsers.Dependencys.Generic.GenericBlockSkipConfig.EnabledLayers">
|
||||
EnabledLayers
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>CSV of currently-enabled layers, e.g. <code>“1,3”</code>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string EnabledLayers { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Generic_GenericBlockSkipConfig_XName_" data-uid="Hi.NcParsers.Dependencys.Generic.GenericBlockSkipConfig.XName*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_GenericBlockSkipConfig_XName" data-uid="Hi.NcParsers.Dependencys.Generic.GenericBlockSkipConfig.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></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_Generic_GenericBlockSkipConfig_IsLayerEnabled_" data-uid="Hi.NcParsers.Dependencys.Generic.GenericBlockSkipConfig.IsLayerEnabled*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_GenericBlockSkipConfig_IsLayerEnabled_System_Int32_" data-uid="Hi.NcParsers.Dependencys.Generic.GenericBlockSkipConfig.IsLayerEnabled(System.Int32)">
|
||||
IsLayerEnabled(int)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Returns true when blocks tagged with this layer should be skipped
|
||||
(controller switch ON).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool IsLayerEnabled(int layer)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>layer</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>Skip layer, 1..9. Bare <code>/</code> is layer 1.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Generic_GenericBlockSkipConfig_MakeXmlSource_" data-uid="Hi.NcParsers.Dependencys.Generic.GenericBlockSkipConfig.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_GenericBlockSkipConfig_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.Dependencys.Generic.GenericBlockSkipConfig.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_Generic_GenericBlockSkipConfig_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_Generic_GenericBlockSkipConfig_SetLayerEnabled_" data-uid="Hi.NcParsers.Dependencys.Generic.GenericBlockSkipConfig.SetLayerEnabled*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_GenericBlockSkipConfig_SetLayerEnabled_System_Int32_System_Boolean_" data-uid="Hi.NcParsers.Dependencys.Generic.GenericBlockSkipConfig.SetLayerEnabled(System.Int32,System.Boolean)">
|
||||
SetLayerEnabled(int, bool)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Enables / disables a specific skip layer.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SetLayerEnabled(int layer, bool enabled)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>layer</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>Skip layer, 1..9.</p>
|
||||
</dd>
|
||||
<dt><code>enabled</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p>True to skip blocks tagged with this layer.</p>
|
||||
</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>
|
||||
+117
-2
@@ -6,7 +6,7 @@
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class IsoCoordinateTable | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Coordinate table for NC controller. The dictionary key is a G-code coordinate name (e.g. &ldquo;G54&rdquo;, &ldquo;G59.2&rdquo;); the dictionary value is machine coordinate offset.">
|
||||
<meta name="description" content="Coordinate table for NC controller. The dictionary key is a G-code coordinate name (e.g. &ldquo;G54&rdquo;, &ldquo;G59.2&rdquo;); the dictionary value is machine coordinate offset. Brand-agnostic standalone implementation of . Brand parameter tables (Fanuc, Syntec, Siemens, Heidenhain) provide hardware-faithful alternatives that map to real controller parameters.">
|
||||
<link rel="icon" href="../img/HiAPI.favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
@@ -100,11 +100,16 @@ Class IsoCoordinateTable
|
||||
<div class="markdown summary"><p>Coordinate table for NC controller.
|
||||
The dictionary key is a G-code coordinate name (e.g. “G54”, “G59.2”);
|
||||
the dictionary value is machine coordinate offset.</p>
|
||||
<p>
|
||||
Brand-agnostic standalone implementation of <a class="xref" href="Hi.NcParsers.Dependencys.IIsoCoordinateConfig.html">IIsoCoordinateConfig</a>.
|
||||
Brand parameter tables (Fanuc, Syntec, Siemens, Heidenhain) provide
|
||||
hardware-faithful alternatives that map to real controller parameters.
|
||||
</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class IsoCoordinateTable : Dictionary<string, Vec3d>, IDictionary<string, Vec3d>, ICollection<KeyValuePair<string, Vec3d>>, IReadOnlyDictionary<string, Vec3d>, IReadOnlyCollection<KeyValuePair<string, Vec3d>>, IEnumerable<KeyValuePair<string, Vec3d>>, IDictionary, ICollection, IEnumerable, IDeserializationCallback, ISerializable, INcDependency, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class IsoCoordinateTable : Dictionary<string, Vec3d>, IDictionary<string, Vec3d>, ICollection<KeyValuePair<string, Vec3d>>, IReadOnlyDictionary<string, Vec3d>, IReadOnlyCollection<KeyValuePair<string, Vec3d>>, IEnumerable<KeyValuePair<string, Vec3d>>, IDictionary, ICollection, IEnumerable, IDeserializationCallback, ISerializable, IIsoCoordinateConfig, INcDependency, IMakeXmlSource</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -132,6 +137,7 @@ the dictionary value is machine coordinate offset.</p>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.ienumerable">IEnumerable</a></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.runtime.serialization.ideserializationcallback">IDeserializationCallback</a></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.runtime.serialization.iserializable">ISerializable</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.Dependencys.IIsoCoordinateConfig.html">IIsoCoordinateConfig</a></div>
|
||||
<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>
|
||||
</dd>
|
||||
@@ -375,10 +381,85 @@ Supports both new string ID format (“G54”) and legacy integer format
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Generic_IsoCoordinateTable_CoordinateIds_" data-uid="Hi.NcParsers.Dependencys.Generic.IsoCoordinateTable.CoordinateIds*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_IsoCoordinateTable_CoordinateIds" data-uid="Hi.NcParsers.Dependencys.Generic.IsoCoordinateTable.CoordinateIds">
|
||||
CoordinateIds
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Enumerates the G-code coordinate ids that this provider currently has data for.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<string> CoordinateIds { 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.ienumerable-1">IEnumerable</a><<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_Generic_IsoCoordinateTable_GetCoordinateOffset_" data-uid="Hi.NcParsers.Dependencys.Generic.IsoCoordinateTable.GetCoordinateOffset*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_IsoCoordinateTable_GetCoordinateOffset_System_String_" data-uid="Hi.NcParsers.Dependencys.Generic.IsoCoordinateTable.GetCoordinateOffset(System.String)">
|
||||
GetCoordinateOffset(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the offset for the given G-code coordinate id.
|
||||
Returns null when no offset is configured for that id by this provider
|
||||
(callers iterate the next provider, or fall back to <a class="xref" href="Hi.Geom.Vec3d.html#Hi_Geom_Vec3d_Zero">Zero</a>).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Vec3d GetCoordinateOffset(string coordId)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>coordId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Generic_IsoCoordinateTable_LegacyIntToKey_" data-uid="Hi.NcParsers.Dependencys.Generic.IsoCoordinateTable.LegacyIntToKey*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_IsoCoordinateTable_LegacyIntToKey_System_Int32_" data-uid="Hi.NcParsers.Dependencys.Generic.IsoCoordinateTable.LegacyIntToKey(System.Int32)">
|
||||
@@ -468,6 +549,40 @@ Since the folder can be moving with the configuration file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Generic_IsoCoordinateTable_SetCoordinateOffset_" data-uid="Hi.NcParsers.Dependencys.Generic.IsoCoordinateTable.SetCoordinateOffset*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_IsoCoordinateTable_SetCoordinateOffset_System_String_Hi_Geom_Vec3d_" data-uid="Hi.NcParsers.Dependencys.Generic.IsoCoordinateTable.SetCoordinateOffset(System.String,Hi.Geom.Vec3d)">
|
||||
SetCoordinateOffset(string, Vec3d)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Sets the offset for the given G-code coordinate id.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SetCoordinateOffset(string coordId, Vec3d offset)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>coordId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>offset</code> <a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
|
||||
+50
@@ -542,6 +542,56 @@ the solution only fit the orientation part of the <code class="paramref">tiltMat
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_OrientationToMcAbc_" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.OrientationToMcAbc*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_OrientationToMcAbc_Hi_Geom_Vec3d_Hi_Geom_Vec3d__" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.OrientationToMcAbc(Hi.Geom.Vec3d,Hi.Geom.Vec3d@)">
|
||||
OrientationToMcAbc(Vec3d, out Vec3d)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Converts a target tool axial direction (endpoint orientation) to machine ABC coordinates.
|
||||
Only the axial alignment is constrained; rotation about the tool axis is free.</p>
|
||||
<p>
|
||||
Use this in place of <a class="xref" href="Hi.Numerical.Xyzabc.IMachineKinematics.html#Hi_Numerical_Xyzabc_IMachineKinematics_OrientationToMcAbc_Hi_Geom_Mat4d_Hi_Geom_Vec3d__">OrientationToMcAbc(Mat4d, out Vec3d)</a> when the
|
||||
rotation about the tool axis is irrelevant (e.g. G53.1 rotary positioning). The
|
||||
axial-only solve avoids the redundant 6-target full-matrix constraint and is more
|
||||
likely to converge for tilt configurations such as <code>G68.2 I180 J90 K0</code>.
|
||||
</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool OrientationToMcAbc(Vec3d toolAxialNormal, out Vec3d mcAbc_rad)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>toolAxialNormal</code> <a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a></dt>
|
||||
<dd><p>Target tool axial direction in table coordinates
|
||||
(the third row of the tilt matrix; e.g. <a class="xref" href="Hi.Geom.Mat4d.html#Hi_Geom_Mat4d_AxialNormal">AxialNormal</a>).</p>
|
||||
</dd>
|
||||
<dt><code>mcAbc_rad</code> <a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a></dt>
|
||||
<dd><p>Output machine ABC coordinates in radians.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p>Whether the conversion was successful.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_PnToMc_" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.PnToMc*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_PnToMc_Hi_Geom_DVec3d_Hi_Geom_DVec3d__" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.PnToMc(Hi.Geom.DVec3d,Hi.Geom.DVec3d@)">
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user