HiNC-Deploy/HiNC-2025-win-desktop-Deploy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.RuntimeApi.html
unknown 97aa5f3b30 tune
2025-08-30 15:31:33 +08:00

3489 lines
99 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class RuntimeApi | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class RuntimeApi | 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.MachiningProcs.RuntimeApi">
<h1 id="Hi_MachiningProcs_RuntimeApi" data-uid="Hi.MachiningProcs.RuntimeApi" class="text-break">
Class RuntimeApi
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.MachiningProcs.html">MachiningProcs</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class RuntimeApi : ICsScriptApi</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">RuntimeApi</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="Hi.ScriptApiUtils.ICsScriptApi.html">ICsScriptApi</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_MachiningProcs_RuntimeApi__ctor_" data-uid="Hi.MachiningProcs.RuntimeApi.#ctor*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi__ctor_Hi_MachiningProcs_IMachiningProjectGetter_" data-uid="Hi.MachiningProcs.RuntimeApi.#ctor(Hi.MachiningProcs.IMachiningProjectGetter)">
RuntimeApi(IMachiningProjectGetter)
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public RuntimeApi(IMachiningProjectGetter machiningProjectGetter)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>machiningProjectGetter</code> <a class="xref" href="Hi.MachiningProcs.IMachiningProjectGetter.html">IMachiningProjectGetter</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_MachiningProcs_RuntimeApi_DiffVisualRadius_mm_" data-uid="Hi.MachiningProcs.RuntimeApi.DiffVisualRadius_mm*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_DiffVisualRadius_mm" data-uid="Hi.MachiningProcs.RuntimeApi.DiffVisualRadius_mm">
DiffVisualRadius_mm
</h3>
<div class="markdown level1 summary"><p>Gets or sets the visual radius in millimeters for difference visualization.
Controls the radius used for highlighting differences between workpiece states.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public double DiffVisualRadius_mm { 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_MachiningProcs_RuntimeApi_DispCacheMb_" data-uid="Hi.MachiningProcs.RuntimeApi.DispCacheMb*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_DispCacheMb" data-uid="Hi.MachiningProcs.RuntimeApi.DispCacheMb">
DispCacheMb
</h3>
<div class="markdown level1 summary"><p>Gets or sets the display cache size in megabytes.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public long DispCacheMb { 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.int64">long</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_DispCache_Mb_" data-uid="Hi.MachiningProcs.RuntimeApi.DispCache_Mb*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_DispCache_Mb" data-uid="Hi.MachiningProcs.RuntimeApi.DispCache_Mb">
DispCache_Mb
</h3>
<div class="markdown level1 summary"><p>Gets or sets the display cache size in megabytes.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public long DispCache_Mb { 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.int64">long</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_EnableAutoMapOnSelectionEnd_" data-uid="Hi.MachiningProcs.RuntimeApi.EnableAutoMapOnSelectionEnd*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_EnableAutoMapOnSelectionEnd" data-uid="Hi.MachiningProcs.RuntimeApi.EnableAutoMapOnSelectionEnd">
EnableAutoMapOnSelectionEnd
</h3>
<div class="markdown level1 summary"><p>Gets or sets whether to automatically map selections when they end.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public bool EnableAutoMapOnSelectionEnd { 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_EnableCollisionDetection_" data-uid="Hi.MachiningProcs.RuntimeApi.EnableCollisionDetection*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_EnableCollisionDetection" data-uid="Hi.MachiningProcs.RuntimeApi.EnableCollisionDetection">
EnableCollisionDetection
</h3>
<div class="markdown level1 summary"><p>Gets or sets whether collision detection is enabled.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(DocContentHtml = &quot;Enable Collision Detection.&quot;)]
public bool EnableCollisionDetection { 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_EnablePauseOnCollision_" data-uid="Hi.MachiningProcs.RuntimeApi.EnablePauseOnCollision*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_EnablePauseOnCollision" data-uid="Hi.MachiningProcs.RuntimeApi.EnablePauseOnCollision">
EnablePauseOnCollision
</h3>
<div class="markdown level1 summary"><p>Obsoleted.</p>
<p>Gets or sets whether to pause execution when a collision is detected.
This property only has an effect if collision detection is enabled.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool EnablePauseOnCollision { 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_EnablePauseOnFailure_" data-uid="Hi.MachiningProcs.RuntimeApi.EnablePauseOnFailure*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_EnablePauseOnFailure" data-uid="Hi.MachiningProcs.RuntimeApi.EnablePauseOnFailure">
EnablePauseOnFailure
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(DocContentHtml = &quot;Enable Pause On Failure.&quot;)]
public bool EnablePauseOnFailure { 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_EnablePhysics_" data-uid="Hi.MachiningProcs.RuntimeApi.EnablePhysics*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_EnablePhysics" data-uid="Hi.MachiningProcs.RuntimeApi.EnablePhysics">
EnablePhysics
</h3>
<div class="markdown level1 summary"><p>Gets or sets whether milling force evaluation is enabled.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(DocContentHtml = &quot;Enable milling force evaluation.&quot;)]
public bool EnablePhysics { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_EnableWearEffect_" data-uid="Hi.MachiningProcs.RuntimeApi.EnableWearEffect*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_EnableWearEffect" data-uid="Hi.MachiningProcs.RuntimeApi.EnableWearEffect">
EnableWearEffect
</h3>
<div class="markdown level1 summary"><p>Gets or sets whether tool wear effects are enabled in simulation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public bool EnableWearEffect { 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_FeedPerCycle_" data-uid="Hi.MachiningProcs.RuntimeApi.FeedPerCycle*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_FeedPerCycle" data-uid="Hi.MachiningProcs.RuntimeApi.FeedPerCycle">
FeedPerCycle
</h3>
<div class="markdown level1 summary"><p>Gets a new feed per cycle machining motion resolution instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public FeedPerCycleMachiningMotionResolution FeedPerCycle { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Numerical.MachiningMotionResolutionUtils.FeedPerCycleMachiningMotionResolution.html">FeedPerCycleMachiningMotionResolution</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_FeedPerTooth_" data-uid="Hi.MachiningProcs.RuntimeApi.FeedPerTooth*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_FeedPerTooth" data-uid="Hi.MachiningProcs.RuntimeApi.FeedPerTooth">
FeedPerTooth
</h3>
<div class="markdown level1 summary"><p>Gets a new feed per tooth machining motion resolution instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public FeedPerToothMachiningMotionResolution FeedPerTooth { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothMachiningMotionResolution.html">FeedPerToothMachiningMotionResolution</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_Global_" data-uid="Hi.MachiningProcs.RuntimeApi.Global*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_Global" data-uid="Hi.MachiningProcs.RuntimeApi.Global">
Global
</h3>
<div class="markdown level1 summary"><p>Global variables.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;Global[$1key]&quot;)]
public Dictionary&lt;object, object&gt; Global { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.dictionary-2">Dictionary</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_InitSpindleTemperature_C_" data-uid="Hi.MachiningProcs.RuntimeApi.InitSpindleTemperature_C*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_InitSpindleTemperature_C" data-uid="Hi.MachiningProcs.RuntimeApi.InitSpindleTemperature_C">
InitSpindleTemperature_C
</h3>
<div class="markdown level1 summary"><p>Gets or sets the initial spindle temperature in degrees Celsius.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(DocContentHtml = &quot;Spindle Temperature on initialization.&quot;)]
public double InitSpindleTemperature_C { 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_MachiningProcs_RuntimeApi_JsAceCompletionProfileJsonArray_" data-uid="Hi.MachiningProcs.RuntimeApi.JsAceCompletionProfileJsonArray*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_JsAceCompletionProfileJsonArray" data-uid="Hi.MachiningProcs.RuntimeApi.JsAceCompletionProfileJsonArray">
JsAceCompletionProfileJsonArray
</h3>
<div class="markdown level1 summary"><p>Internal used.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static JsonArray JsAceCompletionProfileJsonArray { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.json.nodes.jsonarray">JsonArray</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_MachiningMotionResolution_" data-uid="Hi.MachiningProcs.RuntimeApi.MachiningMotionResolution*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_MachiningMotionResolution" data-uid="Hi.MachiningProcs.RuntimeApi.MachiningMotionResolution">
MachiningMotionResolution
</h3>
<div class="markdown level1 summary"><p>Gets or sets the machining motion resolution.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public IMachiningMotionResolution MachiningMotionResolution { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Numerical.MachiningMotionResolutionUtils.IMachiningMotionResolution.html">IMachiningMotionResolution</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_MachiningResolution_" data-uid="Hi.MachiningProcs.RuntimeApi.MachiningResolution*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_MachiningResolution" data-uid="Hi.MachiningProcs.RuntimeApi.MachiningResolution">
MachiningResolution
</h3>
<div class="markdown level1 summary"><p>Gets or sets the machining resolution in millimeters.
For legacy compatable.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
[Obsolete]
public double MachiningResolution { 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_MachiningProcs_RuntimeApi_MachiningResolution_mm_" data-uid="Hi.MachiningProcs.RuntimeApi.MachiningResolution_mm*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_MachiningResolution_mm" data-uid="Hi.MachiningProcs.RuntimeApi.MachiningResolution_mm">
MachiningResolution_mm
</h3>
<div class="markdown level1 summary"><p>Gets or sets the machining resolution in millimeters.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public double MachiningResolution_mm { 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_MachiningProcs_RuntimeApi_MachiningSession_" data-uid="Hi.MachiningProcs.RuntimeApi.MachiningSession*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_MachiningSession" data-uid="Hi.MachiningProcs.RuntimeApi.MachiningSession">
MachiningSession
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MachiningSession MachiningSession { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.MachiningProcs.MachiningSession.html">MachiningSession</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_MapTask_" data-uid="Hi.MachiningProcs.RuntimeApi.MapTask*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_MapTask" data-uid="Hi.MachiningProcs.RuntimeApi.MapTask">
MapTask
</h3>
<div class="markdown level1 summary"><p>Task tracking the status of mapping operations.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task MapTask { 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.threading.tasks.task">Task</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_MillingForceCycleDivisionNum_" data-uid="Hi.MachiningProcs.RuntimeApi.MillingForceCycleDivisionNum*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_MillingForceCycleDivisionNum" data-uid="Hi.MachiningProcs.RuntimeApi.MillingForceCycleDivisionNum">
MillingForceCycleDivisionNum
</h3>
<div class="markdown level1 summary"><p>Gets or sets the number of divisions per cycle for milling force calculation.
This property should be set before milling force evaluation if <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_TrainMillingPara_Hi_MillingForces_Fittings_SampleFlag_System_String_System_Double_">TrainMillingPara(SampleFlag, string, double)</a> is intended to be used.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public static int MillingForceCycleDivisionNum { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_NcOptOption_" data-uid="Hi.MachiningProcs.RuntimeApi.NcOptOption*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_NcOptOption" data-uid="Hi.MachiningProcs.RuntimeApi.NcOptOption">
NcOptOption
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public NcOptOption NcOptOption { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.NcOpt.NcOptOption.html">NcOptOption</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_OptEnableDepthCompensation_" data-uid="Hi.MachiningProcs.RuntimeApi.OptEnableDepthCompensation*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_OptEnableDepthCompensation" data-uid="Hi.MachiningProcs.RuntimeApi.OptEnableDepthCompensation">
OptEnableDepthCompensation
</h3>
<div class="markdown level1 summary"><p>Enables or disables depth compensation during optimization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public bool OptEnableDepthCompensation { 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_OptEnableFeedrate_" data-uid="Hi.MachiningProcs.RuntimeApi.OptEnableFeedrate*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_OptEnableFeedrate" data-uid="Hi.MachiningProcs.RuntimeApi.OptEnableFeedrate">
OptEnableFeedrate
</h3>
<div class="markdown level1 summary"><p>Gets or sets whether to enable feed rate optimization in NC optimization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public bool OptEnableFeedrate { 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">
OptEnableForwardCompensation
</h3>
<div class="markdown level1 summary"><p>Enables or disables forward compensation during optimization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public bool OptEnableForwardCompensation { 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_OptEnableInterpolation_" data-uid="Hi.MachiningProcs.RuntimeApi.OptEnableInterpolation*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_OptEnableInterpolation" data-uid="Hi.MachiningProcs.RuntimeApi.OptEnableInterpolation">
OptEnableInterpolation
</h3>
<div class="markdown level1 summary"><p>Enables or disables reinterpolation for optimization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public bool OptEnableInterpolation { 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">
OptEnableSideCompensation
</h3>
<div class="markdown level1 summary"><p>Enables or disables side compensation during optimization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public bool OptEnableSideCompensation { 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_OptExtendedPostDistance_mm_" data-uid="Hi.MachiningProcs.RuntimeApi.OptExtendedPostDistance_mm*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_OptExtendedPostDistance_mm" data-uid="Hi.MachiningProcs.RuntimeApi.OptExtendedPostDistance_mm">
OptExtendedPostDistance_mm
</h3>
<div class="markdown level1 summary"><p>Gets or sets the extended post-distance in millimeters for NC optimization.
This is the distance after the current segment that will be considered for optimization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public double OptExtendedPostDistance_mm { 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_MachiningProcs_RuntimeApi_OptExtendedPreDistance_mm_" data-uid="Hi.MachiningProcs.RuntimeApi.OptExtendedPreDistance_mm*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_OptExtendedPreDistance_mm" data-uid="Hi.MachiningProcs.RuntimeApi.OptExtendedPreDistance_mm">
OptExtendedPreDistance_mm
</h3>
<div class="markdown level1 summary"><p>Gets or sets the extended pre-distance in millimeters for NC optimization.
This is the distance before the current segment that will be considered for optimization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public double OptExtendedPreDistance_mm { 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_MachiningProcs_RuntimeApi_OptMaxAcceleration_mmds2_" data-uid="Hi.MachiningProcs.RuntimeApi.OptMaxAcceleration_mmds2*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_OptMaxAcceleration_mmds2" data-uid="Hi.MachiningProcs.RuntimeApi.OptMaxAcceleration_mmds2">
OptMaxAcceleration_mmds2
</h3>
<div class="markdown level1 summary"><p>Maximum acceleration in mm/s² during optimization. Only takes effect on reinterpolated section.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(DocContentHtml = &quot;Only take effect on reinterpolated section.&quot;)]
public double OptMaxAcceleration_mmds2 { 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_MachiningProcs_RuntimeApi_OptMaxFeedrate_mmdmin_" data-uid="Hi.MachiningProcs.RuntimeApi.OptMaxFeedrate_mmdmin*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_OptMaxFeedrate_mmdmin" data-uid="Hi.MachiningProcs.RuntimeApi.OptMaxFeedrate_mmdmin">
OptMaxFeedrate_mmdmin
</h3>
<div class="markdown level1 summary"><p>Maximum feed rate in mm/min for cutting movements during optimization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public double OptMaxFeedrate_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_MachiningProcs_RuntimeApi_OptMaxJerk_mmds3_" data-uid="Hi.MachiningProcs.RuntimeApi.OptMaxJerk_mmds3*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_OptMaxJerk_mmds3" data-uid="Hi.MachiningProcs.RuntimeApi.OptMaxJerk_mmds3">
OptMaxJerk_mmds3
</h3>
<div class="markdown level1 summary"><p>Maximum jerk in mm/s³ during optimization. Only takes effect on reinterpolated section.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(DocContentHtml = &quot;Only take effect on reinterpolated section.&quot;)]
public double OptMaxJerk_mmds3 { 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_MachiningProcs_RuntimeApi_OptMinFeedrate_mmdmin_" data-uid="Hi.MachiningProcs.RuntimeApi.OptMinFeedrate_mmdmin*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_OptMinFeedrate_mmdmin" data-uid="Hi.MachiningProcs.RuntimeApi.OptMinFeedrate_mmdmin">
OptMinFeedrate_mmdmin
</h3>
<div class="markdown level1 summary"><p>Minimum feed rate in mm/min for cutting movements during optimization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public double OptMinFeedrate_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_MachiningProcs_RuntimeApi_OptPreferedForce_N_" data-uid="Hi.MachiningProcs.RuntimeApi.OptPreferedForce_N*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_OptPreferedForce_N" data-uid="Hi.MachiningProcs.RuntimeApi.OptPreferedForce_N">
OptPreferedForce_N
</h3>
<div class="markdown level1 summary"><p>Preferred force in N for optimization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public double OptPreferedForce_N { 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_MachiningProcs_RuntimeApi_OptRapidFeed_mmdmin_" data-uid="Hi.MachiningProcs.RuntimeApi.OptRapidFeed_mmdmin*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_OptRapidFeed_mmdmin" data-uid="Hi.MachiningProcs.RuntimeApi.OptRapidFeed_mmdmin">
OptRapidFeed_mmdmin
</h3>
<div class="markdown level1 summary"><p>Rapid feed rate in mm/min for non-cutting movements during optimization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public double OptRapidFeed_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_MachiningProcs_RuntimeApi_OptSpindlePowerSafetyFactor_" data-uid="Hi.MachiningProcs.RuntimeApi.OptSpindlePowerSafetyFactor*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_OptSpindlePowerSafetyFactor" data-uid="Hi.MachiningProcs.RuntimeApi.OptSpindlePowerSafetyFactor">
OptSpindlePowerSafetyFactor
</h3>
<div class="markdown level1 summary"><p>Safety factor for spindle power during optimization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public double OptSpindlePowerSafetyFactor { 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_MachiningProcs_RuntimeApi_OptSpindleTorqueSafetyFactor_" data-uid="Hi.MachiningProcs.RuntimeApi.OptSpindleTorqueSafetyFactor*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_OptSpindleTorqueSafetyFactor" data-uid="Hi.MachiningProcs.RuntimeApi.OptSpindleTorqueSafetyFactor">
OptSpindleTorqueSafetyFactor
</h3>
<div class="markdown level1 summary"><p>Safety factor for spindle torque during optimization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public double OptSpindleTorqueSafetyFactor { 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_MachiningProcs_RuntimeApi_ParaTemplateDimension_" data-uid="Hi.MachiningProcs.RuntimeApi.ParaTemplateDimension*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_ParaTemplateDimension" data-uid="Hi.MachiningProcs.RuntimeApi.ParaTemplateDimension">
ParaTemplateDimension
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public int ParaTemplateDimension { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_ScriptOptions_" data-uid="Hi.MachiningProcs.RuntimeApi.ScriptOptions*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_ScriptOptions" data-uid="Hi.MachiningProcs.RuntimeApi.ScriptOptions">
ScriptOptions
</h3>
<div class="markdown level1 summary"><p>ScriptOptions.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ScriptOptions ScriptOptions { get; set; }</code></pre>
</div>
<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>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_SessionMessageHost_" data-uid="Hi.MachiningProcs.RuntimeApi.SessionMessageHost*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_SessionMessageHost" data-uid="Hi.MachiningProcs.RuntimeApi.SessionMessageHost">
SessionMessageHost
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public SessionMessageHost SessionMessageHost { get; }</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>
<a id="Hi_MachiningProcs_RuntimeApi_StepCount_" data-uid="Hi.MachiningProcs.RuntimeApi.StepCount*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_StepCount" data-uid="Hi.MachiningProcs.RuntimeApi.StepCount">
StepCount
</h3>
<div class="markdown level1 summary"><p>Gets the total number of milling steps.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public int StepCount { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_MachiningProcs_RuntimeApi_AddTimeDataByFile_" data-uid="Hi.MachiningProcs.RuntimeApi.AddTimeDataByFile*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_AddTimeDataByFile_System_String_System_String_System_Double_System_Double_" data-uid="Hi.MachiningProcs.RuntimeApi.AddTimeDataByFile(System.String,System.String,System.Double,System.Double)">
AddTimeDataByFile(string, string, double, double)
</h3>
<div class="markdown level1 summary"><p>Adds time-based data from a file to the time mapping dictionary with specified time bounds in seconds.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;AddTimeDataByFile($1key, $2relFile, $3beginTime, $4endTime)&quot;)]
public bool AddTimeDataByFile(string key, string relFile, double beginTime, double endTime)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>key</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Key to identify the data</p>
</dd>
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Relative path to the data file</p>
</dd>
<dt><code>beginTime</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>Beginning time in seconds</p>
</dd>
<dt><code>endTime</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>Ending time in seconds</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 data was successfully added, false otherwise</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_AddTimeDataByFile_" data-uid="Hi.MachiningProcs.RuntimeApi.AddTimeDataByFile*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_AddTimeDataByFile_System_String_System_String_System_String_System_String_" data-uid="Hi.MachiningProcs.RuntimeApi.AddTimeDataByFile(System.String,System.String,System.String,System.String)">
AddTimeDataByFile(string, string, string, string)
</h3>
<div class="markdown level1 summary"><p>Adds time-based data from a file to the time mapping dictionary with specified time bounds.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;AddTimeDataByFile($1key, $2relFile, $3beginTime, $4endTime)&quot;)]
public bool AddTimeDataByFile(string key, string relFile, string beginTimeText, string endTimeText)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>key</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Key to identify the data</p>
</dd>
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Relative path to the data file</p>
</dd>
<dt><code>beginTimeText</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Beginning time as text (seconds or TimeSpan format)</p>
</dd>
<dt><code>endTimeText</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Ending time as text (seconds or TimeSpan format)</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 data was successfully added, false otherwise</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_AppendMessagesToFile_" data-uid="Hi.MachiningProcs.RuntimeApi.AppendMessagesToFile*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_AppendMessagesToFile_System_String_System_String___" data-uid="Hi.MachiningProcs.RuntimeApi.AppendMessagesToFile(System.String,System.String[])">
AppendMessagesToFile(string, params string[])
</h3>
<div class="markdown level1 summary"><p>Appends messages to a file, optionally filtered by tags.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;AppendMessagesToFile(\&quot;dstRelFile\&quot;,flags)&quot;)]
public void AppendMessagesToFile(string dstRelFile, params string[] flags)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>dstRelFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Destination relative file path</p>
</dd>
<dt><code>flags</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>[]</dt>
<dd><p>Optional flags to filter messages by tags</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_BeginPreserve_" data-uid="Hi.MachiningProcs.RuntimeApi.BeginPreserve*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_BeginPreserve" data-uid="Hi.MachiningProcs.RuntimeApi.BeginPreserve">
BeginPreserve()
</h3>
<div class="markdown level1 summary"><p>Begin Preserve section in optimzation process.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;BeginPreserve()&quot;)]
public void BeginPreserve()</code></pre>
</div>
<a id="Hi_MachiningProcs_RuntimeApi_BeginSelection_" data-uid="Hi.MachiningProcs.RuntimeApi.BeginSelection*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_BeginSelection_System_String_Hi_Numerical_StepSelectionUtils_AnchorMode_Hi_Numerical_StepSelectionUtils_IStepShift_" data-uid="Hi.MachiningProcs.RuntimeApi.BeginSelection(System.String,Hi.Numerical.StepSelectionUtils.AnchorMode,Hi.Numerical.StepSelectionUtils.IStepShift)">
BeginSelection(string, AnchorMode, IStepShift)
</h3>
<div class="markdown level1 summary"><p>Begin mark on current line.
milling step() has not triggered yet.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void BeginSelection(string key, AnchorMode anchorMode = AnchorMode.LineBegin, IStepShift shift = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>key</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Identifier key for the selection</p>
</dd>
<dt><code>anchorMode</code> <a class="xref" href="Hi.Numerical.StepSelectionUtils.AnchorMode.html">AnchorMode</a></dt>
<dd><p>Mode for anchoring the beginning of selection</p>
</dd>
<dt><code>shift</code> <a class="xref" href="Hi.Numerical.StepSelectionUtils.IStepShift.html">IStepShift</a></dt>
<dd><p>Step shift to apply</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_BeginSession_" data-uid="Hi.MachiningProcs.RuntimeApi.BeginSession*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_BeginSession" data-uid="Hi.MachiningProcs.RuntimeApi.BeginSession">
BeginSession()
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void BeginSession()</code></pre>
</div>
<a id="Hi_MachiningProcs_RuntimeApi_ClearTimeMappingData_" data-uid="Hi.MachiningProcs.RuntimeApi.ClearTimeMappingData*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_ClearTimeMappingData" data-uid="Hi.MachiningProcs.RuntimeApi.ClearTimeMappingData">
ClearTimeMappingData()
</h3>
<div class="markdown level1 summary"><p>Clears all time mapping data.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public void ClearTimeMappingData()</code></pre>
</div>
<a id="Hi_MachiningProcs_RuntimeApi_Diff_" data-uid="Hi.MachiningProcs.RuntimeApi.Diff*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_Diff_System_Double_" data-uid="Hi.MachiningProcs.RuntimeApi.Diff(System.Double)">
Diff(double)
</h3>
<div class="markdown level1 summary"><p>Performs a difference analysis on the workpiece geometry to detect variations.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;Diff($1detectionRadius_mm)&quot;)]
public void Diff(double detectionRadius_mm)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>detectionRadius_mm</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>Radius for detecting differences</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_EndPreserve_" data-uid="Hi.MachiningProcs.RuntimeApi.EndPreserve*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_EndPreserve" data-uid="Hi.MachiningProcs.RuntimeApi.EndPreserve">
EndPreserve()
</h3>
<div class="markdown level1 summary"><p>End Preserve section in optimzation process.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;EndPreserve()&quot;)]
public void EndPreserve()</code></pre>
</div>
<a id="Hi_MachiningProcs_RuntimeApi_EndSelection_" data-uid="Hi.MachiningProcs.RuntimeApi.EndSelection*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_EndSelection_System_String_Hi_Numerical_StepSelectionUtils_AnchorMode_Hi_Numerical_StepSelectionUtils_IStepShift_" data-uid="Hi.MachiningProcs.RuntimeApi.EndSelection(System.String,Hi.Numerical.StepSelectionUtils.AnchorMode,Hi.Numerical.StepSelectionUtils.IStepShift)">
EndSelection(string, AnchorMode, IStepShift)
</h3>
<div class="markdown level1 summary"><p>End mark on current line for selection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void EndSelection(string key, AnchorMode anchorMode = AnchorMode.LineEnd, IStepShift shift = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>key</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Identifier key for the selection</p>
</dd>
<dt><code>anchorMode</code> <a class="xref" href="Hi.Numerical.StepSelectionUtils.AnchorMode.html">AnchorMode</a></dt>
<dd><p>Mode for anchoring the end of selection</p>
</dd>
<dt><code>shift</code> <a class="xref" href="Hi.Numerical.StepSelectionUtils.IStepShift.html">IStepShift</a></dt>
<dd><p>Step shift to apply</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_EndSession_" data-uid="Hi.MachiningProcs.RuntimeApi.EndSession*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_EndSession" data-uid="Hi.MachiningProcs.RuntimeApi.EndSession">
EndSession()
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void EndSession()</code></pre>
</div>
<a id="Hi_MachiningProcs_RuntimeApi_ErrorMessage_" data-uid="Hi.MachiningProcs.RuntimeApi.ErrorMessage*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_ErrorMessage_System_String_" data-uid="Hi.MachiningProcs.RuntimeApi.ErrorMessage(System.String)">
ErrorMessage(string)
</h3>
<div class="markdown level1 summary"><p>Displays an error message in the message host.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;ErrorMessage($1message)&quot;)]
public void ErrorMessage(string message)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>message</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The error message to display</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_FixedPace_" data-uid="Hi.MachiningProcs.RuntimeApi.FixedPace*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_FixedPace_System_Double_System_Double_" data-uid="Hi.MachiningProcs.RuntimeApi.FixedPace(System.Double,System.Double)">
FixedPace(double, double)
</h3>
<div class="markdown level1 summary"><p>Creates a fixed machining motion resolution with specified parameters.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;FixedPace($1linearResolution_mm, $2rotaryResolution_deg)&quot;)]
public FixedMachiningMotionResolution FixedPace(double linearResolution_mm, double rotaryResolution_deg)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>linearResolution_mm</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>Linear resolution in millimeters</p>
</dd>
<dt><code>rotaryResolution_deg</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>Rotary resolution in degrees</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Numerical.MachiningMotionResolutionUtils.FixedMachiningMotionResolution.html">FixedMachiningMotionResolution</a></dt>
<dd><p>A new fixed machining motion resolution instance</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_GetMillingStep_" data-uid="Hi.MachiningProcs.RuntimeApi.GetMillingStep*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_GetMillingStep_System_Int32_" data-uid="Hi.MachiningProcs.RuntimeApi.GetMillingStep(System.Int32)">
GetMillingStep(int)
</h3>
<div class="markdown level1 summary"><p>Retrieves a milling step at the specified index.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(Snippet = &quot;GetMillingStep($1\&quot;stepIndex\&quot;)&quot;)]
public MachiningStep GetMillingStep(int stepIndex)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>stepIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>Index of the milling step to retrieve</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a></dt>
<dd><p>The milling step at the specified index</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_GetStickMachiningToolObservationHeight_mm_" data-uid="Hi.MachiningProcs.RuntimeApi.GetStickMachiningToolObservationHeight_mm*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_GetStickMachiningToolObservationHeight_mm_System_Int32_" data-uid="Hi.MachiningProcs.RuntimeApi.GetStickMachiningToolObservationHeight_mm(System.Int32)">
GetStickMachiningToolObservationHeight_mm(int)
</h3>
<div class="markdown level1 summary"><p>Gets the observation height in millimeters for the specified stick machining tool.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;GetStickMachiningToolObservationHeight_mm($1toolId)&quot;)]
public double GetStickMachiningToolObservationHeight_mm(int toolId)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>toolId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The ID of the tool</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 observation height in millimeters</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_GetUniformContourTrayShiftAngle_deg_" data-uid="Hi.MachiningProcs.RuntimeApi.GetUniformContourTrayShiftAngle_deg*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_GetUniformContourTrayShiftAngle_deg_System_Int32_" data-uid="Hi.MachiningProcs.RuntimeApi.GetUniformContourTrayShiftAngle_deg(System.Int32)">
GetUniformContourTrayShiftAngle_deg(int)
</h3>
<div class="markdown level1 summary"><p>Gets the shift angle in degrees for the uniform contour tray of the specified tool.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;GetUniformContourTrayShiftAngle_deg($1toolId)&quot;)]
public double GetUniformContourTrayShiftAngle_deg(int toolId)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>toolId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The ID of the tool</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 shift angle in degrees</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_LineSelection_" data-uid="Hi.MachiningProcs.RuntimeApi.LineSelection*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_LineSelection_System_String_Hi_Numerical_StepSelectionUtils_AnchorMode_Hi_Numerical_StepSelectionUtils_IStepShift_Hi_Numerical_StepSelectionUtils_AnchorMode_Hi_Numerical_StepSelectionUtils_IStepShift_" data-uid="Hi.MachiningProcs.RuntimeApi.LineSelection(System.String,Hi.Numerical.StepSelectionUtils.AnchorMode,Hi.Numerical.StepSelectionUtils.IStepShift,Hi.Numerical.StepSelectionUtils.AnchorMode,Hi.Numerical.StepSelectionUtils.IStepShift)">
LineSelection(string, AnchorMode, IStepShift, AnchorMode, IStepShift)
</h3>
<div class="markdown level1 summary"><p>Create a line selection from begin to end mark.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void LineSelection(string key, AnchorMode beginAnchorMode = AnchorMode.LineBegin, IStepShift beginShift = null, AnchorMode endAnchorMode = AnchorMode.LineEnd, IStepShift endShift = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>key</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Identifier key for the selection</p>
</dd>
<dt><code>beginAnchorMode</code> <a class="xref" href="Hi.Numerical.StepSelectionUtils.AnchorMode.html">AnchorMode</a></dt>
<dd><p>Mode for anchoring the beginning of selection</p>
</dd>
<dt><code>beginShift</code> <a class="xref" href="Hi.Numerical.StepSelectionUtils.IStepShift.html">IStepShift</a></dt>
<dd><p>Step shift to apply at beginning</p>
</dd>
<dt><code>endAnchorMode</code> <a class="xref" href="Hi.Numerical.StepSelectionUtils.AnchorMode.html">AnchorMode</a></dt>
<dd><p>Mode for anchoring the end of selection</p>
</dd>
<dt><code>endShift</code> <a class="xref" href="Hi.Numerical.StepSelectionUtils.IStepShift.html">IStepShift</a></dt>
<dd><p>Step shift to apply at end</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_Map_" data-uid="Hi.MachiningProcs.RuntimeApi.Map*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_Map_System_String_Hi_Mappings_FileTimeSection_System_Nullable_Hi_Mapping_StepTimeShotUtil_CycleSamplingMode__" data-uid="Hi.MachiningProcs.RuntimeApi.Map(System.String,Hi.Mappings.FileTimeSection,System.Nullable{Hi.Mapping.StepTimeShotUtil.CycleSamplingMode})">
Map(string, FileTimeSection, CycleSamplingMode?)
</h3>
<div class="markdown level1 summary"><p>Maps selection data to time section.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task Map(string key, FileTimeSection fileTimeSection = null, StepTimeShotUtil.CycleSamplingMode? cycleSamplingMode = CycleSamplingMode.SpindleCycle)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>key</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Identifier key for the selection</p>
</dd>
<dt><code>fileTimeSection</code> <a class="xref" href="Hi.Mappings.FileTimeSection.html">FileTimeSection</a></dt>
<dd><p>File time section, or null to use the one associated with the key</p>
</dd>
<dt><code>cycleSamplingMode</code> <a class="xref" href="Hi.Mapping.StepTimeShotUtil.html">StepTimeShotUtil</a>.<a class="xref" href="Hi.Mapping.StepTimeShotUtil.CycleSamplingMode.html">CycleSamplingMode</a>?</dt>
<dd><p>Cycle sampling mode</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
<dd><p>Task representing the asynchronous mapping operation</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_Message_" data-uid="Hi.MachiningProcs.RuntimeApi.Message*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_Message_System_String_" data-uid="Hi.MachiningProcs.RuntimeApi.Message(System.String)">
Message(string)
</h3>
<div class="markdown level1 summary"><p>Displays a message in the message host.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;Message($1message)&quot;)]
public void Message(string message)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>message</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The message to display</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_OptimizeToFiles_" data-uid="Hi.MachiningProcs.RuntimeApi.OptimizeToFiles*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_OptimizeToFiles_System_String_" data-uid="Hi.MachiningProcs.RuntimeApi.OptimizeToFiles(System.String)">
OptimizeToFiles(string)
</h3>
<div class="markdown level1 summary"><p>Optimizes NC files and saves results using the specified file template.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(Snippet = &quot;OptimizeToFiles(\&quot;Output/Opt-[NcName]\&quot;)&quot;, DocContentHtml = &quot;Optimize To Files by substitude template keywoard \&quot;[NcName]\&quot;&quot;)]
public void OptimizeToFiles(string relFileTemplate = &quot;Output/Opt-[NcName]&quot;)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>relFileTemplate</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Template for output file path, can include [NcName] placeholder</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_Pace_" data-uid="Hi.MachiningProcs.RuntimeApi.Pace*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_Pace" data-uid="Hi.MachiningProcs.RuntimeApi.Pace">
Pace()
</h3>
<div class="markdown level1 summary"><p>Controls the pace of machining operations during execution.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;Pace();&quot;)]
public void Pace()</code></pre>
</div>
<a id="Hi_MachiningProcs_RuntimeApi_Pause_" data-uid="Hi.MachiningProcs.RuntimeApi.Pause*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_Pause" data-uid="Hi.MachiningProcs.RuntimeApi.Pause">
Pause()
</h3>
<div class="markdown level1 summary"><p>Pause Player</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(DocContentHtml = &quot;Pause Player&quot;)]
public void Pause()</code></pre>
</div>
<a id="Hi_MachiningProcs_RuntimeApi_PlayAct_" data-uid="Hi.MachiningProcs.RuntimeApi.PlayAct*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_PlayAct_Hi_Numerical_Acts_IAct_Hi_MachiningSteps_ISourceCommand_System_Nullable_System_Threading_CancellationToken__" data-uid="Hi.MachiningProcs.RuntimeApi.PlayAct(Hi.Numerical.Acts.IAct,Hi.MachiningSteps.ISourceCommand,System.Nullable{System.Threading.CancellationToken})">
PlayAct(IAct, ISourceCommand, CancellationToken?)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public void PlayAct(IAct act, ISourceCommand sourceCommand = null, CancellationToken? cancellationToken = null)</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>
<dt><code>sourceCommand</code> <a class="xref" href="Hi.MachiningSteps.ISourceCommand.html">ISourceCommand</a></dt>
<dd></dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a>?</dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_PlayClTeleport_" data-uid="Hi.MachiningProcs.RuntimeApi.PlayClTeleport*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_PlayClTeleport_System_Double_System_Double_System_Double_System_Double_System_Double_System_Double_" data-uid="Hi.MachiningProcs.RuntimeApi.PlayClTeleport(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)">
PlayClTeleport(double, double, double, double, double, double)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public void PlayClTeleport(double x, double y, double z, double i, double j, double k)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>x</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dt><code>y</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dt><code>z</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dt><code>i</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dt><code>j</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dt><code>k</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_PlayNc_" data-uid="Hi.MachiningProcs.RuntimeApi.PlayNc*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_PlayNc_System_String_System_String_" data-uid="Hi.MachiningProcs.RuntimeApi.PlayNc(System.String,System.String)">
PlayNc(string, string)
</h3>
<div class="markdown level1 summary"><p>Plays NC code directly from a string, executing each action and pacing between them.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(Snippet = &quot;PlayNc($1\&quot;ncCommand\&quot;,$2\&quot;\&quot;(Direct Command)\&quot;\&quot;);&quot;, DocContentHtml = &quot;Play NC. second parameter is the file name alternative shows in the log.&quot;)]
public void PlayNc(string ncText, string fileNameAlternative = &quot;--&quot;)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>ncText</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>NC code as a string</p>
</dd>
<dt><code>fileNameAlternative</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Alternative name to display in logs</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_PlayNcFile_" data-uid="Hi.MachiningProcs.RuntimeApi.PlayNcFile*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_PlayNcFile_System_String_" data-uid="Hi.MachiningProcs.RuntimeApi.PlayNcFile(System.String)">
PlayNcFile(string)
</h3>
<div class="markdown level1 summary"><p>Plays an NC file with the specified relative path.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;PlayNcFile($1\&quot;ncFile\&quot;);&quot;)]
public void PlayNcFile(string relNcFilePath)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>relNcFilePath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Relative path to the NC file</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_PlayToolingTeleport_" data-uid="Hi.MachiningProcs.RuntimeApi.PlayToolingTeleport*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_PlayToolingTeleport_System_Int32_" data-uid="Hi.MachiningProcs.RuntimeApi.PlayToolingTeleport(System.Int32)">
PlayToolingTeleport(int)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public void PlayToolingTeleport(int toolId)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>toolId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_Preserve_" data-uid="Hi.MachiningProcs.RuntimeApi.Preserve*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_Preserve" data-uid="Hi.MachiningProcs.RuntimeApi.Preserve">
Preserve()
</h3>
<div class="markdown level1 summary"><p>Preserve one line NC code in optimzation process.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;Preserve()&quot;)]
public void Preserve()</code></pre>
</div>
<a id="Hi_MachiningProcs_RuntimeApi_ProgressMessage_" data-uid="Hi.MachiningProcs.RuntimeApi.ProgressMessage*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_ProgressMessage_System_String_" data-uid="Hi.MachiningProcs.RuntimeApi.ProgressMessage(System.String)">
ProgressMessage(string)
</h3>
<div class="markdown level1 summary"><p>Displays a progress message in the message host.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;ProgressMessage($1message)&quot;)]
public void ProgressMessage(string message)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>message</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The progress message to display</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_ReTrainMillingPara_" data-uid="Hi.MachiningProcs.RuntimeApi.ReTrainMillingPara*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_ReTrainMillingPara_Hi_MillingForces_Fittings_SampleFlag_System_String_System_Double_" data-uid="Hi.MachiningProcs.RuntimeApi.ReTrainMillingPara(Hi.MillingForces.Fittings.SampleFlag,System.String,System.Double)">
ReTrainMillingPara(SampleFlag, string, double)
</h3>
<div class="markdown level1 summary"><p>Re-trains milling parameters using the specified sample flag.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;ReTrainMillingPara(Fx|Fy|Fz, $1dstFile)&quot;)]
public void ReTrainMillingPara(SampleFlag sampleFlag, string dstRelFile, double outlierRatio = 2)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>sampleFlag</code> <a class="xref" href="Hi.MillingForces.Fittings.SampleFlag.html">SampleFlag</a></dt>
<dd><p>Sample flag indicating which components to train</p>
</dd>
<dt><code>dstRelFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Destination relative file path</p>
</dd>
<dt><code>outlierRatio</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>Outlier ratio for data filtering</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_ReadCsvByTimeInterpolation_" data-uid="Hi.MachiningProcs.RuntimeApi.ReadCsvByTimeInterpolation*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_ReadCsvByTimeInterpolation_System_String_" data-uid="Hi.MachiningProcs.RuntimeApi.ReadCsvByTimeInterpolation(System.String)">
ReadCsvByTimeInterpolation(string)
</h3>
<div class="markdown level1 summary"><p>Reads a CSV file and performs time-based interpolation to map data to milling steps.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(Snippet = &quot;ReadCsvByTimeInterpolation($1\&quot;csvFile\&quot;)&quot;)]
public void ReadCsvByTimeInterpolation(string csvFile)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>csvFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Path to the CSV file relative to the base directory</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_ReadRuntimeGeom_" data-uid="Hi.MachiningProcs.RuntimeApi.ReadRuntimeGeom*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_ReadRuntimeGeom_System_String_" data-uid="Hi.MachiningProcs.RuntimeApi.ReadRuntimeGeom(System.String)">
ReadRuntimeGeom(string)
</h3>
<div class="markdown level1 summary"><p>Reads runtime geometry from a file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;ReadRuntimeGeom($1\&quot;srcFile\&quot;)&quot;)]
public void ReadRuntimeGeom(string relFile)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Relative path to the input file</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_RegisterStepVariable_" data-uid="Hi.MachiningProcs.RuntimeApi.RegisterStepVariable*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_RegisterStepVariable_System_String_System_String_System_String_System_String_System_Func_Hi_MachiningSteps_MachiningStep_System_Object__" data-uid="Hi.MachiningProcs.RuntimeApi.RegisterStepVariable(System.String,System.String,System.String,System.String,System.Func{Hi.MachiningSteps.MachiningStep,System.Object})">
RegisterStepVariable(string, string, string, string, Func&lt;MachiningStep, object&gt;)
</h3>
<div class="markdown level1 summary"><p>Registers a step variable for tracking during execution.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(Snippet = &quot;RegisterStepVariable(\&quot;$1key\&quot;,\&quot;$2name\&quot;,\&quot;$3unit\&quot;,\&quot;$4formatString\&quot;,\&quot;$5variableFunc\&quot;)&quot;, DocContentHtml = &quot;&lt;p&gt;Register Step Variable.&lt;/p&gt; &lt;p&gt;\&quot;unit\&quot; is nullable&lt;/p&gt; &lt;p&gt;\&quot;formatString\&quot; is nullable&lt;/p&gt;&quot;)]
public void RegisterStepVariable(string key, string name, string unit, string formatString, Func&lt;MachiningStep, object&gt; variableFunc = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>key</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Unique key to identify the variable</p>
</dd>
<dt><code>name</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Human-readable name of the variable</p>
</dd>
<dt><code>unit</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Physical unit of the variable (can be null)</p>
</dd>
<dt><code>formatString</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Format string for displaying the variable (can be null)</p>
</dd>
<dt><code>variableFunc</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a>&lt;<a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>&gt;</dt>
<dd><p>Function to compute the variable value from a milling step (can be null)</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_RemoveFlyPiece_" data-uid="Hi.MachiningProcs.RuntimeApi.RemoveFlyPiece*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_RemoveFlyPiece" data-uid="Hi.MachiningProcs.RuntimeApi.RemoveFlyPiece">
RemoveFlyPiece()
</h3>
<div class="markdown level1 summary"><p>Removes any disconnected or &ldquo;flying&rdquo; pieces from the workpiece geometry.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public void RemoveFlyPiece()</code></pre>
</div>
<a id="Hi_MachiningProcs_RuntimeApi_Reset_" data-uid="Hi.MachiningProcs.RuntimeApi.Reset*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_Reset" data-uid="Hi.MachiningProcs.RuntimeApi.Reset">
Reset()
</h3>
<div class="markdown level1 summary"><p>Reset Player</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(DocContentHtml = &quot;Reset Player&quot;)]
public void Reset()</code></pre>
</div>
<a id="Hi_MachiningProcs_RuntimeApi_ResetRuntime_" data-uid="Hi.MachiningProcs.RuntimeApi.ResetRuntime*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_ResetRuntime" data-uid="Hi.MachiningProcs.RuntimeApi.ResetRuntime">
ResetRuntime()
</h3>
<div class="markdown level1 summary"><p>Clears internal buffers.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public void ResetRuntime()</code></pre>
</div>
<a id="Hi_MachiningProcs_RuntimeApi_RunNc_" data-uid="Hi.MachiningProcs.RuntimeApi.RunNc*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_RunNc_System_String_System_String_" data-uid="Hi.MachiningProcs.RuntimeApi.RunNc(System.String,System.String)">
RunNc(string, string)
</h3>
<div class="markdown level1 summary"><p>Runs NC code directly from a string.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(Snippet = &quot;RunNc($1\&quot;ncCommand\&quot;,$2\&quot;\&quot;(Direct Command)\&quot;\&quot;);&quot;, DocContentHtml = &quot;Run NC. second parameter is the file name alternative shows in the log.&quot;)]
public IEnumerable&lt;Action&gt; RunNc(string ncText, string fileNameAlternative = &quot;--&quot;)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>ncText</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>NC code as a string</p>
</dd>
<dt><code>fileNameAlternative</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Alternative name to display in logs</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="https://learn.microsoft.com/dotnet/api/system.action">Action</a>&gt;</dt>
<dd><p>Enumerable sequence of actions to be executed</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_RunNcFile_" data-uid="Hi.MachiningProcs.RuntimeApi.RunNcFile*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_RunNcFile_System_String_" data-uid="Hi.MachiningProcs.RuntimeApi.RunNcFile(System.String)">
RunNcFile(string)
</h3>
<div class="markdown level1 summary"><p>Runs an NC file with the specified relative path.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;RunNcFile($1\&quot;ncFile\&quot;);&quot;)]
public IEnumerable&lt;Action&gt; RunNcFile(string relNcFilePath)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>relNcFilePath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Relative path to the NC file</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="https://learn.microsoft.com/dotnet/api/system.action">Action</a>&gt;</dt>
<dd><p>Enumerable sequence of actions to be executed</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_SetNcResolutionFeedPerCycle_" data-uid="Hi.MachiningProcs.RuntimeApi.SetNcResolutionFeedPerCycle*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_SetNcResolutionFeedPerCycle" data-uid="Hi.MachiningProcs.RuntimeApi.SetNcResolutionFeedPerCycle">
SetNcResolutionFeedPerCycle()
</h3>
<div class="markdown level1 summary"><p>Sets NC resolution to feed per cycle mode.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void SetNcResolutionFeedPerCycle()</code></pre>
</div>
<a id="Hi_MachiningProcs_RuntimeApi_SetNcResolutionFeedPerTooth_" data-uid="Hi.MachiningProcs.RuntimeApi.SetNcResolutionFeedPerTooth*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_SetNcResolutionFeedPerTooth" data-uid="Hi.MachiningProcs.RuntimeApi.SetNcResolutionFeedPerTooth">
SetNcResolutionFeedPerTooth()
</h3>
<div class="markdown level1 summary"><p>Sets NC resolution to feed per tooth mode.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void SetNcResolutionFeedPerTooth()</code></pre>
</div>
<a id="Hi_MachiningProcs_RuntimeApi_SetNcResolutionFixed_" data-uid="Hi.MachiningProcs.RuntimeApi.SetNcResolutionFixed*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_SetNcResolutionFixed_System_Double_System_Double_" data-uid="Hi.MachiningProcs.RuntimeApi.SetNcResolutionFixed(System.Double,System.Double)">
SetNcResolutionFixed(double, double)
</h3>
<div class="markdown level1 summary"><p>Sets NC resolution to fixed mode with specified resolution values.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void SetNcResolutionFixed(double linearResolution_mm, double rotaryResolution_deg)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>linearResolution_mm</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>Linear resolution in millimeters.</p>
</dd>
<dt><code>rotaryResolution_deg</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>Rotary resolution in degrees.</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_SetStickMachiningToolObservationHeight_mm_" data-uid="Hi.MachiningProcs.RuntimeApi.SetStickMachiningToolObservationHeight_mm*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_SetStickMachiningToolObservationHeight_mm_System_Int32_System_Double_" data-uid="Hi.MachiningProcs.RuntimeApi.SetStickMachiningToolObservationHeight_mm(System.Int32,System.Double)">
SetStickMachiningToolObservationHeight_mm(int, double)
</h3>
<div class="markdown level1 summary"><p>Sets the observation height in millimeters for the specified stick machining tool.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;SetStickMachiningToolObservationHeight_mm($1toolId,$2height_mm)&quot;)]
public void SetStickMachiningToolObservationHeight_mm(int toolId, double height)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>toolId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The ID of the tool</p>
</dd>
<dt><code>height</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>The observation height in millimeters to set</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_SetUniformContourTrayShiftAngle_deg_" data-uid="Hi.MachiningProcs.RuntimeApi.SetUniformContourTrayShiftAngle_deg*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_SetUniformContourTrayShiftAngle_deg_System_Int32_System_Double_" data-uid="Hi.MachiningProcs.RuntimeApi.SetUniformContourTrayShiftAngle_deg(System.Int32,System.Double)">
SetUniformContourTrayShiftAngle_deg(int, double)
</h3>
<div class="markdown level1 summary"><p>Sets the shift angle in degrees for the uniform contour tray of the specified tool.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;SetUniformContourTrayShiftAngle_deg($1toolId,$2angle_deg)&quot;)]
public void SetUniformContourTrayShiftAngle_deg(int toolId, double angle_deg)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>toolId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The ID of the tool</p>
</dd>
<dt><code>angle_deg</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>The shift angle in degrees to set</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_ShiftDistance_mm_" data-uid="Hi.MachiningProcs.RuntimeApi.ShiftDistance_mm*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_ShiftDistance_mm_System_Double_" data-uid="Hi.MachiningProcs.RuntimeApi.ShiftDistance_mm(System.Double)">
ShiftDistance_mm(double)
</h3>
<div class="markdown level1 summary"><p>Creates a distance shift object representing the specified distance in millimeters.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public DistanceShift ShiftDistance_mm(double distanceShift_mm)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>distanceShift_mm</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>Distance shift in millimeters</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Numerical.StepSelectionUtils.DistanceShift.html">DistanceShift</a></dt>
<dd><p>Distance shift object</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_ShiftTime_s_" data-uid="Hi.MachiningProcs.RuntimeApi.ShiftTime_s*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_ShiftTime_s_System_Double_" data-uid="Hi.MachiningProcs.RuntimeApi.ShiftTime_s(System.Double)">
ShiftTime_s(double)
</h3>
<div class="markdown level1 summary"><p>Creates a time shift object representing the specified time in seconds.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TimeShift ShiftTime_s(double seconds)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>seconds</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>Time in seconds</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Numerical.StepSelectionUtils.TimeShift.html">TimeShift</a></dt>
<dd><p>Time shift object</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_TrainMillingPara_" data-uid="Hi.MachiningProcs.RuntimeApi.TrainMillingPara*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_TrainMillingPara_Hi_MillingForces_Fittings_SampleFlag_System_String_System_Double_" data-uid="Hi.MachiningProcs.RuntimeApi.TrainMillingPara(Hi.MillingForces.Fittings.SampleFlag,System.String,System.Double)">
TrainMillingPara(SampleFlag, string, double)
</h3>
<div class="markdown level1 summary"><p>Trains milling parameters using the specified sample flag.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;TrainMillingPara(Fx|Fy|Fz, $1dstFile)&quot;)]
public void TrainMillingPara(SampleFlag sampleFlag, string dstRelFile, double outlierRatio = 2)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>sampleFlag</code> <a class="xref" href="Hi.MillingForces.Fittings.SampleFlag.html">SampleFlag</a></dt>
<dd><p>Sample flag indicating which components to train</p>
</dd>
<dt><code>dstRelFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Destination relative file path</p>
</dd>
<dt><code>outlierRatio</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>Outlier ratio for data filtering</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_WarningMessage_" data-uid="Hi.MachiningProcs.RuntimeApi.WarningMessage*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_WarningMessage_System_String_" data-uid="Hi.MachiningProcs.RuntimeApi.WarningMessage(System.String)">
WarningMessage(string)
</h3>
<div class="markdown level1 summary"><p>Displays a warning message in the message host.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;WarningMessage($1message)&quot;)]
public void WarningMessage(string message)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>message</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The warning message to display</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_WriteRuntimeGeom_" data-uid="Hi.MachiningProcs.RuntimeApi.WriteRuntimeGeom*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_WriteRuntimeGeom_System_String_" data-uid="Hi.MachiningProcs.RuntimeApi.WriteRuntimeGeom(System.String)">
WriteRuntimeGeom(string)
</h3>
<div class="markdown level1 summary"><p>Writes the current runtime geometry to a file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;WriteRuntimeGeom($1\&quot;dstFile\&quot;)&quot;)]
public void WriteRuntimeGeom(string relFile)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Relative path to the output file</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_WriteRuntimeGeomToStl_" data-uid="Hi.MachiningProcs.RuntimeApi.WriteRuntimeGeomToStl*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_WriteRuntimeGeomToStl_System_String_System_Double_" data-uid="Hi.MachiningProcs.RuntimeApi.WriteRuntimeGeomToStl(System.String,System.Double)">
WriteRuntimeGeomToStl(string, double)
</h3>
<div class="markdown level1 summary"><p>Writes the current runtime geometry to an STL file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;WriteRuntimeGeomToStl($1\&quot;dstFile\&quot;,$2resolution_mm)&quot;)]
public void WriteRuntimeGeomToStl(string relFile, double resolution_mm = 0)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Relative path to the output STL file</p>
</dd>
<dt><code>resolution_mm</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>Resolution in millimeters (0 for default)</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_WriteShotFiles_" data-uid="Hi.MachiningProcs.RuntimeApi.WriteShotFiles*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_WriteShotFiles_System_Double_System_String_" data-uid="Hi.MachiningProcs.RuntimeApi.WriteShotFiles(System.Double,System.String)">
WriteShotFiles(double, string)
</h3>
<div class="markdown level1 summary"><p>Writes time-series data to shot files with the specified resolution period (alternative parameter order).</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void WriteShotFiles(double resolutionPeroid_ms, string relFileTemplate)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>resolutionPeroid_ms</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>Resolution period in milliseconds</p>
</dd>
<dt><code>relFileTemplate</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Template for output file path, can include [NcName] placeholder</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_WriteShotFiles_" data-uid="Hi.MachiningProcs.RuntimeApi.WriteShotFiles*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_WriteShotFiles_System_String_System_Double_" data-uid="Hi.MachiningProcs.RuntimeApi.WriteShotFiles(System.String,System.Double)">
WriteShotFiles(string, double)
</h3>
<div class="markdown level1 summary"><p>Writes time-series data to shot files with the specified resolution period.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(Snippet = &quot;WriteShotFiles(\&quot;Output/[NcName].shot.csv\&quot;,resolutionPeroid_ms)&quot;, DocContentHtml = &quot;Write time series data by resolutionPeroid_ms&quot;)]
public void WriteShotFiles(string relFileTemplate = &quot;Output/[NcName].shot.csv&quot;, double resolutionPeroid_ms = 1)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>relFileTemplate</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Template for output file path, can include [NcName] placeholder</p>
</dd>
<dt><code>resolutionPeroid_ms</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>Resolution period in milliseconds</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_WriteStepFiles_" data-uid="Hi.MachiningProcs.RuntimeApi.WriteStepFiles*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_WriteStepFiles_System_String_" data-uid="Hi.MachiningProcs.RuntimeApi.WriteStepFiles(System.String)">
WriteStepFiles(string)
</h3>
<div class="markdown level1 summary"><p>Writes step-series data to files with the specified file template.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(Snippet = &quot;WriteStepFiles(\&quot;Output/[NcName].step.csv\&quot;)&quot;, DocContentHtml = &quot;Write step series data.&quot;)]
public void WriteStepFiles(string relFileTemplate = &quot;Output/[NcName].step.csv&quot;)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>relFileTemplate</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Template for output file path, can include [NcName] placeholder</p>
</dd>
</dl>
<h2 class="section" id="events">Events
</h2>
<h3 id="Hi_MachiningProcs_RuntimeApi_MachiningStepBuilt" data-uid="Hi.MachiningProcs.RuntimeApi.MachiningStepBuilt">
MachiningStepBuilt
</h3>
<div class="markdown level1 summary"><p>Gets or sets the action to configure steps during execution.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(Snippet = &quot;MachiningStepBuilt+=($1preStep,$2curStep)=&gt;{$3Command};&quot;, DocContentHtml = &quot;Runtime Step Configuration action. preStep is the Previous Milling Step; curStep is the Current Milling Step. preStep is null if no previous step existed.&quot;)]
public event MachiningActRunner.MachiningStepBuiltDelegate MachiningStepBuilt</code></pre>
</div>
<h4 class="section">Event Type</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.MachiningProcs.MachiningActRunner.html">MachiningActRunner</a>.<a class="xref" href="Hi.MachiningProcs.MachiningActRunner.MachiningStepBuiltDelegate.html">MachiningStepBuiltDelegate</a></dt>
<dd></dd>
</dl>
<h3 id="Hi_MachiningProcs_RuntimeApi_MachiningStepSelected" data-uid="Hi.MachiningProcs.RuntimeApi.MachiningStepSelected">
MachiningStepSelected
</h3>
<div class="markdown level1 summary"><p>Event that is triggered when a milling step is selected.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(Snippet = &quot;MachiningStepSelected+=($1millingStep)=&gt;{$2Command};&quot;)]
public event Action&lt;MachiningStep&gt; MachiningStepSelected</code></pre>
</div>
<h4 class="section">Event Type</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;<a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a>&gt;</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>
Reference in New Issue View Git Blame Copy Permalink