HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActStateRunner.html
2025-11-05 02:26:02 +08:00

664 lines
19 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class ActStateRunner | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class ActStateRunner | HiAPI-C# 2025 ">
<meta name="description" content="Manages the state of numerical control operations during runtime.">
<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.Acts.ActStateRunner">
<h1 id="Hi_Numerical_Acts_ActStateRunner" data-uid="Hi.Numerical.Acts.ActStateRunner" class="text-break">
Class ActStateRunner
</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.Acts.html">Acts</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>Manages the state of numerical control operations during runtime.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class ActStateRunner</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">ActStateRunner</span></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
</dd></dl>
<dl class="typelist extensionMethods">
<dt>Extension Methods</dt>
<dd>
<div>
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate&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="properties">Properties
</h2>
<a id="Hi_Numerical_Acts_ActStateRunner_ActualTime_" data-uid="Hi.Numerical.Acts.ActStateRunner.ActualTime*"></a>
<h3 id="Hi_Numerical_Acts_ActStateRunner_ActualTime" data-uid="Hi.Numerical.Acts.ActStateRunner.ActualTime">
ActualTime
</h3>
<div class="markdown level1 summary"><p>Actual accumulated worked time.
Actual Program time.
null if not set.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TimeSpan? ActualTime { 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.timespan">TimeSpan</a>?</dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_Acts_ActStateRunner_Data_" data-uid="Hi.Numerical.Acts.ActStateRunner.Data*"></a>
<h3 id="Hi_Numerical_Acts_ActStateRunner_Data" data-uid="Hi.Numerical.Acts.ActStateRunner.Data">
Data
</h3>
<div class="markdown level1 summary"><p>State external data.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Dictionary&lt;string, object&gt; Data { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.dictionary-2">Dictionary</a>&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.object">object</a>&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_Acts_ActStateRunner_Feedrate_mmdmin_" data-uid="Hi.Numerical.Acts.ActStateRunner.Feedrate_mmdmin*"></a>
<h3 id="Hi_Numerical_Acts_ActStateRunner_Feedrate_mmdmin" data-uid="Hi.Numerical.Acts.ActStateRunner.Feedrate_mmdmin">
Feedrate_mmdmin
</h3>
<div class="markdown level1 summary"><p>Last processing Feedrate in mm/min.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double Feedrate_mmdmin { 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.double">double</a></dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_Acts_ActStateRunner_Feedrate_mmds_" data-uid="Hi.Numerical.Acts.ActStateRunner.Feedrate_mmds*"></a>
<h3 id="Hi_Numerical_Acts_ActStateRunner_Feedrate_mmds" data-uid="Hi.Numerical.Acts.ActStateRunner.Feedrate_mmds">
Feedrate_mmds
</h3>
<div class="markdown level1 summary"><p>Last processing Feedrate in mm/sec.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double Feedrate_mmds { 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.double">double</a></dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_Acts_ActStateRunner_IsCoolantOn_" data-uid="Hi.Numerical.Acts.ActStateRunner.IsCoolantOn*"></a>
<h3 id="Hi_Numerical_Acts_ActStateRunner_IsCoolantOn" data-uid="Hi.Numerical.Acts.ActStateRunner.IsCoolantOn">
IsCoolantOn
</h3>
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether the coolant is turned on.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsCoolantOn { 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_Numerical_Acts_ActStateRunner_ProgramTime_" data-uid="Hi.Numerical.Acts.ActStateRunner.ProgramTime*"></a>
<h3 id="Hi_Numerical_Acts_ActStateRunner_ProgramTime" data-uid="Hi.Numerical.Acts.ActStateRunner.ProgramTime">
ProgramTime
</h3>
<div class="markdown level1 summary"><p>Ideal accumulated worked time by simulation.
Ideal Program time.
The value includes last action duration.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TimeSpan ProgramTime { 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.timespan">TimeSpan</a></dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_Acts_ActStateRunner_SpindleAngle_deg_" data-uid="Hi.Numerical.Acts.ActStateRunner.SpindleAngle_deg*"></a>
<h3 id="Hi_Numerical_Acts_ActStateRunner_SpindleAngle_deg" data-uid="Hi.Numerical.Acts.ActStateRunner.SpindleAngle_deg">
SpindleAngle_deg
</h3>
<div class="markdown level1 summary"><p>Spindle rotation angle in degrees.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double SpindleAngle_deg { 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.double">double</a></dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_Acts_ActStateRunner_SpindleAngle_rad_" data-uid="Hi.Numerical.Acts.ActStateRunner.SpindleAngle_rad*"></a>
<h3 id="Hi_Numerical_Acts_ActStateRunner_SpindleAngle_rad" data-uid="Hi.Numerical.Acts.ActStateRunner.SpindleAngle_rad">
SpindleAngle_rad
</h3>
<div class="markdown level1 summary"><p>Spindle rotation angle in radians.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double SpindleAngle_rad { 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.double">double</a></dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_Acts_ActStateRunner_SpindleDirection_" data-uid="Hi.Numerical.Acts.ActStateRunner.SpindleDirection*"></a>
<h3 id="Hi_Numerical_Acts_ActStateRunner_SpindleDirection" data-uid="Hi.Numerical.Acts.ActStateRunner.SpindleDirection">
SpindleDirection
</h3>
<div class="markdown level1 summary"><p>Gets or sets the spindle rotation direction.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SpindleDirection SpindleDirection { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Numerical.SpindleDirection.html">SpindleDirection</a></dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_Acts_ActStateRunner_SpindleSpeed_radds_" data-uid="Hi.Numerical.Acts.ActStateRunner.SpindleSpeed_radds*"></a>
<h3 id="Hi_Numerical_Acts_ActStateRunner_SpindleSpeed_radds" data-uid="Hi.Numerical.Acts.ActStateRunner.SpindleSpeed_radds">
SpindleSpeed_radds
</h3>
<div class="markdown level1 summary"><p>Gets or sets the spindle speed in radians per second.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double SpindleSpeed_radds { 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.double">double</a></dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_Acts_ActStateRunner_SpindleSpeed_rpm_" data-uid="Hi.Numerical.Acts.ActStateRunner.SpindleSpeed_rpm*"></a>
<h3 id="Hi_Numerical_Acts_ActStateRunner_SpindleSpeed_rpm" data-uid="Hi.Numerical.Acts.ActStateRunner.SpindleSpeed_rpm">
SpindleSpeed_rpm
</h3>
<div class="markdown level1 summary"><p>Gets or 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 double SpindleSpeed_rpm { 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.double">double</a></dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_Acts_ActStateRunner_ToolId_" data-uid="Hi.Numerical.Acts.ActStateRunner.ToolId*"></a>
<h3 id="Hi_Numerical_Acts_ActStateRunner_ToolId" data-uid="Hi.Numerical.Acts.ActStateRunner.ToolId">
ToolId
</h3>
<div class="markdown level1 summary"><p>Gets or sets the current tool identifier.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int ToolId { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_Numerical_Acts_ActStateRunner_ProcAct_" data-uid="Hi.Numerical.Acts.ActStateRunner.ProcAct*"></a>
<h3 id="Hi_Numerical_Acts_ActStateRunner_ProcAct_Hi_Numerical_Acts_IAct_" data-uid="Hi.Numerical.Acts.ActStateRunner.ProcAct(Hi.Numerical.Acts.IAct)">
ProcAct(IAct)
</h3>
<div class="markdown level1 summary"><p>filter the same effect action and run the effective action.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IAct ProcAct(IAct act)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>act</code> <a class="xref" href="Hi.Numerical.Acts.IAct.html">IAct</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Numerical.Acts.IAct.html">IAct</a></dt>
<dd><p>null if the input <code class="paramref">act</code> is the same effect action.
otherwise, return <code class="paramref">act</code>.</p>
</dd>
</dl>
<a id="Hi_Numerical_Acts_ActStateRunner_ResetState_" data-uid="Hi.Numerical.Acts.ActStateRunner.ResetState*"></a>
<h3 id="Hi_Numerical_Acts_ActStateRunner_ResetState" data-uid="Hi.Numerical.Acts.ActStateRunner.ResetState">
ResetState()
</h3>
<div class="markdown level1 summary"><p>Resets all state values to their defaults.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void ResetState()</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>