HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.NcStepUtils.NcStepUtil.html
2025-07-18 15:38:28 +08:00

747 lines
19 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class NcStepUtil | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class NcStepUtil | HiAPI-C# 2025 ">
<meta name="description" content="Provides utility functions and constants for NC step operations.">
<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.NcStepUtils.NcStepUtil">
<h1 id="Hi_NcStepUtils_NcStepUtil" data-uid="Hi.NcStepUtils.NcStepUtil" class="text-break">
Class NcStepUtil
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcStepUtils.html">NcStepUtils</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>Provides utility functions and constants for NC step operations.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static class NcStepUtil</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">NcStepUtil</span></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
</dd></dl>
<h2 class="section" id="fields">Fields
</h2>
<h3 id="Hi_NcStepUtils_NcStepUtil_Tag__ActualFeedrate_mmdmin" data-uid="Hi.NcStepUtils.NcStepUtil.Tag__ActualFeedrate_mmdmin">
Tag__ActualFeedrate_mmdmin
</h3>
<div class="markdown level1 summary"><p>Tag for actual feedrate in millimeters per minute.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string Tag__ActualFeedrate_mmdmin = &quot;ActualFeedrate_mmdmin&quot;</code></pre>
</div>
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h3 id="Hi_NcStepUtils_NcStepUtil_Tag__ActualSpindleSpeed_rpm" data-uid="Hi.NcStepUtils.NcStepUtil.Tag__ActualSpindleSpeed_rpm">
Tag__ActualSpindleSpeed_rpm
</h3>
<div class="markdown level1 summary"><p>Tag for actual spindle speed in revolutions per minute.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string Tag__ActualSpindleSpeed_rpm = &quot;ActualSpindleSpeed_rpm&quot;</code></pre>
</div>
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h3 id="Hi_NcStepUtils_NcStepUtil_Tag__Cl_A" data-uid="Hi.NcStepUtils.NcStepUtil.Tag__Cl_A">
Tag__Cl_A
</h3>
<div class="markdown level1 summary"><p>Tag for A-axis rotation of cutter location.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string Tag__Cl_A = &quot;CL.A&quot;</code></pre>
</div>
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h3 id="Hi_NcStepUtils_NcStepUtil_Tag__Cl_B" data-uid="Hi.NcStepUtils.NcStepUtil.Tag__Cl_B">
Tag__Cl_B
</h3>
<div class="markdown level1 summary"><p>Tag for B-axis rotation of cutter location.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string Tag__Cl_B = &quot;CL.B&quot;</code></pre>
</div>
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h3 id="Hi_NcStepUtils_NcStepUtil_Tag__Cl_C" data-uid="Hi.NcStepUtils.NcStepUtil.Tag__Cl_C">
Tag__Cl_C
</h3>
<div class="markdown level1 summary"><p>Tag for C-axis rotation of cutter location.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string Tag__Cl_C = &quot;CL.C&quot;</code></pre>
</div>
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h3 id="Hi_NcStepUtils_NcStepUtil_Tag__Cl_X" data-uid="Hi.NcStepUtils.NcStepUtil.Tag__Cl_X">
Tag__Cl_X
</h3>
<div class="markdown level1 summary"><p>Tag for X coordinate of cutter location.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string Tag__Cl_X = &quot;CL.X&quot;</code></pre>
</div>
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h3 id="Hi_NcStepUtils_NcStepUtil_Tag__Cl_Y" data-uid="Hi.NcStepUtils.NcStepUtil.Tag__Cl_Y">
Tag__Cl_Y
</h3>
<div class="markdown level1 summary"><p>Tag for Y coordinate of cutter location.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string Tag__Cl_Y = &quot;CL.Y&quot;</code></pre>
</div>
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h3 id="Hi_NcStepUtils_NcStepUtil_Tag__Cl_Z" data-uid="Hi.NcStepUtils.NcStepUtil.Tag__Cl_Z">
Tag__Cl_Z
</h3>
<div class="markdown level1 summary"><p>Tag for Z coordinate of cutter location.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string Tag__Cl_Z = &quot;CL.Z&quot;</code></pre>
</div>
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h3 id="Hi_NcStepUtils_NcStepUtil_Tag__CodeFeedrate_mmdmin" data-uid="Hi.NcStepUtils.NcStepUtil.Tag__CodeFeedrate_mmdmin">
Tag__CodeFeedrate_mmdmin
</h3>
<div class="markdown level1 summary"><p>Tag for programmed feedrate in millimeters per minute.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string Tag__CodeFeedrate_mmdmin = &quot;CodeFeedrate_mmdmin&quot;</code></pre>
</div>
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h3 id="Hi_NcStepUtils_NcStepUtil_Tag__CodeSpindleSpeed_rpm" data-uid="Hi.NcStepUtils.NcStepUtil.Tag__CodeSpindleSpeed_rpm">
Tag__CodeSpindleSpeed_rpm
</h3>
<div class="markdown level1 summary"><p>Tag for programmed spindle speed in revolutions per minute.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string Tag__CodeSpindleSpeed_rpm = &quot;CodeSpindleSpeed_rpm&quot;</code></pre>
</div>
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h3 id="Hi_NcStepUtils_NcStepUtil_Tag__CyclePeriod_s" data-uid="Hi.NcStepUtils.NcStepUtil.Tag__CyclePeriod_s">
Tag__CyclePeriod_s
</h3>
<div class="markdown level1 summary"><p>Tag for cycle period in seconds.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string Tag__CyclePeriod_s = &quot;CyclePeriod_s&quot;</code></pre>
</div>
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h3 id="Hi_NcStepUtils_NcStepUtil_Tag__Feedrate_mmdmin" data-uid="Hi.NcStepUtils.NcStepUtil.Tag__Feedrate_mmdmin">
Tag__Feedrate_mmdmin
</h3>
<div class="markdown level1 summary"><p>Tag for feedrate in millimeters per minute.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string Tag__Feedrate_mmdmin = &quot;Feedrate_mmdmin&quot;</code></pre>
</div>
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h3 id="Hi_NcStepUtils_NcStepUtil_Tag__SpindleSpeed_rpm" data-uid="Hi.NcStepUtils.NcStepUtil.Tag__SpindleSpeed_rpm">
Tag__SpindleSpeed_rpm
</h3>
<div class="markdown level1 summary"><p>Tag for spindle speed in revolutions per minute.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string Tag__SpindleSpeed_rpm = &quot;SpindleSpeed_rpm&quot;</code></pre>
</div>
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_NcStepUtils_NcStepUtil_GetFeedPerCycle_mm_" data-uid="Hi.NcStepUtils.NcStepUtil.GetFeedPerCycle_mm*"></a>
<h3 id="Hi_NcStepUtils_NcStepUtil_GetFeedPerCycle_mm_Hi_NcStepUtils_INcStep0_" data-uid="Hi.NcStepUtils.NcStepUtil.GetFeedPerCycle_mm(Hi.NcStepUtils.INcStep0)">
GetFeedPerCycle_mm(INcStep0)
</h3>
<div class="markdown level1 summary"><p>Gets the feed per cycle in millimeters.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static double GetFeedPerCycle_mm(this INcStep0 step)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>step</code> <a class="xref" href="Hi.NcStepUtils.INcStep0.html">INcStep0</a></dt>
<dd><p>The NC step.</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>Feed per cycle in millimeters.</p>
</dd>
</dl>
<a id="Hi_NcStepUtils_NcStepUtil_GetGeneralCsvDictionary_" data-uid="Hi.NcStepUtils.NcStepUtil.GetGeneralCsvDictionary*"></a>
<h3 id="Hi_NcStepUtils_NcStepUtil_GetGeneralCsvDictionary_Hi_NcStepUtils_INcStep0_" data-uid="Hi.NcStepUtils.NcStepUtil.GetGeneralCsvDictionary(Hi.NcStepUtils.INcStep0)">
GetGeneralCsvDictionary(INcStep0)
</h3>
<div class="markdown level1 summary"><p>Gets a general CSV dictionary containing step information.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Dictionary&lt;string, string&gt; GetGeneralCsvDictionary(this INcStep0 step)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>step</code> <a class="xref" href="Hi.NcStepUtils.INcStep0.html">INcStep0</a></dt>
<dd><p>The NC step.</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.dictionary-2">Dictionary</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd><p>Dictionary with step information in CSV format.</p>
</dd>
</dl>
<a id="Hi_NcStepUtils_NcStepUtil_GetGeneralQuantityByKey_" data-uid="Hi.NcStepUtils.NcStepUtil.GetGeneralQuantityByKey*"></a>
<h3 id="Hi_NcStepUtils_NcStepUtil_GetGeneralQuantityByKey_Hi_NcStepUtils_INcStep0_System_String_" data-uid="Hi.NcStepUtils.NcStepUtil.GetGeneralQuantityByKey(Hi.NcStepUtils.INcStep0,System.String)">
GetGeneralQuantityByKey(INcStep0, string)
</h3>
<div class="markdown level1 summary"><p>Gets a general quantity value by key from the step.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static double GetGeneralQuantityByKey(this INcStep0 step, string key)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>step</code> <a class="xref" href="Hi.NcStepUtils.INcStep0.html">INcStep0</a></dt>
<dd><p>The NC step.</p>
</dd>
<dt><code>key</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The key to look up.</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 quantity value associated with the key.</p>
</dd>
</dl>
<a id="Hi_NcStepUtils_NcStepUtil_GetMcXyzabc_" data-uid="Hi.NcStepUtils.NcStepUtil.GetMcXyzabc*"></a>
<h3 id="Hi_NcStepUtils_NcStepUtil_GetMcXyzabc_Hi_NcStepUtils_INcStep0_" data-uid="Hi.NcStepUtils.NcStepUtil.GetMcXyzabc(Hi.NcStepUtils.INcStep0)">
GetMcXyzabc(INcStep0)
</h3>
<div class="markdown level1 summary"><p>Gets the machine XYZABC coordinates.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static DVec3d GetMcXyzabc(this INcStep0 step)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>step</code> <a class="xref" href="Hi.NcStepUtils.INcStep0.html">INcStep0</a></dt>
<dd><p>The NC step.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Geom.DVec3d.html">DVec3d</a></dt>
<dd><p>Machine XYZABC coordinates as a DVec3d.</p>
</dd>
</dl>
</article>
<div class="contribution d-print-none">
</div>
</div>
<div class="affix">
<nav id="affix"></nav>
</div>
</main>
<div class="container-xxl search-results" id="search-results"></div>
<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
<span> Copyright © 2025 <a href='https://superhightech.com.tw'>Tech Coordinate</a>. All rights reserved. <a href='https://superhightech.com.tw'>超級高科技股份有限公司</a> © 2025 版權所有 </span>
</div>
</div>
</footer>
</body>
</html>