2588 lines
74 KiB
HTML
2588 lines
74 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Class LocalProjectService | HiAPI-C# 2025 </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Class LocalProjectService | HiAPI-C# 2025 ">
|
|
|
|
<meta name="description" content="Root(Local) project service. Apply absolute file path.">
|
|
<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.LocalProjectService">
|
|
|
|
|
|
|
|
<h1 id="Hi_MachiningProcs_LocalProjectService" data-uid="Hi.MachiningProcs.LocalProjectService" class="text-break">
|
|
Class LocalProjectService
|
|
</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>Root(Local) project service.
|
|
Apply absolute file path.</p>
|
|
</div>
|
|
<div class="markdown conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class LocalProjectService : IProjectService, IMachiningProjectGetter, IMachiningStepHost, IGetMachiningEquipment, IDisposable</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">LocalProjectService</span></div>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl class="typelist implements">
|
|
<dt>Implements</dt>
|
|
<dd>
|
|
<div><a class="xref" href="Hi.MachiningProcs.IProjectService.html">IProjectService</a></div>
|
|
<div><a class="xref" href="Hi.MachiningProcs.IMachiningProjectGetter.html">IMachiningProjectGetter</a></div>
|
|
<div><a class="xref" href="Hi.MachiningSteps.IMachiningStepHost.html">IMachiningStepHost</a></div>
|
|
<div><a class="xref" href="Hi.Machining.MachiningEquipmentUtils.IGetMachiningEquipment.html">IGetMachiningEquipment</a></div>
|
|
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</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 id="Hi_MachiningProcs_LocalProjectService_remarks">Remarks</h2>
|
|
<div class="markdown level0 remarks"><p><a class="xref" href="Hi.MachiningProcs.LocalProjectService.html">LocalProjectService</a> handles the runtime data and cache generally not requires configuration IO.
|
|
Compare to <a class="xref" href="Hi.MachiningProcs.MachiningProject.html">MachiningProject</a>, <a class="xref" href="Hi.MachiningProcs.LocalProjectService.html">LocalProjectService</a> also handles events that does not reset on the <a class="xref" href="Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_MachiningProject">MachiningProject</a> been reloaded.</p>
|
|
</div>
|
|
|
|
|
|
<h2 class="section" id="constructors">Constructors
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService__ctor_" data-uid="Hi.MachiningProcs.LocalProjectService.#ctor*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService__ctor" data-uid="Hi.MachiningProcs.LocalProjectService.#ctor">
|
|
LocalProjectService()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Ctor.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public LocalProjectService()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService__ctor_" data-uid="Hi.MachiningProcs.LocalProjectService.#ctor*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService__ctor_Hi_HiNcKits_UserService_Microsoft_Extensions_Logging_ILogger_Hi_MachiningProcs_LocalProjectService__" data-uid="Hi.MachiningProcs.LocalProjectService.#ctor(Hi.HiNcKits.UserService,Microsoft.Extensions.Logging.ILogger{Hi.MachiningProcs.LocalProjectService})">
|
|
LocalProjectService(UserService, ILogger<LocalProjectService>)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Initializes a new instance.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public LocalProjectService(UserService userService, ILogger<LocalProjectService> logger)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>userService</code> <a class="xref" href="Hi.HiNcKits.UserService.html">UserService</a></dt>
|
|
<dd><p>The application service.</p>
|
|
</dd>
|
|
<dt><code>logger</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.ilogger-1">ILogger</a><<a class="xref" href="Hi.MachiningProcs.LocalProjectService.html">LocalProjectService</a>></dt>
|
|
<dd><p>The logger instance.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="properties">Properties
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_BoundSelectorHost_" data-uid="Hi.MachiningProcs.LocalProjectService.BoundSelectorHost*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_BoundSelectorHost" data-uid="Hi.MachiningProcs.LocalProjectService.BoundSelectorHost">
|
|
BoundSelectorHost
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the bound selector host for managing selection boundaries.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public BoundSelectorHost BoundSelectorHost { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Numerical.StepSelectionUtils.BoundSelectorHost.html">BoundSelectorHost</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_ClStrip_" data-uid="Hi.MachiningProcs.LocalProjectService.ClStrip*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_ClStrip" data-uid="Hi.MachiningProcs.LocalProjectService.ClStrip">
|
|
ClStrip
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the cutter location strip containing the machining steps.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ClStrip ClStrip { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.CutterLocations.ClStrips.ClStrip.html">ClStrip</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_CoordinateEntryDisplayee_" data-uid="Hi.MachiningProcs.LocalProjectService.CoordinateEntryDisplayee*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_CoordinateEntryDisplayee" data-uid="Hi.MachiningProcs.LocalProjectService.CoordinateEntryDisplayee">
|
|
CoordinateEntryDisplayee
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the displayee for coordinate entry visualization.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public CoordinateEntryDisplayee CoordinateEntryDisplayee { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Numerical.CoordinateEntryDisplayee.html">CoordinateEntryDisplayee</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_DictionaryColorGuide_" data-uid="Hi.MachiningProcs.LocalProjectService.DictionaryColorGuide*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_DictionaryColorGuide" data-uid="Hi.MachiningProcs.LocalProjectService.DictionaryColorGuide">
|
|
DictionaryColorGuide
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the color guide for dictionary-based coloring.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public DictionaryColorGuide DictionaryColorGuide { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Coloring.DictionaryColorGuide.html">DictionaryColorGuide</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_EnableCollisionDetection_" data-uid="Hi.MachiningProcs.LocalProjectService.EnableCollisionDetection*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_EnableCollisionDetection" data-uid="Hi.MachiningProcs.LocalProjectService.EnableCollisionDetection">
|
|
EnableCollisionDetection
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets whether collision detection is enabled.
|
|
When set to true, initializes collision detection mechanism.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">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_LocalProjectService_EnablePauseOnFailure_" data-uid="Hi.MachiningProcs.LocalProjectService.EnablePauseOnFailure*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_EnablePauseOnFailure" data-uid="Hi.MachiningProcs.LocalProjectService.EnablePauseOnFailure">
|
|
EnablePauseOnFailure
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets whether to pause execution on failure.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool EnablePauseOnFailure { get; set; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_EnableStrokeLimitCheck_" data-uid="Hi.MachiningProcs.LocalProjectService.EnableStrokeLimitCheck*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_EnableStrokeLimitCheck" data-uid="Hi.MachiningProcs.LocalProjectService.EnableStrokeLimitCheck">
|
|
EnableStrokeLimitCheck
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets whether stroke limit checking is enabled.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool EnableStrokeLimitCheck { 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_LocalProjectService_Fixture_" data-uid="Hi.MachiningProcs.LocalProjectService.Fixture*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_Fixture" data-uid="Hi.MachiningProcs.LocalProjectService.Fixture">
|
|
Fixture
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the fixture.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Fixture Fixture { get; set; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.NcMech.Fixtures.Fixture.html">Fixture</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_Global_" data-uid="Hi.MachiningProcs.LocalProjectService.Global*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_Global" data-uid="Hi.MachiningProcs.LocalProjectService.Global">
|
|
Global
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>global variable for <a class="xref" href="Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_RuntimeApi">RuntimeApi</a>.
|
|
Not save on XML.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Dictionary<object, object> Global { 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><<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_LocalProjectService_InspectingKey_" data-uid="Hi.MachiningProcs.LocalProjectService.InspectingKey*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_InspectingKey" data-uid="Hi.MachiningProcs.LocalProjectService.InspectingKey">
|
|
InspectingKey
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the current inspecting key for visualization.
|
|
When set, updates the inspecting quantity function.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string InspectingKey { 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.string">string</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_InspectingQuantityFunc_" data-uid="Hi.MachiningProcs.LocalProjectService.InspectingQuantityFunc*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_InspectingQuantityFunc" data-uid="Hi.MachiningProcs.LocalProjectService.InspectingQuantityFunc">
|
|
InspectingQuantityFunc
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the function that retrieves the quantity value for the current inspecting key.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Func<MachiningStep, double?> InspectingQuantityFunc { 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.func-2">Func</a><<a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>?></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_Logger_" data-uid="Hi.MachiningProcs.LocalProjectService.Logger*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_Logger" data-uid="Hi.MachiningProcs.LocalProjectService.Logger">
|
|
Logger
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the logger instance for this service.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ILogger<LocalProjectService> Logger { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.ilogger-1">ILogger</a><<a class="xref" href="Hi.MachiningProcs.LocalProjectService.html">LocalProjectService</a>></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_MachiningActRunner_" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningActRunner*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_MachiningActRunner" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningActRunner">
|
|
MachiningActRunner
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the machining act runner responsible for executing machining operations.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public MachiningActRunner MachiningActRunner { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.MachiningProcs.MachiningActRunner.html">MachiningActRunner</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_MachiningChain_" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningChain*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_MachiningChain" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningChain">
|
|
MachiningChain
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the machining chain.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IMachiningChain MachiningChain { get; set; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Mech.IMachiningChain.html">IMachiningChain</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_MachiningChainFile_" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningChainFile*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_MachiningChainFile" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningChainFile">
|
|
MachiningChainFile
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the file path of the solid machining chain.
|
|
This is used for XML serialization and file management.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string MachiningChainFile { 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.string">string</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_MachiningEquipment_" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningEquipment*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_MachiningEquipment" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningEquipment">
|
|
MachiningEquipment
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the machining equipment used for milling.
|
|
Updates related components when changed.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public MachiningEquipment MachiningEquipment { get; set; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html">MachiningEquipment</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_MachiningProject_" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningProject*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_MachiningProject" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningProject">
|
|
MachiningProject
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the machining project instance.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public MachiningProject MachiningProject { get; set; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.MachiningProcs.MachiningProject.html">MachiningProject</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_MachiningProjectPath_" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningProjectPath*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_MachiningProjectPath" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningProjectPath">
|
|
MachiningProjectPath
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string MachiningProjectPath { 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.string">string</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_MachiningSession_" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningSession*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_MachiningSession" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningSession">
|
|
MachiningSession
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the current machining session.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public MachiningSession MachiningSession { get; set; }</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_LocalProjectService_MachiningTool_" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningTool*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_MachiningTool" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningTool">
|
|
MachiningTool
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the machining tool.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IMachiningTool MachiningTool { get; set; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Machining.IMachiningTool.html">IMachiningTool</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_MachiningToolHouse_" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningToolHouse*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_MachiningToolHouse" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningToolHouse">
|
|
MachiningToolHouse
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the machining tool house containing tool configurations.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public MachiningToolHouse MachiningToolHouse { get; set; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Machining.MachiningToolHouse.html">MachiningToolHouse</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_MachiningToolHouseFile_" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningToolHouseFile*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_MachiningToolHouseFile" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningToolHouseFile">
|
|
MachiningToolHouseFile
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the file path to the milling tool house configuration.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string MachiningToolHouseFile { 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.string">string</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_MillingStepLuggageReader_" data-uid="Hi.MachiningProcs.LocalProjectService.MillingStepLuggageReader*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_MillingStepLuggageReader" data-uid="Hi.MachiningProcs.LocalProjectService.MillingStepLuggageReader">
|
|
MillingStepLuggageReader
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the reader for accessing milling step luggage data.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ParallelBulkReader<MillingStepLuggage> MillingStepLuggageReader { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Common.ParallelBulkUtils.ParallelBulkReader-1.html">ParallelBulkReader</a><<a class="xref" href="Hi.MillingSteps.MillingStepLuggage.html">MillingStepLuggage</a>></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_NcOptProc_" data-uid="Hi.MachiningProcs.LocalProjectService.NcOptProc*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_NcOptProc" data-uid="Hi.MachiningProcs.LocalProjectService.NcOptProc">
|
|
NcOptProc
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the NC optimization processor for optimizing NC programs.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public NcOptProc NcOptProc { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.NcOpt.NcOptProc.html">NcOptProc</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_NcRunner_" data-uid="Hi.MachiningProcs.LocalProjectService.NcRunner*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_NcRunner" data-uid="Hi.MachiningProcs.LocalProjectService.NcRunner">
|
|
NcRunner
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the NC runner responsible for executing NC programs.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public NcRunner NcRunner { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Numerical.FilePlayers.NcRunner.html">NcRunner</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_PacePlayer_" data-uid="Hi.MachiningProcs.LocalProjectService.PacePlayer*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_PacePlayer" data-uid="Hi.MachiningProcs.LocalProjectService.PacePlayer">
|
|
PacePlayer
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the pace player for controlling execution pace of milling operations.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public PacePlayer PacePlayer { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Common.PacePlayer.html">PacePlayer</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_Progress_" data-uid="Hi.MachiningProcs.LocalProjectService.Progress*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_Progress" data-uid="Hi.MachiningProcs.LocalProjectService.Progress">
|
|
Progress
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the progress reporting mechanism for long-running operations.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Progress<IProgressReport> Progress { 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.progress-1">Progress</a><<a class="xref" href="Hi.Common.NativeProgresses.IProgressReport.html">IProgressReport</a>></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_ProjectDirectory_" data-uid="Hi.MachiningProcs.LocalProjectService.ProjectDirectory*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_ProjectDirectory" data-uid="Hi.MachiningProcs.LocalProjectService.ProjectDirectory">
|
|
ProjectDirectory
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the directory containing the machining project.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string ProjectDirectory { 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.string">string</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_RuntimeApi_" data-uid="Hi.MachiningProcs.LocalProjectService.RuntimeApi*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_RuntimeApi" data-uid="Hi.MachiningProcs.LocalProjectService.RuntimeApi">
|
|
RuntimeApi
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the shell API for interacting with this machining process.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public RuntimeApi RuntimeApi { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_SessionMessageHost_" data-uid="Hi.MachiningProcs.LocalProjectService.SessionMessageHost*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_SessionMessageHost" data-uid="Hi.MachiningProcs.LocalProjectService.SessionMessageHost">
|
|
SessionMessageHost
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the message host for displaying messages, warnings, and errors.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public SessionMessageHost SessionMessageHost { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.MachiningProcs.SessionMessageHost.html">SessionMessageHost</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_StepPropertyAccessDictionary_" data-uid="Hi.MachiningProcs.LocalProjectService.StepPropertyAccessDictionary*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_StepPropertyAccessDictionary" data-uid="Hi.MachiningProcs.LocalProjectService.StepPropertyAccessDictionary">
|
|
StepPropertyAccessDictionary
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the dictionary mapping property keys to their access methods.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ConcurrentDictionary<string, PropertyAccess<MachiningStep>> StepPropertyAccessDictionary { 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.concurrent.concurrentdictionary-2">ConcurrentDictionary</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a class="xref" href="Hi.MachiningSteps.PropertyAccess-1.html">PropertyAccess</a><<a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a>>></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_TimeMapping_" data-uid="Hi.MachiningProcs.LocalProjectService.TimeMapping*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_TimeMapping" data-uid="Hi.MachiningProcs.LocalProjectService.TimeMapping">
|
|
TimeMapping
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the time mapping for synchronizing different time-based data streams.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public TimeMapping TimeMapping { get; set; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Mapping.TimeMapping.html">TimeMapping</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_UserService_" data-uid="Hi.MachiningProcs.LocalProjectService.UserService*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_UserService" data-uid="Hi.MachiningProcs.LocalProjectService.UserService">
|
|
UserService
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the application service instance.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public UserService UserService { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.HiNcKits.UserService.html">UserService</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_Workpiece_" data-uid="Hi.MachiningProcs.LocalProjectService.Workpiece*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_Workpiece" data-uid="Hi.MachiningProcs.LocalProjectService.Workpiece">
|
|
Workpiece
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the workpiece to be machined.
|
|
Ensures proper initialization of workpiece properties.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Workpiece Workpiece { get; set; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.NcMech.Workpieces.Workpiece.html">Workpiece</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="methods">Methods
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_Act_" data-uid="Hi.MachiningProcs.LocalProjectService.Act*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_Act_Hi_Numerical_Acts_IAct_Hi_Common_FileLines_IIndexedFileLine_System_Nullable_System_Threading_CancellationToken__" data-uid="Hi.MachiningProcs.LocalProjectService.Act(Hi.Numerical.Acts.IAct,Hi.Common.FileLines.IIndexedFileLine,System.Nullable{System.Threading.CancellationToken})">
|
|
Act(IAct, IIndexedFileLine, CancellationToken?)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Executes an act and collects all results.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Act(IAct act, IIndexedFileLine sourceCommand = null, CancellationToken? cancellationToken = null)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>act</code> <a class="xref" href="Hi.Numerical.Acts.IAct.html">IAct</a></dt>
|
|
<dd><p>The act to execute.</p>
|
|
</dd>
|
|
<dt><code>sourceCommand</code> <a class="xref" href="Hi.Common.FileLines.IIndexedFileLine.html">IIndexedFileLine</a></dt>
|
|
<dd><p>The source command that triggered the act.</p>
|
|
</dd>
|
|
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a>?</dt>
|
|
<dd><p>Cancellation token to cancel the operation.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_BeginSession_" data-uid="Hi.MachiningProcs.LocalProjectService.BeginSession*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_BeginSession" data-uid="Hi.MachiningProcs.LocalProjectService.BeginSession">
|
|
BeginSession()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Initiate a simulation session.
|
|
Clear the state from previous session (if existed).</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void BeginSession()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_CloseProject_" data-uid="Hi.MachiningProcs.LocalProjectService.CloseProject*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_CloseProject" data-uid="Hi.MachiningProcs.LocalProjectService.CloseProject">
|
|
CloseProject()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Closes the current project.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void CloseProject()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_Dispose_" data-uid="Hi.MachiningProcs.LocalProjectService.Dispose*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_Dispose" data-uid="Hi.MachiningProcs.LocalProjectService.Dispose">
|
|
Dispose()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_Dispose_" data-uid="Hi.MachiningProcs.LocalProjectService.Dispose*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_Dispose_System_Boolean_" data-uid="Hi.MachiningProcs.LocalProjectService.Dispose(System.Boolean)">
|
|
Dispose(bool)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected virtual void Dispose(bool disposing)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>disposing</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_EndSession_" data-uid="Hi.MachiningProcs.LocalProjectService.EndSession*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_EndSession" data-uid="Hi.MachiningProcs.LocalProjectService.EndSession">
|
|
EndSession()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Ends the current machining session and releases associated resources.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void EndSession()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_GetInspectingKeyPresentName_" data-uid="Hi.MachiningProcs.LocalProjectService.GetInspectingKeyPresentName*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_GetInspectingKeyPresentName_Hi_Common_StringLocalizer_" data-uid="Hi.MachiningProcs.LocalProjectService.GetInspectingKeyPresentName(Hi.Common.StringLocalizer)">
|
|
GetInspectingKeyPresentName(StringLocalizer)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the localized presentation name for the current inspecting key.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string GetInspectingKeyPresentName(StringLocalizer stringLocalizer)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>stringLocalizer</code> <a class="xref" href="Hi.Common.StringLocalizer.html">StringLocalizer</a></dt>
|
|
<dd><p>The string localizer to use for localization</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>The localized presentation name</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_GetLocalProjectService_" data-uid="Hi.MachiningProcs.LocalProjectService.GetLocalProjectService*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_GetLocalProjectService" data-uid="Hi.MachiningProcs.LocalProjectService.GetLocalProjectService">
|
|
GetLocalProjectService()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Get Local Project Service as base-service.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public LocalProjectService GetLocalProjectService()</code></pre>
|
|
</div>
|
|
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.MachiningProcs.LocalProjectService.html">LocalProjectService</a></dt>
|
|
<dd><p>Local Project Service</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_GetMachiningProject_" data-uid="Hi.MachiningProcs.LocalProjectService.GetMachiningProject*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_GetMachiningProject" data-uid="Hi.MachiningProcs.LocalProjectService.GetMachiningProject">
|
|
GetMachiningProject()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the MachiningProject instance.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public MachiningProject GetMachiningProject()</code></pre>
|
|
</div>
|
|
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.MachiningProcs.MachiningProject.html">MachiningProject</a></dt>
|
|
<dd><p>The MachiningProject instance.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_GetMillingEquipment_" data-uid="Hi.MachiningProcs.LocalProjectService.GetMillingEquipment*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_GetMillingEquipment" data-uid="Hi.MachiningProcs.LocalProjectService.GetMillingEquipment">
|
|
GetMillingEquipment()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Get <a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html">MachiningEquipment</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public MachiningEquipment GetMillingEquipment()</code></pre>
|
|
</div>
|
|
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html">MachiningEquipment</a></dt>
|
|
<dd><p><a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html">MachiningEquipment</a></p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_LoadProject_" data-uid="Hi.MachiningProcs.LocalProjectService.LoadProject*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_LoadProject_System_String_" data-uid="Hi.MachiningProcs.LocalProjectService.LoadProject(System.String)">
|
|
LoadProject(string)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Loads a project by file path relative to the admin directory.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void LoadProject(string projectPath)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>projectPath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>The absolute file path</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_NewProject_" data-uid="Hi.MachiningProcs.LocalProjectService.NewProject*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_NewProject_System_String_" data-uid="Hi.MachiningProcs.LocalProjectService.NewProject(System.String)">
|
|
NewProject(string)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Creates a new project by file path.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void NewProject(string projectPath)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>projectPath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>The absolute file path</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_PlayCsvFile_" data-uid="Hi.MachiningProcs.LocalProjectService.PlayCsvFile*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_PlayCsvFile_System_String_System_String_" data-uid="Hi.MachiningProcs.LocalProjectService.PlayCsvFile(System.String,System.String)">
|
|
PlayCsvFile(string, string)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Plays a CSV file from the specified path.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void PlayCsvFile(string baseDirectory, string relFilePath)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>Base directory for resolving relative paths.</p>
|
|
</dd>
|
|
<dt><code>relFilePath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>Relative path to the CSV file.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_PlayNc_" data-uid="Hi.MachiningProcs.LocalProjectService.PlayNc*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_PlayNc_System_String_System_String_" data-uid="Hi.MachiningProcs.LocalProjectService.PlayNc(System.String,System.String)">
|
|
PlayNc(string, string)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Plays NC commands from raw text with pace control.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">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>The NC command text to execute</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 associate with the NC program</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_PlayNcFile_" data-uid="Hi.MachiningProcs.LocalProjectService.PlayNcFile*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_PlayNcFile_System_String_System_String_" data-uid="Hi.MachiningProcs.LocalProjectService.PlayNcFile(System.String,System.String)">
|
|
PlayNcFile(string, string)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Plays an NC file from the specified path with pace control.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void PlayNcFile(string baseDirectory, string relFilePath)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>Base directory for resolving relative paths</p>
|
|
</dd>
|
|
<dt><code>relFilePath</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_LocalProjectService_ProcAct_" data-uid="Hi.MachiningProcs.LocalProjectService.ProcAct*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_ProcAct_Hi_Numerical_Acts_IAct_Hi_Common_FileLines_IIndexedFileLine_System_Nullable_System_Threading_CancellationToken__" data-uid="Hi.MachiningProcs.LocalProjectService.ProcAct(Hi.Numerical.Acts.IAct,Hi.Common.FileLines.IIndexedFileLine,System.Nullable{System.Threading.CancellationToken})">
|
|
ProcAct(IAct, IIndexedFileLine, CancellationToken?)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Processes an act and returns the results.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IEnumerable<object> ProcAct(IAct act, IIndexedFileLine sourceCommand = null, CancellationToken? cancellationToken = null)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>act</code> <a class="xref" href="Hi.Numerical.Acts.IAct.html">IAct</a></dt>
|
|
<dd><p>The act to process.</p>
|
|
</dd>
|
|
<dt><code>sourceCommand</code> <a class="xref" href="Hi.Common.FileLines.IIndexedFileLine.html">IIndexedFileLine</a></dt>
|
|
<dd><p>The source command that triggered the act.</p>
|
|
</dd>
|
|
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a>?</dt>
|
|
<dd><p>Cancellation token to cancel the operation.</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.object">object</a>></dt>
|
|
<dd><p>Enumerable of results from processing the act.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_ReTrainMillingPara_" data-uid="Hi.MachiningProcs.LocalProjectService.ReTrainMillingPara*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_ReTrainMillingPara_Hi_MillingForces_Fittings_SampleFlag_System_Double_System_String_System_Threading_CancellationToken_" data-uid="Hi.MachiningProcs.LocalProjectService.ReTrainMillingPara(Hi.MillingForces.Fittings.SampleFlag,System.Double,System.String,System.Threading.CancellationToken)">
|
|
ReTrainMillingPara(SampleFlag, double, string, CancellationToken)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Train Milling Parameter.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void ReTrainMillingPara(SampleFlag sampleFlags, double outlierRatio, string dstRelFile, CancellationToken cancellationToken)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>sampleFlags</code> <a class="xref" href="Hi.MillingForces.Fittings.SampleFlag.html">SampleFlag</a></dt>
|
|
<dd></dd>
|
|
<dt><code>outlierRatio</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
|
<dd></dd>
|
|
<dt><code>dstRelFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd></dd>
|
|
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_RefreshDrawing_" data-uid="Hi.MachiningProcs.LocalProjectService.RefreshDrawing*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_RefreshDrawing" data-uid="Hi.MachiningProcs.LocalProjectService.RefreshDrawing">
|
|
RefreshDrawing()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Refreshes the visual display of the milling course.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void RefreshDrawing()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_ReloadProject_" data-uid="Hi.MachiningProcs.LocalProjectService.ReloadProject*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_ReloadProject" data-uid="Hi.MachiningProcs.LocalProjectService.ReloadProject">
|
|
ReloadProject()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Reloads the current project.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void ReloadProject()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_ResetRuntime_" data-uid="Hi.MachiningProcs.LocalProjectService.ResetRuntime*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_ResetRuntime" data-uid="Hi.MachiningProcs.LocalProjectService.ResetRuntime">
|
|
ResetRuntime()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Reset the runtime states including: runtime geometry, collision flags, machine tool position, CL strips, message buffer and etc..</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void ResetRuntime()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_RunCsvFile_" data-uid="Hi.MachiningProcs.LocalProjectService.RunCsvFile*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_RunCsvFile_System_String_System_String_" data-uid="Hi.MachiningProcs.LocalProjectService.RunCsvFile(System.String,System.String)">
|
|
RunCsvFile(string, string)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Runs a CSV file from the specified path.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IEnumerable<Action> RunCsvFile(string baseDirectory, string relFilePath)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>Base directory for resolving relative paths.</p>
|
|
</dd>
|
|
<dt><code>relFilePath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>Relative path to the CSV 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>An enumerable of actions to be executed.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_RunNc_" data-uid="Hi.MachiningProcs.LocalProjectService.RunNc*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_RunNc_System_String_System_String_" data-uid="Hi.MachiningProcs.LocalProjectService.RunNc(System.String,System.String)">
|
|
RunNc(string, string)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Runs NC commands from raw text.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">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>The NC command text to execute</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 associate with the NC program</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>An enumerable of actions to be executed</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_RunNcFile_" data-uid="Hi.MachiningProcs.LocalProjectService.RunNcFile*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_RunNcFile_System_String_System_String_" data-uid="Hi.MachiningProcs.LocalProjectService.RunNcFile(System.String,System.String)">
|
|
RunNcFile(string, string)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Runs an NC file from the specified path.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IEnumerable<Action> RunNcFile(string baseDirectory, string relFilePath)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>Base directory for resolving relative paths. If the value is null, <a class="xref" href="Hi.MachiningProcs.MachiningProject.html#Hi_MachiningProcs_MachiningProject_BaseDirectory">BaseDirectory</a> substitutes the value.</p>
|
|
</dd>
|
|
<dt><code>relFilePath</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>An enumerable of actions to be executed.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_SaveAsProject_" data-uid="Hi.MachiningProcs.LocalProjectService.SaveAsProject*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_SaveAsProject_System_String_" data-uid="Hi.MachiningProcs.LocalProjectService.SaveAsProject(System.String)">
|
|
SaveAsProject(string)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Saves the current project to a specified relative file path.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void SaveAsProject(string projectPath)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>projectPath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>The absolute file path</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_SaveProject_" data-uid="Hi.MachiningProcs.LocalProjectService.SaveProject*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_SaveProject" data-uid="Hi.MachiningProcs.LocalProjectService.SaveProject">
|
|
SaveProject()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Save project by project path.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void SaveProject()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_TrainMillingPara_" data-uid="Hi.MachiningProcs.LocalProjectService.TrainMillingPara*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_TrainMillingPara_Hi_MillingForces_Fittings_SampleFlag_System_Boolean_System_Double_System_String_System_Threading_CancellationToken_Hi_MillingForces_Fittings_ICuttingPara_" data-uid="Hi.MachiningProcs.LocalProjectService.TrainMillingPara(Hi.MillingForces.Fittings.SampleFlag,System.Boolean,System.Double,System.String,System.Threading.CancellationToken,Hi.MillingForces.Fittings.ICuttingPara)">
|
|
TrainMillingPara(SampleFlag, bool, double, string, CancellationToken, ICuttingPara)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Train Milling Parameter.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void TrainMillingPara(SampleFlag sampleFlags, bool enableFzOnlyDuringDrilling, double outlierRatio, string dstRelFile, CancellationToken cancellationToken, ICuttingPara paraTemplate)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>sampleFlags</code> <a class="xref" href="Hi.MillingForces.Fittings.SampleFlag.html">SampleFlag</a></dt>
|
|
<dd></dd>
|
|
<dt><code>enableFzOnlyDuringDrilling</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
|
<dd></dd>
|
|
<dt><code>outlierRatio</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
|
<dd></dd>
|
|
<dt><code>dstRelFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd></dd>
|
|
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
|
|
<dd></dd>
|
|
<dt><code>paraTemplate</code> <a class="xref" href="Hi.MillingForces.Fittings.ICuttingPara.html">ICuttingPara</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_UpdateByMachiningChain_" data-uid="Hi.MachiningProcs.LocalProjectService.UpdateByMachiningChain*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_UpdateByMachiningChain" data-uid="Hi.MachiningProcs.LocalProjectService.UpdateByMachiningChain">
|
|
UpdateByMachiningChain()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Updates components when the machining chain changes.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void UpdateByMachiningChain()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_UpdateByMachiningEquipment_" data-uid="Hi.MachiningProcs.LocalProjectService.UpdateByMachiningEquipment*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_UpdateByMachiningEquipment" data-uid="Hi.MachiningProcs.LocalProjectService.UpdateByMachiningEquipment">
|
|
UpdateByMachiningEquipment()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Call on MachiningEquipment Or MachiningChainChanged.
|
|
i.e. Update By MachiningEquipment Or MachiningChain.
|
|
The function is called on <a class="xref" href="Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_MachiningEquipment">MachiningEquipment</a> and its delegate property changed.
|
|
If the changing is raised outer from THIS service, this updating function should be manual called.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void UpdateByMachiningEquipment()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_UpdateIdealMillingToolOffsetTableByToolHouse_" data-uid="Hi.MachiningProcs.LocalProjectService.UpdateIdealMillingToolOffsetTableByToolHouse*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_UpdateIdealMillingToolOffsetTableByToolHouse" data-uid="Hi.MachiningProcs.LocalProjectService.UpdateIdealMillingToolOffsetTableByToolHouse">
|
|
UpdateIdealMillingToolOffsetTableByToolHouse()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Updates the ideal milling tool offset table based on the current tool house configuration.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void UpdateIdealMillingToolOffsetTableByToolHouse()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_WriteShotFile_" data-uid="Hi.MachiningProcs.LocalProjectService.WriteShotFile*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_WriteShotFile_System_TimeSpan_System_String_" data-uid="Hi.MachiningProcs.LocalProjectService.WriteShotFile(System.TimeSpan,System.String)">
|
|
WriteShotFile(TimeSpan, string)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Writes time-based shot data to a file with the specified sampling period.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void WriteShotFile(TimeSpan samplingPeriod, string relFileTemplate = "Output/[NcName].shot.csv")</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>samplingPeriod</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.timespan">TimeSpan</a></dt>
|
|
<dd><p>The time period between samples</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 the output file path, can include [NcName] placeholder</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_LocalProjectService_WriteStepFile_" data-uid="Hi.MachiningProcs.LocalProjectService.WriteStepFile*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_WriteStepFile_System_String_" data-uid="Hi.MachiningProcs.LocalProjectService.WriteStepFile(System.String)">
|
|
WriteStepFile(string)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Writes step-based data to a file.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void WriteStepFile(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 the output file path, can include [NcName] placeholder</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="events">Events
|
|
</h2>
|
|
|
|
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_MachiningProjectChanged" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningProjectChanged">
|
|
MachiningProjectChanged
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Event raised when the machining project changes.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public event LocalProjectService.MachiningProjectChangedDelegate MachiningProjectChanged</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Event Type</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.MachiningProcs.LocalProjectService.html">LocalProjectService</a>.<a class="xref" href="Hi.MachiningProcs.LocalProjectService.MachiningProjectChangedDelegate.html">MachiningProjectChangedDelegate</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_MachiningStepBuilt" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningStepBuilt">
|
|
MachiningStepBuilt
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>event to configure steps.
|
|
The first parameter is the previous step; the second parameter is the current step.
|
|
The previous step is null if no previous step exists.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">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_LocalProjectService_OnRanNcBlock" data-uid="Hi.MachiningProcs.LocalProjectService.OnRanNcBlock">
|
|
OnRanNcBlock
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Event triggered after an NC block is executed.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public event Action OnRanNcBlock</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">Action</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_OnUpdatedInspectingQuantityFunc" data-uid="Hi.MachiningProcs.LocalProjectService.OnUpdatedInspectingQuantityFunc">
|
|
OnUpdatedInspectingQuantityFunc
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Event triggered when the inspecting quantity function is updated.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public event Action OnUpdatedInspectingQuantityFunc</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">Action</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Hi_MachiningProcs_LocalProjectService_WorkpieceChanged" data-uid="Hi.MachiningProcs.LocalProjectService.WorkpieceChanged">
|
|
WorkpieceChanged
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Event that is raised when the workpiece is changed.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public event Action<SeqPair<Workpiece>> WorkpieceChanged</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.Common.SeqPair-1.html">SeqPair</a><<a class="xref" href="Hi.NcMech.Workpieces.Workpiece.html">Workpiece</a>>></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h4 class="section" id="Hi_MachiningProcs_LocalProjectService_WorkpieceChanged_remarks">Remarks</h4>
|
|
<div class="markdown level1 remarks"><p>This event is triggered whenever the workpiece property is modified.
|
|
Subscribers can use this event to respond to changes in the workpiece configuration,
|
|
such as updating visualizations or recalculating machining parameters.
|
|
The event provides both the previous and new workpiece values through a SeqPair.</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
<div class="contribution d-print-none">
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="affix">
|
|
<nav id="affix"></nav>
|
|
</div>
|
|
</main>
|
|
|
|
<div class="container-xxl search-results" id="search-results"></div>
|
|
|
|
<footer class="border-top text-secondary">
|
|
<div class="container-xxl">
|
|
<div class="flex-fill">
|
|
<span> Copyright © 2025 <a href='https://superhightech.com.tw'>Tech Coordinate</a>. All rights reserved. <a href='https://superhightech.com.tw'>超級高科技股份有限公司</a> © 2025 版權所有 </span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</body>
|
|
</html>
|