HiNC-Deploy/HiNC-2025-win-desktop-Deploy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

tune

Browse Source
This commit is contained in:
iamboss
2025-07-25 16:27:29 +08:00
parent 38b27cd481
commit b5cad3c171
1114 changed files with 68009 additions and 23981 deletions
Download Patch File Download Diff File Expand all files Collapse all files
App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningProject.html
+293 -53
View File
@@ -102,7 +102,7 @@ Class MachiningProject
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class MachiningProject : IDisposable, IMachiningStepHost, IGetMachiningEquipment, IMakeXmlSource</code></pre>
<pre><code class="lang-csharp hljs">public class MachiningProject : IDisposable, IMachiningStepHost, IGetMachiningEquipment, IMakeXmlSource, IMachiningProjectGetter</code></pre>
</div>
@@ -120,9 +120,10 @@ Class MachiningProject
<dt>Implements</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
<div><a class="xref" href="Hi.MillingSteps.IMachiningStepHost.html">IMachiningStepHost</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="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
<div><a class="xref" href="Hi.MachiningProcs.IMachiningProjectGetter.html">IMachiningProjectGetter</a></div>
</dd>
</dl>
@@ -432,6 +433,38 @@ Uses the default MongoDB connection.</p>
<a id="Hi_MachiningProcs_MachiningProject_ClStrip_" data-uid="Hi.MachiningProcs.MachiningProject.ClStrip*"></a>
<h3 id="Hi_MachiningProcs_MachiningProject_ClStrip" data-uid="Hi.MachiningProcs.MachiningProject.ClStrip">
ClStrip
</h3>
<div class="markdown level1 summary"><p>Gets the cutter location strip.</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_MachiningProject_CoordinateEntryDisplayee_" data-uid="Hi.MachiningProcs.MachiningProject.CoordinateEntryDisplayee*"></a>
<h3 id="Hi_MachiningProcs_MachiningProject_CoordinateEntryDisplayee" data-uid="Hi.MachiningProcs.MachiningProject.CoordinateEntryDisplayee">
@@ -561,20 +594,51 @@ When set to true, initializes collision detection mechanism.</p>
<a id="Hi_MachiningProcs_MachiningProject_EnablePauseOnCollision_" data-uid="Hi.MachiningProcs.MachiningProject.EnablePauseOnCollision*"></a>
<a id="Hi_MachiningProcs_MachiningProject_EnablePauseOnFailure_" data-uid="Hi.MachiningProcs.MachiningProject.EnablePauseOnFailure*"></a>
<h3 id="Hi_MachiningProcs_MachiningProject_EnablePauseOnCollision" data-uid="Hi.MachiningProcs.MachiningProject.EnablePauseOnCollision">
EnablePauseOnCollision
<h3 id="Hi_MachiningProcs_MachiningProject_EnablePauseOnFailure" data-uid="Hi.MachiningProcs.MachiningProject.EnablePauseOnFailure">
EnablePauseOnFailure
</h3>
<div class="markdown level1 summary"><p>Gets or sets whether to pause simulation when a collision is detected.
Only effective when collision detection is enabled.</p>
<div class="markdown level1 summary"><p>Enable Pause On Failure Detected.
Only take effect if the <a class="xref" href="Hi.MachiningProcs.MachiningProject.html#Hi_MachiningProcs_MachiningProject_EnableCollisionDetection">EnableCollisionDetection</a> or <a class="xref" href="Hi.MachiningProcs.MachiningProject.html#Hi_MachiningProcs_MachiningProject_EnableStrokeLimitCheck">EnableStrokeLimitCheck</a> is enabled.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool EnablePauseOnCollision { get; set; }</code></pre>
<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_MachiningProject_EnableStrokeLimitCheck_" data-uid="Hi.MachiningProcs.MachiningProject.EnableStrokeLimitCheck*"></a>
<h3 id="Hi_MachiningProcs_MachiningProject_EnableStrokeLimitCheck" data-uid="Hi.MachiningProcs.MachiningProject.EnableStrokeLimitCheck">
EnableStrokeLimitCheck
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool EnableStrokeLimitCheck { get; set; }</code></pre>
</div>
@@ -601,7 +665,7 @@ Only effective when collision detection is enabled.</p>
</h3>
<div class="markdown level1 summary"><p>global variable for <a class="xref" href="Hi.MachiningProcs.MachiningProject.html#Hi_MachiningProcs_MachiningProject_ShellApi">ShellApi</a>.
<div class="markdown level1 summary"><p>global variable for <a class="xref" href="Hi.MachiningProcs.MachiningProject.html#Hi_MachiningProcs_MachiningProject_RuntimeController">RuntimeController</a>.
Not save on XML.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -681,39 +745,7 @@ When set, updates the inspecting quantity function.</p>
<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>&lt;<a class="xref" href="Hi.MillingSteps.MachiningStep.html">MachiningStep</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>?&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_MachiningProject_KeyToAccessDictionary_" data-uid="Hi.MachiningProcs.MachiningProject.KeyToAccessDictionary*"></a>
<h3 id="Hi_MachiningProcs_MachiningProject_KeyToAccessDictionary" data-uid="Hi.MachiningProcs.MachiningProject.KeyToAccessDictionary">
KeyToAccessDictionary
</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&lt;string, StepPropertyAccess&gt; KeyToAccessDictionary { 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>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a class="xref" href="Hi.MillingSteps.StepPropertyAccess.html">StepPropertyAccess</a>&gt;</dt>
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a>&lt;<a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>?&gt;</dt>
<dd></dd>
</dl>
@@ -981,6 +1013,68 @@ Updates related components when changed.</p>
<a id="Hi_MachiningProcs_MachiningProject_NcEnv_" data-uid="Hi.MachiningProcs.MachiningProject.NcEnv*"></a>
<h3 id="Hi_MachiningProcs_MachiningProject_NcEnv" data-uid="Hi.MachiningProcs.MachiningProject.NcEnv">
NcEnv
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public NcEnv NcEnv { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Numerical.NcEnv.html">NcEnv</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_MachiningProject_NcOptOptionDictionary_" data-uid="Hi.MachiningProcs.MachiningProject.NcOptOptionDictionary*"></a>
<h3 id="Hi_MachiningProcs_MachiningProject_NcOptOptionDictionary" data-uid="Hi.MachiningProcs.MachiningProject.NcOptOptionDictionary">
NcOptOptionDictionary
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Dictionary&lt;string, NcOptOption&gt; NcOptOptionDictionary { 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.string">string</a>, <a class="xref" href="Hi.NcOpt.NcOptOption.html">NcOptOption</a>&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_MachiningProject_NcOptProc_" data-uid="Hi.MachiningProcs.MachiningProject.NcOptProc*"></a>
<h3 id="Hi_MachiningProcs_MachiningProject_NcOptProc" data-uid="Hi.MachiningProcs.MachiningProject.NcOptProc">
@@ -1089,7 +1183,7 @@ Updates related components when changed.</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IShellCommand PlayerCommand { get; }</code></pre>
<pre><code class="lang-csharp hljs">public IShellCommand PlayerCommand { get; set; }</code></pre>
</div>
@@ -1098,7 +1192,7 @@ Updates related components when changed.</p>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.ShellCommandUtils.IShellCommand.html">IShellCommand</a></dt>
<dt><a class="xref" href="Hi.ShellCommands.IShellCommand.html">IShellCommand</a></dt>
<dd></dd>
</dl>
@@ -1141,6 +1235,38 @@ Updates related components when changed.</p>
<a id="Hi_MachiningProcs_MachiningProject_RuntimeController_" data-uid="Hi.MachiningProcs.MachiningProject.RuntimeController*"></a>
<h3 id="Hi_MachiningProcs_MachiningProject_RuntimeController" data-uid="Hi.MachiningProcs.MachiningProject.RuntimeController">
RuntimeController
</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 RuntimeController RuntimeController { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.MachiningProcs.RuntimeController.html">RuntimeController</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_MachiningProject_SessionMessageHost_" data-uid="Hi.MachiningProcs.MachiningProject.SessionMessageHost*"></a>
<h3 id="Hi_MachiningProcs_MachiningProject_SessionMessageHost" data-uid="Hi.MachiningProcs.MachiningProject.SessionMessageHost">
@@ -1173,19 +1299,19 @@ Updates related components when changed.</p>
<a id="Hi_MachiningProcs_MachiningProject_ShellApi_" data-uid="Hi.MachiningProcs.MachiningProject.ShellApi*"></a>
<a id="Hi_MachiningProcs_MachiningProject_StepPropertyAccessDictionary_" data-uid="Hi.MachiningProcs.MachiningProject.StepPropertyAccessDictionary*"></a>
<h3 id="Hi_MachiningProcs_MachiningProject_ShellApi" data-uid="Hi.MachiningProcs.MachiningProject.ShellApi">
ShellApi
<h3 id="Hi_MachiningProcs_MachiningProject_StepPropertyAccessDictionary" data-uid="Hi.MachiningProcs.MachiningProject.StepPropertyAccessDictionary">
StepPropertyAccessDictionary
</h3>
<div class="markdown level1 summary"><p>Gets the shell API for interacting with this machining process.</p>
<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 ShellApi ShellApi { get; }</code></pre>
<pre><code class="lang-csharp hljs">public ConcurrentDictionary&lt;string, PropertyAccess&lt;MachiningStep&gt;&gt; StepPropertyAccessDictionary { get; }</code></pre>
</div>
@@ -1194,7 +1320,7 @@ Updates related components when changed.</p>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.MachiningProcs.ShellApi.html">ShellApi</a></dt>
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.concurrent.concurrentdictionary-2">ConcurrentDictionary</a>&lt;<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>&lt;<a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a>&gt;&gt;</dt>
<dd></dd>
</dl>
@@ -1307,6 +1433,41 @@ Ensures proper initialization of workpiece properties.</p>
</h2>
<a id="Hi_MachiningProcs_MachiningProject_Act_" data-uid="Hi.MachiningProcs.MachiningProject.Act*"></a>
<h3 id="Hi_MachiningProcs_MachiningProject_Act_Hi_Numerical_Acts_IAct_Hi_MachiningSteps_ISourceCommand_System_Nullable_System_Threading_CancellationToken__" data-uid="Hi.MachiningProcs.MachiningProject.Act(Hi.Numerical.Acts.IAct,Hi.MachiningSteps.ISourceCommand,System.Nullable{System.Threading.CancellationToken})">
Act(IAct, ISourceCommand, CancellationToken?)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Act(IAct act, ISourceCommand sourceCommand = null, CancellationToken? cancellationToken = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>act</code> <a class="xref" href="Hi.Numerical.Acts.IAct.html">IAct</a></dt>
<dd></dd>
<dt><code>sourceCommand</code> <a class="xref" href="Hi.MachiningSteps.ISourceCommand.html">ISourceCommand</a></dt>
<dd></dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a>?</dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_MachiningProject_BeginSession_" data-uid="Hi.MachiningProcs.MachiningProject.BeginSession*"></a>
<h3 id="Hi_MachiningProcs_MachiningProject_BeginSession" data-uid="Hi.MachiningProcs.MachiningProject.BeginSession">
@@ -1459,6 +1620,37 @@ Clear the state from previous session (if existed).</p>
<a id="Hi_MachiningProcs_MachiningProject_GetMachiningProject_" data-uid="Hi.MachiningProcs.MachiningProject.GetMachiningProject*"></a>
<h3 id="Hi_MachiningProcs_MachiningProject_GetMachiningProject" data-uid="Hi.MachiningProcs.MachiningProject.GetMachiningProject">
GetMachiningProject()
</h3>
<div class="markdown level1 summary"></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></dd>
</dl>
<a id="Hi_MachiningProcs_MachiningProject_GetMillingEquipment_" data-uid="Hi.MachiningProcs.MachiningProject.GetMillingEquipment*"></a>
<h3 id="Hi_MachiningProcs_MachiningProject_GetMillingEquipment" data-uid="Hi.MachiningProcs.MachiningProject.GetMillingEquipment">
@@ -1533,8 +1725,8 @@ Clear the state from previous session (if existed).</p>
<a id="Hi_MachiningProcs_MachiningProject_MakeXmlSource_" data-uid="Hi.MachiningProcs.MachiningProject.MakeXmlSource*"></a>
<h3 id="Hi_MachiningProcs_MachiningProject_MakeXmlSource_System_String_System_String_" data-uid="Hi.MachiningProcs.MachiningProject.MakeXmlSource(System.String,System.String)">
MakeXmlSource(string, string)
<h3 id="Hi_MachiningProcs_MachiningProject_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.MachiningProcs.MachiningProject.MakeXmlSource(System.String,System.String,System.Boolean)">
MakeXmlSource(string, string, bool)
</h3>
@@ -1544,7 +1736,7 @@ This method may also generate additional resources such as related files.</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile)</code></pre>
<pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -1554,6 +1746,9 @@ This method may also generate additional resources such as related files.</p>
</dd>
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The relative file path for the XML source</p>
</dd>
<dt><code>exhibitionOnly</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>if true, the extended file creation is suppressed.</p>
</dd>
</dl>
@@ -1570,6 +1765,11 @@ This method may also generate additional resources such as related files.</p>
<h4 class="section" id="Hi_MachiningProcs_MachiningProject_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
Since the folder can be moving with the configuration file.</p>
</div>
@@ -1646,6 +1846,46 @@ This method may also generate additional resources such as related files.</p>
<a id="Hi_MachiningProcs_MachiningProject_ProcAct_" data-uid="Hi.MachiningProcs.MachiningProject.ProcAct*"></a>
<h3 id="Hi_MachiningProcs_MachiningProject_ProcAct_Hi_Numerical_Acts_IAct_Hi_MachiningSteps_ISourceCommand_System_Nullable_System_Threading_CancellationToken__" data-uid="Hi.MachiningProcs.MachiningProject.ProcAct(Hi.Numerical.Acts.IAct,Hi.MachiningSteps.ISourceCommand,System.Nullable{System.Threading.CancellationToken})">
ProcAct(IAct, ISourceCommand, CancellationToken?)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IEnumerable&lt;object&gt; ProcAct(IAct act, ISourceCommand sourceCommand = null, CancellationToken? cancellationToken = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>act</code> <a class="xref" href="Hi.Numerical.Acts.IAct.html">IAct</a></dt>
<dd></dd>
<dt><code>sourceCommand</code> <a class="xref" href="Hi.MachiningSteps.ISourceCommand.html">ISourceCommand</a></dt>
<dd></dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a>?</dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_MachiningProject_ReTrainMillingPara_" data-uid="Hi.MachiningProcs.MachiningProject.ReTrainMillingPara*"></a>
<h3 id="Hi_MachiningProcs_MachiningProject_ReTrainMillingPara_Hi_MillingForces_Fittings_SampleFlag_System_Double_System_String_System_Threading_CancellationToken_" data-uid="Hi.MachiningProcs.MachiningProject.ReTrainMillingPara(Hi.MillingForces.Fittings.SampleFlag,System.Double,System.String,System.Threading.CancellationToken)">