This commit is contained in:
2025-12-05 16:33:37 +08:00
parent dbbe3303b3
commit 9de88d2db0
163 changed files with 5633 additions and 2293 deletions
@@ -103,7 +103,7 @@ Class Substraction
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[BsonIgnoreExtraElements]
public class Substraction : IWriteBin, IExpandToBox3d</code></pre>
public class Substraction : IWriteBin, IDisplayee, IExpandToBox3d</code></pre>
</div>
@@ -121,6 +121,7 @@ public class Substraction : IWriteBin, IExpandToBox3d</code></pre>
<dt>Implements</dt>
<dd>
<div><a class="xref" href="Hi.Common.IWriteBin.html">IWriteBin</a></div>
<div><a class="xref" href="Hi.Disp.IDisplayee.html">IDisplayee</a></div>
<div><a class="xref" href="Hi.Geom.IExpandToBox3d.html">IExpandToBox3d</a></div>
</dd>
</dl>
@@ -167,6 +168,9 @@ public class Substraction : IWriteBin, IExpandToBox3d</code></pre>
<div>
<a class="xref" href="Hi.Milling.MillingRemovalUtil.html#Hi_Milling_MillingRemovalUtil_GetContoursOnToolRunningCoordinate_Hi_Cbtr_Substraction_Hi_MachiningSteps_MachineMotionStep_">MillingRemovalUtil.GetContoursOnToolRunningCoordinate(Substraction, MachineMotionStep)</a>
</div>
<div>
<a class="xref" href="Hi.Disp.DispUtil.html#Hi_Disp_DispUtil_Display_Hi_Disp_IDisplayee_Hi_Disp_Bind_Hi_Geom_Mat4d_">DispUtil.Display(IDisplayee, Bind, Mat4d)</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>
@@ -293,7 +297,7 @@ public class Substraction : IWriteBin, IExpandToBox3d</code></pre>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the contact contours.</p>
<div class="markdown level1 summary"><p>Gets or sets the contact contours on workpiece coordinate.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -533,6 +537,39 @@ public int StepIndex { get; set; }</code></pre>
<a id="Hi_Cbtr_Substraction_Display_" data-uid="Hi.Cbtr.Substraction.Display*"></a>
<h3 id="Hi_Cbtr_Substraction_Display_Hi_Disp_Bind_" data-uid="Hi.Cbtr.Substraction.Display(Hi.Disp.Bind)">
Display(Bind)
</h3>
<div class="markdown level1 summary"><p>Display function called in <a class="xref" href="Hi.Disp.DispEngine.html">DispEngine</a> rendering loop.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Display(Bind bind)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>bind</code> <a class="xref" href="Hi.Disp.Bind.html">Bind</a></dt>
<dd><p>Bind with <a class="xref" href="Hi.Disp.DispEngine.html">DispEngine</a>. See <a class="xref" href="Hi.Disp.Bind.html">Bind</a>.</p>
</dd>
</dl>
<a id="Hi_Cbtr_Substraction_ExpandToBox3d_" data-uid="Hi.Cbtr.Substraction.ExpandToBox3d*"></a>
<h3 id="Hi_Cbtr_Substraction_ExpandToBox3d_Hi_Geom_Box3d_" data-uid="Hi.Cbtr.Substraction.ExpandToBox3d(Hi.Geom.Box3d)">
@@ -391,42 +391,6 @@ Class UnmanagedSubstraction
<a id="Hi_Cbtr_UnmanagedSubstraction_DisplayContours_" data-uid="Hi.Cbtr.UnmanagedSubstraction.DisplayContours*"></a>
<h3 id="Hi_Cbtr_UnmanagedSubstraction_DisplayContours_System_Collections_Generic_List_System_Collections_Generic_List_Hi_Geom_Vec3d___Hi_Disp_Bind_" data-uid="Hi.Cbtr.UnmanagedSubstraction.DisplayContours(System.Collections.Generic.List{System.Collections.Generic.List{Hi.Geom.Vec3d}},Hi.Disp.Bind)">
DisplayContours(List&lt;List&lt;Vec3d&gt;&gt;, Bind)
</h3>
<div class="markdown level1 summary"><p>Displays contours in a visualization binding.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void DisplayContours(List&lt;List&lt;Vec3d&gt;&gt; contours, Bind bind)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>contours</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a>&gt;&gt;</dt>
<dd><p>The list of contours to display, where each contour is a list of 3D points.</p>
</dd>
<dt><code>bind</code> <a class="xref" href="Hi.Disp.Bind.html">Bind</a></dt>
<dd><p>The binding to display the contours in.</p>
</dd>
</dl>
<a id="Hi_Cbtr_UnmanagedSubstraction_Dispose_" data-uid="Hi.Cbtr.UnmanagedSubstraction.Dispose*"></a>
<h3 id="Hi_Cbtr_UnmanagedSubstraction_Dispose" data-uid="Hi.Cbtr.UnmanagedSubstraction.Dispose">
@@ -151,11 +151,11 @@ Enum BinarySearchResult
</dd>
<dt id="Hi_Common_BinarySearchResult_FoundCeil"><code>FoundCeil = 8</code></dt>
<dd><p>Indicates that a value greater than or equal to the target was found.</p>
<dd><p>Indicates that a value greater than to the target was found.</p>
</dd>
<dt id="Hi_Common_BinarySearchResult_FoundFloor"><code>FoundFloor = 4</code></dt>
<dd><p>Indicates that a value less than or equal to the target was found.</p>
<dd><p>Indicates that a value less than to the target was found.</p>
</dd>
<dt id="Hi_Common_BinarySearchResult_NotExisted"><code>NotExisted = 1</code></dt>
@@ -0,0 +1,183 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Enum SortedListUtil.SeekDirection | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Enum SortedListUtil.SeekDirection | HiAPI-C# 2025 ">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">
<meta name="docfx:rel" content="../">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../public/docfx.min.js"></script>
<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>
</head>
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../img/HiAPI.logo.png" alt="">
</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>
<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>
<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Hi.Common.Collections.SortedListUtil.SeekDirection">
<h1 id="Hi_Common_Collections_SortedListUtil_SeekDirection" data-uid="Hi.Common.Collections.SortedListUtil.SeekDirection" class="text-break">
Enum SortedListUtil.SeekDirection
</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.Collections.html">Collections</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public enum SortedListUtil.SeekDirection</code></pre>
</div>
<dl class="typelist extensionMethods">
<dt>Extension Methods</dt>
<dd>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke&lt;TSrc&gt;(TSrc, Action&lt;TSrc&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke&lt;TSrc, TDst&gt;(TSrc, Func&lt;TSrc, TDst&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.MaskUtil.html#Hi_Common_MaskUtil_GetMaskedValue__1___0___0_System_Boolean_">MaskUtil.GetMaskedValue&lt;T&gt;(T, T, bool)</a>
</div>
<div>
<a class="xref" href="Hi.Common.MaskUtil.html#Hi_Common_MaskUtil_SetMask__1___0____0_System_Boolean_">MaskUtil.SetMask&lt;T&gt;(ref T, T, bool)</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="fields">Fields
</h2>
<dl class="parameters">
<dt id="Hi_Common_Collections_SortedListUtil_SeekDirection_Backward"><code>Backward = 2</code></dt>
<dd></dd>
<dt id="Hi_Common_Collections_SortedListUtil_SeekDirection_Forward"><code>Forward = 1</code></dt>
<dd></dd>
<dt id="Hi_Common_Collections_SortedListUtil_SeekDirection_Free"><code>Free = 0</code></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>
@@ -155,18 +155,18 @@ Class SortedListUtil
<a id="Hi_Common_Collections_SortedListUtil_GetByMethod_" data-uid="Hi.Common.Collections.SortedListUtil.GetByMethod*"></a>
<h3 id="Hi_Common_Collections_SortedListUtil_GetByMethod__2_System_Collections_Generic_SortedList___0___1____0_Hi_Common_Collections_SortedListUtil_SearchMethod_Hi_Common_BinarySearchResult__" data-uid="Hi.Common.Collections.SortedListUtil.GetByMethod``2(System.Collections.Generic.SortedList{``0,``1},``0,Hi.Common.Collections.SortedListUtil.SearchMethod,Hi.Common.BinarySearchResult@)">
GetByMethod&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, SearchMethod, out BinarySearchResult)
<h3 id="Hi_Common_Collections_SortedListUtil_GetByMethod__2_System_Collections_Generic_SortedList___0___1____0_Hi_Common_Collections_SortedListUtil_SearchMethod___1__System_Int32_System_Int32_" data-uid="Hi.Common.Collections.SortedListUtil.GetByMethod``2(System.Collections.Generic.SortedList{``0,``1},``0,Hi.Common.Collections.SortedListUtil.SearchMethod,``1@,System.Int32,System.Int32)">
GetByMethod&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, SearchMethod, out V, int, int)
</h3>
<div class="markdown level1 summary"><p>Get value by <code class="paramref">searchMethod</code>.
If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Common_BinarySearchResult_NotExisted">NotExisted</a>, return the default value of <code class="typeparamref">V</code>.</p>
If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Common_BinarySearchResult_NotExisted">NotExisted</a>, <code class="paramref">resultValue</code> will be the default value of <code class="typeparamref">V</code>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static V GetByMethod&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, SortedListUtil.SearchMethod searchMethod, out BinarySearchResult result) where TKey : IComparable&lt;TKey&gt;</code></pre>
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetByMethod&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, SortedListUtil.SearchMethod searchMethod, out V resultValue, int beginIndex = 0, int endIndex = -1) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -180,15 +180,21 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<dt><code>searchMethod</code> <a class="xref" href="Hi.Common.Collections.SortedListUtil.html">SortedListUtil</a>.<a class="xref" href="Hi.Common.Collections.SortedListUtil.SearchMethod.html">SearchMethod</a></dt>
<dd><p>search method</p>
</dd>
<dt><code>result</code> <a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd><p>result</p>
<dt><code>resultValue</code> <span class="xref">V</span></dt>
<dd><p>searched value</p>
</dd>
<dt><code>beginIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The starting index for the search range (inclusive). Default is 0.</p>
</dd>
<dt><code>endIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The ending index for the search range (exclusive). Default is -1, which means the end of the list.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">V</span></dt>
<dd><p>searched value</p>
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd><p>search result</p>
</dd>
</dl>
@@ -211,10 +217,10 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<a id="Hi_Common_Collections_SortedListUtil_GetCeilIndex_" data-uid="Hi.Common.Collections.SortedListUtil.GetCeilIndex*"></a>
<a id="Hi_Common_Collections_SortedListUtil_GetCeilListIndex_" data-uid="Hi.Common.Collections.SortedListUtil.GetCeilListIndex*"></a>
<h3 id="Hi_Common_Collections_SortedListUtil_GetCeilIndex__2_System_Collections_Generic_SortedList___0___1____0_Hi_Common_BinarySearchResult__" data-uid="Hi.Common.Collections.SortedListUtil.GetCeilIndex``2(System.Collections.Generic.SortedList{``0,``1},``0,Hi.Common.BinarySearchResult@)">
GetCeilIndex&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, out BinarySearchResult)
<h3 id="Hi_Common_Collections_SortedListUtil_GetCeilListIndex__2_System_Collections_Generic_SortedList___0___1____0_System_Int32__System_Int32_System_Int32_" data-uid="Hi.Common.Collections.SortedListUtil.GetCeilListIndex``2(System.Collections.Generic.SortedList{``0,``1},``0,System.Int32@,System.Int32,System.Int32)">
GetCeilListIndex&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, out int, int, int)
</h3>
@@ -223,7 +229,7 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static int GetCeilIndex&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out BinarySearchResult result) where TKey : IComparable&lt;TKey&gt;</code></pre>
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetCeilListIndex&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out int resultListIndex, int beginListIndex = 0, int endListIndex = -1) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -234,15 +240,19 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<dt><code>key</code> <span class="xref">TKey</span></dt>
<dd><p>The key to search for.</p>
</dd>
<dt><code>result</code> <a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd><p>When this method returns, contains a value indicating whether an exact match was found, a ceiling value was found, or no suitable element exists.</p>
<dt><code>resultListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>When this method returns, contains the index of the ceiling element if found; otherwise, -1.</p>
</dd>
<dt><code>beginListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dt><code>endListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</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.int32">int</a></dt>
<dd><p>The index of the ceiling element if found; otherwise, -1.</p>
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd><p>A value indicating whether an exact match was found, a ceiling value was found, or no suitable element exists.</p>
</dd>
</dl>
@@ -267,18 +277,69 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<a id="Hi_Common_Collections_SortedListUtil_GetCeil_" data-uid="Hi.Common.Collections.SortedListUtil.GetCeil*"></a>
<h3 id="Hi_Common_Collections_SortedListUtil_GetCeil__2_System_Collections_Generic_SortedList___0___1____0_Hi_Common_BinarySearchResult__" data-uid="Hi.Common.Collections.SortedListUtil.GetCeil``2(System.Collections.Generic.SortedList{``0,``1},``0,Hi.Common.BinarySearchResult@)">
GetCeil&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, out BinarySearchResult)
<h3 id="Hi_Common_Collections_SortedListUtil_GetCeil__2_System_Collections_Generic_SortedList___0___1____0___1__System_Int32_System_Int32_" data-uid="Hi.Common.Collections.SortedListUtil.GetCeil``2(System.Collections.Generic.SortedList{``0,``1},``0,``1@,System.Int32,System.Int32)">
GetCeil&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, out V, int, int)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetCeil&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out V resultValue, int beginIndex = 0, int endIndex = -1) where TKey : IComparable&lt;TKey&gt;</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.sortedlist-2">SortedList</a>&lt;TKey, V&gt;</dt>
<dd></dd>
<dt><code>key</code> <span class="xref">TKey</span></dt>
<dd></dd>
<dt><code>resultValue</code> <span class="xref">V</span></dt>
<dd></dd>
<dt><code>beginIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dt><code>endIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd></dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>TKey</code></dt>
<dd></dd>
<dt><code>V</code></dt>
<dd></dd>
</dl>
<a id="Hi_Common_Collections_SortedListUtil_GetCeil_" data-uid="Hi.Common.Collections.SortedListUtil.GetCeil*"></a>
<h3 id="Hi_Common_Collections_SortedListUtil_GetCeil__2_System_Collections_Generic_SortedList___0___1____0___1__System_Int32__System_Int32_System_Int32_" data-uid="Hi.Common.Collections.SortedListUtil.GetCeil``2(System.Collections.Generic.SortedList{``0,``1},``0,``1@,System.Int32@,System.Int32,System.Int32)">
GetCeil&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, out V, out int, int, int)
</h3>
<div class="markdown level1 summary"><p>Get ceil value by <code class="paramref">key</code>.
If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Common_BinarySearchResult_NotExisted">NotExisted</a>, return the default value of <code class="typeparamref">V</code>.</p>
If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Common_BinarySearchResult_NotExisted">NotExisted</a>, <code class="paramref">resultValue</code> will be the default value of <code class="typeparamref">V</code>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static V GetCeil&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out BinarySearchResult result) where TKey : IComparable&lt;TKey&gt;</code></pre>
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetCeil&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out V resultValue, out int ceilIndex, int beginIndex = 0, int endIndex = -1) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -289,15 +350,23 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<dt><code>key</code> <span class="xref">TKey</span></dt>
<dd><p>key</p>
</dd>
<dt><code>result</code> <a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd><p>result</p>
<dt><code>resultValue</code> <span class="xref">V</span></dt>
<dd><p>ceil value</p>
</dd>
<dt><code>ceilIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dt><code>beginIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The starting index for the search range (inclusive). Default is 0.</p>
</dd>
<dt><code>endIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The ending index for the search range (exclusive). Default is -1, which means the end of the list.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">V</span></dt>
<dd><p>ceil value</p>
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd><p>search result</p>
</dd>
</dl>
@@ -322,8 +391,8 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<a id="Hi_Common_Collections_SortedListUtil_GetEnumerableByKeyBoundary_" data-uid="Hi.Common.Collections.SortedListUtil.GetEnumerableByKeyBoundary*"></a>
<h3 id="Hi_Common_Collections_SortedListUtil_GetEnumerableByKeyBoundary__2_System_Collections_Generic_SortedList___0___1____0_System_Boolean___0_System_Boolean_" data-uid="Hi.Common.Collections.SortedListUtil.GetEnumerableByKeyBoundary``2(System.Collections.Generic.SortedList{``0,``1},``0,System.Boolean,``0,System.Boolean)">
GetEnumerableByKeyBoundary&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, bool, TKey, bool)
<h3 id="Hi_Common_Collections_SortedListUtil_GetEnumerableByKeyBoundary__2_System_Collections_Generic_SortedList___0___1____0_System_Boolean___0_System_Boolean_System_Int32_System_Int32_" data-uid="Hi.Common.Collections.SortedListUtil.GetEnumerableByKeyBoundary``2(System.Collections.Generic.SortedList{``0,``1},``0,System.Boolean,``0,System.Boolean,System.Int32,System.Int32)">
GetEnumerableByKeyBoundary&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, bool, TKey, bool, int, int)
</h3>
@@ -332,7 +401,7 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;KeyValuePair&lt;TKey, V&gt;&gt; GetEnumerableByKeyBoundary&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey begin, bool isIncludingBeginFloor, TKey end, bool isIncludingEndCeil) where TKey : IComparable&lt;TKey&gt;</code></pre>
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;KeyValuePair&lt;TKey, V&gt;&gt; GetEnumerableByKeyBoundary&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey begin, bool isIncludingBeginFloor, TKey end, bool isIncludingEndCeil, int beginIndex = 0, int endIndex = -1) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -351,6 +420,12 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
</dd>
<dt><code>isIncludingEndCeil</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>Whether to include the ceiling value of the ending key.</p>
</dd>
<dt><code>beginIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The starting index for the search range (inclusive). Default is 0.</p>
</dd>
<dt><code>endIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The ending index for the search range (exclusive). Default is -1, which means the end of the list.</p>
</dd>
</dl>
@@ -380,10 +455,118 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<a id="Hi_Common_Collections_SortedListUtil_GetFloorIndex_" data-uid="Hi.Common.Collections.SortedListUtil.GetFloorIndex*"></a>
<a id="Hi_Common_Collections_SortedListUtil_GetFloorBySeek_" data-uid="Hi.Common.Collections.SortedListUtil.GetFloorBySeek*"></a>
<h3 id="Hi_Common_Collections_SortedListUtil_GetFloorIndex__2_System_Collections_Generic_SortedList___0___1____0_Hi_Common_BinarySearchResult__" data-uid="Hi.Common.Collections.SortedListUtil.GetFloorIndex``2(System.Collections.Generic.SortedList{``0,``1},``0,Hi.Common.BinarySearchResult@)">
GetFloorIndex&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, out BinarySearchResult)
<h3 id="Hi_Common_Collections_SortedListUtil_GetFloorBySeek__2_System_Collections_Generic_SortedList___0___1____0___1__System_Int32__System_Int32_Hi_Common_Collections_SortedListUtil_SeekDirection_" data-uid="Hi.Common.Collections.SortedListUtil.GetFloorBySeek``2(System.Collections.Generic.SortedList{``0,``1},``0,``1@,System.Int32@,System.Int32,Hi.Common.Collections.SortedListUtil.SeekDirection)">
GetFloorBySeek&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, out V, out int, int, SeekDirection)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetFloorBySeek&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out V floorValue, out int floorListIndex, int startListIndex, SortedListUtil.SeekDirection seekDirection = SeekDirection.Free) where TKey : IComparable&lt;TKey&gt;</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.sortedlist-2">SortedList</a>&lt;TKey, V&gt;</dt>
<dd></dd>
<dt><code>key</code> <span class="xref">TKey</span></dt>
<dd></dd>
<dt><code>floorValue</code> <span class="xref">V</span></dt>
<dd></dd>
<dt><code>floorListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dt><code>startListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dt><code>seekDirection</code> <a class="xref" href="Hi.Common.Collections.SortedListUtil.html">SortedListUtil</a>.<a class="xref" href="Hi.Common.Collections.SortedListUtil.SeekDirection.html">SeekDirection</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd></dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>TKey</code></dt>
<dd></dd>
<dt><code>V</code></dt>
<dd></dd>
</dl>
<a id="Hi_Common_Collections_SortedListUtil_GetFloorListIndexBySeek_" data-uid="Hi.Common.Collections.SortedListUtil.GetFloorListIndexBySeek*"></a>
<h3 id="Hi_Common_Collections_SortedListUtil_GetFloorListIndexBySeek__2_System_Collections_Generic_SortedList___0___1____0_System_Int32__System_Int32_Hi_Common_Collections_SortedListUtil_SeekDirection_" data-uid="Hi.Common.Collections.SortedListUtil.GetFloorListIndexBySeek``2(System.Collections.Generic.SortedList{``0,``1},``0,System.Int32@,System.Int32,Hi.Common.Collections.SortedListUtil.SeekDirection)">
GetFloorListIndexBySeek&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, out int, int, SeekDirection)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetFloorListIndexBySeek&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out int floorListIndex, int startListIndex, SortedListUtil.SeekDirection seekDirection = SeekDirection.Free) where TKey : IComparable&lt;TKey&gt;</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.sortedlist-2">SortedList</a>&lt;TKey, V&gt;</dt>
<dd></dd>
<dt><code>key</code> <span class="xref">TKey</span></dt>
<dd></dd>
<dt><code>floorListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dt><code>startListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dt><code>seekDirection</code> <a class="xref" href="Hi.Common.Collections.SortedListUtil.html">SortedListUtil</a>.<a class="xref" href="Hi.Common.Collections.SortedListUtil.SeekDirection.html">SeekDirection</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd></dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>TKey</code></dt>
<dd></dd>
<dt><code>V</code></dt>
<dd></dd>
</dl>
<h4 class="section" id="Hi_Common_Collections_SortedListUtil_GetFloorListIndexBySeek__2_System_Collections_Generic_SortedList___0___1____0_System_Int32__System_Int32_Hi_Common_Collections_SortedListUtil_SeekDirection__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>The <a class="xref" href="Hi.Common.Collections.SortedListUtil.SeekDirection.html#Hi_Common_Collections_SortedListUtil_SeekDirection_Free">Free</a> seek direction does not loss additional performance.
The seek direction only effect the resulting value by the <code class="paramref">startListIndex</code> bound.</p>
</div>
<a id="Hi_Common_Collections_SortedListUtil_GetFloorListIndex_" data-uid="Hi.Common.Collections.SortedListUtil.GetFloorListIndex*"></a>
<h3 id="Hi_Common_Collections_SortedListUtil_GetFloorListIndex__2_System_Collections_Generic_SortedList___0___1____0_System_Int32__System_Int32_System_Int32_" data-uid="Hi.Common.Collections.SortedListUtil.GetFloorListIndex``2(System.Collections.Generic.SortedList{``0,``1},``0,System.Int32@,System.Int32,System.Int32)">
GetFloorListIndex&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, out int, int, int)
</h3>
@@ -392,7 +575,7 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static int GetFloorIndex&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out BinarySearchResult result) where TKey : IComparable&lt;TKey&gt;</code></pre>
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetFloorListIndex&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out int resultListIndex, int beginListIndex = 0, int endListIndex = -1) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -403,15 +586,19 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<dt><code>key</code> <span class="xref">TKey</span></dt>
<dd><p>The key to search for.</p>
</dd>
<dt><code>result</code> <a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd><p>When this method returns, contains a value indicating whether an exact match was found, a floor value was found, or no suitable element exists.</p>
<dt><code>resultListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>When this method returns, contains the index of the floor element if found; otherwise, -1.</p>
</dd>
<dt><code>beginListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dt><code>endListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</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.int32">int</a></dt>
<dd><p>The index of the floor element if found; otherwise, -1.</p>
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd><p>A value indicating whether an exact match was found, a floor value was found, or no suitable element exists.</p>
</dd>
</dl>
@@ -436,18 +623,18 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<a id="Hi_Common_Collections_SortedListUtil_GetFloor_" data-uid="Hi.Common.Collections.SortedListUtil.GetFloor*"></a>
<h3 id="Hi_Common_Collections_SortedListUtil_GetFloor__2_System_Collections_Generic_SortedList___0___1____0_Hi_Common_BinarySearchResult__" data-uid="Hi.Common.Collections.SortedListUtil.GetFloor``2(System.Collections.Generic.SortedList{``0,``1},``0,Hi.Common.BinarySearchResult@)">
GetFloor&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, out BinarySearchResult)
<h3 id="Hi_Common_Collections_SortedListUtil_GetFloor__2_System_Collections_Generic_SortedList___0___1____0___1__System_Int32_System_Int32_" data-uid="Hi.Common.Collections.SortedListUtil.GetFloor``2(System.Collections.Generic.SortedList{``0,``1},``0,``1@,System.Int32,System.Int32)">
GetFloor&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, out V, int, int)
</h3>
<div class="markdown level1 summary"><p>Get floor value by <code class="paramref">key</code>.
If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Common_BinarySearchResult_NotExisted">NotExisted</a>, return the default value of <code class="typeparamref">V</code>.</p>
If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Common_BinarySearchResult_NotExisted">NotExisted</a>, <code class="paramref">resultValue</code> will be the default value of <code class="typeparamref">V</code>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static V GetFloor&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out BinarySearchResult result) where TKey : IComparable&lt;TKey&gt;</code></pre>
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetFloor&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out V resultValue, int beginIndex = 0, int endIndex = -1) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -458,15 +645,21 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<dt><code>key</code> <span class="xref">TKey</span></dt>
<dd><p>key</p>
</dd>
<dt><code>result</code> <a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd><p>result</p>
<dt><code>resultValue</code> <span class="xref">V</span></dt>
<dd><p>floor value</p>
</dd>
<dt><code>beginIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The starting index for the search range (inclusive). Default is 0.</p>
</dd>
<dt><code>endIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The ending index for the search range (exclusive). Default is -1, which means the end of the list.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">V</span></dt>
<dd><p>floor value</p>
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd><p>search result</p>
</dd>
</dl>
@@ -489,10 +682,128 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<a id="Hi_Common_Collections_SortedListUtil_GetFloor_" data-uid="Hi.Common.Collections.SortedListUtil.GetFloor*"></a>
<h3 id="Hi_Common_Collections_SortedListUtil_GetFloor__2_System_Collections_Generic_SortedList___0___1____0___1__System_Int32__System_Int32_System_Int32_" data-uid="Hi.Common.Collections.SortedListUtil.GetFloor``2(System.Collections.Generic.SortedList{``0,``1},``0,``1@,System.Int32@,System.Int32,System.Int32)">
GetFloor&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, out V, out int, int, int)
</h3>
<div class="markdown level1 summary"><p>Get floor value by <code class="paramref">key</code>.
If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Common_BinarySearchResult_NotExisted">NotExisted</a>, <code class="paramref">resultValue</code> will be the default value of <code class="typeparamref">V</code>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetFloor&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out V resultValue, out int floorIndex, int beginIndex = 0, int endIndex = -1) where TKey : IComparable&lt;TKey&gt;</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.sortedlist-2">SortedList</a>&lt;TKey, V&gt;</dt>
<dd><p>source</p>
</dd>
<dt><code>key</code> <span class="xref">TKey</span></dt>
<dd><p>key</p>
</dd>
<dt><code>resultValue</code> <span class="xref">V</span></dt>
<dd><p>floor value</p>
</dd>
<dt><code>floorIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dt><code>beginIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The starting index for the search range (inclusive). Default is 0.</p>
</dd>
<dt><code>endIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The ending index for the search range (exclusive). Default is -1, which means the end of the list.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd><p>search result</p>
</dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>TKey</code></dt>
<dd><p>Key type</p>
</dd>
<dt><code>V</code></dt>
<dd><p>Value type</p>
</dd>
</dl>
<a id="Hi_Common_Collections_SortedListUtil_GetIndexRangeByKeyBoundary_" data-uid="Hi.Common.Collections.SortedListUtil.GetIndexRangeByKeyBoundary*"></a>
<h3 id="Hi_Common_Collections_SortedListUtil_GetIndexRangeByKeyBoundary__2_System_Collections_Generic_SortedList___0___1____0_System_Boolean___0_System_Boolean_System_Int32_System_Int32_" data-uid="Hi.Common.Collections.SortedListUtil.GetIndexRangeByKeyBoundary``2(System.Collections.Generic.SortedList{``0,``1},``0,System.Boolean,``0,System.Boolean,System.Int32,System.Int32)">
GetIndexRangeByKeyBoundary&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, bool, TKey, bool, int, int)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Range&lt;int&gt; GetIndexRangeByKeyBoundary&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey begin, bool isIncludingBeginFloor, TKey end, bool isIncludingEndCeil, int beginListIndex = 0, int endListIndex = -1) where TKey : IComparable&lt;TKey&gt;</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.sortedlist-2">SortedList</a>&lt;TKey, V&gt;</dt>
<dd></dd>
<dt><code>begin</code> <span class="xref">TKey</span></dt>
<dd></dd>
<dt><code>isIncludingBeginFloor</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dt><code>end</code> <span class="xref">TKey</span></dt>
<dd></dd>
<dt><code>isIncludingEndCeil</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dt><code>beginListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dt><code>endListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.Range-1.html">Range</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>&gt;</dt>
<dd></dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>TKey</code></dt>
<dd></dd>
<dt><code>V</code></dt>
<dd></dd>
</dl>
<a id="Hi_Common_Collections_SortedListUtil_GetNearestIndex_" data-uid="Hi.Common.Collections.SortedListUtil.GetNearestIndex*"></a>
<h3 id="Hi_Common_Collections_SortedListUtil_GetNearestIndex__1_System_Collections_Generic_SortedList_System_Double___0__System_Double_Hi_Common_BinarySearchResult__" data-uid="Hi.Common.Collections.SortedListUtil.GetNearestIndex``1(System.Collections.Generic.SortedList{System.Double,``0},System.Double,Hi.Common.BinarySearchResult@)">
GetNearestIndex&lt;V&gt;(SortedList&lt;double, V&gt;, double, out BinarySearchResult)
<h3 id="Hi_Common_Collections_SortedListUtil_GetNearestIndex__1_System_Collections_Generic_SortedList_System_Double___0__System_Double_System_Int32__System_Int32_System_Int32_" data-uid="Hi.Common.Collections.SortedListUtil.GetNearestIndex``1(System.Collections.Generic.SortedList{System.Double,``0},System.Double,System.Int32@,System.Int32,System.Int32)">
GetNearestIndex&lt;V&gt;(SortedList&lt;double, V&gt;, double, out int, int, int)
</h3>
@@ -501,7 +812,7 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static int GetNearestIndex&lt;V&gt;(this SortedList&lt;double, V&gt; src, double key, out BinarySearchResult result)</code></pre>
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetNearestIndex&lt;V&gt;(this SortedList&lt;double, V&gt; src, double key, out int resultIndex, int beginIndex = 0, int endIndex = -1)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -512,15 +823,21 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<dt><code>key</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>The key to search for.</p>
</dd>
<dt><code>result</code> <a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd><p>When this method returns, contains a value indicating whether an exact match was found, or the nearest floor/ceiling value.</p>
<dt><code>resultIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>When this method returns, contains the index of the nearest element if found; otherwise, -1.</p>
</dd>
<dt><code>beginIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The starting index for the search range (inclusive). Default is 0.</p>
</dd>
<dt><code>endIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The ending index for the search range (exclusive). Default is -1, which means the end of the list.</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>The index of the nearest element if found; otherwise, -1.</p>
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd><p>A value indicating whether an exact match was found, or the nearest floor/ceiling value.</p>
</dd>
</dl>
@@ -542,8 +859,8 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<a id="Hi_Common_Collections_SortedListUtil_GetNearestKey_" data-uid="Hi.Common.Collections.SortedListUtil.GetNearestKey*"></a>
<h3 id="Hi_Common_Collections_SortedListUtil_GetNearestKey__1_System_Collections_Generic_SortedList_System_Double___0__System_Double_Hi_Common_BinarySearchResult__" data-uid="Hi.Common.Collections.SortedListUtil.GetNearestKey``1(System.Collections.Generic.SortedList{System.Double,``0},System.Double,Hi.Common.BinarySearchResult@)">
GetNearestKey&lt;V&gt;(SortedList&lt;double, V&gt;, double, out BinarySearchResult)
<h3 id="Hi_Common_Collections_SortedListUtil_GetNearestKey__1_System_Collections_Generic_SortedList_System_Double___0__System_Double_System_Double__System_Int32_System_Int32_" data-uid="Hi.Common.Collections.SortedListUtil.GetNearestKey``1(System.Collections.Generic.SortedList{System.Double,``0},System.Double,System.Double@,System.Int32,System.Int32)">
GetNearestKey&lt;V&gt;(SortedList&lt;double, V&gt;, double, out double, int, int)
</h3>
@@ -552,7 +869,7 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static double GetNearestKey&lt;V&gt;(this SortedList&lt;double, V&gt; src, double key, out BinarySearchResult result)</code></pre>
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetNearestKey&lt;V&gt;(this SortedList&lt;double, V&gt; src, double key, out double resultKey, int beginIndex = 0, int endIndex = -1)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -563,15 +880,21 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<dt><code>key</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>The key to search for.</p>
</dd>
<dt><code>result</code> <a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd><p>When this method returns, contains a value indicating whether an exact match was found, or the nearest floor/ceiling value.</p>
<dt><code>resultKey</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>When this method returns, contains the nearest key if found; otherwise, NaN.</p>
</dd>
<dt><code>beginIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The starting index for the search range (inclusive). Default is 0.</p>
</dd>
<dt><code>endIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The ending index for the search range (exclusive). Default is -1, which means the end of the list.</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><p>The nearest key if found; otherwise, NaN.</p>
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd><p>A value indicating whether an exact match was found, or the nearest floor/ceiling value.</p>
</dd>
</dl>
@@ -593,8 +916,8 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<a id="Hi_Common_Collections_SortedListUtil_GetNearestValue_" data-uid="Hi.Common.Collections.SortedListUtil.GetNearestValue*"></a>
<h3 id="Hi_Common_Collections_SortedListUtil_GetNearestValue__1_System_Collections_Generic_SortedList_System_Double___0__System_Double_Hi_Common_BinarySearchResult__" data-uid="Hi.Common.Collections.SortedListUtil.GetNearestValue``1(System.Collections.Generic.SortedList{System.Double,``0},System.Double,Hi.Common.BinarySearchResult@)">
GetNearestValue&lt;V&gt;(SortedList&lt;double, V&gt;, double, out BinarySearchResult)
<h3 id="Hi_Common_Collections_SortedListUtil_GetNearestValue__1_System_Collections_Generic_SortedList_System_Double___0__System_Double___0__System_Int32_System_Int32_" data-uid="Hi.Common.Collections.SortedListUtil.GetNearestValue``1(System.Collections.Generic.SortedList{System.Double,``0},System.Double,``0@,System.Int32,System.Int32)">
GetNearestValue&lt;V&gt;(SortedList&lt;double, V&gt;, double, out V, int, int)
</h3>
@@ -603,7 +926,7 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static V GetNearestValue&lt;V&gt;(this SortedList&lt;double, V&gt; src, double key, out BinarySearchResult result)</code></pre>
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetNearestValue&lt;V&gt;(this SortedList&lt;double, V&gt; src, double key, out V resultValue, int beginIndex = 0, int endIndex = -1)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -614,15 +937,21 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<dt><code>key</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>The key to search for.</p>
</dd>
<dt><code>result</code> <a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd><p>When this method returns, contains a value indicating whether an exact match was found, or the nearest floor/ceiling value.</p>
<dt><code>resultValue</code> <span class="xref">V</span></dt>
<dd><p>When this method returns, contains the value corresponding to the nearest key if found; otherwise, the default value for the type.</p>
</dd>
<dt><code>beginIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The starting index for the search range (inclusive). Default is 0.</p>
</dd>
<dt><code>endIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The ending index for the search range (exclusive). Default is -1, which means the end of the list.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">V</span></dt>
<dd><p>The value corresponding to the nearest key if found; otherwise, the default value for the type.</p>
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd><p>A value indicating whether an exact match was found, or the nearest floor/ceiling value.</p>
</dd>
</dl>
@@ -644,8 +973,8 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<a id="Hi_Common_Collections_SortedListUtil_GetSortedListByKeyBoundary_" data-uid="Hi.Common.Collections.SortedListUtil.GetSortedListByKeyBoundary*"></a>
<h3 id="Hi_Common_Collections_SortedListUtil_GetSortedListByKeyBoundary__2_System_Collections_Generic_SortedList___0___1____0_System_Boolean___0_System_Boolean_" data-uid="Hi.Common.Collections.SortedListUtil.GetSortedListByKeyBoundary``2(System.Collections.Generic.SortedList{``0,``1},``0,System.Boolean,``0,System.Boolean)">
GetSortedListByKeyBoundary&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, bool, TKey, bool)
<h3 id="Hi_Common_Collections_SortedListUtil_GetSortedListByKeyBoundary__2_System_Collections_Generic_SortedList___0___1____0_System_Boolean___0_System_Boolean_System_Int32_System_Int32_" data-uid="Hi.Common.Collections.SortedListUtil.GetSortedListByKeyBoundary``2(System.Collections.Generic.SortedList{``0,``1},``0,System.Boolean,``0,System.Boolean,System.Int32,System.Int32)">
GetSortedListByKeyBoundary&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, bool, TKey, bool, int, int)
</h3>
@@ -654,7 +983,7 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SortedList&lt;TKey, V&gt; GetSortedListByKeyBoundary&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey begin, bool isIncludingBeginFloor, TKey end, bool isIncludingEndCeil) where TKey : IComparable&lt;TKey&gt;</code></pre>
<pre><code class="lang-csharp hljs">public static SortedList&lt;TKey, V&gt; GetSortedListByKeyBoundary&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey begin, bool isIncludingBeginFloor, TKey end, bool isIncludingEndCeil, int beginIndex = 0, int endIndex = -1) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -673,6 +1002,12 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
</dd>
<dt><code>isIncludingEndCeil</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>Whether to include the ceiling value of the ending key.</p>
</dd>
<dt><code>beginIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The starting index for the search range (inclusive). Default is 0.</p>
</dd>
<dt><code>endIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The ending index for the search range (exclusive). Default is -1, which means the end of the list.</p>
</dd>
</dl>
@@ -704,8 +1039,8 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<a id="Hi_Common_Collections_SortedListUtil_GetValuesByKeyBoundary_" data-uid="Hi.Common.Collections.SortedListUtil.GetValuesByKeyBoundary*"></a>
<h3 id="Hi_Common_Collections_SortedListUtil_GetValuesByKeyBoundary__2_System_Collections_Generic_SortedList___0___1____0_System_Boolean___0_System_Boolean_" data-uid="Hi.Common.Collections.SortedListUtil.GetValuesByKeyBoundary``2(System.Collections.Generic.SortedList{``0,``1},``0,System.Boolean,``0,System.Boolean)">
GetValuesByKeyBoundary&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, bool, TKey, bool)
<h3 id="Hi_Common_Collections_SortedListUtil_GetValuesByKeyBoundary__2_System_Collections_Generic_SortedList___0___1____0_System_Boolean___0_System_Boolean_System_Int32_System_Int32_" data-uid="Hi.Common.Collections.SortedListUtil.GetValuesByKeyBoundary``2(System.Collections.Generic.SortedList{``0,``1},``0,System.Boolean,``0,System.Boolean,System.Int32,System.Int32)">
GetValuesByKeyBoundary&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, bool, TKey, bool, int, int)
</h3>
@@ -714,7 +1049,7 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static List&lt;V&gt; GetValuesByKeyBoundary&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey begin, bool isIncludingBeginFloor, TKey end, bool isIncludingEndCeil) where TKey : IComparable&lt;TKey&gt;</code></pre>
<pre><code class="lang-csharp hljs">public static List&lt;V&gt; GetValuesByKeyBoundary&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey begin, bool isIncludingBeginFloor, TKey end, bool isIncludingEndCeil, int beginIndex = 0, int endIndex = -1) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -733,6 +1068,12 @@ If <code class="paramref">result</code> is <a class="xref" href="Hi.Common.Binar
</dd>
<dt><code>isIncludingEndCeil</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>Whether to include the ceiling value of the ending key.</p>
</dd>
<dt><code>beginIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The starting index for the search range (inclusive). Default is 0.</p>
</dd>
<dt><code>endIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The ending index for the search range (exclusive). Default is -1, which means the end of the list.</p>
</dd>
</dl>
@@ -147,6 +147,10 @@ Enums
<dd><p>Specifies the search method to use when looking for values in a sorted list.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Common.Collections.SortedListUtil.SeekDirection.html">SortedListUtil.SeekDirection</a></dt>
<dd></dd>
</dl>
</article>
@@ -784,6 +784,37 @@ Start on 0.</p>
<a id="Hi_Common_FileLines_IndexedFileLine_ToHumanString_" data-uid="Hi.Common.FileLines.IndexedFileLine.ToHumanString*"></a>
<h3 id="Hi_Common_FileLines_IndexedFileLine_ToHumanString" data-uid="Hi.Common.FileLines.IndexedFileLine.ToHumanString">
ToHumanString()
</h3>
<div class="markdown level1 summary"></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_IndexedFileLine_ToString_" data-uid="Hi.Common.FileLines.IndexedFileLine.ToString*"></a>
<h3 id="Hi_Common_FileLines_IndexedFileLine_ToString" data-uid="Hi.Common.FileLines.IndexedFileLine.ToString">
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class IndexSegment | HiAPI-C# 2025 ">
<meta name="description" content="Represents a segment of indices with a beginning and ending point. Used for defining ranges of data in collections or arrays.">
<meta name="description" content="Represents a segment of indices with a beginning (inclusive) and ending (exclusive&amp;gt; point. Used for defining segment of data in collections or arrays.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,8 +97,8 @@ Class IndexSegment
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
</div>
<div class="markdown summary"><p>Represents a segment of indices with a beginning and ending point.
Used for defining ranges of data in collections or arrays.</p>
<div class="markdown summary"><p>Represents a segment of indices with a beginning (inclusive) and ending (exclusive&gt; point.
Used for defining segment of data in collections or arrays.</p>
</div>
<div class="markdown conceptual"></div>
@@ -772,12 +772,12 @@ Used for defining ranges of data in collections or arrays.</p>
</h3>
<div class="markdown level1 summary"><p>Gets an index segment from a list of data items based on the specified indices.</p>
<div class="markdown level1 summary"><p>Gets an index segment from a list of data items by the specific group index.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IndexSegment GetIndexSegment&lt;TData&gt;(IList&lt;TData&gt; steps, int cacheStepIndex, int keyStepIndex, Func&lt;TData, int?&gt; dataToKeyIndexFunc)</code></pre>
<pre><code class="lang-csharp hljs">public static IndexSegment GetIndexSegment&lt;TData&gt;(IList&lt;TData&gt; steps, int startListIndex, int targetGroupIndex, Func&lt;TData, int?&gt; dataToGroupIndexFunc)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -785,14 +785,14 @@ Used for defining ranges of data in collections or arrays.</p>
<dt><code>steps</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList</a>&lt;TData&gt;</dt>
<dd><p>The list of data items.</p>
</dd>
<dt><code>cacheStepIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The cache step index.</p>
<dt><code>startListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The start step index for seeking.</p>
</dd>
<dt><code>keyStepIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The key step index.</p>
<dt><code>targetGroupIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The target segment key.</p>
</dd>
<dt><code>dataToKeyIndexFunc</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a>&lt;TData, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?&gt;</dt>
<dd><p>A function that extracts an index from a data item.</p>
<dt><code>dataToGroupIndexFunc</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a>&lt;TData, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?&gt;</dt>
<dd><p>A function that extracts a segmentkey from a data item.</p>
</dd>
</dl>
@@ -2,9 +2,9 @@
<html>
<head>
<meta charset="utf-8">
<title>Interface IMessageKit | HiAPI-C# 2025 </title>
<title>Interface IMessageHost | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Interface IMessageKit | HiAPI-C# 2025 ">
<meta name="title" content="Interface IMessageHost | HiAPI-C# 2025 ">
<meta name="description" content="Interface for objects that can host and manage messages.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
@@ -84,12 +84,12 @@
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Hi.Common.Messages.IMessageKit">
<article data-uid="Hi.Common.Messages.IMessageHost">
<h1 id="Hi_Common_Messages_IMessageKit" data-uid="Hi.Common.Messages.IMessageKit" class="text-break">
Interface IMessageKit
<h1 id="Hi_Common_Messages_IMessageHost" data-uid="Hi.Common.Messages.IMessageHost" class="text-break">
Interface IMessageHost
</h1>
<div class="facts text-secondary">
@@ -102,7 +102,7 @@ Interface IMessageKit
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IMessageKit</code></pre>
<pre><code class="lang-csharp hljs">public interface IMessageHost</code></pre>
</div>
@@ -125,25 +125,25 @@ Interface IMessageKit
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke&lt;TSrc, TDst&gt;(TSrc, Func&lt;TSrc, TDst&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddError_Hi_Common_Messages_IMessageKit_System_String_System_String___">MessageHostUtil.AddError(IMessageKit, string, params string[])</a>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddError_Hi_Common_Messages_IMessageHost_System_String_System_String___">MessageHostUtil.AddError(IMessageHost, string, params string[])</a>
</div>
<div>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddException_Hi_Common_Messages_IMessageKit_System_Exception_System_String___">MessageHostUtil.AddException(IMessageKit, Exception, params string[])</a>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddException_Hi_Common_Messages_IMessageHost_System_Exception_System_String___">MessageHostUtil.AddException(IMessageHost, Exception, params string[])</a>
</div>
<div>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddInfo_Hi_Common_Messages_IMessageKit_System_String_System_String___">MessageHostUtil.AddInfo(IMessageKit, string, params string[])</a>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddInfo_Hi_Common_Messages_IMessageHost_System_String_System_String___">MessageHostUtil.AddInfo(IMessageHost, string, params string[])</a>
</div>
<div>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddMessage_Hi_Common_Messages_IMessageKit_System_String_System_String___">MessageHostUtil.AddMessage(IMessageKit, string, params string[])</a>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddMessage_Hi_Common_Messages_IMessageHost_System_String_System_String___">MessageHostUtil.AddMessage(IMessageHost, string, params string[])</a>
</div>
<div>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddProgress_Hi_Common_Messages_IMessageKit_System_String_System_String___">MessageHostUtil.AddProgress(IMessageKit, string, params string[])</a>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddProgress_Hi_Common_Messages_IMessageHost_System_String_System_String___">MessageHostUtil.AddProgress(IMessageHost, string, params string[])</a>
</div>
<div>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddSuccess_Hi_Common_Messages_IMessageKit_System_String_System_String___">MessageHostUtil.AddSuccess(IMessageKit, string, params string[])</a>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddSuccess_Hi_Common_Messages_IMessageHost_System_String_System_String___">MessageHostUtil.AddSuccess(IMessageHost, string, params string[])</a>
</div>
<div>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddWarning_Hi_Common_Messages_IMessageKit_System_String_System_String___">MessageHostUtil.AddWarning(IMessageKit, string, params string[])</a>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddWarning_Hi_Common_Messages_IMessageHost_System_String_System_String___">MessageHostUtil.AddWarning(IMessageHost, string, params string[])</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>
@@ -167,9 +167,9 @@ Interface IMessageKit
</h2>
<a id="Hi_Common_Messages_IMessageKit_Add_" data-uid="Hi.Common.Messages.IMessageKit.Add*"></a>
<a id="Hi_Common_Messages_IMessageHost_Add_" data-uid="Hi.Common.Messages.IMessageHost.Add*"></a>
<h3 id="Hi_Common_Messages_IMessageKit_Add_System_Object_" data-uid="Hi.Common.Messages.IMessageKit.Add(System.Object)">
<h3 id="Hi_Common_Messages_IMessageHost_Add_System_Object_" data-uid="Hi.Common.Messages.IMessageHost.Add(System.Object)">
Add(object)
</h3>
@@ -2,9 +2,9 @@
<html>
<head>
<meta charset="utf-8">
<title>Class MessageKit | HiAPI-C# 2025 </title>
<title>Class MessageHost | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class MessageKit | HiAPI-C# 2025 ">
<meta name="title" content="Class MessageHost | HiAPI-C# 2025 ">
<meta name="description" content="Provides utility methods for handling messages.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
@@ -84,12 +84,12 @@
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Hi.Common.Messages.MessageKit">
<article data-uid="Hi.Common.Messages.MessageHost">
<h1 id="Hi_Common_Messages_MessageKit" data-uid="Hi.Common.Messages.MessageKit" class="text-break">
Class MessageKit
<h1 id="Hi_Common_Messages_MessageHost" data-uid="Hi.Common.Messages.MessageHost" class="text-break">
Class MessageHost
</h1>
<div class="facts text-secondary">
@@ -102,7 +102,7 @@ Class MessageKit
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class MessageKit : IMessageKit</code></pre>
<pre><code class="lang-csharp hljs">public class MessageHost : IMessageHost</code></pre>
</div>
@@ -112,14 +112,14 @@ Class MessageKit
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><span class="xref">MessageKit</span></div>
<div><span class="xref">MessageHost</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></div>
<div><a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></div>
</dd>
</dl>
@@ -154,25 +154,25 @@ Class MessageKit
<dt>Extension Methods</dt>
<dd>
<div>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddError_Hi_Common_Messages_IMessageKit_System_String_System_String___">MessageHostUtil.AddError(IMessageKit, string, params string[])</a>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddError_Hi_Common_Messages_IMessageHost_System_String_System_String___">MessageHostUtil.AddError(IMessageHost, string, params string[])</a>
</div>
<div>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddException_Hi_Common_Messages_IMessageKit_System_Exception_System_String___">MessageHostUtil.AddException(IMessageKit, Exception, params string[])</a>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddException_Hi_Common_Messages_IMessageHost_System_Exception_System_String___">MessageHostUtil.AddException(IMessageHost, Exception, params string[])</a>
</div>
<div>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddInfo_Hi_Common_Messages_IMessageKit_System_String_System_String___">MessageHostUtil.AddInfo(IMessageKit, string, params string[])</a>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddInfo_Hi_Common_Messages_IMessageHost_System_String_System_String___">MessageHostUtil.AddInfo(IMessageHost, string, params string[])</a>
</div>
<div>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddMessage_Hi_Common_Messages_IMessageKit_System_String_System_String___">MessageHostUtil.AddMessage(IMessageKit, string, params string[])</a>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddMessage_Hi_Common_Messages_IMessageHost_System_String_System_String___">MessageHostUtil.AddMessage(IMessageHost, string, params string[])</a>
</div>
<div>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddProgress_Hi_Common_Messages_IMessageKit_System_String_System_String___">MessageHostUtil.AddProgress(IMessageKit, string, params string[])</a>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddProgress_Hi_Common_Messages_IMessageHost_System_String_System_String___">MessageHostUtil.AddProgress(IMessageHost, string, params string[])</a>
</div>
<div>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddSuccess_Hi_Common_Messages_IMessageKit_System_String_System_String___">MessageHostUtil.AddSuccess(IMessageKit, string, params string[])</a>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddSuccess_Hi_Common_Messages_IMessageHost_System_String_System_String___">MessageHostUtil.AddSuccess(IMessageHost, string, params string[])</a>
</div>
<div>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddWarning_Hi_Common_Messages_IMessageKit_System_String_System_String___">MessageHostUtil.AddWarning(IMessageKit, string, params string[])</a>
<a class="xref" href="Hi.Common.Messages.MessageHostUtil.html#Hi_Common_Messages_MessageHostUtil_AddWarning_Hi_Common_Messages_IMessageHost_System_String_System_String___">MessageHostUtil.AddWarning(IMessageHost, string, params string[])</a>
</div>
<div>
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate&lt;TSelf&gt;(TSelf, params object[])</a>
@@ -205,9 +205,9 @@ Class MessageKit
</h2>
<a id="Hi_Common_Messages_MessageKit_Default_" data-uid="Hi.Common.Messages.MessageKit.Default*"></a>
<a id="Hi_Common_Messages_MessageHost_Default_" data-uid="Hi.Common.Messages.MessageHost.Default*"></a>
<h3 id="Hi_Common_Messages_MessageKit_Default" data-uid="Hi.Common.Messages.MessageKit.Default">
<h3 id="Hi_Common_Messages_MessageHost_Default" data-uid="Hi.Common.Messages.MessageHost.Default">
Default
</h3>
@@ -217,7 +217,7 @@ Class MessageKit
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static MessageKit Default { get; set; }</code></pre>
<pre><code class="lang-csharp hljs">public static MessageHost Default { get; set; }</code></pre>
</div>
@@ -226,7 +226,7 @@ Class MessageKit
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.Messages.MessageKit.html">MessageKit</a></dt>
<dt><a class="xref" href="Hi.Common.Messages.MessageHost.html">MessageHost</a></dt>
<dd></dd>
</dl>
@@ -241,9 +241,9 @@ Class MessageKit
</h2>
<a id="Hi_Common_Messages_MessageKit_Add_" data-uid="Hi.Common.Messages.MessageKit.Add*"></a>
<a id="Hi_Common_Messages_MessageHost_Add_" data-uid="Hi.Common.Messages.MessageHost.Add*"></a>
<h3 id="Hi_Common_Messages_MessageKit_Add_System_Object_" data-uid="Hi.Common.Messages.MessageKit.Add(System.Object)">
<h3 id="Hi_Common_Messages_MessageHost_Add_System_Object_" data-uid="Hi.Common.Messages.MessageHost.Add(System.Object)">
Add(object)
</h3>
@@ -280,9 +280,9 @@ Class MessageKit
<a id="Hi_Common_Messages_MessageKit_AddError_" data-uid="Hi.Common.Messages.MessageKit.AddError*"></a>
<a id="Hi_Common_Messages_MessageHost_AddError_" data-uid="Hi.Common.Messages.MessageHost.AddError*"></a>
<h3 id="Hi_Common_Messages_MessageKit_AddError_System_String_" data-uid="Hi.Common.Messages.MessageKit.AddError(System.String)">
<h3 id="Hi_Common_Messages_MessageHost_AddError_System_String_" data-uid="Hi.Common.Messages.MessageHost.AddError(System.String)">
AddError(string)
</h3>
@@ -314,9 +314,9 @@ Apply <a class="xref" href="Hi.Common.ExceptionUtil.html">ExceptionUtil</a>.<a c
<a id="Hi_Common_Messages_MessageKit_AddException_" data-uid="Hi.Common.Messages.MessageKit.AddException*"></a>
<a id="Hi_Common_Messages_MessageHost_AddException_" data-uid="Hi.Common.Messages.MessageHost.AddException*"></a>
<h3 id="Hi_Common_Messages_MessageKit_AddException_System_Exception_" data-uid="Hi.Common.Messages.MessageKit.AddException(System.Exception)">
<h3 id="Hi_Common_Messages_MessageHost_AddException_System_Exception_" data-uid="Hi.Common.Messages.MessageHost.AddException(System.Exception)">
AddException(Exception)
</h3>
@@ -347,9 +347,9 @@ Apply <a class="xref" href="Hi.Common.ExceptionUtil.html">ExceptionUtil</a>.<a c
<a id="Hi_Common_Messages_MessageKit_AddInfo_" data-uid="Hi.Common.Messages.MessageKit.AddInfo*"></a>
<a id="Hi_Common_Messages_MessageHost_AddInfo_" data-uid="Hi.Common.Messages.MessageHost.AddInfo*"></a>
<h3 id="Hi_Common_Messages_MessageKit_AddInfo_System_String_" data-uid="Hi.Common.Messages.MessageKit.AddInfo(System.String)">
<h3 id="Hi_Common_Messages_MessageHost_AddInfo_System_String_" data-uid="Hi.Common.Messages.MessageHost.AddInfo(System.String)">
AddInfo(string)
</h3>
@@ -380,9 +380,9 @@ Apply <a class="xref" href="Hi.Common.ExceptionUtil.html">ExceptionUtil</a>.<a c
<a id="Hi_Common_Messages_MessageKit_AddMessage_" data-uid="Hi.Common.Messages.MessageKit.AddMessage*"></a>
<a id="Hi_Common_Messages_MessageHost_AddMessage_" data-uid="Hi.Common.Messages.MessageHost.AddMessage*"></a>
<h3 id="Hi_Common_Messages_MessageKit_AddMessage_System_String_" data-uid="Hi.Common.Messages.MessageKit.AddMessage(System.String)">
<h3 id="Hi_Common_Messages_MessageHost_AddMessage_System_String_" data-uid="Hi.Common.Messages.MessageHost.AddMessage(System.String)">
AddMessage(string)
</h3>
@@ -413,9 +413,9 @@ Apply <a class="xref" href="Hi.Common.ExceptionUtil.html">ExceptionUtil</a>.<a c
<a id="Hi_Common_Messages_MessageKit_AddProgress_" data-uid="Hi.Common.Messages.MessageKit.AddProgress*"></a>
<a id="Hi_Common_Messages_MessageHost_AddProgress_" data-uid="Hi.Common.Messages.MessageHost.AddProgress*"></a>
<h3 id="Hi_Common_Messages_MessageKit_AddProgress_System_String_" data-uid="Hi.Common.Messages.MessageKit.AddProgress(System.String)">
<h3 id="Hi_Common_Messages_MessageHost_AddProgress_System_String_" data-uid="Hi.Common.Messages.MessageHost.AddProgress(System.String)">
AddProgress(string)
</h3>
@@ -446,9 +446,9 @@ Apply <a class="xref" href="Hi.Common.ExceptionUtil.html">ExceptionUtil</a>.<a c
<a id="Hi_Common_Messages_MessageKit_AddSuccess_" data-uid="Hi.Common.Messages.MessageKit.AddSuccess*"></a>
<a id="Hi_Common_Messages_MessageHost_AddSuccess_" data-uid="Hi.Common.Messages.MessageHost.AddSuccess*"></a>
<h3 id="Hi_Common_Messages_MessageKit_AddSuccess_System_String_" data-uid="Hi.Common.Messages.MessageKit.AddSuccess(System.String)">
<h3 id="Hi_Common_Messages_MessageHost_AddSuccess_System_String_" data-uid="Hi.Common.Messages.MessageHost.AddSuccess(System.String)">
AddSuccess(string)
</h3>
@@ -479,9 +479,9 @@ Apply <a class="xref" href="Hi.Common.ExceptionUtil.html">ExceptionUtil</a>.<a c
<a id="Hi_Common_Messages_MessageKit_AddWarning_" data-uid="Hi.Common.Messages.MessageKit.AddWarning*"></a>
<a id="Hi_Common_Messages_MessageHost_AddWarning_" data-uid="Hi.Common.Messages.MessageHost.AddWarning*"></a>
<h3 id="Hi_Common_Messages_MessageKit_AddWarning_System_String_" data-uid="Hi.Common.Messages.MessageKit.AddWarning(System.String)">
<h3 id="Hi_Common_Messages_MessageHost_AddWarning_System_String_" data-uid="Hi.Common.Messages.MessageHost.AddWarning(System.String)">
AddWarning(string)
</h3>
@@ -512,9 +512,9 @@ Apply <a class="xref" href="Hi.Common.ExceptionUtil.html">ExceptionUtil</a>.<a c
<a id="Hi_Common_Messages_MessageKit_Default_OnAdding_" data-uid="Hi.Common.Messages.MessageKit.Default_OnAdding*"></a>
<a id="Hi_Common_Messages_MessageHost_Default_OnAdding_" data-uid="Hi.Common.Messages.MessageHost.Default_OnAdding*"></a>
<h3 id="Hi_Common_Messages_MessageKit_Default_OnAdding_System_Object_" data-uid="Hi.Common.Messages.MessageKit.Default_OnAdding(System.Object)">
<h3 id="Hi_Common_Messages_MessageHost_Default_OnAdding_System_Object_" data-uid="Hi.Common.Messages.MessageHost.Default_OnAdding(System.Object)">
Default_OnAdding(object)
</h3>
@@ -556,7 +556,7 @@ Apply <a class="xref" href="Hi.Common.ExceptionUtil.html">ExceptionUtil</a>.<a c
<h3 id="Hi_Common_Messages_MessageKit_OnAdding" data-uid="Hi.Common.Messages.MessageKit.OnAdding">
<h3 id="Hi_Common_Messages_MessageHost_OnAdding" data-uid="Hi.Common.Messages.MessageHost.OnAdding">
OnAdding
</h3>
@@ -97,7 +97,7 @@ Class MessageHostUtil
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
</div>
<div class="markdown summary"><p>Utility methods for working with <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a> implementations.</p>
<div class="markdown summary"><p>Utility methods for working with <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a> implementations.</p>
</div>
<div class="markdown conceptual"></div>
@@ -155,8 +155,8 @@ Class MessageHostUtil
<a id="Hi_Common_Messages_MessageHostUtil_AddError_" data-uid="Hi.Common.Messages.MessageHostUtil.AddError*"></a>
<h3 id="Hi_Common_Messages_MessageHostUtil_AddError_Hi_Common_Messages_IMessageKit_System_String_System_String___" data-uid="Hi.Common.Messages.MessageHostUtil.AddError(Hi.Common.Messages.IMessageKit,System.String,System.String[])">
AddError(IMessageKit, string, params string[])
<h3 id="Hi_Common_Messages_MessageHostUtil_AddError_Hi_Common_Messages_IMessageHost_System_String_System_String___" data-uid="Hi.Common.Messages.MessageHostUtil.AddError(Hi.Common.Messages.IMessageHost,System.String,System.String[])">
AddError(IMessageHost, string, params string[])
</h3>
@@ -165,12 +165,12 @@ Class MessageHostUtil
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static object AddError(this IMessageKit host, string message, params string[] otherTags)</code></pre>
<pre><code class="lang-csharp hljs">public static object AddError(this IMessageHost host, string message, params string[] otherTags)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>host</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>host</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>The message host</p>
</dd>
<dt><code>message</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
@@ -200,8 +200,8 @@ Class MessageHostUtil
<a id="Hi_Common_Messages_MessageHostUtil_AddException_" data-uid="Hi.Common.Messages.MessageHostUtil.AddException*"></a>
<h3 id="Hi_Common_Messages_MessageHostUtil_AddException_Hi_Common_Messages_IMessageKit_System_Exception_System_String___" data-uid="Hi.Common.Messages.MessageHostUtil.AddException(Hi.Common.Messages.IMessageKit,System.Exception,System.String[])">
AddException(IMessageKit, Exception, params string[])
<h3 id="Hi_Common_Messages_MessageHostUtil_AddException_Hi_Common_Messages_IMessageHost_System_Exception_System_String___" data-uid="Hi.Common.Messages.MessageHostUtil.AddException(Hi.Common.Messages.IMessageHost,System.Exception,System.String[])">
AddException(IMessageHost, Exception, params string[])
</h3>
@@ -210,12 +210,12 @@ Class MessageHostUtil
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static object AddException(this IMessageKit host, Exception exception, params string[] otherTags)</code></pre>
<pre><code class="lang-csharp hljs">public static object AddException(this IMessageHost host, Exception exception, params string[] otherTags)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>host</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>host</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>The message host</p>
</dd>
<dt><code>exception</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a></dt>
@@ -245,8 +245,8 @@ Class MessageHostUtil
<a id="Hi_Common_Messages_MessageHostUtil_AddInfo_" data-uid="Hi.Common.Messages.MessageHostUtil.AddInfo*"></a>
<h3 id="Hi_Common_Messages_MessageHostUtil_AddInfo_Hi_Common_Messages_IMessageKit_System_String_System_String___" data-uid="Hi.Common.Messages.MessageHostUtil.AddInfo(Hi.Common.Messages.IMessageKit,System.String,System.String[])">
AddInfo(IMessageKit, string, params string[])
<h3 id="Hi_Common_Messages_MessageHostUtil_AddInfo_Hi_Common_Messages_IMessageHost_System_String_System_String___" data-uid="Hi.Common.Messages.MessageHostUtil.AddInfo(Hi.Common.Messages.IMessageHost,System.String,System.String[])">
AddInfo(IMessageHost, string, params string[])
</h3>
@@ -255,12 +255,12 @@ Class MessageHostUtil
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static object AddInfo(this IMessageKit host, string message, params string[] otherTags)</code></pre>
<pre><code class="lang-csharp hljs">public static object AddInfo(this IMessageHost host, string message, params string[] otherTags)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>host</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>host</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>The message host</p>
</dd>
<dt><code>message</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
@@ -290,8 +290,8 @@ Class MessageHostUtil
<a id="Hi_Common_Messages_MessageHostUtil_AddMessage_" data-uid="Hi.Common.Messages.MessageHostUtil.AddMessage*"></a>
<h3 id="Hi_Common_Messages_MessageHostUtil_AddMessage_Hi_Common_Messages_IMessageKit_System_String_System_String___" data-uid="Hi.Common.Messages.MessageHostUtil.AddMessage(Hi.Common.Messages.IMessageKit,System.String,System.String[])">
AddMessage(IMessageKit, string, params string[])
<h3 id="Hi_Common_Messages_MessageHostUtil_AddMessage_Hi_Common_Messages_IMessageHost_System_String_System_String___" data-uid="Hi.Common.Messages.MessageHostUtil.AddMessage(Hi.Common.Messages.IMessageHost,System.String,System.String[])">
AddMessage(IMessageHost, string, params string[])
</h3>
@@ -300,12 +300,12 @@ Class MessageHostUtil
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static object AddMessage(this IMessageKit host, string msg, params string[] tags)</code></pre>
<pre><code class="lang-csharp hljs">public static object AddMessage(this IMessageHost host, string msg, params string[] tags)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>host</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>host</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>The message host</p>
</dd>
<dt><code>msg</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
@@ -335,8 +335,8 @@ Class MessageHostUtil
<a id="Hi_Common_Messages_MessageHostUtil_AddProgress_" data-uid="Hi.Common.Messages.MessageHostUtil.AddProgress*"></a>
<h3 id="Hi_Common_Messages_MessageHostUtil_AddProgress_Hi_Common_Messages_IMessageKit_System_String_System_String___" data-uid="Hi.Common.Messages.MessageHostUtil.AddProgress(Hi.Common.Messages.IMessageKit,System.String,System.String[])">
AddProgress(IMessageKit, string, params string[])
<h3 id="Hi_Common_Messages_MessageHostUtil_AddProgress_Hi_Common_Messages_IMessageHost_System_String_System_String___" data-uid="Hi.Common.Messages.MessageHostUtil.AddProgress(Hi.Common.Messages.IMessageHost,System.String,System.String[])">
AddProgress(IMessageHost, string, params string[])
</h3>
@@ -345,12 +345,12 @@ Class MessageHostUtil
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static object AddProgress(this IMessageKit host, string message, params string[] otherTags)</code></pre>
<pre><code class="lang-csharp hljs">public static object AddProgress(this IMessageHost host, string message, params string[] otherTags)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>host</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>host</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>The message host</p>
</dd>
<dt><code>message</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
@@ -380,8 +380,8 @@ Class MessageHostUtil
<a id="Hi_Common_Messages_MessageHostUtil_AddSuccess_" data-uid="Hi.Common.Messages.MessageHostUtil.AddSuccess*"></a>
<h3 id="Hi_Common_Messages_MessageHostUtil_AddSuccess_Hi_Common_Messages_IMessageKit_System_String_System_String___" data-uid="Hi.Common.Messages.MessageHostUtil.AddSuccess(Hi.Common.Messages.IMessageKit,System.String,System.String[])">
AddSuccess(IMessageKit, string, params string[])
<h3 id="Hi_Common_Messages_MessageHostUtil_AddSuccess_Hi_Common_Messages_IMessageHost_System_String_System_String___" data-uid="Hi.Common.Messages.MessageHostUtil.AddSuccess(Hi.Common.Messages.IMessageHost,System.String,System.String[])">
AddSuccess(IMessageHost, string, params string[])
</h3>
@@ -390,12 +390,12 @@ Class MessageHostUtil
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static object AddSuccess(this IMessageKit host, string message, params string[] otherTags)</code></pre>
<pre><code class="lang-csharp hljs">public static object AddSuccess(this IMessageHost host, string message, params string[] otherTags)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>host</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>host</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>The message host</p>
</dd>
<dt><code>message</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
@@ -425,8 +425,8 @@ Class MessageHostUtil
<a id="Hi_Common_Messages_MessageHostUtil_AddWarning_" data-uid="Hi.Common.Messages.MessageHostUtil.AddWarning*"></a>
<h3 id="Hi_Common_Messages_MessageHostUtil_AddWarning_Hi_Common_Messages_IMessageKit_System_String_System_String___" data-uid="Hi.Common.Messages.MessageHostUtil.AddWarning(Hi.Common.Messages.IMessageKit,System.String,System.String[])">
AddWarning(IMessageKit, string, params string[])
<h3 id="Hi_Common_Messages_MessageHostUtil_AddWarning_Hi_Common_Messages_IMessageHost_System_String_System_String___" data-uid="Hi.Common.Messages.MessageHostUtil.AddWarning(Hi.Common.Messages.IMessageHost,System.String,System.String[])">
AddWarning(IMessageHost, string, params string[])
</h3>
@@ -435,12 +435,12 @@ Class MessageHostUtil
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static object AddWarning(this IMessageKit host, string message, params string[] otherTags)</code></pre>
<pre><code class="lang-csharp hljs">public static object AddWarning(this IMessageHost host, string message, params string[] otherTags)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>host</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>host</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>The message host</p>
</dd>
<dt><code>message</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
@@ -100,13 +100,13 @@ Classes
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Common.Messages.MessageHostUtil.html">MessageHostUtil</a></dt>
<dd><p>Utility methods for working with <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a> implementations.</p>
<dt><a class="xref" href="Hi.Common.Messages.MessageHost.html">MessageHost</a></dt>
<dd><p>Provides utility methods for handling messages.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Common.Messages.MessageKit.html">MessageKit</a></dt>
<dd><p>Provides utility methods for handling messages.</p>
<dt><a class="xref" href="Hi.Common.Messages.MessageHostUtil.html">MessageHostUtil</a></dt>
<dd><p>Utility methods for working with <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a> implementations.</p>
</dd>
</dl>
<dl class="jumplist">
@@ -118,7 +118,7 @@ Classes
Interfaces
</h3>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>Interface for objects that can host and manage messages.</p>
</dd>
</dl>
@@ -221,7 +221,8 @@ Class PacePlayee
</h3>
<div class="markdown level1 summary"><p>Waits for the player to signal the next pace.</p>
<div class="markdown level1 summary"><p>A pausable mark for the playing process.
The function enables <a class="xref" href="Hi.Common.PacePlayer.html#Hi_Common_PacePlayer_Pause">Pause()</a> to take effect.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -237,6 +238,9 @@ Class PacePlayee
<h4 class="section" id="Hi_Common_PacePlayee_Pace_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Waits for the player to signal the next pace.</p>
</div>
@@ -324,10 +324,10 @@ The writing data is buffered and processed on a separate task to improve perform
<a id="Hi_Common_ParallelBulkUtils_ParallelBulkWriter_1_WaitAll_" data-uid="Hi.Common.ParallelBulkUtils.ParallelBulkWriter`1.WaitAll*"></a>
<a id="Hi_Common_ParallelBulkUtils_ParallelBulkWriter_1_Wait_" data-uid="Hi.Common.ParallelBulkUtils.ParallelBulkWriter`1.Wait*"></a>
<h3 id="Hi_Common_ParallelBulkUtils_ParallelBulkWriter_1_WaitAll" data-uid="Hi.Common.ParallelBulkUtils.ParallelBulkWriter`1.WaitAll">
WaitAll()
<h3 id="Hi_Common_ParallelBulkUtils_ParallelBulkWriter_1_Wait" data-uid="Hi.Common.ParallelBulkUtils.ParallelBulkWriter`1.Wait">
Wait()
</h3>
@@ -336,7 +336,7 @@ The writing data is buffered and processed on a separate task to improve perform
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void WaitAll()</code></pre>
<pre><code class="lang-csharp hljs">public void Wait()</code></pre>
</div>
@@ -482,22 +482,22 @@ Class PathUtil
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string GetPathByTemplate(string templatePath, string replacedPathKeyword, string replacedNameKeyword, string replacingPath)</code></pre>
<pre><code class="lang-csharp hljs">public static string GetPathByTemplate(string templatePath, string replacingPath, string replacedPathKeyword, string replacedNameKeyword)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>templatePath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The template path containing keywords to be replaced</p>
</dd>
<dt><code>replacingPath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The path to use as replacement</p>
</dd>
<dt><code>replacedPathKeyword</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The path keyword to be replaced in the template</p>
</dd>
<dt><code>replacedNameKeyword</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The name keyword to be replaced in the template</p>
</dd>
<dt><code>replacingPath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The path to use as replacement</p>
</dd>
</dl>
+2 -2
View File
@@ -164,8 +164,8 @@ If the execution time is over the <a class="xref" href="Hi.Common.BlockingTimer.
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Common.IndexSegment.html">IndexSegment</a></dt>
<dd><p>Represents a segment of indices with a beginning and ending point.
Used for defining ranges of data in collections or arrays.</p>
<dd><p>Represents a segment of indices with a beginning (inclusive) and ending (exclusive&gt; point.
Used for defining segment of data in collections or arrays.</p>
</dd>
</dl>
<dl class="jumplist">
@@ -1052,7 +1052,8 @@ A value of -1 indicates that the display should follow the end of the strip.</p>
</h3>
<div class="markdown level1 summary"><p>Sets the display range for the cutter location strip.</p>
<div class="markdown level1 summary"><p>Sets the display range for the cutter location strip.
This method sets both the beginning and ending positions of the display range.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -1063,16 +1064,16 @@ A value of -1 indicates that the display should follow the end of the strip.</p>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>beginIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The beginning index of the display range.</p>
<dd><p>The beginning index of the display range. Will be clamped to [0, StripPoses.Count - 1].</p>
</dd>
<dt><code>endIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The ending index of the display range.</p>
<dd><p>The ending index of the display range. A value of -1 indicates that the display should follow the end of the strip. Values greater than or equal to StripPoses.Count will be converted to -1. Will be clamped to [-1, StripPoses.Count].</p>
</dd>
<dt><code>caller</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>The caller object that requests the display range change.</p>
<dd><p>The caller object that requests the display range change. Used for event notifications.</p>
</dd>
<dt><code>lowestLength</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The minimum length of the display range. Default is 2.</p>
<dd><p>The minimum length of the display range. Currently not used in the implementation. Default is 2.</p>
</dd>
</dl>
@@ -1620,6 +1620,42 @@ The Ctor keeps <a class="xref" href="Hi.Geom.Box3d.html#Hi_Geom_Box3d_Min">Min</
<a id="Hi_Geom_Box3d_Expand_" data-uid="Hi.Geom.Box3d.Expand*"></a>
<h3 id="Hi_Geom_Box3d_Expand_System_Collections_Generic_IEnumerable_Hi_Geom_Vec3d__" data-uid="Hi.Geom.Box3d.Expand(System.Collections.Generic.IEnumerable{Hi.Geom.Vec3d})">
Expand(IEnumerable&lt;Vec3d&gt;)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Box3d Expand(IEnumerable&lt;Vec3d&gt; ps)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>ps</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a>&gt;</dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Geom.Box3d.html">Box3d</a></dt>
<dd></dd>
</dl>
<a id="Hi_Geom_Box3d_ExpandToBox3d_" data-uid="Hi.Geom.Box3d.ExpandToBox3d*"></a>
<h3 id="Hi_Geom_Box3d_ExpandToBox3d_Hi_Geom_Box3d_" data-uid="Hi.Geom.Box3d.ExpandToBox3d(Hi.Geom.Box3d)">
@@ -166,7 +166,7 @@ The algorithm intelligently chooses the optimal boundary points based on the ini
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;BinarySolvingStatus&gt; CenterSplitionSolve(Func&lt;double, double&gt; func, Range&lt;double&gt; xBoundary, Vec2d x0y0, double yTarget, double convergenceLimit, Func&lt;double, bool&gt; isYAcceptableFunc, int maxIteration = 12)</code></pre>
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;BinarySolvingEntry&gt; CenterSplitionSolve(Func&lt;double, double&gt; func, Range&lt;double&gt; xBoundary, Vec2d x0y0, double yTarget, double convergenceLimit, Func&lt;double, bool&gt; isYAcceptableFunc, int maxIteration = 12)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -196,7 +196,7 @@ The algorithm intelligently chooses the optimal boundary points based on the ini
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Hi.Geom.Solvers.BinarySolvingStatus.html">BinarySolvingStatus</a>&gt;</dt>
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Hi.Geom.Solvers.BinarySolvingEntry.html">BinarySolvingEntry</a>&gt;</dt>
<dd><p>A sequence of solving status objects showing the progress of the solution</p>
</dd>
</dl>
@@ -223,7 +223,7 @@ The algorithm intelligently chooses the optimal boundary points based on the ini
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;BinarySolvingStatus&gt; CenterSplitionSolve(Func&lt;double, double&gt; func, Range&lt;double&gt; xBoundary, double x0, double yTarget, double convergenceLimit, Func&lt;double, bool&gt; isYAcceptableFunc, int maxIteration = 12)</code></pre>
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;BinarySolvingEntry&gt; CenterSplitionSolve(Func&lt;double, double&gt; func, Range&lt;double&gt; xBoundary, double x0, double yTarget, double convergenceLimit, Func&lt;double, bool&gt; isYAcceptableFunc, int maxIteration = 12)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -253,7 +253,7 @@ The algorithm intelligently chooses the optimal boundary points based on the ini
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Hi.Geom.Solvers.BinarySolvingStatus.html">BinarySolvingStatus</a>&gt;</dt>
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Hi.Geom.Solvers.BinarySolvingEntry.html">BinarySolvingEntry</a>&gt;</dt>
<dd><p>A sequence of solving status objects showing the progress of the solution</p>
</dd>
</dl>
@@ -280,7 +280,7 @@ The algorithm intelligently chooses the optimal boundary points based on the ini
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;BinarySolvingStatus&gt; CenterSplitionSolve(Func&lt;double, double&gt; func, Range&lt;double&gt; xBoundary, double yTarget, double convergenceLimit, Func&lt;double, bool&gt; isYAcceptableFunc, int maxIteration = 12)</code></pre>
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;BinarySolvingEntry&gt; CenterSplitionSolve(Func&lt;double, double&gt; func, Range&lt;double&gt; xBoundary, double yTarget, double convergenceLimit, Func&lt;double, bool&gt; isYAcceptableFunc, int maxIteration = 12)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -307,7 +307,7 @@ The algorithm intelligently chooses the optimal boundary points based on the ini
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Hi.Geom.Solvers.BinarySolvingStatus.html">BinarySolvingStatus</a>&gt;</dt>
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Hi.Geom.Solvers.BinarySolvingEntry.html">BinarySolvingEntry</a>&gt;</dt>
<dd><p>A sequence of solving status objects showing the progress of the solution</p>
</dd>
</dl>
@@ -334,7 +334,7 @@ The algorithm intelligently chooses the optimal boundary points based on the ini
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;BinarySolvingStatus&gt; CenterSplitionSolve(Func&lt;double, double&gt; func, double x0, double y0, double xBoundary, double yTarget, double convergenceLimit, Func&lt;double, bool&gt; isYAcceptableFunc, int maxIteration = 12)</code></pre>
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;BinarySolvingEntry&gt; CenterSplitionSolve(Func&lt;double, double&gt; func, double x0, double y0, double xBoundary, double yTarget, double convergenceLimit, Func&lt;double, bool&gt; isYAcceptableFunc, int maxIteration = 12)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -367,7 +367,7 @@ The algorithm intelligently chooses the optimal boundary points based on the ini
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Hi.Geom.Solvers.BinarySolvingStatus.html">BinarySolvingStatus</a>&gt;</dt>
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Hi.Geom.Solvers.BinarySolvingEntry.html">BinarySolvingEntry</a>&gt;</dt>
<dd><p>A sequence of solving status objects showing the progress of the solution</p>
</dd>
</dl>
@@ -394,7 +394,7 @@ The algorithm intelligently chooses the optimal boundary points based on the ini
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;BinarySolvingStatus&gt; CenterSplitionSolveWithY1(Func&lt;double, double&gt; func, double x0, double y0, double x1, double y1, double yTarget, double convergenceLimit, Func&lt;double, bool&gt; isYAcceptableFunc, int maxIteration = 12)</code></pre>
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;BinarySolvingEntry&gt; CenterSplitionSolveWithY1(Func&lt;double, double&gt; func, double x0, double y0, double x1, double y1, double yTarget, double convergenceLimit, Func&lt;double, bool&gt; isYAcceptableFunc, int maxIteration = 12)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -430,7 +430,7 @@ The algorithm intelligently chooses the optimal boundary points based on the ini
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Hi.Geom.Solvers.BinarySolvingStatus.html">BinarySolvingStatus</a>&gt;</dt>
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Hi.Geom.Solvers.BinarySolvingEntry.html">BinarySolvingEntry</a>&gt;</dt>
<dd><p>A sequence of solving status objects showing the progress of the solution</p>
</dd>
</dl>
@@ -457,7 +457,7 @@ The algorithm intelligently chooses the optimal boundary points based on the ini
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;BinarySolvingStatus&gt; SlopeSolve(Func&lt;double, double&gt; func, double x0, double y0, double x1, double yTarget, double convergenceLimit, int maxIteration = 12)</code></pre>
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;BinarySolvingEntry&gt; SlopeSolve(Func&lt;double, double&gt; func, double x0, double y0, double x1, double yTarget, double convergenceLimit, int maxIteration = 12)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -487,7 +487,7 @@ The algorithm intelligently chooses the optimal boundary points based on the ini
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Hi.Geom.Solvers.BinarySolvingStatus.html">BinarySolvingStatus</a>&gt;</dt>
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Hi.Geom.Solvers.BinarySolvingEntry.html">BinarySolvingEntry</a>&gt;</dt>
<dd><p>A sequence of solving status objects showing the progress of the solution</p>
</dd>
</dl>
@@ -514,7 +514,7 @@ The algorithm intelligently chooses the optimal boundary points based on the ini
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;BinarySolvingStatus&gt; SlopeSolveWithY1(Func&lt;double, double&gt; func, double x0, double y0, double x1, double y1, double yTarget, double convergenceLimit, int maxIteration = 12)</code></pre>
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;BinarySolvingEntry&gt; SlopeSolveWithY1(Func&lt;double, double&gt; func, double x0, double y0, double x1, double y1, double yTarget, double convergenceLimit, int maxIteration = 12)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -547,7 +547,7 @@ The algorithm intelligently chooses the optimal boundary points based on the ini
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Hi.Geom.Solvers.BinarySolvingStatus.html">BinarySolvingStatus</a>&gt;</dt>
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Hi.Geom.Solvers.BinarySolvingEntry.html">BinarySolvingEntry</a>&gt;</dt>
<dd><p>A sequence of solving status objects showing the progress of the solution</p>
</dd>
</dl>
@@ -2,9 +2,9 @@
<html>
<head>
<meta charset="utf-8">
<title>Class BinarySolvingStatus | HiAPI-C# 2025 </title>
<title>Class BinarySolvingEntry | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class BinarySolvingStatus | HiAPI-C# 2025 ">
<meta name="title" content="Class BinarySolvingEntry | HiAPI-C# 2025 ">
<meta name="description" content="Represents the status of a binary solving process. Contains information about the current state of the solver including best solutions and error metrics.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
@@ -84,12 +84,12 @@
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Hi.Geom.Solvers.BinarySolvingStatus">
<article data-uid="Hi.Geom.Solvers.BinarySolvingEntry">
<h1 id="Hi_Geom_Solvers_BinarySolvingStatus" data-uid="Hi.Geom.Solvers.BinarySolvingStatus" class="text-break">
Class BinarySolvingStatus
<h1 id="Hi_Geom_Solvers_BinarySolvingEntry" data-uid="Hi.Geom.Solvers.BinarySolvingEntry" class="text-break">
Class BinarySolvingEntry
</h1>
<div class="facts text-secondary">
@@ -103,7 +103,7 @@ Contains information about the current state of the solver including best soluti
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class BinarySolvingStatus</code></pre>
<pre><code class="lang-csharp hljs">public class BinarySolvingEntry</code></pre>
</div>
@@ -113,7 +113,7 @@ Contains information about the current state of the solver including best soluti
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><span class="xref">BinarySolvingStatus</span></div>
<div><span class="xref">BinarySolvingEntry</span></div>
</dd>
</dl>
@@ -176,24 +176,24 @@ Contains information about the current state of the solver including best soluti
</h2>
<a id="Hi_Geom_Solvers_BinarySolvingStatus__ctor_" data-uid="Hi.Geom.Solvers.BinarySolvingStatus.#ctor*"></a>
<a id="Hi_Geom_Solvers_BinarySolvingEntry__ctor_" data-uid="Hi.Geom.Solvers.BinarySolvingEntry.#ctor*"></a>
<h3 id="Hi_Geom_Solvers_BinarySolvingStatus__ctor_Hi_Geom_Solvers_SolvingResultStatus_System_Int32_System_Double_System_Double_System_Double_System_Double_System_Double_System_Double_" data-uid="Hi.Geom.Solvers.BinarySolvingStatus.#ctor(Hi.Geom.Solvers.SolvingResultStatus,System.Int32,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)">
BinarySolvingStatus(SolvingResultStatus, int, double, double, double, double, double, double)
<h3 id="Hi_Geom_Solvers_BinarySolvingEntry__ctor_Hi_Geom_Solvers_SolvingStatus_System_Int32_System_Double_System_Double_System_Double_System_Double_System_Double_System_Double_" data-uid="Hi.Geom.Solvers.BinarySolvingEntry.#ctor(Hi.Geom.Solvers.SolvingStatus,System.Int32,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)">
BinarySolvingEntry(SolvingStatus, int, double, double, double, double, double, double)
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Geom.Solvers.BinarySolvingStatus.html">BinarySolvingStatus</a> class.</p>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Geom.Solvers.BinarySolvingEntry.html">BinarySolvingEntry</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public BinarySolvingStatus(SolvingResultStatus solvingResultStatus, int iteration, double bestX, double bestY, double minBias, double workingX, double workingY, double bias)</code></pre>
<pre><code class="lang-csharp hljs">public BinarySolvingEntry(SolvingStatus solvingResultStatus, int iteration, double bestX, double bestY, double minBias, double workingX, double workingY, double bias)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>solvingResultStatus</code> <a class="xref" href="Hi.Geom.Solvers.SolvingResultStatus.html">SolvingResultStatus</a></dt>
<dt><code>solvingResultStatus</code> <a class="xref" href="Hi.Geom.Solvers.SolvingStatus.html">SolvingStatus</a></dt>
<dd><p>The current status of the solving process</p>
</dd>
<dt><code>iteration</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
@@ -234,9 +234,9 @@ Contains information about the current state of the solver including best soluti
</h2>
<a id="Hi_Geom_Solvers_BinarySolvingStatus_BestX_" data-uid="Hi.Geom.Solvers.BinarySolvingStatus.BestX*"></a>
<a id="Hi_Geom_Solvers_BinarySolvingEntry_BestX_" data-uid="Hi.Geom.Solvers.BinarySolvingEntry.BestX*"></a>
<h3 id="Hi_Geom_Solvers_BinarySolvingStatus_BestX" data-uid="Hi.Geom.Solvers.BinarySolvingStatus.BestX">
<h3 id="Hi_Geom_Solvers_BinarySolvingEntry_BestX" data-uid="Hi.Geom.Solvers.BinarySolvingEntry.BestX">
BestX
</h3>
@@ -266,9 +266,9 @@ Contains information about the current state of the solver including best soluti
<a id="Hi_Geom_Solvers_BinarySolvingStatus_BestY_" data-uid="Hi.Geom.Solvers.BinarySolvingStatus.BestY*"></a>
<a id="Hi_Geom_Solvers_BinarySolvingEntry_BestY_" data-uid="Hi.Geom.Solvers.BinarySolvingEntry.BestY*"></a>
<h3 id="Hi_Geom_Solvers_BinarySolvingStatus_BestY" data-uid="Hi.Geom.Solvers.BinarySolvingStatus.BestY">
<h3 id="Hi_Geom_Solvers_BinarySolvingEntry_BestY" data-uid="Hi.Geom.Solvers.BinarySolvingEntry.BestY">
BestY
</h3>
@@ -298,9 +298,9 @@ Contains information about the current state of the solver including best soluti
<a id="Hi_Geom_Solvers_BinarySolvingStatus_Bias_" data-uid="Hi.Geom.Solvers.BinarySolvingStatus.Bias*"></a>
<a id="Hi_Geom_Solvers_BinarySolvingEntry_Bias_" data-uid="Hi.Geom.Solvers.BinarySolvingEntry.Bias*"></a>
<h3 id="Hi_Geom_Solvers_BinarySolvingStatus_Bias" data-uid="Hi.Geom.Solvers.BinarySolvingStatus.Bias">
<h3 id="Hi_Geom_Solvers_BinarySolvingEntry_Bias" data-uid="Hi.Geom.Solvers.BinarySolvingEntry.Bias">
Bias
</h3>
@@ -330,9 +330,9 @@ Contains information about the current state of the solver including best soluti
<a id="Hi_Geom_Solvers_BinarySolvingStatus_Iteration_" data-uid="Hi.Geom.Solvers.BinarySolvingStatus.Iteration*"></a>
<a id="Hi_Geom_Solvers_BinarySolvingEntry_Iteration_" data-uid="Hi.Geom.Solvers.BinarySolvingEntry.Iteration*"></a>
<h3 id="Hi_Geom_Solvers_BinarySolvingStatus_Iteration" data-uid="Hi.Geom.Solvers.BinarySolvingStatus.Iteration">
<h3 id="Hi_Geom_Solvers_BinarySolvingEntry_Iteration" data-uid="Hi.Geom.Solvers.BinarySolvingEntry.Iteration">
Iteration
</h3>
@@ -362,9 +362,9 @@ Contains information about the current state of the solver including best soluti
<a id="Hi_Geom_Solvers_BinarySolvingStatus_MinBias_" data-uid="Hi.Geom.Solvers.BinarySolvingStatus.MinBias*"></a>
<a id="Hi_Geom_Solvers_BinarySolvingEntry_MinBias_" data-uid="Hi.Geom.Solvers.BinarySolvingEntry.MinBias*"></a>
<h3 id="Hi_Geom_Solvers_BinarySolvingStatus_MinBias" data-uid="Hi.Geom.Solvers.BinarySolvingStatus.MinBias">
<h3 id="Hi_Geom_Solvers_BinarySolvingEntry_MinBias" data-uid="Hi.Geom.Solvers.BinarySolvingEntry.MinBias">
MinBias
</h3>
@@ -394,10 +394,10 @@ Contains information about the current state of the solver including best soluti
<a id="Hi_Geom_Solvers_BinarySolvingStatus_SolvingResultStatus_" data-uid="Hi.Geom.Solvers.BinarySolvingStatus.SolvingResultStatus*"></a>
<a id="Hi_Geom_Solvers_BinarySolvingEntry_SolvingStatus_" data-uid="Hi.Geom.Solvers.BinarySolvingEntry.SolvingStatus*"></a>
<h3 id="Hi_Geom_Solvers_BinarySolvingStatus_SolvingResultStatus" data-uid="Hi.Geom.Solvers.BinarySolvingStatus.SolvingResultStatus">
SolvingResultStatus
<h3 id="Hi_Geom_Solvers_BinarySolvingEntry_SolvingStatus" data-uid="Hi.Geom.Solvers.BinarySolvingEntry.SolvingStatus">
SolvingStatus
</h3>
@@ -406,7 +406,7 @@ Contains information about the current state of the solver including best soluti
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SolvingResultStatus SolvingResultStatus { get; set; }</code></pre>
<pre><code class="lang-csharp hljs">public SolvingStatus SolvingStatus { get; set; }</code></pre>
</div>
@@ -415,7 +415,7 @@ Contains information about the current state of the solver including best soluti
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Geom.Solvers.SolvingResultStatus.html">SolvingResultStatus</a></dt>
<dt><a class="xref" href="Hi.Geom.Solvers.SolvingStatus.html">SolvingStatus</a></dt>
<dd></dd>
</dl>
@@ -426,9 +426,9 @@ Contains information about the current state of the solver including best soluti
<a id="Hi_Geom_Solvers_BinarySolvingStatus_WorkingX_" data-uid="Hi.Geom.Solvers.BinarySolvingStatus.WorkingX*"></a>
<a id="Hi_Geom_Solvers_BinarySolvingEntry_WorkingX_" data-uid="Hi.Geom.Solvers.BinarySolvingEntry.WorkingX*"></a>
<h3 id="Hi_Geom_Solvers_BinarySolvingStatus_WorkingX" data-uid="Hi.Geom.Solvers.BinarySolvingStatus.WorkingX">
<h3 id="Hi_Geom_Solvers_BinarySolvingEntry_WorkingX" data-uid="Hi.Geom.Solvers.BinarySolvingEntry.WorkingX">
WorkingX
</h3>
@@ -458,9 +458,9 @@ Contains information about the current state of the solver including best soluti
<a id="Hi_Geom_Solvers_BinarySolvingStatus_WorkingY_" data-uid="Hi.Geom.Solvers.BinarySolvingStatus.WorkingY*"></a>
<a id="Hi_Geom_Solvers_BinarySolvingEntry_WorkingY_" data-uid="Hi.Geom.Solvers.BinarySolvingEntry.WorkingY*"></a>
<h3 id="Hi_Geom_Solvers_BinarySolvingStatus_WorkingY" data-uid="Hi.Geom.Solvers.BinarySolvingStatus.WorkingY">
<h3 id="Hi_Geom_Solvers_BinarySolvingEntry_WorkingY" data-uid="Hi.Geom.Solvers.BinarySolvingEntry.WorkingY">
WorkingY
</h3>
@@ -494,9 +494,9 @@ Contains information about the current state of the solver including best soluti
</h2>
<a id="Hi_Geom_Solvers_BinarySolvingStatus_ToString_" data-uid="Hi.Geom.Solvers.BinarySolvingStatus.ToString*"></a>
<a id="Hi_Geom_Solvers_BinarySolvingEntry_ToString_" data-uid="Hi.Geom.Solvers.BinarySolvingEntry.ToString*"></a>
<h3 id="Hi_Geom_Solvers_BinarySolvingStatus_ToString" data-uid="Hi.Geom.Solvers.BinarySolvingStatus.ToString">
<h3 id="Hi_Geom_Solvers_BinarySolvingEntry_ToString" data-uid="Hi.Geom.Solvers.BinarySolvingEntry.ToString">
ToString()
</h3>
@@ -611,7 +611,7 @@ Class NumericalSolver
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SolvingResultStatus Solve(double[] paras, double[] targets, out double minBias, out double[,] jacob)</code></pre>
<pre><code class="lang-csharp hljs">public SolvingStatus Solve(double[] paras, double[] targets, out double minBias, out double[,] jacob)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -632,7 +632,7 @@ Class NumericalSolver
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Geom.Solvers.SolvingResultStatus.html">SolvingResultStatus</a></dt>
<dt><a class="xref" href="Hi.Geom.Solvers.SolvingStatus.html">SolvingStatus</a></dt>
<dd><p>The status of the solving process</p>
</dd>
</dl>
@@ -181,8 +181,8 @@ Contains detailed information about the solution including parameters, biases, a
<a id="Hi_Geom_Solvers_SolvingResult__ctor_" data-uid="Hi.Geom.Solvers.SolvingResult.#ctor*"></a>
<h3 id="Hi_Geom_Solvers_SolvingResult__ctor_Hi_Geom_Solvers_SolvingResultStatus_System_Double___System_Double___System_Double_System_Int32_System_Int32_System_Double___System_Double_0__0___" data-uid="Hi.Geom.Solvers.SolvingResult.#ctor(Hi.Geom.Solvers.SolvingResultStatus,System.Double[],System.Double[],System.Double,System.Int32,System.Int32,System.Double[],System.Double[0:,0:])">
SolvingResult(SolvingResultStatus, double[], double[], double, int, int, double[], double[,])
<h3 id="Hi_Geom_Solvers_SolvingResult__ctor_Hi_Geom_Solvers_SolvingStatus_System_Double___System_Double___System_Double_System_Int32_System_Int32_System_Double___System_Double_0__0___" data-uid="Hi.Geom.Solvers.SolvingResult.#ctor(Hi.Geom.Solvers.SolvingStatus,System.Double[],System.Double[],System.Double,System.Int32,System.Int32,System.Double[],System.Double[0:,0:])">
SolvingResult(SolvingStatus, double[], double[], double, int, int, double[], double[,])
</h3>
@@ -191,12 +191,12 @@ Contains detailed information about the solution including parameters, biases, a
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SolvingResult(SolvingResultStatus solvingResultStatus, double[] workingParas, double[] biases, double convergence, int iteration, int continuousSlowMomentumIteration, double[] paraCompensationOnNext, double[,] jacob)</code></pre>
<pre><code class="lang-csharp hljs">public SolvingResult(SolvingStatus solvingResultStatus, double[] workingParas, double[] biases, double convergence, int iteration, int continuousSlowMomentumIteration, double[] paraCompensationOnNext, double[,] jacob)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>solvingResultStatus</code> <a class="xref" href="Hi.Geom.Solvers.SolvingResultStatus.html">SolvingResultStatus</a></dt>
<dt><code>solvingResultStatus</code> <a class="xref" href="Hi.Geom.Solvers.SolvingStatus.html">SolvingStatus</a></dt>
<dd><p>The status of the solving process</p>
</dd>
<dt><code>workingParas</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>[]</dt>
@@ -434,7 +434,7 @@ Contains detailed information about the solution including parameters, biases, a
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SolvingResultStatus solvingResultStatus</code></pre>
<pre><code class="lang-csharp hljs">public SolvingStatus solvingResultStatus</code></pre>
</div>
@@ -442,7 +442,7 @@ Contains detailed information about the solution including parameters, biases, a
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Geom.Solvers.SolvingResultStatus.html">SolvingResultStatus</a></dt>
<dt><a class="xref" href="Hi.Geom.Solvers.SolvingStatus.html">SolvingStatus</a></dt>
<dd></dd>
</dl>
@@ -2,9 +2,9 @@
<html>
<head>
<meta charset="utf-8">
<title>Enum SolvingResultStatus | HiAPI-C# 2025 </title>
<title>Enum SolvingStatus | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Enum SolvingResultStatus | HiAPI-C# 2025 ">
<meta name="title" content="Enum SolvingStatus | HiAPI-C# 2025 ">
<meta name="description" content="Enumeration of possible statuses for solving results.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
@@ -84,13 +84,13 @@
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Hi.Geom.Solvers.SolvingResultStatus">
<article data-uid="Hi.Geom.Solvers.SolvingStatus">
<h1 id="Hi_Geom_Solvers_SolvingResultStatus" data-uid="Hi.Geom.Solvers.SolvingResultStatus" class="text-break">
Enum SolvingResultStatus
<h1 id="Hi_Geom_Solvers_SolvingStatus" data-uid="Hi.Geom.Solvers.SolvingStatus" class="text-break">
Enum SolvingStatus
</h1>
<div class="facts text-secondary">
@@ -103,7 +103,7 @@ Enum SolvingResultStatus
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public enum SolvingResultStatus</code></pre>
<pre><code class="lang-csharp hljs">public enum SolvingStatus</code></pre>
</div>
@@ -145,23 +145,23 @@ Enum SolvingResultStatus
<h2 id="fields">Fields
</h2>
<dl class="parameters">
<dt id="Hi_Geom_Solvers_SolvingResultStatus_Iterating"><code>Iterating = 4</code></dt>
<dt id="Hi_Geom_Solvers_SolvingStatus_Iterating"><code>Iterating = 4</code></dt>
<dd><p>Currently in the process of iterating.</p>
</dd>
<dt id="Hi_Geom_Solvers_SolvingResultStatus_NotCal"><code>NotCal = 0</code></dt>
<dt id="Hi_Geom_Solvers_SolvingStatus_NotCal"><code>NotCal = 0</code></dt>
<dd><p>Not calculated yet.</p>
</dd>
<dt id="Hi_Geom_Solvers_SolvingResultStatus_OverIteration"><code>OverIteration = 3</code></dt>
<dt id="Hi_Geom_Solvers_SolvingStatus_OverIteration"><code>OverIteration = 3</code></dt>
<dd><p>Exceeded maximum number of iterations.</p>
</dd>
<dt id="Hi_Geom_Solvers_SolvingResultStatus_Singular"><code>Singular = 2</code></dt>
<dt id="Hi_Geom_Solvers_SolvingStatus_Singular"><code>Singular = 2</code></dt>
<dd><p>Singular condition encountered during solving.</p>
</dd>
<dt id="Hi_Geom_Solvers_SolvingResultStatus_Solved"><code>Solved = 1</code></dt>
<dt id="Hi_Geom_Solvers_SolvingStatus_Solved"><code>Solved = 1</code></dt>
<dd><p>Successfully solved.</p>
</dd>
@@ -100,7 +100,7 @@ Classes
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Geom.Solvers.BinarySolvingStatus.html">BinarySolvingStatus</a></dt>
<dt><a class="xref" href="Hi.Geom.Solvers.BinarySolvingEntry.html">BinarySolvingEntry</a></dt>
<dd><p>Represents the status of a binary solving process.
Contains information about the current state of the solver including best solutions and error metrics.</p>
</dd>
@@ -131,7 +131,7 @@ Contains detailed information about the solution including parameters, biases, a
Enums
</h3>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Geom.Solvers.SolvingResultStatus.html">SolvingResultStatus</a></dt>
<dt><a class="xref" href="Hi.Geom.Solvers.SolvingStatus.html">SolvingStatus</a></dt>
<dd><p>Enumeration of possible statuses for solving results.</p>
</dd>
</dl>
@@ -407,48 +407,6 @@ There is no performance gain from that parameter.</p>
<a id="Hi_Machining_MachiningVolumeRemovalProc_StepSubstract_" data-uid="Hi.Machining.MachiningVolumeRemovalProc.StepSubstract*"></a>
<h3 id="Hi_Machining_MachiningVolumeRemovalProc_StepSubstract_Hi_Cbtr_GeomBoolCache_Hi_NcMech_Workpieces_Workpiece_" data-uid="Hi.Machining.MachiningVolumeRemovalProc.StepSubstract(Hi.Cbtr.GeomBoolCache,Hi.NcMech.Workpieces.Workpiece)">
StepSubstract(GeomBoolCache, Workpiece)
</h3>
<div class="markdown level1 summary"><p>Performs volume subtraction using the provided geometric boolean cache on the workpiece.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Substraction StepSubstract(GeomBoolCache geomBoolCache, Workpiece workpiece)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>geomBoolCache</code> <a class="xref" href="Hi.Cbtr.GeomBoolCache.html">GeomBoolCache</a></dt>
<dd><p>The geometric boolean cache containing the operation data.</p>
</dd>
<dt><code>workpiece</code> <a class="xref" href="Hi.NcMech.Workpieces.Workpiece.html">Workpiece</a></dt>
<dd><p>The workpiece to perform subtraction on.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Cbtr.Substraction.html">Substraction</a></dt>
<dd><p>The result of the subtraction operation, or null if the operation cannot be performed.</p>
</dd>
</dl>
<h2 class="section" id="events">Events
</h2>
@@ -340,10 +340,10 @@ and managing session state.</p>
<a id="Hi_MachiningProcs_MachiningSession_StepIndexToNcOptOptionList_" data-uid="Hi.MachiningProcs.MachiningSession.StepIndexToNcOptOptionList*"></a>
<a id="Hi_MachiningProcs_MachiningSession_StepIndexToNcOptOptionSortedList_" data-uid="Hi.MachiningProcs.MachiningSession.StepIndexToNcOptOptionSortedList*"></a>
<h3 id="Hi_MachiningProcs_MachiningSession_StepIndexToNcOptOptionList" data-uid="Hi.MachiningProcs.MachiningSession.StepIndexToNcOptOptionList">
StepIndexToNcOptOptionList
<h3 id="Hi_MachiningProcs_MachiningSession_StepIndexToNcOptOptionSortedList" data-uid="Hi.MachiningProcs.MachiningSession.StepIndexToNcOptOptionSortedList">
StepIndexToNcOptOptionSortedList
</h3>
@@ -354,7 +354,7 @@ Takes effect during internal optimization process.</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SortedList&lt;int, NcOptOption&gt; StepIndexToNcOptOptionList { get; set; }</code></pre>
<pre><code class="lang-csharp hljs">public SortedList&lt;int, NcOptOption&gt; StepIndexToNcOptOptionSortedList { get; set; }</code></pre>
</div>
@@ -1008,6 +1008,38 @@ public bool OptEnableFeedrate { get; set; }</code></pre>
<a id="Hi_MachiningProcs_RuntimeApi_OptEnableFirstSituProcLog_" data-uid="Hi.MachiningProcs.RuntimeApi.OptEnableFirstSituProcLog*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_OptEnableFirstSituProcLog" data-uid="Hi.MachiningProcs.RuntimeApi.OptEnableFirstSituProcLog">
OptEnableFirstSituProcLog
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public static bool OptEnableFirstSituProcLog { 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_OptEnableForwardCompensation_" data-uid="Hi.MachiningProcs.RuntimeApi.OptEnableForwardCompensation*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_OptEnableForwardCompensation" data-uid="Hi.MachiningProcs.RuntimeApi.OptEnableForwardCompensation">
@@ -1074,6 +1106,38 @@ public bool OptEnableInterpolation { get; set; }</code></pre>
<a id="Hi_MachiningProcs_RuntimeApi_OptEnableNcEmbeddedLog_" data-uid="Hi.MachiningProcs.RuntimeApi.OptEnableNcEmbeddedLog*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_OptEnableNcEmbeddedLog" data-uid="Hi.MachiningProcs.RuntimeApi.OptEnableNcEmbeddedLog">
OptEnableNcEmbeddedLog
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public static bool OptEnableNcEmbeddedLog { 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_OptEnableSideCompensation_" data-uid="Hi.MachiningProcs.RuntimeApi.OptEnableSideCompensation*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_OptEnableSideCompensation" data-uid="Hi.MachiningProcs.RuntimeApi.OptEnableSideCompensation">
@@ -1761,7 +1825,7 @@ public double OptYieldingUtilizationFactor { get; set; }</code></pre>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://github.com/dotnet/roslyn/blob/8edf7bcd4f1594c3d68a6a567469f41dbd33dd1b/src/Scripting/Core/ScriptOptions.cs">ScriptOptions</a></dt>
<dt><a class="xref" href="https://github.com/dotnet/roslyn/blob/6c4a46a31302167b425d5e0a31ea83c9a9aa1d09/src/Scripting/Core/ScriptOptions.cs">ScriptOptions</a></dt>
<dd></dd>
</dl>
@@ -2084,7 +2148,8 @@ milling step() has not triggered yet.</p>
</h3>
<div class="markdown level1 summary"><p>Begins a new machining session.</p>
<div class="markdown level1 summary"><p>Begins a new machining session.
Not for end user.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -2240,7 +2305,8 @@ public void EndPreserve()</code></pre>
</h3>
<div class="markdown level1 summary"><p>Ends the current machining session.</p>
<div class="markdown level1 summary"><p>Ends the current machining session.
Not for end user.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -2720,7 +2786,8 @@ public void OptimizeToFiles(string relFileTemplate = &quot;Output/Opt-[NcName]&q
</h3>
<div class="markdown level1 summary"><p>Controls the pace of machining operations during execution.</p>
<div class="markdown level1 summary"><p>A pausable mark for the playing process.
The function enables <a class="xref" href="Hi.Common.PacePlayer.html#Hi_Common_PacePlayer_Pause">Pause()</a> to take effect.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -2737,6 +2804,9 @@ public void Pace()</code></pre>
<h4 class="section" id="Hi_MachiningProcs_RuntimeApi_Pace_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Waits for the player to signal the next pace.</p>
</div>
@@ -3304,7 +3374,8 @@ public void ResetRuntime()</code></pre>
</h3>
<div class="markdown level1 summary"><p>Runs NC code directly from a string.</p>
<div class="markdown level1 summary"><p>Runs NC code directly from a string.
Not for end user.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -3347,7 +3418,8 @@ public IEnumerable&lt;Action&gt; RunNc(string ncText, string fileNameAlternative
</h3>
<div class="markdown level1 summary"><p>Runs an NC file with the specified relative path.</p>
<div class="markdown level1 summary"><p>Runs an NC file with the specified relative path.
Not for end user.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -2319,7 +2319,7 @@ public int ParaTemplateDimension { get; set; }</code></pre>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://github.com/dotnet/roslyn/blob/8edf7bcd4f1594c3d68a6a567469f41dbd33dd1b/src/Scripting/Core/ScriptOptions.cs">ScriptOptions</a></dt>
<dt><a class="xref" href="https://github.com/dotnet/roslyn/blob/6c4a46a31302167b425d5e0a31ea83c9a9aa1d09/src/Scripting/Core/ScriptOptions.cs">ScriptOptions</a></dt>
<dd></dd>
</dl>
@@ -102,7 +102,7 @@ Class SessionMessageHost
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class SessionMessageHost : IMessageKit</code></pre>
<pre><code class="lang-csharp hljs">public class SessionMessageHost : IMessageHost</code></pre>
</div>
@@ -119,7 +119,7 @@ Class SessionMessageHost
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></div>
<div><a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></div>
</dd>
</dl>
@@ -290,7 +290,8 @@ Note that the spindle information is only for milling behavior.</p>
</h3>
<div class="markdown level1 summary"><p>The work time at the end of the step.</p>
<div class="markdown level1 summary"><p>The work time at the end of the step.
The value is <a class="xref" href="Hi.MachiningSteps.MachineMotionStep.html#Hi_MachiningSteps_MachineMotionStep_StepBeginTime">StepBeginTime</a> + <a class="xref" href="Hi.MachiningSteps.MachineMotionStep.html#Hi_MachiningSteps_MachineMotionStep_StepDuration">StepDuration</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -1668,6 +1669,37 @@ Note that the spindle information is only for milling behavior.</p>
<a id="Hi_MachiningSteps_MachineMotionStep_GetSpindleSpeed_cycleds_" data-uid="Hi.MachiningSteps.MachineMotionStep.GetSpindleSpeed_cycleds*"></a>
<h3 id="Hi_MachiningSteps_MachineMotionStep_GetSpindleSpeed_cycleds" data-uid="Hi.MachiningSteps.MachineMotionStep.GetSpindleSpeed_cycleds">
GetSpindleSpeed_cycleds()
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double GetSpindleSpeed_cycleds()</code></pre>
</div>
<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_MachiningSteps_MachineMotionStep_GetSpindleSpeed_radds_" data-uid="Hi.MachiningSteps.MachineMotionStep.GetSpindleSpeed_radds*"></a>
<h3 id="Hi_MachiningSteps_MachineMotionStep_GetSpindleSpeed_radds" data-uid="Hi.MachiningSteps.MachineMotionStep.GetSpindleSpeed_radds">
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class MachiningStep | HiAPI-C# 2025 ">
<meta name="description" content="Represents a machining step enriched with physics, mapping and source metadata.">
<meta name="description" content="Represents a machining step enriched with physics, mapping and source metadata. The duration-based step property is based on the duration from previous-step to current-step.">
<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 @@ Class MachiningStep
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>Represents a machining step enriched with physics, mapping and source metadata.</p>
<div class="markdown summary"><p>Represents a machining step enriched with physics, mapping and source metadata.
The duration-based step property is based on the duration from previous-step to current-step.</p>
</div>
<div class="markdown conceptual"></div>
@@ -2828,7 +2829,8 @@ public Vec3d MoveOnProgramCoordinate { get; }</code></pre>
</h3>
<div class="markdown level1 summary"><p>Gets the moving length in mm.</p>
<div class="markdown level1 summary"><p>Gets the moving length in mm.
From previous-step to current-step.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -3984,6 +3986,37 @@ public SpindleDirection GetSpindleDirection()</code></pre>
<a id="Hi_MachiningSteps_MachiningStep_GetSpindleSpeed_cycleds_" data-uid="Hi.MachiningSteps.MachiningStep.GetSpindleSpeed_cycleds*"></a>
<h3 id="Hi_MachiningSteps_MachiningStep_GetSpindleSpeed_cycleds" data-uid="Hi.MachiningSteps.MachiningStep.GetSpindleSpeed_cycleds">
GetSpindleSpeed_cycleds()
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double GetSpindleSpeed_cycleds()</code></pre>
</div>
<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_MachiningSteps_MachiningStep_GetSpindleSpeed_radds_" data-uid="Hi.MachiningSteps.MachiningStep.GetSpindleSpeed_radds*"></a>
<h3 id="Hi_MachiningSteps_MachiningStep_GetSpindleSpeed_radds" data-uid="Hi.MachiningSteps.MachiningStep.GetSpindleSpeed_radds">
@@ -4025,7 +4058,7 @@ public SpindleDirection GetSpindleDirection()</code></pre>
</h3>
<div class="markdown level1 summary"><p>Update <a class="xref" href="Hi.NcOpt.NcOptOption.html">NcOptOption</a> for this step only.
Unlike the modification within the script (script command in NC code or RuntimeApi), the setting is not applied to the further step.</p>
It should not be mixed with the StepBuilt event and NC inline script since the concurent process may break the logics.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -102,7 +102,8 @@ Note that the spindle information is only for milling behavior.</p>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a></dt>
<dd><p>Represents a machining step enriched with physics, mapping and source metadata.</p>
<dd><p>Represents a machining step enriched with physics, mapping and source metadata.
The duration-based step property is based on the duration from previous-step to current-step.</p>
</dd>
</dl>
<dl class="jumplist">
@@ -494,8 +494,8 @@ Class CsvNcStep
<a id="Hi_Mapping_CsvNcStep_BuildByFile_" data-uid="Hi.Mapping.CsvNcStep.BuildByFile*"></a>
<h3 id="Hi_Mapping_CsvNcStep_BuildByFile_Hi_CutterLocations_ClStrips_ClStrip_System_String_System_String_Hi_Common_Messages_IMessageKit_Hi_Mapping_CsvNcStep_StepInterpoationMode_" data-uid="Hi.Mapping.CsvNcStep.BuildByFile(Hi.CutterLocations.ClStrips.ClStrip,System.String,System.String,Hi.Common.Messages.IMessageKit,Hi.Mapping.CsvNcStep.StepInterpoationMode)">
BuildByFile(ClStrip, string, string, IMessageKit, StepInterpoationMode)
<h3 id="Hi_Mapping_CsvNcStep_BuildByFile_Hi_CutterLocations_ClStrips_ClStrip_System_String_System_String_Hi_Common_Messages_IMessageHost_Hi_Mapping_CsvNcStep_StepInterpoationMode_" data-uid="Hi.Mapping.CsvNcStep.BuildByFile(Hi.CutterLocations.ClStrips.ClStrip,System.String,System.String,Hi.Common.Messages.IMessageHost,Hi.Mapping.CsvNcStep.StepInterpoationMode)">
BuildByFile(ClStrip, string, string, IMessageHost, StepInterpoationMode)
</h3>
@@ -504,7 +504,7 @@ Class CsvNcStep
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void BuildByFile(ClStrip clStrip, string baseDirectory, string relPath, IMessageKit messageHost, CsvNcStep.StepInterpoationMode stepInterpoationMode)</code></pre>
<pre><code class="lang-csharp hljs">public static void BuildByFile(ClStrip clStrip, string baseDirectory, string relPath, IMessageHost messageHost, CsvNcStep.StepInterpoationMode stepInterpoationMode)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -518,7 +518,7 @@ Class CsvNcStep
<dt><code>relPath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The relative path to the CSV file.</p>
</dd>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>The message host for logging.</p>
</dd>
<dt><code>stepInterpoationMode</code> <a class="xref" href="Hi.Mapping.CsvNcStep.html">CsvNcStep</a>.<a class="xref" href="Hi.Mapping.CsvNcStep.StepInterpoationMode.html">StepInterpoationMode</a></dt>
@@ -319,8 +319,8 @@ Class MillingTraining
<a id="Hi_MillingForces_Training_MillingTraining_Convert_" data-uid="Hi.MillingForces.Training.MillingTraining.Convert*"></a>
<h3 id="Hi_MillingForces_Training_MillingTraining_Convert_Hi_MillingForces_Fittings_ICuttingPara_Hi_MillingForces_Fittings_ICuttingPara_Hi_Milling_Apts_GeneralApt_System_Double_System_Double_Hi_Common_Messages_IMessageKit_System_Threading_CancellationToken_" data-uid="Hi.MillingForces.Training.MillingTraining.Convert(Hi.MillingForces.Fittings.ICuttingPara,Hi.MillingForces.Fittings.ICuttingPara,Hi.Milling.Apts.GeneralApt,System.Double,System.Double,Hi.Common.Messages.IMessageKit,System.Threading.CancellationToken)">
Convert(ICuttingPara, ICuttingPara, GeneralApt, double, double, IMessageKit, CancellationToken)
<h3 id="Hi_MillingForces_Training_MillingTraining_Convert_Hi_MillingForces_Fittings_ICuttingPara_Hi_MillingForces_Fittings_ICuttingPara_Hi_Milling_Apts_GeneralApt_System_Double_System_Double_Hi_Common_Messages_IMessageHost_System_Threading_CancellationToken_" data-uid="Hi.MillingForces.Training.MillingTraining.Convert(Hi.MillingForces.Fittings.ICuttingPara,Hi.MillingForces.Fittings.ICuttingPara,Hi.Milling.Apts.GeneralApt,System.Double,System.Double,Hi.Common.Messages.IMessageHost,System.Threading.CancellationToken)">
Convert(ICuttingPara, ICuttingPara, GeneralApt, double, double, IMessageHost, CancellationToken)
</h3>
@@ -329,7 +329,7 @@ Class MillingTraining
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static ICuttingPara Convert(ICuttingPara src, ICuttingPara dstTemplate, GeneralApt apt, double helixAngle_rad, double radialRakeAngle_rad, IMessageKit messageHost, CancellationToken cancellationToken)</code></pre>
<pre><code class="lang-csharp hljs">public static ICuttingPara Convert(ICuttingPara src, ICuttingPara dstTemplate, GeneralApt apt, double helixAngle_rad, double radialRakeAngle_rad, IMessageHost messageHost, CancellationToken cancellationToken)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -349,7 +349,7 @@ Class MillingTraining
<dt><code>radialRakeAngle_rad</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>Radial rake angle in radians</p>
</dd>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>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>
@@ -376,8 +376,8 @@ Class MillingTraining
<a id="Hi_MillingForces_Training_MillingTraining_Convert_" data-uid="Hi.MillingForces.Training.MillingTraining.Convert*"></a>
<h3 id="Hi_MillingForces_Training_MillingTraining_Convert_Hi_MillingForces_ProfileMillingParas_LocalProfileMillingPara_System_Double_System_Double_Hi_Common_Messages_IMessageKit_System_Threading_CancellationToken_" data-uid="Hi.MillingForces.Training.MillingTraining.Convert(Hi.MillingForces.ProfileMillingParas.LocalProfileMillingPara,System.Double,System.Double,Hi.Common.Messages.IMessageKit,System.Threading.CancellationToken)">
Convert(LocalProfileMillingPara, double, double, IMessageKit, CancellationToken)
<h3 id="Hi_MillingForces_Training_MillingTraining_Convert_Hi_MillingForces_ProfileMillingParas_LocalProfileMillingPara_System_Double_System_Double_Hi_Common_Messages_IMessageHost_System_Threading_CancellationToken_" data-uid="Hi.MillingForces.Training.MillingTraining.Convert(Hi.MillingForces.ProfileMillingParas.LocalProfileMillingPara,System.Double,System.Double,Hi.Common.Messages.IMessageHost,System.Threading.CancellationToken)">
Convert(LocalProfileMillingPara, double, double, IMessageHost, CancellationToken)
</h3>
@@ -386,7 +386,7 @@ Class MillingTraining
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static RakeFaceCuttingPara2d Convert(LocalProfileMillingPara src, double helixAngle_rad, double radialRakeAngle_rad, IMessageKit messageHost, CancellationToken cancellationToken)</code></pre>
<pre><code class="lang-csharp hljs">public static RakeFaceCuttingPara2d Convert(LocalProfileMillingPara src, double helixAngle_rad, double radialRakeAngle_rad, IMessageHost messageHost, CancellationToken cancellationToken)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -400,7 +400,7 @@ Class MillingTraining
<dt><code>radialRakeAngle_rad</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>Radial rake angle in radians</p>
</dd>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>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>
@@ -427,8 +427,8 @@ Class MillingTraining
<a id="Hi_MillingForces_Training_MillingTraining_GatherAndGetUpdate_" data-uid="Hi.MillingForces.Training.MillingTraining.GatherAndGetUpdate*"></a>
<h3 id="Hi_MillingForces_Training_MillingTraining_GatherAndGetUpdate_System_Collections_Concurrent_ConcurrentDictionary_System_Int32_System_Collections_Generic_List_Hi_Mapping_ITimeShot___Hi_CutterLocations_ClStrips_ClStrip_Hi_MillingForces_Fittings_ICuttingPara_Hi_MillingForces_Fittings_SampleFlag_System_Double_Hi_Common_Messages_IMessageKit_System_Threading_CancellationToken_" data-uid="Hi.MillingForces.Training.MillingTraining.GatherAndGetUpdate(System.Collections.Concurrent.ConcurrentDictionary{System.Int32,System.Collections.Generic.List{Hi.Mapping.ITimeShot}},Hi.CutterLocations.ClStrips.ClStrip,Hi.MillingForces.Fittings.ICuttingPara,Hi.MillingForces.Fittings.SampleFlag,System.Double,Hi.Common.Messages.IMessageKit,System.Threading.CancellationToken)">
GatherAndGetUpdate(ConcurrentDictionary&lt;int, List&lt;ITimeShot&gt;&gt;, ClStrip, ICuttingPara, SampleFlag, double, IMessageKit, CancellationToken)
<h3 id="Hi_MillingForces_Training_MillingTraining_GatherAndGetUpdate_System_Collections_Concurrent_ConcurrentDictionary_System_Int32_System_Collections_Generic_List_Hi_Mapping_ITimeShot___Hi_CutterLocations_ClStrips_ClStrip_Hi_MillingForces_Fittings_ICuttingPara_Hi_MillingForces_Fittings_SampleFlag_System_Double_Hi_Common_Messages_IMessageHost_System_Threading_CancellationToken_" data-uid="Hi.MillingForces.Training.MillingTraining.GatherAndGetUpdate(System.Collections.Concurrent.ConcurrentDictionary{System.Int32,System.Collections.Generic.List{Hi.Mapping.ITimeShot}},Hi.CutterLocations.ClStrips.ClStrip,Hi.MillingForces.Fittings.ICuttingPara,Hi.MillingForces.Fittings.SampleFlag,System.Double,Hi.Common.Messages.IMessageHost,System.Threading.CancellationToken)">
GatherAndGetUpdate(ConcurrentDictionary&lt;int, List&lt;ITimeShot&gt;&gt;, ClStrip, ICuttingPara, SampleFlag, double, IMessageHost, CancellationToken)
</h3>
@@ -437,7 +437,7 @@ Class MillingTraining
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static ICuttingPara GatherAndGetUpdate(ConcurrentDictionary&lt;int, List&lt;ITimeShot&gt;&gt; stepToTimeShotListDictionary, ClStrip clStrip, ICuttingPara anchorPara, SampleFlag sampleFlags, double outlierRatio, IMessageKit messageHost, CancellationToken cancellationToken)</code></pre>
<pre><code class="lang-csharp hljs">public static ICuttingPara GatherAndGetUpdate(ConcurrentDictionary&lt;int, List&lt;ITimeShot&gt;&gt; stepToTimeShotListDictionary, ClStrip clStrip, ICuttingPara anchorPara, SampleFlag sampleFlags, double outlierRatio, IMessageHost messageHost, CancellationToken cancellationToken)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -457,7 +457,7 @@ Class MillingTraining
<dt><code>outlierRatio</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>Ratio of outliers to exclude</p>
</dd>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>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>
@@ -259,7 +259,10 @@ The object is part of data in the <a class="xref" href="Hi.MachiningSteps.Machin
</h3>
<div class="markdown level1 summary"><p>Radial Width.</p>
<div class="markdown level1 summary"><p>Radial Width.
The value may not equal to the bounding box.
It has filtered by plural method.
The value is for human viewing.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -292,6 +292,70 @@ Class NcOptProc
<a id="Hi_NcOpt_NcOptProc_EnableFirstSituProcLog_" data-uid="Hi.NcOpt.NcOptProc.EnableFirstSituProcLog*"></a>
<h3 id="Hi_NcOpt_NcOptProc_EnableFirstSituProcLog" data-uid="Hi.NcOpt.NcOptProc.EnableFirstSituProcLog">
EnableFirstSituProcLog
</h3>
<div class="markdown level1 summary"><p>Enable create log file for first (independent) situ process.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool EnableFirstSituProcLog { 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_NcOpt_NcOptProc_EnableNcEmbeddedLog_" data-uid="Hi.NcOpt.NcOptProc.EnableNcEmbeddedLog*"></a>
<h3 id="Hi_NcOpt_NcOptProc_EnableNcEmbeddedLog" data-uid="Hi.NcOpt.NcOptProc.EnableNcEmbeddedLog">
EnableNcEmbeddedLog
</h3>
<div class="markdown level1 summary"><p>Enable embedded log to optimized NC file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool EnableNcEmbeddedLog { 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_NcOpt_NcOptProc_XName_" data-uid="Hi.NcOpt.NcOptProc.XName*"></a>
<h3 id="Hi_NcOpt_NcOptProc_XName" data-uid="Hi.NcOpt.NcOptProc.XName">
@@ -381,8 +445,8 @@ Since the folder can be moving with the configuration file.</p>
<a id="Hi_NcOpt_NcOptProc_Optimize_" data-uid="Hi.NcOpt.NcOptProc.Optimize*"></a>
<h3 id="Hi_NcOpt_NcOptProc_Optimize_Hi_MillingForces_Fittings_ICuttingPara_Hi_MachiningProcs_MachiningSession_System_Collections_Generic_LinkedList_Hi_Numerical_NcLine__Hi_Numerical_NcEnv_System_Collections_Generic_List_Hi_MachiningSteps_MachiningStep__Hi_Machining_MachiningToolHouse_Hi_Common_Messages_IMessageKit_System_Threading_CancellationToken_System_String_" data-uid="Hi.NcOpt.NcOptProc.Optimize(Hi.MillingForces.Fittings.ICuttingPara,Hi.MachiningProcs.MachiningSession,System.Collections.Generic.LinkedList{Hi.Numerical.NcLine},Hi.Numerical.NcEnv,System.Collections.Generic.List{Hi.MachiningSteps.MachiningStep},Hi.Machining.MachiningToolHouse,Hi.Common.Messages.IMessageKit,System.Threading.CancellationToken,System.String)">
Optimize(ICuttingPara, MachiningSession, LinkedList&lt;NcLine&gt;, NcEnv, List&lt;MachiningStep&gt;, MachiningToolHouse, IMessageKit, CancellationToken, string)
<h3 id="Hi_NcOpt_NcOptProc_Optimize_Hi_MillingForces_Fittings_ICuttingPara_Hi_MachiningProcs_MachiningSession_System_Collections_Generic_LinkedList_Hi_Numerical_NcLine__Hi_Numerical_NcEnv_System_Collections_Generic_List_Hi_MachiningSteps_MachiningStep__Hi_Machining_MachiningToolHouse_Hi_Common_Messages_IMessageHost_System_Threading_CancellationToken_System_String_System_String_" data-uid="Hi.NcOpt.NcOptProc.Optimize(Hi.MillingForces.Fittings.ICuttingPara,Hi.MachiningProcs.MachiningSession,System.Collections.Generic.LinkedList{Hi.Numerical.NcLine},Hi.Numerical.NcEnv,System.Collections.Generic.List{Hi.MachiningSteps.MachiningStep},Hi.Machining.MachiningToolHouse,Hi.Common.Messages.IMessageHost,System.Threading.CancellationToken,System.String,System.String)">
Optimize(ICuttingPara, MachiningSession, LinkedList&lt;NcLine&gt;, NcEnv, List&lt;MachiningStep&gt;, MachiningToolHouse, IMessageHost, CancellationToken, string, string)
</h3>
@@ -391,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&lt;(NcLine SrcNcLine, NcLine OptNcLine)&gt; Optimize(ICuttingPara millingPara, MachiningSession machiningSession, LinkedList&lt;NcLine&gt; srcNcLines, NcEnv ncEnv, List&lt;MachiningStep&gt; millingSteps, MachiningToolHouse millingToolHouse, IMessageKit messageHost, CancellationToken cancellationToken, string relFileTemplate)</code></pre>
<pre><code class="lang-csharp hljs">public IEnumerable&lt;(NcLine SrcNcLine, NcLine OptNcLine)&gt; Optimize(ICuttingPara millingPara, MachiningSession machiningSession, LinkedList&lt;NcLine&gt; srcNcLines, NcEnv ncEnv, List&lt;MachiningStep&gt; machiningSteps, MachiningToolHouse millingToolHouse, IMessageHost messageHost, CancellationToken cancellationToken, string baseDirectory, string relFileTemplate)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -408,18 +472,20 @@ Since the folder can be moving with the configuration file.</p>
<dt><code>ncEnv</code> <a class="xref" href="Hi.Numerical.NcEnv.html">NcEnv</a></dt>
<dd><p>The NC environment settings</p>
</dd>
<dt><code>millingSteps</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a>&gt;</dt>
<dt><code>machiningSteps</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a>&gt;</dt>
<dd><p>The list of milling steps</p>
</dd>
<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="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</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>
<dd><p>Cancellation token to cancel the operation</p>
</dd>
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>relFileTemplate</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The relative file template for output</p>
</dd>
@@ -444,8 +510,8 @@ Since the folder can be moving with the configuration file.</p>
<a id="Hi_NcOpt_NcOptProc_OptimizeToFiles_" data-uid="Hi.NcOpt.NcOptProc.OptimizeToFiles*"></a>
<h3 id="Hi_NcOpt_NcOptProc_OptimizeToFiles_Hi_MillingForces_Fittings_ICuttingPara_Hi_MachiningProcs_MachiningSession_System_Collections_Generic_LinkedList_Hi_Numerical_NcLine__Hi_Numerical_NcEnv_Hi_Machining_MachiningToolHouse_Hi_CutterLocations_ClStrips_ClStrip_System_String_Hi_Common_Messages_IMessageKit_System_Threading_CancellationToken_System_String_" data-uid="Hi.NcOpt.NcOptProc.OptimizeToFiles(Hi.MillingForces.Fittings.ICuttingPara,Hi.MachiningProcs.MachiningSession,System.Collections.Generic.LinkedList{Hi.Numerical.NcLine},Hi.Numerical.NcEnv,Hi.Machining.MachiningToolHouse,Hi.CutterLocations.ClStrips.ClStrip,System.String,Hi.Common.Messages.IMessageKit,System.Threading.CancellationToken,System.String)">
OptimizeToFiles(ICuttingPara, MachiningSession, LinkedList&lt;NcLine&gt;, NcEnv, MachiningToolHouse, ClStrip, string, IMessageKit, CancellationToken, string)
<h3 id="Hi_NcOpt_NcOptProc_OptimizeToFiles_Hi_MillingForces_Fittings_ICuttingPara_Hi_MachiningProcs_MachiningSession_System_Collections_Generic_LinkedList_Hi_Numerical_NcLine__Hi_Numerical_NcEnv_Hi_Machining_MachiningToolHouse_Hi_CutterLocations_ClStrips_ClStrip_System_String_Hi_Common_Messages_IMessageHost_System_Threading_CancellationToken_System_String_" data-uid="Hi.NcOpt.NcOptProc.OptimizeToFiles(Hi.MillingForces.Fittings.ICuttingPara,Hi.MachiningProcs.MachiningSession,System.Collections.Generic.LinkedList{Hi.Numerical.NcLine},Hi.Numerical.NcEnv,Hi.Machining.MachiningToolHouse,Hi.CutterLocations.ClStrips.ClStrip,System.String,Hi.Common.Messages.IMessageHost,System.Threading.CancellationToken,System.String)">
OptimizeToFiles(ICuttingPara, MachiningSession, LinkedList&lt;NcLine&gt;, NcEnv, MachiningToolHouse, ClStrip, string, IMessageHost, CancellationToken, string)
</h3>
@@ -454,7 +520,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&lt;NcLine&gt; ncLines, NcEnv ncEnv, MachiningToolHouse millingToolHouse, ClStrip clStrip, string baseDirectory, IMessageKit messageHost, CancellationToken cancellationToken, string relFileTemplate = &quot;Output/Opt-[NcName]&quot;)</code></pre>
<pre><code class="lang-csharp hljs">public void OptimizeToFiles(ICuttingPara millingPara, MachiningSession machiningSession, LinkedList&lt;NcLine&gt; ncLines, NcEnv ncEnv, MachiningToolHouse millingToolHouse, ClStrip clStrip, string baseDirectory, IMessageHost messageHost, CancellationToken cancellationToken, string relFileTemplate = &quot;Output/Opt-[NcName]&quot;)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -480,7 +546,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="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</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,473 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class CsvRunner | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class CsvRunner | HiAPI-C# 2025 ">
<meta name="description" content="Provides functionality for running and processing csv lines.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">
<meta name="docfx:rel" content="../">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../public/docfx.min.js"></script>
<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>
</head>
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../img/HiAPI.logo.png" alt="">
</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>
<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>
<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Hi.Numerical.FilePlayers.CsvRunner">
<h1 id="Hi_Numerical_FilePlayers_CsvRunner" data-uid="Hi.Numerical.FilePlayers.CsvRunner" class="text-break">
Class CsvRunner
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Numerical.html">Numerical</a>.<a class="xref" href="Hi.Numerical.FilePlayers.html">FilePlayers</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
</div>
<div class="markdown summary"><p>Provides functionality for running and processing csv lines.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class CsvRunner : IControlRunner</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">CsvRunner</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="Hi.Numerical.FilePlayers.IControlRunner.html">IControlRunner</a></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
</dd></dl>
<dl class="typelist extensionMethods">
<dt>Extension Methods</dt>
<dd>
<div>
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate&lt;TSelf&gt;(TSelf, params object[])</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke&lt;TSrc&gt;(TSrc, Action&lt;TSrc&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke&lt;TSrc, TDst&gt;(TSrc, Func&lt;TSrc, TDst&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
</div>
<div>
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
</div>
<div>
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
</div>
<div>
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
</div>
</dd></dl>
<h2 class="section" id="constructors">Constructors
</h2>
<a id="Hi_Numerical_FilePlayers_CsvRunner__ctor_" data-uid="Hi.Numerical.FilePlayers.CsvRunner.#ctor*"></a>
<h3 id="Hi_Numerical_FilePlayers_CsvRunner__ctor_Hi_Common_PacePlayer_Hi_MachiningProcs_SessionMessageHost_" data-uid="Hi.Numerical.FilePlayers.CsvRunner.#ctor(Hi.Common.PacePlayer,Hi.MachiningProcs.SessionMessageHost)">
CsvRunner(PacePlayer, SessionMessageHost)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CsvRunner(PacePlayer pacePlayer, SessionMessageHost sessionMessageHost)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>pacePlayer</code> <a class="xref" href="Hi.Common.PacePlayer.html">PacePlayer</a></dt>
<dd></dd>
<dt><code>sessionMessageHost</code> <a class="xref" href="Hi.MachiningProcs.SessionMessageHost.html">SessionMessageHost</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_Numerical_FilePlayers_CsvRunner_Config_" data-uid="Hi.Numerical.FilePlayers.CsvRunner.Config*"></a>
<h3 id="Hi_Numerical_FilePlayers_CsvRunner_Config" data-uid="Hi.Numerical.FilePlayers.CsvRunner.Config">
Config
</h3>
<div class="markdown level1 summary"><p>Configuration for CSV Runner.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CsvRunnerConfig Config { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Numerical.FilePlayers.CsvRunnerConfig.html">CsvRunnerConfig</a></dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_FilePlayers_CsvRunner_PacePlayer_" data-uid="Hi.Numerical.FilePlayers.CsvRunner.PacePlayer*"></a>
<h3 id="Hi_Numerical_FilePlayers_CsvRunner_PacePlayer" data-uid="Hi.Numerical.FilePlayers.CsvRunner.PacePlayer">
PacePlayer
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public PacePlayer PacePlayer { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.PacePlayer.html">PacePlayer</a></dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_FilePlayers_CsvRunner_SessionMessageHost_" data-uid="Hi.Numerical.FilePlayers.CsvRunner.SessionMessageHost*"></a>
<h3 id="Hi_Numerical_FilePlayers_CsvRunner_SessionMessageHost" data-uid="Hi.Numerical.FilePlayers.CsvRunner.SessionMessageHost">
SessionMessageHost
</h3>
<div class="markdown level1 summary"><p>External Hosted.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SessionMessageHost SessionMessageHost { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.MachiningProcs.SessionMessageHost.html">SessionMessageHost</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_Numerical_FilePlayers_CsvRunner_Reset_" data-uid="Hi.Numerical.FilePlayers.CsvRunner.Reset*"></a>
<h3 id="Hi_Numerical_FilePlayers_CsvRunner_Reset" data-uid="Hi.Numerical.FilePlayers.CsvRunner.Reset">
Reset()
</h3>
<div class="markdown level1 summary"><p>Reset runtime data.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Reset()</code></pre>
</div>
<a id="Hi_Numerical_FilePlayers_CsvRunner_ResetFileIndex_" data-uid="Hi.Numerical.FilePlayers.CsvRunner.ResetFileIndex*"></a>
<h3 id="Hi_Numerical_FilePlayers_CsvRunner_ResetFileIndex" data-uid="Hi.Numerical.FilePlayers.CsvRunner.ResetFileIndex">
ResetFileIndex()
</h3>
<div class="markdown level1 summary"><p>Resets the file index to zero.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void ResetFileIndex()</code></pre>
</div>
<a id="Hi_Numerical_FilePlayers_CsvRunner_RunControlLines_" data-uid="Hi.Numerical.FilePlayers.CsvRunner.RunControlLines*"></a>
<h3 id="Hi_Numerical_FilePlayers_CsvRunner_RunControlLines_System_String_System_Collections_Generic_IEnumerable_System_String__System_Threading_CancellationToken_" data-uid="Hi.Numerical.FilePlayers.CsvRunner.RunControlLines(System.String,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
RunControlLines(string, IEnumerable&lt;string&gt;, CancellationToken)
</h3>
<div class="markdown level1 summary"><p>Runs raw Control lines and yields source control line and Act pairs.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IEnumerable&lt;SourceCommandActEntry&gt; RunControlLines(string relFilePath, IEnumerable&lt;string&gt; lines, CancellationToken cancellationToken)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>relFilePath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The relative path of the control file</p>
</dd>
<dt><code>lines</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd><p>The enumerable collection of command (control code) lines</p>
</dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd><p>Cancellation token to cancel the operation</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Hi.Numerical.FilePlayers.SourceCommandActEntry.html">SourceCommandActEntry</a>&gt;</dt>
<dd><p>Enumerable of source control line and Act pairs</p>
</dd>
</dl>
<a id="Hi_Numerical_FilePlayers_CsvRunner_RunToLineEnd_" data-uid="Hi.Numerical.FilePlayers.CsvRunner.RunToLineEnd*"></a>
<h3 id="Hi_Numerical_FilePlayers_CsvRunner_RunToLineEnd" data-uid="Hi.Numerical.FilePlayers.CsvRunner.RunToLineEnd">
RunToLineEnd()
</h3>
<div class="markdown level1 summary"><p>Set <a class="xref" href="Hi.Common.EnumerablePlayer.html">EnumerablePlayer</a> before use the function.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void RunToLineEnd()</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>
@@ -94,6 +94,11 @@
<h3 id="classes">
Classes
</h3>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Numerical.FilePlayers.CsvRunner.html">CsvRunner</a></dt>
<dd><p>Provides functionality for running and processing csv lines.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Numerical.FilePlayers.CsvRunnerConfig.html">CsvRunnerConfig</a></dt>
<dd><p>Configuration class for CSV Runner.</p>
@@ -1384,8 +1384,8 @@ Set to NaN if tooling motion not apply the axis motion.</p>
<a id="Hi_Numerical_NcEnv_CheckStrokeLimit_" data-uid="Hi.Numerical.NcEnv.CheckStrokeLimit*"></a>
<h3 id="Hi_Numerical_NcEnv_CheckStrokeLimit_Hi_Geom_DVec3d_Hi_Common_Messages_IMessageKit_" data-uid="Hi.Numerical.NcEnv.CheckStrokeLimit(Hi.Geom.DVec3d,Hi.Common.Messages.IMessageKit)">
CheckStrokeLimit(DVec3d, IMessageKit)
<h3 id="Hi_Numerical_NcEnv_CheckStrokeLimit_Hi_Geom_DVec3d_Hi_Common_Messages_IMessageHost_" data-uid="Hi.Numerical.NcEnv.CheckStrokeLimit(Hi.Geom.DVec3d,Hi.Common.Messages.IMessageHost)">
CheckStrokeLimit(DVec3d, IMessageHost)
</h3>
@@ -1394,7 +1394,7 @@ Set to NaN if tooling motion not apply the axis motion.</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool CheckStrokeLimit(DVec3d mcXyzabc_mm_rad, IMessageKit messageKit)</code></pre>
<pre><code class="lang-csharp hljs">public bool CheckStrokeLimit(DVec3d mcXyzabc_mm_rad, IMessageHost messageKit)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -1402,7 +1402,7 @@ Set to NaN if tooling motion not apply the axis motion.</p>
<dt><code>mcXyzabc_mm_rad</code> <a class="xref" href="Hi.Geom.DVec3d.html">DVec3d</a></dt>
<dd><p>Machine coordinates in mm and radians.</p>
</dd>
<dt><code>messageKit</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>messageKit</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>Message kit for error reporting.</p>
</dd>
</dl>
@@ -155,8 +155,8 @@ Class NcFlagUtil
<a id="Hi_Numerical_NcFlagUtil_GetCompensationHeight_" data-uid="Hi.Numerical.NcFlagUtil.GetCompensationHeight*"></a>
<h3 id="Hi_Numerical_NcFlagUtil_GetCompensationHeight_System_Collections_BitArray_System_Int32_Hi_Numerical_MillingToolOffsetTable_Hi_Numerical_CncBrand_Hi_Common_Messages_IMessageKit_" data-uid="Hi.Numerical.NcFlagUtil.GetCompensationHeight(System.Collections.BitArray,System.Int32,Hi.Numerical.MillingToolOffsetTable,Hi.Numerical.CncBrand,Hi.Common.Messages.IMessageKit)">
GetCompensationHeight(BitArray, int, MillingToolOffsetTable, CncBrand, IMessageKit)
<h3 id="Hi_Numerical_NcFlagUtil_GetCompensationHeight_System_Collections_BitArray_System_Int32_Hi_Numerical_MillingToolOffsetTable_Hi_Numerical_CncBrand_Hi_Common_Messages_IMessageHost_" data-uid="Hi.Numerical.NcFlagUtil.GetCompensationHeight(System.Collections.BitArray,System.Int32,Hi.Numerical.MillingToolOffsetTable,Hi.Numerical.CncBrand,Hi.Common.Messages.IMessageHost)">
GetCompensationHeight(BitArray, int, MillingToolOffsetTable, CncBrand, IMessageHost)
</h3>
@@ -165,7 +165,7 @@ Class NcFlagUtil
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static double GetCompensationHeight(this BitArray ncFlagBitArray, int H, MillingToolOffsetTable millingToolOffsetTable, CncBrand cncBrand, IMessageKit messageHost)</code></pre>
<pre><code class="lang-csharp hljs">public static double GetCompensationHeight(this BitArray ncFlagBitArray, int H, MillingToolOffsetTable millingToolOffsetTable, CncBrand cncBrand, IMessageHost messageHost)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -182,7 +182,7 @@ Class NcFlagUtil
<dt><code>cncBrand</code> <a class="xref" href="Hi.Numerical.CncBrand.html">CncBrand</a></dt>
<dd><p>CNC brand</p>
</dd>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>Message host for warnings</p>
</dd>
</dl>
@@ -206,8 +206,8 @@ Class NcFlagUtil
<a id="Hi_Numerical_NcFlagUtil_GetCompensationRadius_" data-uid="Hi.Numerical.NcFlagUtil.GetCompensationRadius*"></a>
<h3 id="Hi_Numerical_NcFlagUtil_GetCompensationRadius_System_Collections_BitArray_System_Int32_Hi_Numerical_MillingToolOffsetTable_Hi_Numerical_CncBrand_Hi_Common_Messages_IMessageKit_" data-uid="Hi.Numerical.NcFlagUtil.GetCompensationRadius(System.Collections.BitArray,System.Int32,Hi.Numerical.MillingToolOffsetTable,Hi.Numerical.CncBrand,Hi.Common.Messages.IMessageKit)">
GetCompensationRadius(BitArray, int, MillingToolOffsetTable, CncBrand, IMessageKit)
<h3 id="Hi_Numerical_NcFlagUtil_GetCompensationRadius_System_Collections_BitArray_System_Int32_Hi_Numerical_MillingToolOffsetTable_Hi_Numerical_CncBrand_Hi_Common_Messages_IMessageHost_" data-uid="Hi.Numerical.NcFlagUtil.GetCompensationRadius(System.Collections.BitArray,System.Int32,Hi.Numerical.MillingToolOffsetTable,Hi.Numerical.CncBrand,Hi.Common.Messages.IMessageHost)">
GetCompensationRadius(BitArray, int, MillingToolOffsetTable, CncBrand, IMessageHost)
</h3>
@@ -216,7 +216,7 @@ Class NcFlagUtil
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static double GetCompensationRadius(this BitArray ncFlagBitArray, int D, MillingToolOffsetTable millingToolOffsetTable, CncBrand cncBrand, IMessageKit messageHost)</code></pre>
<pre><code class="lang-csharp hljs">public static double GetCompensationRadius(this BitArray ncFlagBitArray, int D, MillingToolOffsetTable millingToolOffsetTable, CncBrand cncBrand, IMessageHost messageHost)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -233,7 +233,7 @@ Class NcFlagUtil
<dt><code>cncBrand</code> <a class="xref" href="Hi.Numerical.CncBrand.html">CncBrand</a></dt>
<dd><p>The CNC controller brand.</p>
</dd>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>The message host for reporting warnings or errors.</p>
</dd>
</dl>
@@ -197,8 +197,8 @@ Class NcLine
<a id="Hi_Numerical_NcLine__ctor_" data-uid="Hi.Numerical.NcLine.#ctor*"></a>
<h3 id="Hi_Numerical_NcLine__ctor_Hi_Numerical_NcEnv_Hi_Common_FileLines_IndexedFileLine_Hi_Numerical_NcLine_Hi_Numerical_NcNoteCache__Hi_Common_Messages_IMessageKit_" data-uid="Hi.Numerical.NcLine.#ctor(Hi.Numerical.NcEnv,Hi.Common.FileLines.IndexedFileLine,Hi.Numerical.NcLine,Hi.Numerical.NcNoteCache@,Hi.Common.Messages.IMessageKit)">
NcLine(NcEnv, IndexedFileLine, NcLine, out NcNoteCache, IMessageKit)
<h3 id="Hi_Numerical_NcLine__ctor_Hi_Numerical_NcEnv_Hi_Common_FileLines_IndexedFileLine_Hi_Numerical_NcLine_Hi_Numerical_NcNoteCache__Hi_Common_Messages_IMessageHost_" data-uid="Hi.Numerical.NcLine.#ctor(Hi.Numerical.NcEnv,Hi.Common.FileLines.IndexedFileLine,Hi.Numerical.NcLine,Hi.Numerical.NcNoteCache@,Hi.Common.Messages.IMessageHost)">
NcLine(NcEnv, IndexedFileLine, NcLine, out NcNoteCache, IMessageHost)
</h3>
@@ -207,7 +207,7 @@ Class NcLine
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public NcLine(NcEnv ncEnv, IndexedFileLine fileLine, NcLine preNcLine, out NcNoteCache ncLineCache, IMessageKit messageHost)</code></pre>
<pre><code class="lang-csharp hljs">public NcLine(NcEnv ncEnv, IndexedFileLine fileLine, NcLine preNcLine, out NcNoteCache ncLineCache, IMessageHost messageHost)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -225,7 +225,7 @@ If previous <a class="xref" href="Hi.Numerical.NcLine.html">NcLine</a> is not nu
<dt><code>ncLineCache</code> <a class="xref" href="Hi.Numerical.NcNoteCache.html">NcNoteCache</a></dt>
<dd><p>Output NC note cache</p>
</dd>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>Message host for warnings</p>
</dd>
</dl>
@@ -243,8 +243,8 @@ If previous <a class="xref" href="Hi.Numerical.NcLine.html">NcLine</a> is not nu
<a id="Hi_Numerical_NcLine__ctor_" data-uid="Hi.Numerical.NcLine.#ctor*"></a>
<h3 id="Hi_Numerical_NcLine__ctor_Hi_Numerical_NcEnv_Hi_Common_Messages_IMessageKit_" data-uid="Hi.Numerical.NcLine.#ctor(Hi.Numerical.NcEnv,Hi.Common.Messages.IMessageKit)">
NcLine(NcEnv, IMessageKit)
<h3 id="Hi_Numerical_NcLine__ctor_Hi_Numerical_NcEnv_Hi_Common_Messages_IMessageHost_" data-uid="Hi.Numerical.NcLine.#ctor(Hi.Numerical.NcEnv,Hi.Common.Messages.IMessageHost)">
NcLine(NcEnv, IMessageHost)
</h3>
@@ -253,14 +253,14 @@ If previous <a class="xref" href="Hi.Numerical.NcLine.html">NcLine</a> is not nu
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public NcLine(NcEnv ncEnv, IMessageKit messageHost)</code></pre>
<pre><code class="lang-csharp hljs">public NcLine(NcEnv ncEnv, IMessageHost messageHost)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>ncEnv</code> <a class="xref" href="Hi.Numerical.NcEnv.html">NcEnv</a></dt>
<dd></dd>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd></dd>
</dl>
@@ -2058,8 +2058,8 @@ So be care that do not change the NC XYZ if not needed.</p>
<a id="Hi_Numerical_NcLine_GetCompensationHeight_" data-uid="Hi.Numerical.NcLine.GetCompensationHeight*"></a>
<h3 id="Hi_Numerical_NcLine_GetCompensationHeight_Hi_Numerical_NcEnv_Hi_Common_Messages_IMessageKit_" data-uid="Hi.Numerical.NcLine.GetCompensationHeight(Hi.Numerical.NcEnv,Hi.Common.Messages.IMessageKit)">
GetCompensationHeight(NcEnv, IMessageKit)
<h3 id="Hi_Numerical_NcLine_GetCompensationHeight_Hi_Numerical_NcEnv_Hi_Common_Messages_IMessageHost_" data-uid="Hi.Numerical.NcLine.GetCompensationHeight(Hi.Numerical.NcEnv,Hi.Common.Messages.IMessageHost)">
GetCompensationHeight(NcEnv, IMessageHost)
</h3>
@@ -2068,7 +2068,7 @@ So be care that do not change the NC XYZ if not needed.</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double GetCompensationHeight(NcEnv ncEnv, IMessageKit messageHost)</code></pre>
<pre><code class="lang-csharp hljs">public double GetCompensationHeight(NcEnv ncEnv, IMessageHost messageHost)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -2076,7 +2076,7 @@ So be care that do not change the NC XYZ if not needed.</p>
<dt><code>ncEnv</code> <a class="xref" href="Hi.Numerical.NcEnv.html">NcEnv</a></dt>
<dd><p>NC environment</p>
</dd>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>Message host for warnings</p>
</dd>
</dl>
@@ -2100,8 +2100,8 @@ So be care that do not change the NC XYZ if not needed.</p>
<a id="Hi_Numerical_NcLine_GetCompensationRadius_" data-uid="Hi.Numerical.NcLine.GetCompensationRadius*"></a>
<h3 id="Hi_Numerical_NcLine_GetCompensationRadius_Hi_Numerical_CncBrand_Hi_Numerical_MillingToolOffsetTable_Hi_Common_Messages_IMessageKit_" data-uid="Hi.Numerical.NcLine.GetCompensationRadius(Hi.Numerical.CncBrand,Hi.Numerical.MillingToolOffsetTable,Hi.Common.Messages.IMessageKit)">
GetCompensationRadius(CncBrand, MillingToolOffsetTable, IMessageKit)
<h3 id="Hi_Numerical_NcLine_GetCompensationRadius_Hi_Numerical_CncBrand_Hi_Numerical_MillingToolOffsetTable_Hi_Common_Messages_IMessageHost_" data-uid="Hi.Numerical.NcLine.GetCompensationRadius(Hi.Numerical.CncBrand,Hi.Numerical.MillingToolOffsetTable,Hi.Common.Messages.IMessageHost)">
GetCompensationRadius(CncBrand, MillingToolOffsetTable, IMessageHost)
</h3>
@@ -2110,7 +2110,7 @@ So be care that do not change the NC XYZ if not needed.</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double GetCompensationRadius(CncBrand cncBrand, MillingToolOffsetTable millingToolOffsetTable, IMessageKit messageHost)</code></pre>
<pre><code class="lang-csharp hljs">public double GetCompensationRadius(CncBrand cncBrand, MillingToolOffsetTable millingToolOffsetTable, IMessageHost messageHost)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -2121,7 +2121,7 @@ So be care that do not change the NC XYZ if not needed.</p>
<dt><code>millingToolOffsetTable</code> <a class="xref" href="Hi.Numerical.MillingToolOffsetTable.html">MillingToolOffsetTable</a></dt>
<dd><p>Milling tool offset table</p>
</dd>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>Message host for warnings</p>
</dd>
</dl>
@@ -2250,8 +2250,8 @@ So be care that do not change the NC XYZ if not needed.</p>
<a id="Hi_Numerical_NcLine_GetMcByProgramPos_" data-uid="Hi.Numerical.NcLine.GetMcByProgramPos*"></a>
<h3 id="Hi_Numerical_NcLine_GetMcByProgramPos_Hi_Geom_Vec3d_Hi_Numerical_NcEnv_Hi_Numerical_NcNoteCache_Hi_Common_Messages_IMessageKit_Hi_Geom_Vec3d__" data-uid="Hi.Numerical.NcLine.GetMcByProgramPos(Hi.Geom.Vec3d,Hi.Numerical.NcEnv,Hi.Numerical.NcNoteCache,Hi.Common.Messages.IMessageKit,Hi.Geom.Vec3d@)">
GetMcByProgramPos(Vec3d, NcEnv, NcNoteCache, IMessageKit, out Vec3d)
<h3 id="Hi_Numerical_NcLine_GetMcByProgramPos_Hi_Geom_Vec3d_Hi_Numerical_NcEnv_Hi_Numerical_NcNoteCache_Hi_Common_Messages_IMessageHost_Hi_Geom_Vec3d__" data-uid="Hi.Numerical.NcLine.GetMcByProgramPos(Hi.Geom.Vec3d,Hi.Numerical.NcEnv,Hi.Numerical.NcNoteCache,Hi.Common.Messages.IMessageHost,Hi.Geom.Vec3d@)">
GetMcByProgramPos(Vec3d, NcEnv, NcNoteCache, IMessageHost, out Vec3d)
</h3>
@@ -2260,7 +2260,7 @@ So be care that do not change the NC XYZ if not needed.</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public DVec3d GetMcByProgramPos(Vec3d programPos, NcEnv ncEnv, NcNoteCache ncLineCache, IMessageKit messageHost, out Vec3d programXyz)</code></pre>
<pre><code class="lang-csharp hljs">public DVec3d GetMcByProgramPos(Vec3d programPos, NcEnv ncEnv, NcNoteCache ncLineCache, IMessageHost messageHost, out Vec3d programXyz)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -2271,7 +2271,7 @@ So be care that do not change the NC XYZ if not needed.</p>
<dd></dd>
<dt><code>ncLineCache</code> <a class="xref" href="Hi.Numerical.NcNoteCache.html">NcNoteCache</a></dt>
<dd></dd>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd></dd>
<dt><code>programXyz</code> <a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a></dt>
<dd></dd>
@@ -2295,8 +2295,8 @@ So be care that do not change the NC XYZ if not needed.</p>
<a id="Hi_Numerical_NcLine_GetProgramXyzabc_" data-uid="Hi.Numerical.NcLine.GetProgramXyzabc*"></a>
<h3 id="Hi_Numerical_NcLine_GetProgramXyzabc_Hi_Numerical_NcEnv_Hi_Geom_DVec3d_System_Nullable_System_Boolean___Hi_Common_Messages_IMessageKit_" data-uid="Hi.Numerical.NcLine.GetProgramXyzabc(Hi.Numerical.NcEnv,Hi.Geom.DVec3d,System.Nullable{System.Boolean}@,Hi.Common.Messages.IMessageKit)">
GetProgramXyzabc(NcEnv, DVec3d, out bool?, IMessageKit)
<h3 id="Hi_Numerical_NcLine_GetProgramXyzabc_Hi_Numerical_NcEnv_Hi_Geom_DVec3d_System_Nullable_System_Boolean___Hi_Common_Messages_IMessageHost_" data-uid="Hi.Numerical.NcLine.GetProgramXyzabc(Hi.Numerical.NcEnv,Hi.Geom.DVec3d,System.Nullable{System.Boolean}@,Hi.Common.Messages.IMessageHost)">
GetProgramXyzabc(NcEnv, DVec3d, out bool?, IMessageHost)
</h3>
@@ -2305,7 +2305,7 @@ So be care that do not change the NC XYZ if not needed.</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public DVec3d GetProgramXyzabc(NcEnv ncEnv, DVec3d mcXyzabc, out bool? isG68p2Successed, IMessageKit messageHost)</code></pre>
<pre><code class="lang-csharp hljs">public DVec3d GetProgramXyzabc(NcEnv ncEnv, DVec3d mcXyzabc, out bool? isG68p2Successed, IMessageHost messageHost)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -2319,7 +2319,7 @@ So be care that do not change the NC XYZ if not needed.</p>
<dt><code>isG68p2Successed</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>?</dt>
<dd><p>Output parameter indicating whether G68.2 coordinate conversion was successful.</p>
</dd>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>The message host for logging.</p>
</dd>
</dl>
@@ -2455,8 +2455,8 @@ So be care that do not change the NC XYZ if not needed.</p>
<a id="Hi_Numerical_NcLine_RebuildByMc_" data-uid="Hi.Numerical.NcLine.RebuildByMc*"></a>
<h3 id="Hi_Numerical_NcLine_RebuildByMc_Hi_Numerical_NcEnv_Hi_Geom_DVec3d_Hi_Numerical_NcNoteCache_Hi_Common_Messages_IMessageKit_" data-uid="Hi.Numerical.NcLine.RebuildByMc(Hi.Numerical.NcEnv,Hi.Geom.DVec3d,Hi.Numerical.NcNoteCache,Hi.Common.Messages.IMessageKit)">
RebuildByMc(NcEnv, DVec3d, NcNoteCache, IMessageKit)
<h3 id="Hi_Numerical_NcLine_RebuildByMc_Hi_Numerical_NcEnv_Hi_Geom_DVec3d_Hi_Numerical_NcNoteCache_Hi_Common_Messages_IMessageHost_" data-uid="Hi.Numerical.NcLine.RebuildByMc(Hi.Numerical.NcEnv,Hi.Geom.DVec3d,Hi.Numerical.NcNoteCache,Hi.Common.Messages.IMessageHost)">
RebuildByMc(NcEnv, DVec3d, NcNoteCache, IMessageHost)
</h3>
@@ -2465,7 +2465,7 @@ So be care that do not change the NC XYZ if not needed.</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void RebuildByMc(NcEnv ncEnv, DVec3d mc, NcNoteCache ncLineCache, IMessageKit messageHost)</code></pre>
<pre><code class="lang-csharp hljs">public void RebuildByMc(NcEnv ncEnv, DVec3d mc, NcNoteCache ncLineCache, IMessageHost messageHost)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -2479,7 +2479,7 @@ So be care that do not change the NC XYZ if not needed.</p>
<dt><code>ncLineCache</code> <a class="xref" href="Hi.Numerical.NcNoteCache.html">NcNoteCache</a></dt>
<dd><p>NC line cache.</p>
</dd>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>Message host for logging and reporting.</p>
</dd>
</dl>
@@ -2497,8 +2497,8 @@ So be care that do not change the NC XYZ if not needed.</p>
<a id="Hi_Numerical_NcLine_RebuildByProgramXyz_" data-uid="Hi.Numerical.NcLine.RebuildByProgramXyz*"></a>
<h3 id="Hi_Numerical_NcLine_RebuildByProgramXyz_Hi_Numerical_NcEnv_Hi_Geom_Vec3d_Hi_Numerical_NcNoteCache_Hi_Common_Messages_IMessageKit_" data-uid="Hi.Numerical.NcLine.RebuildByProgramXyz(Hi.Numerical.NcEnv,Hi.Geom.Vec3d,Hi.Numerical.NcNoteCache,Hi.Common.Messages.IMessageKit)">
RebuildByProgramXyz(NcEnv, Vec3d, NcNoteCache, IMessageKit)
<h3 id="Hi_Numerical_NcLine_RebuildByProgramXyz_Hi_Numerical_NcEnv_Hi_Geom_Vec3d_Hi_Numerical_NcNoteCache_Hi_Common_Messages_IMessageHost_" data-uid="Hi.Numerical.NcLine.RebuildByProgramXyz(Hi.Numerical.NcEnv,Hi.Geom.Vec3d,Hi.Numerical.NcNoteCache,Hi.Common.Messages.IMessageHost)">
RebuildByProgramXyz(NcEnv, Vec3d, NcNoteCache, IMessageHost)
</h3>
@@ -2507,7 +2507,7 @@ So be care that do not change the NC XYZ if not needed.</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void RebuildByProgramXyz(NcEnv ncEnv, Vec3d programXyz, NcNoteCache ncNoteCache, IMessageKit messageHost)</code></pre>
<pre><code class="lang-csharp hljs">public void RebuildByProgramXyz(NcEnv ncEnv, Vec3d programXyz, NcNoteCache ncNoteCache, IMessageHost messageHost)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -2521,7 +2521,7 @@ So be care that do not change the NC XYZ if not needed.</p>
<dt><code>ncNoteCache</code> <a class="xref" href="Hi.Numerical.NcNoteCache.html">NcNoteCache</a></dt>
<dd><p>NC note cache.</p>
</dd>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>Message host for logging and reporting.</p>
</dd>
</dl>
@@ -155,8 +155,8 @@ Class NcProc
<a id="Hi_Numerical_NcProc_GetActs_" data-uid="Hi.Numerical.NcProc.GetActs*"></a>
<h3 id="Hi_Numerical_NcProc_GetActs_Hi_Numerical_NcEnv_Hi_Common_SeqPair_Hi_Numerical_NcLine__Hi_Common_Messages_IMessageKit_" data-uid="Hi.Numerical.NcProc.GetActs(Hi.Numerical.NcEnv,Hi.Common.SeqPair{Hi.Numerical.NcLine},Hi.Common.Messages.IMessageKit)">
GetActs(NcEnv, SeqPair&lt;NcLine&gt;, IMessageKit)
<h3 id="Hi_Numerical_NcProc_GetActs_Hi_Numerical_NcEnv_Hi_Common_SeqPair_Hi_Numerical_NcLine__Hi_Common_Messages_IMessageHost_" data-uid="Hi.Numerical.NcProc.GetActs(Hi.Numerical.NcEnv,Hi.Common.SeqPair{Hi.Numerical.NcLine},Hi.Common.Messages.IMessageHost)">
GetActs(NcEnv, SeqPair&lt;NcLine&gt;, IMessageHost)
</h3>
@@ -165,7 +165,7 @@ Class NcProc
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;IAct&gt; GetActs(NcEnv ncEnv, SeqPair&lt;NcLine&gt; ncLineSeq, IMessageKit messageHost)</code></pre>
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;IAct&gt; GetActs(NcEnv ncEnv, SeqPair&lt;NcLine&gt; ncLineSeq, IMessageHost messageHost)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -176,7 +176,7 @@ Class NcProc
<dt><code>ncLineSeq</code> <a class="xref" href="Hi.Common.SeqPair-1.html">SeqPair</a>&lt;<a class="xref" href="Hi.Numerical.NcLine.html">NcLine</a>&gt;</dt>
<dd><p>The sequence pair of NcLines</p>
</dd>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>The message host for logging</p>
</dd>
</dl>
@@ -200,8 +200,8 @@ Class NcProc
<a id="Hi_Numerical_NcProc_GetActs_" data-uid="Hi.Numerical.NcProc.GetActs*"></a>
<h3 id="Hi_Numerical_NcProc_GetActs_Hi_Numerical_NcEnv_Hi_Numerical_NcLine_Hi_Numerical_NcLine_Hi_Common_Messages_IMessageKit_" data-uid="Hi.Numerical.NcProc.GetActs(Hi.Numerical.NcEnv,Hi.Numerical.NcLine,Hi.Numerical.NcLine,Hi.Common.Messages.IMessageKit)">
GetActs(NcEnv, NcLine, NcLine, IMessageKit)
<h3 id="Hi_Numerical_NcProc_GetActs_Hi_Numerical_NcEnv_Hi_Numerical_NcLine_Hi_Numerical_NcLine_Hi_Common_Messages_IMessageHost_" data-uid="Hi.Numerical.NcProc.GetActs(Hi.Numerical.NcEnv,Hi.Numerical.NcLine,Hi.Numerical.NcLine,Hi.Common.Messages.IMessageHost)">
GetActs(NcEnv, NcLine, NcLine, IMessageHost)
</h3>
@@ -210,7 +210,7 @@ Class NcProc
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;IAct&gt; GetActs(NcEnv ncEnv, NcLine preNcLine, NcLine curNcLine, IMessageKit messageHost)</code></pre>
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;IAct&gt; GetActs(NcEnv ncEnv, NcLine preNcLine, NcLine curNcLine, IMessageHost messageHost)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -224,7 +224,7 @@ Class NcProc
<dt><code>curNcLine</code> <a class="xref" href="Hi.Numerical.NcLine.html">NcLine</a></dt>
<dd><p>The current NcLine</p>
</dd>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>The message host for logging</p>
</dd>
</dl>
@@ -248,8 +248,8 @@ Class NcProc
<a id="Hi_Numerical_NcProc_GetActs_" data-uid="Hi.Numerical.NcProc.GetActs*"></a>
<h3 id="Hi_Numerical_NcProc_GetActs_Hi_Numerical_NcEnv_System_Collections_Generic_LinkedListNode_Hi_Numerical_NcLine__Hi_Common_Messages_IMessageKit_" data-uid="Hi.Numerical.NcProc.GetActs(Hi.Numerical.NcEnv,System.Collections.Generic.LinkedListNode{Hi.Numerical.NcLine},Hi.Common.Messages.IMessageKit)">
GetActs(NcEnv, LinkedListNode&lt;NcLine&gt;, IMessageKit)
<h3 id="Hi_Numerical_NcProc_GetActs_Hi_Numerical_NcEnv_System_Collections_Generic_LinkedListNode_Hi_Numerical_NcLine__Hi_Common_Messages_IMessageHost_" data-uid="Hi.Numerical.NcProc.GetActs(Hi.Numerical.NcEnv,System.Collections.Generic.LinkedListNode{Hi.Numerical.NcLine},Hi.Common.Messages.IMessageHost)">
GetActs(NcEnv, LinkedListNode&lt;NcLine&gt;, IMessageHost)
</h3>
@@ -258,7 +258,7 @@ Class NcProc
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;IAct&gt; GetActs(NcEnv ncEnv, LinkedListNode&lt;NcLine&gt; ncLineNode, IMessageKit messageHost)</code></pre>
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;IAct&gt; GetActs(NcEnv ncEnv, LinkedListNode&lt;NcLine&gt; ncLineNode, IMessageHost messageHost)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -269,7 +269,7 @@ Class NcProc
<dt><code>ncLineNode</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.linkedlistnode-1">LinkedListNode</a>&lt;<a class="xref" href="Hi.Numerical.NcLine.html">NcLine</a>&gt;</dt>
<dd><p>The linked list node containing the NcLine</p>
</dd>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>The message host for logging</p>
</dd>
</dl>
@@ -405,8 +405,8 @@ Program Pos can be Cartesian XYZ or Polar Coordinate Interpolation Mode (G12.1)
<a id="Hi_Numerical_RadiusCompensationBuf_ResolveRadiusCompensation_" data-uid="Hi.Numerical.RadiusCompensationBuf.ResolveRadiusCompensation*"></a>
<h3 id="Hi_Numerical_RadiusCompensationBuf_ResolveRadiusCompensation_System_Collections_Generic_LinkedListNode_Hi_Numerical_NcLine__Hi_Numerical_NcEnv_Hi_Numerical_NcNoteCache_Hi_Common_Messages_IMessageKit_" data-uid="Hi.Numerical.RadiusCompensationBuf.ResolveRadiusCompensation(System.Collections.Generic.LinkedListNode{Hi.Numerical.NcLine},Hi.Numerical.NcEnv,Hi.Numerical.NcNoteCache,Hi.Common.Messages.IMessageKit)">
ResolveRadiusCompensation(LinkedListNode&lt;NcLine&gt;, NcEnv, NcNoteCache, IMessageKit)
<h3 id="Hi_Numerical_RadiusCompensationBuf_ResolveRadiusCompensation_System_Collections_Generic_LinkedListNode_Hi_Numerical_NcLine__Hi_Numerical_NcEnv_Hi_Numerical_NcNoteCache_Hi_Common_Messages_IMessageHost_" data-uid="Hi.Numerical.RadiusCompensationBuf.ResolveRadiusCompensation(System.Collections.Generic.LinkedListNode{Hi.Numerical.NcLine},Hi.Numerical.NcEnv,Hi.Numerical.NcNoteCache,Hi.Common.Messages.IMessageHost)">
ResolveRadiusCompensation(LinkedListNode&lt;NcLine&gt;, NcEnv, NcNoteCache, IMessageHost)
</h3>
@@ -415,7 +415,7 @@ Program Pos can be Cartesian XYZ or Polar Coordinate Interpolation Mode (G12.1)
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool ResolveRadiusCompensation(LinkedListNode&lt;NcLine&gt; srcNode, NcEnv ncEnv, NcNoteCache ncLineCache, IMessageKit messageHost)</code></pre>
<pre><code class="lang-csharp hljs">public static bool ResolveRadiusCompensation(LinkedListNode&lt;NcLine&gt; srcNode, NcEnv ncEnv, NcNoteCache ncLineCache, IMessageHost messageHost)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -429,7 +429,7 @@ Program Pos can be Cartesian XYZ or Polar Coordinate Interpolation Mode (G12.1)
<dt><code>ncLineCache</code> <a class="xref" href="Hi.Numerical.NcNoteCache.html">NcNoteCache</a></dt>
<dd><p>The NC line cache for storing messages.</p>
</dd>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>The message host for reporting issues.</p>
</dd>
</dl>
@@ -199,7 +199,7 @@ Interface ICsScriptApi
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://github.com/dotnet/roslyn/blob/8edf7bcd4f1594c3d68a6a567469f41dbd33dd1b/src/Scripting/Core/ScriptOptions.cs">ScriptOptions</a></dt>
<dt><a class="xref" href="https://github.com/dotnet/roslyn/blob/6c4a46a31302167b425d5e0a31ea83c9a9aa1d09/src/Scripting/Core/ScriptOptions.cs">ScriptOptions</a></dt>
<dd></dd>
</dl>
+11 -5
View File
@@ -409,6 +409,9 @@
<li>
<a href="Hi.Common.Collections.SortedListUtil.SearchMethod.html" name="" title="SortedListUtil.SearchMethod">SortedListUtil.SearchMethod</a>
</li>
<li>
<a href="Hi.Common.Collections.SortedListUtil.SeekDirection.html" name="" title="SortedListUtil.SeekDirection">SortedListUtil.SeekDirection</a>
</li>
<li>
<a href="Hi.Common.Collections.SynList-1.html" name="" title="SynList&lt;T&gt;">SynList&lt;T&gt;</a>
</li>
@@ -503,7 +506,7 @@
<a href="Hi.Common.Messages.BootstrapTheme.html" name="" title="BootstrapTheme">BootstrapTheme</a>
</li>
<li>
<a href="Hi.Common.Messages.IMessageKit.html" name="" title="IMessageKit">IMessageKit</a>
<a href="Hi.Common.Messages.IMessageHost.html" name="" title="IMessageHost">IMessageHost</a>
</li>
<li>
<a href="Hi.Common.Messages.MessageBoardUtil.html" name="" title="MessageBoardUtil">MessageBoardUtil</a>
@@ -512,10 +515,10 @@
<a href="Hi.Common.Messages.MessageFlag.html" name="" title="MessageFlag">MessageFlag</a>
</li>
<li>
<a href="Hi.Common.Messages.MessageHostUtil.html" name="" title="MessageHostUtil">MessageHostUtil</a>
<a href="Hi.Common.Messages.MessageHost.html" name="" title="MessageHost">MessageHost</a>
</li>
<li>
<a href="Hi.Common.Messages.MessageKit.html" name="" title="MessageKit">MessageKit</a>
<a href="Hi.Common.Messages.MessageHostUtil.html" name="" title="MessageHostUtil">MessageHostUtil</a>
</li>
<li>
<a href="Hi.Common.Messages.MultiTagMessage.html" name="" title="MultiTagMessage">MultiTagMessage</a>
@@ -1038,7 +1041,7 @@
<a href="Hi.Geom.Solvers.BinarySolverUtil.html" name="" title="BinarySolverUtil">BinarySolverUtil</a>
</li>
<li>
<a href="Hi.Geom.Solvers.BinarySolvingStatus.html" name="" title="BinarySolvingStatus">BinarySolvingStatus</a>
<a href="Hi.Geom.Solvers.BinarySolvingEntry.html" name="" title="BinarySolvingEntry">BinarySolvingEntry</a>
</li>
<li>
<a href="Hi.Geom.Solvers.DeepSolvingStatus.html" name="" title="DeepSolvingStatus">DeepSolvingStatus</a>
@@ -1059,7 +1062,7 @@
<a href="Hi.Geom.Solvers.SolvingResult.html" name="" title="SolvingResult">SolvingResult</a>
</li>
<li>
<a href="Hi.Geom.Solvers.SolvingResultStatus.html" name="" title="SolvingResultStatus">SolvingResultStatus</a>
<a href="Hi.Geom.Solvers.SolvingStatus.html" name="" title="SolvingStatus">SolvingStatus</a>
</li>
<li>
<a href="Hi.Geom.Solvers.SolvingTerm.html" name="" title="SolvingTerm">SolvingTerm</a>
@@ -2614,6 +2617,9 @@
<a href="Hi.Numerical.FilePlayers.html" name="" title="Hi.Numerical.FilePlayers">Hi.Numerical.FilePlayers</a>
<ul class="nav level2">
<li>
<a href="Hi.Numerical.FilePlayers.CsvRunner.html" name="" title="CsvRunner">CsvRunner</a>
</li>
<li>
<a href="Hi.Numerical.FilePlayers.CsvRunnerConfig.html" name="" title="CsvRunnerConfig">CsvRunnerConfig</a>
</li>
File diff suppressed because one or more lines are too long