448 lines
14 KiB
HTML
448 lines
14 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Class NumericUtil | HiAPI-C# 2025 </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Class NumericUtil | HiAPI-C# 2025 ">
|
|
|
|
<meta name="description" content="Utility class for numeric operations and unit conversions.">
|
|
<link rel="icon" href="../img/HiAPI.favicon.ico">
|
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
|
<link rel="stylesheet" href="../public/main.css">
|
|
<meta name="docfx:navrel" content="../toc.html">
|
|
<meta name="docfx:tocrel" content="toc.html">
|
|
|
|
<meta name="docfx:rel" content="../">
|
|
|
|
|
|
|
|
<meta name="loc:inThisArticle" content="In this article">
|
|
<meta name="loc:searchResultsCount" content="{count} results for "{query}"">
|
|
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
|
<meta name="loc:tocFilter" content="Filter by title">
|
|
<meta name="loc:nextArticle" content="Next">
|
|
<meta name="loc:prevArticle" content="Previous">
|
|
<meta name="loc:themeLight" content="Light">
|
|
<meta name="loc:themeDark" content="Dark">
|
|
<meta name="loc:themeAuto" content="Auto">
|
|
<meta name="loc:changeTheme" content="Change theme">
|
|
<meta name="loc:copy" content="Copy">
|
|
<meta name="loc:downloadPdf" content="Download PDF">
|
|
|
|
<script type="module" src="./../public/docfx.min.js"></script>
|
|
|
|
<script>
|
|
const theme = localStorage.getItem('theme') || 'auto'
|
|
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
|
|
</script>
|
|
|
|
</head>
|
|
|
|
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
|
<header class="bg-body border-bottom">
|
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
|
<div class="container-xxl flex-nowrap">
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../img/HiAPI.logo.png" alt="">
|
|
|
|
</a>
|
|
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
|
|
<i class="bi bi-three-dots"></i>
|
|
</button>
|
|
<div class="collapse navbar-collapse" id="navpanel">
|
|
<div id="navbar">
|
|
<form class="search" role="search" id="search">
|
|
<i class="bi bi-search"></i>
|
|
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
</header>
|
|
|
|
<main class="container-xxl">
|
|
<div class="toc-offcanvas">
|
|
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
|
|
<div class="offcanvas-header">
|
|
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
|
|
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
|
|
</div>
|
|
<div class="offcanvas-body">
|
|
<nav class="toc" id="toc"></nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="content">
|
|
<div class="actionbar">
|
|
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
|
|
<i class="bi bi-list"></i>
|
|
</button>
|
|
|
|
<nav id="breadcrumb"></nav>
|
|
</div>
|
|
|
|
<article data-uid="Hi.Numerical.NumericUtil">
|
|
|
|
|
|
|
|
<h1 id="Hi_Numerical_NumericUtil" data-uid="Hi.Numerical.NumericUtil" class="text-break">
|
|
Class NumericUtil
|
|
</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></dd></dl>
|
|
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
|
|
</div>
|
|
|
|
<div class="markdown summary"><p>Utility class for numeric operations and unit conversions.</p>
|
|
</div>
|
|
<div class="markdown conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static class NumericUtil</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">NumericUtil</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="methods">Methods
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_Numerical_NumericUtil_GetFeedrate_mmdmin_" data-uid="Hi.Numerical.NumericUtil.GetFeedrate_mmdmin*"></a>
|
|
|
|
<h3 id="Hi_Numerical_NumericUtil_GetFeedrate_mmdmin_Hi_Numerical_IGetFeedrate_" data-uid="Hi.Numerical.NumericUtil.GetFeedrate_mmdmin(Hi.Numerical.IGetFeedrate)">
|
|
GetFeedrate_mmdmin(IGetFeedrate)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the feedrate in millimeters per minute.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static double GetFeedrate_mmdmin(this IGetFeedrate src)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>src</code> <a class="xref" href="Hi.Numerical.IGetFeedrate.html">IGetFeedrate</a></dt>
|
|
<dd><p>The feedrate source</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>Feedrate in mm/min</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Numerical_NumericUtil_GetSpindleCyclePeriod_" data-uid="Hi.Numerical.NumericUtil.GetSpindleCyclePeriod*"></a>
|
|
|
|
<h3 id="Hi_Numerical_NumericUtil_GetSpindleCyclePeriod_Hi_Numerical_IGetSpindleSpeed_" data-uid="Hi.Numerical.NumericUtil.GetSpindleCyclePeriod(Hi.Numerical.IGetSpindleSpeed)">
|
|
GetSpindleCyclePeriod(IGetSpindleSpeed)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the spindle cycle period as a TimeSpan.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static TimeSpan GetSpindleCyclePeriod(this IGetSpindleSpeed src)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>src</code> <a class="xref" href="Hi.Numerical.IGetSpindleSpeed.html">IGetSpindleSpeed</a></dt>
|
|
<dd><p>The spindle speed source</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.timespan">TimeSpan</a></dt>
|
|
<dd><p>Cycle period as a TimeSpan</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Numerical_NumericUtil_GetSpindleCyclePeriod_s_" data-uid="Hi.Numerical.NumericUtil.GetSpindleCyclePeriod_s*"></a>
|
|
|
|
<h3 id="Hi_Numerical_NumericUtil_GetSpindleCyclePeriod_s_Hi_Numerical_IGetSpindleSpeed_" data-uid="Hi.Numerical.NumericUtil.GetSpindleCyclePeriod_s(Hi.Numerical.IGetSpindleSpeed)">
|
|
GetSpindleCyclePeriod_s(IGetSpindleSpeed)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the spindle cycle period in seconds.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static double GetSpindleCyclePeriod_s(this IGetSpindleSpeed src)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>src</code> <a class="xref" href="Hi.Numerical.IGetSpindleSpeed.html">IGetSpindleSpeed</a></dt>
|
|
<dd><p>The spindle speed source</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>Cycle period in seconds</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Numerical_NumericUtil_GetSpindleSpeed_rpm_" data-uid="Hi.Numerical.NumericUtil.GetSpindleSpeed_rpm*"></a>
|
|
|
|
<h3 id="Hi_Numerical_NumericUtil_GetSpindleSpeed_rpm_Hi_Numerical_IGetSpindleSpeed_" data-uid="Hi.Numerical.NumericUtil.GetSpindleSpeed_rpm(Hi.Numerical.IGetSpindleSpeed)">
|
|
GetSpindleSpeed_rpm(IGetSpindleSpeed)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the spindle speed in revolutions per minute.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static double GetSpindleSpeed_rpm(this IGetSpindleSpeed src)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>src</code> <a class="xref" href="Hi.Numerical.IGetSpindleSpeed.html">IGetSpindleSpeed</a></dt>
|
|
<dd><p>The spindle speed source</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>Spindle speed in rpm</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Numerical_NumericUtil_IsRotating_" data-uid="Hi.Numerical.NumericUtil.IsRotating*"></a>
|
|
|
|
<h3 id="Hi_Numerical_NumericUtil_IsRotating_Hi_Numerical_SpindleDirection_" data-uid="Hi.Numerical.NumericUtil.IsRotating(Hi.Numerical.SpindleDirection)">
|
|
IsRotating(SpindleDirection)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Determines whether the spindle is rotating (either clockwise or counter-clockwise).</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool IsRotating(this SpindleDirection spindleDirection)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>spindleDirection</code> <a class="xref" href="Hi.Numerical.SpindleDirection.html">SpindleDirection</a></dt>
|
|
<dd><p>The spindle direction to check</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
|
<dd><p>True if the spindle is rotating; otherwise, false</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Numerical_NumericUtil_SetFeedrate_mmdmin_" data-uid="Hi.Numerical.NumericUtil.SetFeedrate_mmdmin*"></a>
|
|
|
|
<h3 id="Hi_Numerical_NumericUtil_SetFeedrate_mmdmin_Hi_Numerical_ISetFeedrate_System_Double_" data-uid="Hi.Numerical.NumericUtil.SetFeedrate_mmdmin(Hi.Numerical.ISetFeedrate,System.Double)">
|
|
SetFeedrate_mmdmin(ISetFeedrate, double)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Sets the feedrate in millimeters per minute.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void SetFeedrate_mmdmin(this ISetFeedrate src, double feedrate_mmdmin)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>src</code> <a class="xref" href="Hi.Numerical.ISetFeedrate.html">ISetFeedrate</a></dt>
|
|
<dd><p>The feedrate target</p>
|
|
</dd>
|
|
<dt><code>feedrate_mmdmin</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
|
<dd><p>Feedrate value in mm/min</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Numerical_NumericUtil_SetSpindleSpeed_rpm_" data-uid="Hi.Numerical.NumericUtil.SetSpindleSpeed_rpm*"></a>
|
|
|
|
<h3 id="Hi_Numerical_NumericUtil_SetSpindleSpeed_rpm_Hi_Numerical_ISetSpindleSpeed_System_Double_" data-uid="Hi.Numerical.NumericUtil.SetSpindleSpeed_rpm(Hi.Numerical.ISetSpindleSpeed,System.Double)">
|
|
SetSpindleSpeed_rpm(ISetSpindleSpeed, double)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Sets the spindle speed in revolutions per minute.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void SetSpindleSpeed_rpm(this ISetSpindleSpeed src, double spindleSpeed_rpm)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>src</code> <a class="xref" href="Hi.Numerical.ISetSpindleSpeed.html">ISetSpindleSpeed</a></dt>
|
|
<dd><p>The spindle speed target</p>
|
|
</dd>
|
|
<dt><code>spindleSpeed_rpm</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
|
<dd><p>Spindle speed value in rpm</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>
|