HiNC-Deploy/HiNC-2025-win-desktop-Deploy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningSession.html
iambossTC 38b27cd481 tune
2025-07-18 15:38:28 +08:00

563 lines
17 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class MachiningSession | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class MachiningSession | HiAPI-C# 2025 ">
<meta name="description" content="Represents a machining session that manages the execution and optimization of machining operations. Provides functionality for controlling the machining process, handling optimization options, and managing session state.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">
<meta name="docfx:rel" content="../">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../public/docfx.min.js"></script>
<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>
</head>
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../img/HiAPI.logo.png" alt="">
</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>
<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>
<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Hi.MachiningProcs.MachiningSession">
<h1 id="Hi_MachiningProcs_MachiningSession" data-uid="Hi.MachiningProcs.MachiningSession" class="text-break">
Class MachiningSession
</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>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>Represents a machining session that manages the execution and optimization of machining operations.
Provides functionality for controlling the machining process, handling optimization options,
and managing session state.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class MachiningSession</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">MachiningSession</span></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
</dd></dl>
<dl class="typelist extensionMethods">
<dt>Extension Methods</dt>
<dd>
<div>
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate&lt;TSelf&gt;(TSelf, params object[])</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke&lt;TSrc&gt;(TSrc, Action&lt;TSrc&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke&lt;TSrc, TDst&gt;(TSrc, Func&lt;TSrc, TDst&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
</div>
<div>
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
</div>
<div>
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
</div>
<div>
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
</div>
</dd></dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_MachiningProcs_MachiningSession_CurrentSourceCommand_" data-uid="Hi.MachiningProcs.MachiningSession.CurrentSourceCommand*"></a>
<h3 id="Hi_MachiningProcs_MachiningSession_CurrentSourceCommand" data-uid="Hi.MachiningProcs.MachiningSession.CurrentSourceCommand">
CurrentSourceCommand
</h3>
<div class="markdown level1 summary"><p>Gets or sets the current source command being processed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ISourceCommand CurrentSourceCommand { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.MillingSteps.ISourceCommand.html">ISourceCommand</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_MachiningSession_Data_" data-uid="Hi.MachiningProcs.MachiningSession.Data*"></a>
<h3 id="Hi_MachiningProcs_MachiningSession_Data" data-uid="Hi.MachiningProcs.MachiningSession.Data">
Data
</h3>
<div class="markdown level1 summary"><p>Gets or sets the data dictionary for the player session.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Dictionary&lt;object, object&gt; Data { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.dictionary-2">Dictionary</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_MachiningSession_NcOptOption_" data-uid="Hi.MachiningProcs.MachiningSession.NcOptOption*"></a>
<h3 id="Hi_MachiningProcs_MachiningSession_NcOptOption" data-uid="Hi.MachiningProcs.MachiningSession.NcOptOption">
NcOptOption
</h3>
<div class="markdown level1 summary"><p>Gets or sets the NC optimization options for UI operations.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public NcOptOption NcOptOption { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.NcOpt.NcOptOption.html">NcOptOption</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_MachiningSession_PacePlayee_" data-uid="Hi.MachiningProcs.MachiningSession.PacePlayee*"></a>
<h3 id="Hi_MachiningProcs_MachiningSession_PacePlayee" data-uid="Hi.MachiningProcs.MachiningSession.PacePlayee">
PacePlayee
</h3>
<div class="markdown level1 summary"><p>Internal set only.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public PacePlayee PacePlayee { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.PacePlayee.html">PacePlayee</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_MachiningSession_StepIndexToNcOptOptionList_" data-uid="Hi.MachiningProcs.MachiningSession.StepIndexToNcOptOptionList*"></a>
<h3 id="Hi_MachiningProcs_MachiningSession_StepIndexToNcOptOptionList" data-uid="Hi.MachiningProcs.MachiningSession.StepIndexToNcOptOptionList">
StepIndexToNcOptOptionList
</h3>
<div class="markdown level1 summary"><p>Gets or sets the mapping of step indices to NC optimization options.
For internal use only.
Takes effect during internal optimization process.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SortedList&lt;int, NcOptOption&gt; StepIndexToNcOptOptionList { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.sortedlist-2">SortedList</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>, <a class="xref" href="Hi.NcOpt.NcOptOption.html">NcOptOption</a>&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_MachiningSession_StepTaskBundle_" data-uid="Hi.MachiningProcs.MachiningSession.StepTaskBundle*"></a>
<h3 id="Hi_MachiningProcs_MachiningSession_StepTaskBundle" data-uid="Hi.MachiningProcs.MachiningSession.StepTaskBundle">
StepTaskBundle
</h3>
<div class="markdown level1 summary"><p>Gets or sets the current step task bundle.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MachiningParallelProc.StepTaskBundle StepTaskBundle { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.MachiningProcs.MachiningParallelProc.html">MachiningParallelProc</a>.<a class="xref" href="Hi.MachiningProcs.MachiningParallelProc.StepTaskBundle.html">StepTaskBundle</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_MachiningProcs_MachiningSession_BeginPreserve_" data-uid="Hi.MachiningProcs.MachiningSession.BeginPreserve*"></a>
<h3 id="Hi_MachiningProcs_MachiningSession_BeginPreserve" data-uid="Hi.MachiningProcs.MachiningSession.BeginPreserve">
BeginPreserve()
</h3>
<div class="markdown level1 summary"><p>Begins a preserve section in the optimization process.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void BeginPreserve()</code></pre>
</div>
<a id="Hi_MachiningProcs_MachiningSession_EndPreserve_" data-uid="Hi.MachiningProcs.MachiningSession.EndPreserve*"></a>
<h3 id="Hi_MachiningProcs_MachiningSession_EndPreserve" data-uid="Hi.MachiningProcs.MachiningSession.EndPreserve">
EndPreserve()
</h3>
<div class="markdown level1 summary"><p>Ends a preserve section in the optimization process.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void EndPreserve()</code></pre>
</div>
<a id="Hi_MachiningProcs_MachiningSession_Preserve_" data-uid="Hi.MachiningProcs.MachiningSession.Preserve*"></a>
<h3 id="Hi_MachiningProcs_MachiningSession_Preserve" data-uid="Hi.MachiningProcs.MachiningSession.Preserve">
Preserve()
</h3>
<div class="markdown level1 summary"><p>Preserves one line of NC code in the optimization process.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Preserve()</code></pre>
</div>
<a id="Hi_MachiningProcs_MachiningSession_UpdateNcOptOptionMapIfNeeded_" data-uid="Hi.MachiningProcs.MachiningSession.UpdateNcOptOptionMapIfNeeded*"></a>
<h3 id="Hi_MachiningProcs_MachiningSession_UpdateNcOptOptionMapIfNeeded_System_Int32_" data-uid="Hi.MachiningProcs.MachiningSession.UpdateNcOptOptionMapIfNeeded(System.Int32)">
UpdateNcOptOptionMapIfNeeded(int)
</h3>
<div class="markdown level1 summary"><p>Updates the NC optimization option map if needed.
Internal use only.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool UpdateNcOptOptionMapIfNeeded(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>The index of the step to update.</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 map was updated; otherwise, false.</p>
</dd>
</dl>
<h2 class="section" id="events">Events
</h2>
<h3 id="Hi_MachiningProcs_MachiningSession_OnCurrentLineEnd" data-uid="Hi.MachiningProcs.MachiningSession.OnCurrentLineEnd">
OnCurrentLineEnd
</h3>
<div class="markdown level1 summary"><p>Event raised when the current line ends.
The event buffer is cleared on every line change.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event Action&lt;CancellationToken&gt; OnCurrentLineEnd</code></pre>
</div>
<h4 class="section">Event Type</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a>&gt;</dt>
<dd></dd>
</dl>
</article>
<div class="contribution d-print-none">
</div>
</div>
<div class="affix">
<nav id="affix"></nav>
</div>
</main>
<div class="container-xxl search-results" id="search-results"></div>
<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
<span> Copyright © 2025 <a href='https://superhightech.com.tw'>Tech Coordinate</a>. All rights reserved. <a href='https://superhightech.com.tw'>超級高科技股份有限公司</a> © 2025 版權所有 </span>
</div>
</div>
</footer>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink