3202 lines
92 KiB
HTML
3202 lines
92 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Class ShellApi | HiAPI-C# 2025 </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Class ShellApi | HiAPI-C# 2025 ">
|
|
|
|
<meta name="description" content="Provides a C# scripting API for controlling and manipulating the milling course. Allows for runtime control of milling operations, geometry manipulation, and data analysis.">
|
|
<link rel="icon" href="../img/HiAPI.favicon.ico">
|
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
|
<link rel="stylesheet" href="../public/main.css">
|
|
<meta name="docfx:navrel" content="../toc.html">
|
|
<meta name="docfx:tocrel" content="toc.html">
|
|
|
|
<meta name="docfx:rel" content="../">
|
|
|
|
|
|
|
|
<meta name="loc:inThisArticle" content="In this article">
|
|
<meta name="loc:searchResultsCount" content="{count} results for "{query}"">
|
|
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
|
<meta name="loc:tocFilter" content="Filter by title">
|
|
<meta name="loc:nextArticle" content="Next">
|
|
<meta name="loc:prevArticle" content="Previous">
|
|
<meta name="loc:themeLight" content="Light">
|
|
<meta name="loc:themeDark" content="Dark">
|
|
<meta name="loc:themeAuto" content="Auto">
|
|
<meta name="loc:changeTheme" content="Change theme">
|
|
<meta name="loc:copy" content="Copy">
|
|
<meta name="loc:downloadPdf" content="Download PDF">
|
|
|
|
<script type="module" src="./../public/docfx.min.js"></script>
|
|
|
|
<script>
|
|
const theme = localStorage.getItem('theme') || 'auto'
|
|
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
|
|
</script>
|
|
|
|
</head>
|
|
|
|
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
|
<header class="bg-body border-bottom">
|
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
|
<div class="container-xxl flex-nowrap">
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../img/HiAPI.logo.png" alt="">
|
|
|
|
</a>
|
|
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
|
|
<i class="bi bi-three-dots"></i>
|
|
</button>
|
|
<div class="collapse navbar-collapse" id="navpanel">
|
|
<div id="navbar">
|
|
<form class="search" role="search" id="search">
|
|
<i class="bi bi-search"></i>
|
|
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
</header>
|
|
|
|
<main class="container-xxl">
|
|
<div class="toc-offcanvas">
|
|
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
|
|
<div class="offcanvas-header">
|
|
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
|
|
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
|
|
</div>
|
|
<div class="offcanvas-body">
|
|
<nav class="toc" id="toc"></nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="content">
|
|
<div class="actionbar">
|
|
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
|
|
<i class="bi bi-list"></i>
|
|
</button>
|
|
|
|
<nav id="breadcrumb"></nav>
|
|
</div>
|
|
|
|
<article data-uid="Hi.MachiningProcs.ShellApi">
|
|
|
|
|
|
|
|
<h1 id="Hi_MachiningProcs_ShellApi" data-uid="Hi.MachiningProcs.ShellApi" class="text-break">
|
|
Class ShellApi
|
|
</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"><p>Provides a C# scripting API for controlling and manipulating the milling course.
|
|
Allows for runtime control of milling operations, geometry manipulation, and data analysis.</p>
|
|
</div>
|
|
<div class="markdown conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class ShellApi : 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">ShellApi</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<TSelf>(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<TSrc>(TSrc, Action<TSrc>)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)</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_ShellApi__ctor_" data-uid="Hi.MachiningProcs.ShellApi.#ctor*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi__ctor_Hi_MachiningProcs_MachiningProject_" data-uid="Hi.MachiningProcs.ShellApi.#ctor(Hi.MachiningProcs.MachiningProject)">
|
|
ShellApi(MachiningProject)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.MachiningProcs.ShellApi.html">ShellApi</a> class.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ShellApi(MachiningProject machiningProject)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>machiningProject</code> <a class="xref" href="Hi.MachiningProcs.MachiningProject.html">MachiningProject</a></dt>
|
|
<dd><p>The milling course this API will interact with</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="properties">Properties
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_MachiningProcs_ShellApi_DiffVisualRadius_mm_" data-uid="Hi.MachiningProcs.ShellApi.DiffVisualRadius_mm*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_DiffVisualRadius_mm" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_DispCacheMb_" data-uid="Hi.MachiningProcs.ShellApi.DispCacheMb*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_DispCacheMb" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_DispCache_Mb_" data-uid="Hi.MachiningProcs.ShellApi.DispCache_Mb*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_DispCache_Mb" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_EnableAutoMapOnSelectionEnd_" data-uid="Hi.MachiningProcs.ShellApi.EnableAutoMapOnSelectionEnd*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_EnableAutoMapOnSelectionEnd" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_EnableCollisionDetection_" data-uid="Hi.MachiningProcs.ShellApi.EnableCollisionDetection*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_EnableCollisionDetection" data-uid="Hi.MachiningProcs.ShellApi.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 = "Enable Collision Detection.")]
|
|
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_ShellApi_EnableMillingForceEvaluation_" data-uid="Hi.MachiningProcs.ShellApi.EnableMillingForceEvaluation*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_EnableMillingForceEvaluation" data-uid="Hi.MachiningProcs.ShellApi.EnableMillingForceEvaluation">
|
|
EnableMillingForceEvaluation
|
|
|
|
</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 = "Enable Milling Force Evaluation.")]
|
|
public bool EnableMillingForceEvaluation { 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_ShellApi_EnablePauseOnCollision_" data-uid="Hi.MachiningProcs.ShellApi.EnablePauseOnCollision*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_EnablePauseOnCollision" data-uid="Hi.MachiningProcs.ShellApi.EnablePauseOnCollision">
|
|
EnablePauseOnCollision
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><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">[JsAce(DocContentHtml = "Enable Pause On Collision. This property works only if Collision Detection is enabled.")]
|
|
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_ShellApi_EnableWearEffect_" data-uid="Hi.MachiningProcs.ShellApi.EnableWearEffect*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_EnableWearEffect" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_FeedPerCycle_" data-uid="Hi.MachiningProcs.ShellApi.FeedPerCycle*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_FeedPerCycle" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_FeedPerTooth_" data-uid="Hi.MachiningProcs.ShellApi.FeedPerTooth*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_FeedPerTooth" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_Global_" data-uid="Hi.MachiningProcs.ShellApi.Global*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_Global" data-uid="Hi.MachiningProcs.ShellApi.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("Global[$1key]")]
|
|
public Dictionary<object, object> 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><<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>></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_ShellApi_InitSpindleTemperature_C_" data-uid="Hi.MachiningProcs.ShellApi.InitSpindleTemperature_C*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_InitSpindleTemperature_C" data-uid="Hi.MachiningProcs.ShellApi.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 = "Spindle Temperature on initialization.")]
|
|
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_ShellApi_JsAceCompletionProfileJsonArray_" data-uid="Hi.MachiningProcs.ShellApi.JsAceCompletionProfileJsonArray*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_JsAceCompletionProfileJsonArray" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_MachiningMotionResolution_" data-uid="Hi.MachiningProcs.ShellApi.MachiningMotionResolution*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_MachiningMotionResolution" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_MachiningResolution_" data-uid="Hi.MachiningProcs.ShellApi.MachiningResolution*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_MachiningResolution" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_MachiningResolution_mm_" data-uid="Hi.MachiningProcs.ShellApi.MachiningResolution_mm*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_MachiningResolution_mm" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_MachiningSession_" data-uid="Hi.MachiningProcs.ShellApi.MachiningSession*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_MachiningSession" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_MapTask_" data-uid="Hi.MachiningProcs.ShellApi.MapTask*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_MapTask" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_MillingForceCycleDivisionNum_" data-uid="Hi.MachiningProcs.ShellApi.MillingForceCycleDivisionNum*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_MillingForceCycleDivisionNum" data-uid="Hi.MachiningProcs.ShellApi.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.ShellApi.html#Hi_MachiningProcs_ShellApi_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_ShellApi_OptEnableDepthCompensation_" data-uid="Hi.MachiningProcs.ShellApi.OptEnableDepthCompensation*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_OptEnableDepthCompensation" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_OptEnableFeedrate_" data-uid="Hi.MachiningProcs.ShellApi.OptEnableFeedrate*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_OptEnableFeedrate" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_OptEnableForwardCompensation_" data-uid="Hi.MachiningProcs.ShellApi.OptEnableForwardCompensation*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_OptEnableForwardCompensation" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_OptEnableInterpolation_" data-uid="Hi.MachiningProcs.ShellApi.OptEnableInterpolation*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_OptEnableInterpolation" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_OptEnableSideCompensation_" data-uid="Hi.MachiningProcs.ShellApi.OptEnableSideCompensation*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_OptEnableSideCompensation" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_OptExtendedPostDistance_mm_" data-uid="Hi.MachiningProcs.ShellApi.OptExtendedPostDistance_mm*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_OptExtendedPostDistance_mm" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_OptExtendedPreDistance_mm_" data-uid="Hi.MachiningProcs.ShellApi.OptExtendedPreDistance_mm*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_OptExtendedPreDistance_mm" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_OptMaxAcceleration_mmds2_" data-uid="Hi.MachiningProcs.ShellApi.OptMaxAcceleration_mmds2*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_OptMaxAcceleration_mmds2" data-uid="Hi.MachiningProcs.ShellApi.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 = "Only take effect on reinterpolated section.")]
|
|
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_ShellApi_OptMaxFeedrate_mmdmin_" data-uid="Hi.MachiningProcs.ShellApi.OptMaxFeedrate_mmdmin*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_OptMaxFeedrate_mmdmin" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_OptMaxJerk_mmds3_" data-uid="Hi.MachiningProcs.ShellApi.OptMaxJerk_mmds3*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_OptMaxJerk_mmds3" data-uid="Hi.MachiningProcs.ShellApi.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 = "Only take effect on reinterpolated section.")]
|
|
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_ShellApi_OptMinFeedrate_mmdmin_" data-uid="Hi.MachiningProcs.ShellApi.OptMinFeedrate_mmdmin*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_OptMinFeedrate_mmdmin" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_OptPreferedForce_N_" data-uid="Hi.MachiningProcs.ShellApi.OptPreferedForce_N*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_OptPreferedForce_N" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_OptRapidFeed_mmdmin_" data-uid="Hi.MachiningProcs.ShellApi.OptRapidFeed_mmdmin*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_OptRapidFeed_mmdmin" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_OptSpindlePowerSafetyFactor_" data-uid="Hi.MachiningProcs.ShellApi.OptSpindlePowerSafetyFactor*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_OptSpindlePowerSafetyFactor" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_OptSpindleTorqueSafetyFactor_" data-uid="Hi.MachiningProcs.ShellApi.OptSpindleTorqueSafetyFactor*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_OptSpindleTorqueSafetyFactor" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_ScriptOptions_" data-uid="Hi.MachiningProcs.ShellApi.ScriptOptions*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_ScriptOptions" data-uid="Hi.MachiningProcs.ShellApi.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/75e79dace86b274327a1afe479228d82a06051a4/src/Scripting/Core/ScriptOptions.cs">ScriptOptions</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_ShellApi_StepCount_" data-uid="Hi.MachiningProcs.ShellApi.StepCount*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_StepCount" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_AddTimeDataByFile_" data-uid="Hi.MachiningProcs.ShellApi.AddTimeDataByFile*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_AddTimeDataByFile_System_String_System_String_System_Double_System_Double_" data-uid="Hi.MachiningProcs.ShellApi.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("AddTimeDataByFile($1key, $2relFile, $3beginTime, $4endTime)")]
|
|
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_ShellApi_AddTimeDataByFile_" data-uid="Hi.MachiningProcs.ShellApi.AddTimeDataByFile*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_AddTimeDataByFile_System_String_System_String_System_String_System_String_" data-uid="Hi.MachiningProcs.ShellApi.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("AddTimeDataByFile($1key, $2relFile, $3beginTime, $4endTime)")]
|
|
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_ShellApi_AppendMessagesToFile_" data-uid="Hi.MachiningProcs.ShellApi.AppendMessagesToFile*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_AppendMessagesToFile_System_String_System_String___" data-uid="Hi.MachiningProcs.ShellApi.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("AppendMessagesToFile(\"dstRelFile\",flags)")]
|
|
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_ShellApi_BeginPreserve_" data-uid="Hi.MachiningProcs.ShellApi.BeginPreserve*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_BeginPreserve" data-uid="Hi.MachiningProcs.ShellApi.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("BeginPreserve()")]
|
|
public void BeginPreserve()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_ShellApi_BeginSelection_" data-uid="Hi.MachiningProcs.ShellApi.BeginSelection*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_BeginSelection_System_String_Hi_Numerical_StepSelectionUtils_BoundAnchorMode_Hi_Numerical_StepSelectionUtils_IStepShift_" data-uid="Hi.MachiningProcs.ShellApi.BeginSelection(System.String,Hi.Numerical.StepSelectionUtils.BoundAnchorMode,Hi.Numerical.StepSelectionUtils.IStepShift)">
|
|
BeginSelection(string, BoundAnchorMode, 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, BoundAnchorMode anchorMode = BoundAnchorMode.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.BoundAnchorMode.html">BoundAnchorMode</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_ShellApi_ClearTimeMappingData_" data-uid="Hi.MachiningProcs.ShellApi.ClearTimeMappingData*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_ClearTimeMappingData" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_Diff_" data-uid="Hi.MachiningProcs.ShellApi.Diff*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_Diff_System_Double_" data-uid="Hi.MachiningProcs.ShellApi.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("Diff($1detectionRadius_mm)")]
|
|
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_ShellApi_EndPreserve_" data-uid="Hi.MachiningProcs.ShellApi.EndPreserve*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_EndPreserve" data-uid="Hi.MachiningProcs.ShellApi.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("EndPreserve()")]
|
|
public void EndPreserve()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_ShellApi_EndSelection_" data-uid="Hi.MachiningProcs.ShellApi.EndSelection*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_EndSelection_System_String_Hi_Numerical_StepSelectionUtils_BoundAnchorMode_Hi_Numerical_StepSelectionUtils_IStepShift_" data-uid="Hi.MachiningProcs.ShellApi.EndSelection(System.String,Hi.Numerical.StepSelectionUtils.BoundAnchorMode,Hi.Numerical.StepSelectionUtils.IStepShift)">
|
|
EndSelection(string, BoundAnchorMode, 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, BoundAnchorMode anchorMode = BoundAnchorMode.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.BoundAnchorMode.html">BoundAnchorMode</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_ShellApi_ErrorMessage_" data-uid="Hi.MachiningProcs.ShellApi.ErrorMessage*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_ErrorMessage_System_String_" data-uid="Hi.MachiningProcs.ShellApi.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("ErrorMessage($1message)")]
|
|
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_ShellApi_FixedPace_" data-uid="Hi.MachiningProcs.ShellApi.FixedPace*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_FixedPace_System_Double_System_Double_" data-uid="Hi.MachiningProcs.ShellApi.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("FixedPace($1linearResolution_mm, $2rotaryResolution_deg)")]
|
|
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_ShellApi_GetMillingStep_" data-uid="Hi.MachiningProcs.ShellApi.GetMillingStep*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_GetMillingStep_System_Int32_" data-uid="Hi.MachiningProcs.ShellApi.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 = "GetMillingStep($1\"stepIndex\")")]
|
|
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.MillingSteps.MachiningStep.html">MachiningStep</a></dt>
|
|
<dd><p>The milling step at the specified index</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_ShellApi_GetStickMachiningToolObservationHeight_mm_" data-uid="Hi.MachiningProcs.ShellApi.GetStickMachiningToolObservationHeight_mm*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_GetStickMachiningToolObservationHeight_mm_System_Int32_" data-uid="Hi.MachiningProcs.ShellApi.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("GetStickMachiningToolObservationHeight_mm($1toolId)")]
|
|
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_ShellApi_GetUniformContourTrayShiftAngle_deg_" data-uid="Hi.MachiningProcs.ShellApi.GetUniformContourTrayShiftAngle_deg*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_GetUniformContourTrayShiftAngle_deg_System_Int32_" data-uid="Hi.MachiningProcs.ShellApi.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("GetUniformContourTrayShiftAngle_deg($1toolId)")]
|
|
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_ShellApi_LineSelection_" data-uid="Hi.MachiningProcs.ShellApi.LineSelection*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_LineSelection_System_String_Hi_Numerical_StepSelectionUtils_BoundAnchorMode_Hi_Numerical_StepSelectionUtils_IStepShift_Hi_Numerical_StepSelectionUtils_BoundAnchorMode_Hi_Numerical_StepSelectionUtils_IStepShift_" data-uid="Hi.MachiningProcs.ShellApi.LineSelection(System.String,Hi.Numerical.StepSelectionUtils.BoundAnchorMode,Hi.Numerical.StepSelectionUtils.IStepShift,Hi.Numerical.StepSelectionUtils.BoundAnchorMode,Hi.Numerical.StepSelectionUtils.IStepShift)">
|
|
LineSelection(string, BoundAnchorMode, IStepShift, BoundAnchorMode, 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, BoundAnchorMode beginAnchorMode = BoundAnchorMode.LineBegin, IStepShift beginShift = null, BoundAnchorMode endAnchorMode = BoundAnchorMode.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.BoundAnchorMode.html">BoundAnchorMode</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.BoundAnchorMode.html">BoundAnchorMode</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_ShellApi_Map_" data-uid="Hi.MachiningProcs.ShellApi.Map*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_Map_System_String_Hi_Mappings_FileTimeSection_System_Nullable_Hi_Mapping_StepTimeShotUtil_CycleSamplingMode__" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_Message_" data-uid="Hi.MachiningProcs.ShellApi.Message*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_Message_System_String_" data-uid="Hi.MachiningProcs.ShellApi.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("Message($1message)")]
|
|
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_ShellApi_OptimizeToFiles_" data-uid="Hi.MachiningProcs.ShellApi.OptimizeToFiles*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_OptimizeToFiles_System_String_" data-uid="Hi.MachiningProcs.ShellApi.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 = "OptimizeToFiles(\"Output/Opt-[NcName]\")", DocContentHtml = "Optimize To Files by substitude template keywoard \"[NcName]\"")]
|
|
public void OptimizeToFiles(string relFileTemplate = "Output/Opt-[NcName]")</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_ShellApi_Pace_" data-uid="Hi.MachiningProcs.ShellApi.Pace*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_Pace" data-uid="Hi.MachiningProcs.ShellApi.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("Pace();")]
|
|
public void Pace()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_ShellApi_Pause_" data-uid="Hi.MachiningProcs.ShellApi.Pause*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_Pause" data-uid="Hi.MachiningProcs.ShellApi.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 = "Pause Player")]
|
|
public void Pause()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_ShellApi_PlayNc_" data-uid="Hi.MachiningProcs.ShellApi.PlayNc*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_PlayNc_System_String_System_String_" data-uid="Hi.MachiningProcs.ShellApi.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 = "PlayNc($1\"ncCommand\",$2\"\"(Direct Command)\"\");", DocContentHtml = "Play NC. second parameter is the file name alternative shows in the log.")]
|
|
public void PlayNc(string ncText, string fileNameAlternative = "--")</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_ShellApi_PlayNcFile_" data-uid="Hi.MachiningProcs.ShellApi.PlayNcFile*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_PlayNcFile_System_String_" data-uid="Hi.MachiningProcs.ShellApi.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("PlayNcFile($1\"ncFile\");")]
|
|
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_ShellApi_Preserve_" data-uid="Hi.MachiningProcs.ShellApi.Preserve*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_Preserve" data-uid="Hi.MachiningProcs.ShellApi.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("Preserve()")]
|
|
public void Preserve()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_ShellApi_ProgressMessage_" data-uid="Hi.MachiningProcs.ShellApi.ProgressMessage*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_ProgressMessage_System_String_" data-uid="Hi.MachiningProcs.ShellApi.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("ProgressMessage($1message)")]
|
|
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_ShellApi_ReTrainMillingPara_" data-uid="Hi.MachiningProcs.ShellApi.ReTrainMillingPara*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_ReTrainMillingPara_Hi_MillingForces_Fittings_SampleFlag_System_String_System_Double_" data-uid="Hi.MachiningProcs.ShellApi.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("ReTrainMillingPara(Fx|Fy|Fz, $1dstFile)")]
|
|
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_ShellApi_ReadCsvByTimeInterpolation_" data-uid="Hi.MachiningProcs.ShellApi.ReadCsvByTimeInterpolation*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_ReadCsvByTimeInterpolation_System_String_" data-uid="Hi.MachiningProcs.ShellApi.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 = "ReadCsvByTimeInterpolation($1\"csvFile\")")]
|
|
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_ShellApi_ReadRuntimeGeom_" data-uid="Hi.MachiningProcs.ShellApi.ReadRuntimeGeom*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_ReadRuntimeGeom_System_String_" data-uid="Hi.MachiningProcs.ShellApi.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("ReadRuntimeGeom($1\"srcFile\")")]
|
|
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_ShellApi_RegisterStepVariable_" data-uid="Hi.MachiningProcs.ShellApi.RegisterStepVariable*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_RegisterStepVariable_System_String_System_String_System_String_System_String_System_Func_Hi_MillingSteps_MachiningStep_System_Object__" data-uid="Hi.MachiningProcs.ShellApi.RegisterStepVariable(System.String,System.String,System.String,System.String,System.Func{Hi.MillingSteps.MachiningStep,System.Object})">
|
|
RegisterStepVariable(string, string, string, string, Func<MachiningStep, object>)
|
|
|
|
</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 = "RegisterStepVariable(\"$1key\",\"$2name\",\"$3unit\",\"$4formatString\",\"$5variableFunc\")", DocContentHtml = "<p>Register Step Variable.</p> <p>\"unit\" is nullable</p> <p>\"formatString\" is nullable</p>")]
|
|
public void RegisterStepVariable(string key, string name, string unit, string formatString, Func<MachiningStep, object> 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><<a class="xref" href="Hi.MillingSteps.MachiningStep.html">MachiningStep</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
|
<dd><p>Function to compute the variable value from a milling step (can be null)</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_ShellApi_RemoveFlyPiece_" data-uid="Hi.MachiningProcs.ShellApi.RemoveFlyPiece*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_RemoveFlyPiece" data-uid="Hi.MachiningProcs.ShellApi.RemoveFlyPiece">
|
|
RemoveFlyPiece()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Removes any disconnected or “flying” 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_ShellApi_Reset_" data-uid="Hi.MachiningProcs.ShellApi.Reset*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_Reset" data-uid="Hi.MachiningProcs.ShellApi.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 = "Reset Player")]
|
|
public void Reset()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_ShellApi_ResetRuntime_" data-uid="Hi.MachiningProcs.ShellApi.ResetRuntime*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_ResetRuntime" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_RunNc_" data-uid="Hi.MachiningProcs.ShellApi.RunNc*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_RunNc_System_String_System_String_" data-uid="Hi.MachiningProcs.ShellApi.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 = "RunNc($1\"ncCommand\",$2\"\"(Direct Command)\"\");", DocContentHtml = "Run NC. second parameter is the file name alternative shows in the log.")]
|
|
public IEnumerable<Action> RunNc(string ncText, string fileNameAlternative = "--")</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><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action">Action</a>></dt>
|
|
<dd><p>Enumerable sequence of actions to be executed</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_ShellApi_RunNcFile_" data-uid="Hi.MachiningProcs.ShellApi.RunNcFile*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_RunNcFile_System_String_" data-uid="Hi.MachiningProcs.ShellApi.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("RunNcFile($1\"ncFile\");")]
|
|
public IEnumerable<Action> 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><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action">Action</a>></dt>
|
|
<dd><p>Enumerable sequence of actions to be executed</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_ShellApi_SetNcResolutionFeedPerCycle_" data-uid="Hi.MachiningProcs.ShellApi.SetNcResolutionFeedPerCycle*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_SetNcResolutionFeedPerCycle" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_SetNcResolutionFeedPerTooth_" data-uid="Hi.MachiningProcs.ShellApi.SetNcResolutionFeedPerTooth*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_SetNcResolutionFeedPerTooth" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_SetNcResolutionFixed_" data-uid="Hi.MachiningProcs.ShellApi.SetNcResolutionFixed*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_SetNcResolutionFixed_System_Double_System_Double_" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_SetStickMachiningToolObservationHeight_mm_" data-uid="Hi.MachiningProcs.ShellApi.SetStickMachiningToolObservationHeight_mm*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_SetStickMachiningToolObservationHeight_mm_System_Int32_System_Double_" data-uid="Hi.MachiningProcs.ShellApi.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("SetStickMachiningToolObservationHeight_mm($1toolId,$2height_mm)")]
|
|
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_ShellApi_SetUniformContourTrayShiftAngle_deg_" data-uid="Hi.MachiningProcs.ShellApi.SetUniformContourTrayShiftAngle_deg*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_SetUniformContourTrayShiftAngle_deg_System_Int32_System_Double_" data-uid="Hi.MachiningProcs.ShellApi.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("SetUniformContourTrayShiftAngle_deg($1toolId,$2angle_deg)")]
|
|
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_ShellApi_ShiftDistance_mm_" data-uid="Hi.MachiningProcs.ShellApi.ShiftDistance_mm*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_ShiftDistance_mm_System_Double_" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_ShiftTime_s_" data-uid="Hi.MachiningProcs.ShellApi.ShiftTime_s*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_ShiftTime_s_System_Double_" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_TrainMillingPara_" data-uid="Hi.MachiningProcs.ShellApi.TrainMillingPara*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_TrainMillingPara_Hi_MillingForces_Fittings_SampleFlag_System_String_System_Double_" data-uid="Hi.MachiningProcs.ShellApi.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("TrainMillingPara(Fx|Fy|Fz, $1dstFile)")]
|
|
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_ShellApi_WarningMessage_" data-uid="Hi.MachiningProcs.ShellApi.WarningMessage*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_WarningMessage_System_String_" data-uid="Hi.MachiningProcs.ShellApi.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("WarningMessage($1message)")]
|
|
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_ShellApi_WriteRuntimeGeom_" data-uid="Hi.MachiningProcs.ShellApi.WriteRuntimeGeom*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_WriteRuntimeGeom_System_String_" data-uid="Hi.MachiningProcs.ShellApi.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("WriteRuntimeGeom($1\"dstFile\")")]
|
|
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_ShellApi_WriteRuntimeGeomToStl_" data-uid="Hi.MachiningProcs.ShellApi.WriteRuntimeGeomToStl*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_WriteRuntimeGeomToStl_System_String_System_Double_" data-uid="Hi.MachiningProcs.ShellApi.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("WriteRuntimeGeomToStl($1\"dstFile\",$2resolution_mm)")]
|
|
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_ShellApi_WriteShotFiles_" data-uid="Hi.MachiningProcs.ShellApi.WriteShotFiles*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_WriteShotFiles_System_Double_System_String_" data-uid="Hi.MachiningProcs.ShellApi.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_ShellApi_WriteShotFiles_" data-uid="Hi.MachiningProcs.ShellApi.WriteShotFiles*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_WriteShotFiles_System_String_System_Double_" data-uid="Hi.MachiningProcs.ShellApi.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 = "WriteShotFiles(\"Output/[NcName].shot.csv\",resolutionPeroid_ms)", DocContentHtml = "Write time series data by resolutionPeroid_ms")]
|
|
public void WriteShotFiles(string relFileTemplate = "Output/[NcName].shot.csv", 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_ShellApi_WriteStepFiles_" data-uid="Hi.MachiningProcs.ShellApi.WriteStepFiles*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_ShellApi_WriteStepFiles_System_String_" data-uid="Hi.MachiningProcs.ShellApi.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 = "WriteStepFiles(\"Output/[NcName].step.csv\")", DocContentHtml = "Write step series data.")]
|
|
public void WriteStepFiles(string relFileTemplate = "Output/[NcName].step.csv")</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_ShellApi_MachiningStepBuilt" data-uid="Hi.MachiningProcs.ShellApi.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 = "MachiningStepBuilt+=($1preStep,$2curStep)=>{$3Command};", DocContentHtml = "Runtime Step Configuration action. preStep is the Previous Milling Step; curStep is the Current Milling Step. preStep is null if no previous step existed.")]
|
|
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_ShellApi_MillingStepSelected" data-uid="Hi.MachiningProcs.ShellApi.MillingStepSelected">
|
|
MillingStepSelected
|
|
|
|
</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 = "MillingStepSelected+=($1millingStep)=>{$2Command};")]
|
|
public event Action<MachiningStep> MillingStepSelected</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><<a class="xref" href="Hi.MillingSteps.MachiningStep.html">MachiningStep</a>></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>
|