tune

2025-09-06 21:25:33 +08:00
parent f6dd232ef8
commit 878475acf8
108 changed files with 5919 additions and 4961 deletions
@@ -6,7 +6,7 @@
      <meta name="viewport" content="width=device-width, initial-scale=1.0">
      <meta name="title" content="Class RuntimeApi | HiAPI-C# 2025 ">
      
-      
+      <meta name="description" content="Runtime API for machining operations.">
      <link rel="icon" href="../img/HiAPI.favicon.ico">
      <link rel="stylesheet" href="../public/docfx.min.css">
      <link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,8 @@ Class RuntimeApi
  <dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
  </div>

-  <div class="markdown summary"></div>
+  <div class="markdown summary"><p>Runtime API for machining operations.</p>
+</div>
  <div class="markdown conceptual"></div>

  <div class="codewrapper">
@@ -425,7 +426,8 @@ This property only has an effect if collision detection is enabled.</p>
  
  </h3>

-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Gets or sets whether to pause on failure during execution.</p>
+</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
@@ -885,7 +887,8 @@ public static int MillingForceCycleDivisionNum { get; set; }</code></pre>
  
  </h3>

-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Gets or sets the NC optimization options.</p>
+</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
@@ -1414,7 +1417,8 @@ public double OptSpindleTorqueSafetyFactor { get; set; }</code></pre>
  
  </h3>

-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Gets or sets the parameter template dimension (2D or 3D).</p>
+</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
@@ -1478,7 +1482,8 @@ public int ParaTemplateDimension { get; set; }</code></pre>
  
  </h3>

-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Gets the session message host for displaying messages.</p>
+</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
@@ -1750,7 +1755,8 @@ milling step() has not triggered yet.</p>
  
  </h3>

-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Begins a new machining session.</p>
+</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
@@ -1905,7 +1911,8 @@ public void EndPreserve()</code></pre>
  
  </h3>

-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Ends the current machining session.</p>
+</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
@@ -2342,7 +2349,8 @@ public void Pause()</code></pre>
  
  </h3>

-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Plays an act with pacing control.</p>
+</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
@@ -2353,11 +2361,14 @@ public void PlayAct(IAct act, ISourceCommand sourceCommand = null, CancellationT
  <h4 class="section">Parameters</h4>
  <dl class="parameters">
    <dt><code>act</code> <a class="xref" href="Hi.Numerical.Acts.IAct.html">IAct</a></dt>
-    <dd></dd>
+    <dd><p>The act to play.</p>
+</dd>
    <dt><code>sourceCommand</code> <a class="xref" href="Hi.MachiningSteps.ISourceCommand.html">ISourceCommand</a></dt>
-    <dd></dd>
+    <dd><p>The source command.</p>
+</dd>
    <dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a>?</dt>
-    <dd></dd>
+    <dd><p>Cancellation token.</p>
+</dd>
  </dl>


@@ -2378,7 +2389,8 @@ public void PlayAct(IAct act, ISourceCommand sourceCommand = null, CancellationT
  
  </h3>

-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Plays a CL (cutter location) teleport operation.</p>
+</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
@@ -2389,17 +2401,23 @@ public void PlayClTeleport(double x, double y, double z, double i, double j, dou
  <h4 class="section">Parameters</h4>
  <dl class="parameters">
    <dt><code>x</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
-    <dd></dd>
+    <dd><p>X coordinate.</p>
+</dd>
    <dt><code>y</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
-    <dd></dd>
+    <dd><p>Y coordinate.</p>
+</dd>
    <dt><code>z</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
-    <dd></dd>
+    <dd><p>Z coordinate.</p>
+</dd>
    <dt><code>i</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
-    <dd></dd>
+    <dd><p>I vector component.</p>
+</dd>
    <dt><code>j</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
-    <dd></dd>
+    <dd><p>J vector component.</p>
+</dd>
    <dt><code>k</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
-    <dd></dd>
+    <dd><p>K vector component.</p>
+</dd>
  </dl>


@@ -2491,7 +2509,8 @@ public void PlayNcFile(string relNcFilePath)</code></pre>
  
  </h3>

-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Plays a tooling teleport operation.</p>
+</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
@@ -2502,7 +2521,8 @@ public void PlayToolingTeleport(int toolId)</code></pre>
  <h4 class="section">Parameters</h4>
  <dl class="parameters">
    <dt><code>toolId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
-    <dd></dd>
+    <dd><p>The tool ID to teleport.</p>
+</dd>
  </dl>