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-12-22 23:35:40 +08:00
parent 32ff8b45e3
commit 4556281c0a
77 changed files with 9248 additions and 3996 deletions
Download Patch File Download Diff File Expand all files Collapse all files
App/wwwroot/HiAPI-docsite/api/Hi.Mapping.TimeMapping.html
+27 -125
View File
@@ -187,8 +187,8 @@ Class TimeMapping
<a id="Hi_Mapping_TimeMapping__ctor_" data-uid="Hi.Mapping.TimeMapping.#ctor*"></a>
<h3 id="Hi_Mapping_TimeMapping__ctor_Hi_CutterLocations_ClStrips_ClStrip_Hi_Machining_MachiningToolHouse_System_Func_System_String__" data-uid="Hi.Mapping.TimeMapping.#ctor(Hi.CutterLocations.ClStrips.ClStrip,Hi.Machining.MachiningToolHouse,System.Func{System.String})">
TimeMapping(ClStrip, MachiningToolHouse, Func&lt;string&gt;)
<h3 id="Hi_Mapping_TimeMapping__ctor_System_Func_System_String__" data-uid="Hi.Mapping.TimeMapping.#ctor(System.Func{System.String})">
TimeMapping(Func&lt;string&gt;)
</h3>
@@ -197,17 +197,11 @@ Class TimeMapping
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TimeMapping(ClStrip clStrip, MachiningToolHouse millingToolHouse, Func&lt;string&gt; baseDirectoryGetter)</code></pre>
<pre><code class="lang-csharp hljs">public TimeMapping(Func&lt;string&gt; baseDirectoryGetter)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>clStrip</code> <a class="xref" href="Hi.CutterLocations.ClStrips.ClStrip.html">ClStrip</a></dt>
<dd><p>The cutter location strip containing the machining steps.</p>
</dd>
<dt><code>millingToolHouse</code> <a class="xref" href="Hi.Machining.MachiningToolHouse.html">MachiningToolHouse</a></dt>
<dd><p>The machining tool house containing available tools.</p>
</dd>
<dt><code>baseDirectoryGetter</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd><p>The function to get the base directory for file paths.</p>
</dd>
@@ -337,39 +331,6 @@ All relative file paths in the mapping are resolved against this directory.</p>
<a id="Hi_Mapping_TimeMapping_ClStrip_" data-uid="Hi.Mapping.TimeMapping.ClStrip*"></a>
<h3 id="Hi_Mapping_TimeMapping_ClStrip" data-uid="Hi.Mapping.TimeMapping.ClStrip">
ClStrip
</h3>
<div class="markdown level1 summary"><p>Gets or sets the cutter location strip containing the machining steps.
This is used as a reference for mapping time shots to machining steps.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ClStrip ClStrip { get; set; }</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_Mapping_TimeMapping_KeyToRelFileTimeSectionDictionary_" data-uid="Hi.Mapping.TimeMapping.KeyToRelFileTimeSectionDictionary*"></a>
<h3 id="Hi_Mapping_TimeMapping_KeyToRelFileTimeSectionDictionary" data-uid="Hi.Mapping.TimeMapping.KeyToRelFileTimeSectionDictionary">
@@ -404,75 +365,6 @@ which portion of a measurement file corresponds to a particular machining operat
<a id="Hi_Mapping_TimeMapping_LineReaded_" data-uid="Hi.Mapping.TimeMapping.LineReaded*"></a>
<h3 id="Hi_Mapping_TimeMapping_LineReaded" data-uid="Hi.Mapping.TimeMapping.LineReaded">
LineReaded
</h3>
<div class="markdown level1 summary"><p>Gets or sets the callback action that is invoked when a line is read from a measurement file.
This can be used to track progress during file loading operations.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Action&lt;int&gt; LineReaded { 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.action-1">Action</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>&gt;</dt>
<dd></dd>
</dl>
<h4 class="section" id="Hi_Mapping_TimeMapping_LineReaded_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>The parameter passed to the action is the current line number being read.</p>
</div>
<a id="Hi_Mapping_TimeMapping_MillingToolHouse_" data-uid="Hi.Mapping.TimeMapping.MillingToolHouse*"></a>
<h3 id="Hi_Mapping_TimeMapping_MillingToolHouse" data-uid="Hi.Mapping.TimeMapping.MillingToolHouse">
MillingToolHouse
</h3>
<div class="markdown level1 summary"><p>Gets or sets the machining tool house containing available tools.
This is used to determine tool-specific parameters during mapping.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MachiningToolHouse MillingToolHouse { 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_Mapping_TimeMapping_RelFileToTimeShotListDictionary_" data-uid="Hi.Mapping.TimeMapping.RelFileToTimeShotListDictionary*"></a>
<h3 id="Hi_Mapping_TimeMapping_RelFileToTimeShotListDictionary" data-uid="Hi.Mapping.TimeMapping.RelFileToTimeShotListDictionary">
@@ -582,8 +474,8 @@ It matches the class name to maintain consistency between code and XML represent
<a id="Hi_Mapping_TimeMapping_CallTimeShotByRelFile_" data-uid="Hi.Mapping.TimeMapping.CallTimeShotByRelFile*"></a>
<h3 id="Hi_Mapping_TimeMapping_CallTimeShotByRelFile_System_String_System_Nullable_System_Threading_CancellationToken__" data-uid="Hi.Mapping.TimeMapping.CallTimeShotByRelFile(System.String,System.Nullable{System.Threading.CancellationToken})">
CallTimeShotByRelFile(string, CancellationToken?)
<h3 id="Hi_Mapping_TimeMapping_CallTimeShotByRelFile_System_String_Hi_Common_Messages_IMessageHost_System_Nullable_System_Threading_CancellationToken__" data-uid="Hi.Mapping.TimeMapping.CallTimeShotByRelFile(System.String,Hi.Common.Messages.IMessageHost,System.Nullable{System.Threading.CancellationToken})">
CallTimeShotByRelFile(string, IMessageHost, CancellationToken?)
</h3>
@@ -592,7 +484,7 @@ It matches the class name to maintain consistency between code and XML represent
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;ITimeShot&gt; CallTimeShotByRelFile(string relFile, CancellationToken? cancellationToken = null)</code></pre>
<pre><code class="lang-csharp hljs">public List&lt;ITimeShot&gt; CallTimeShotByRelFile(string relFile, IMessageHost messageHost, CancellationToken? cancellationToken = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -600,6 +492,8 @@ It matches the class name to maintain consistency between code and XML represent
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The relative path to the file containing time shots.</p>
</dd>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</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><p>Optional token to cancel the loading operation.</p>
</dd>
@@ -619,7 +513,7 @@ If the file is already being loaded by another thread, waits for that operation
<h4 class="section" id="Hi_Mapping_TimeMapping_CallTimeShotByRelFile_System_String_System_Nullable_System_Threading_CancellationToken___remarks">Remarks</h4>
<h4 class="section" id="Hi_Mapping_TimeMapping_CallTimeShotByRelFile_System_String_Hi_Common_Messages_IMessageHost_System_Nullable_System_Threading_CancellationToken___remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>This method is thread-safe and ensures each file is only read once, even with concurrent access.
Any exceptions during file reading are captured and can be inspected through the task's exception property.</p>
</div>
@@ -780,8 +674,8 @@ Any exceptions during file reading are captured and can be inspected through the
<a id="Hi_Mapping_TimeMapping_LoadTimeShotFiles_" data-uid="Hi.Mapping.TimeMapping.LoadTimeShotFiles*"></a>
<h3 id="Hi_Mapping_TimeMapping_LoadTimeShotFiles_System_Nullable_System_Threading_CancellationToken__" data-uid="Hi.Mapping.TimeMapping.LoadTimeShotFiles(System.Nullable{System.Threading.CancellationToken})">
LoadTimeShotFiles(CancellationToken?)
<h3 id="Hi_Mapping_TimeMapping_LoadTimeShotFiles_Hi_Common_Messages_IMessageHost_System_Nullable_System_Threading_CancellationToken__" data-uid="Hi.Mapping.TimeMapping.LoadTimeShotFiles(Hi.Common.Messages.IMessageHost,System.Nullable{System.Threading.CancellationToken})">
LoadTimeShotFiles(IMessageHost, CancellationToken?)
</h3>
@@ -790,11 +684,13 @@ Any exceptions during file reading are captured and can be inspected through the
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void LoadTimeShotFiles(CancellationToken? cancellationToken = null)</code></pre>
<pre><code class="lang-csharp hljs">public void LoadTimeShotFiles(IMessageHost messageHost, CancellationToken? cancellationToken = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</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><p>Optional cancellation token to cancel the operation.</p>
</dd>
@@ -867,8 +763,8 @@ Any exceptions during file reading are captured and can be inspected through the
<a id="Hi_Mapping_TimeMapping_Map_" data-uid="Hi.Mapping.TimeMapping.Map*"></a>
<h3 id="Hi_Mapping_TimeMapping_Map_Hi_Common_Range_System_Int32__Hi_Mappings_FileTimeSection_Hi_Mapping_StepTimeShotUtil_CycleSamplingMode_System_Nullable_System_Threading_CancellationToken__" data-uid="Hi.Mapping.TimeMapping.Map(Hi.Common.Range{System.Int32},Hi.Mappings.FileTimeSection,Hi.Mapping.StepTimeShotUtil.CycleSamplingMode,System.Nullable{System.Threading.CancellationToken})">
Map(Range&lt;int&gt;, FileTimeSection, CycleSamplingMode, CancellationToken?)
<h3 id="Hi_Mapping_TimeMapping_Map_Hi_Common_Range_System_Int32__Hi_Mappings_FileTimeSection_Hi_Mapping_StepTimeShotUtil_CycleSamplingMode_Hi_CutterLocations_ClStrips_ClStrip_Hi_Common_Messages_IMessageHost_System_Nullable_System_Threading_CancellationToken__" data-uid="Hi.Mapping.TimeMapping.Map(Hi.Common.Range{System.Int32},Hi.Mappings.FileTimeSection,Hi.Mapping.StepTimeShotUtil.CycleSamplingMode,Hi.CutterLocations.ClStrips.ClStrip,Hi.Common.Messages.IMessageHost,System.Nullable{System.Threading.CancellationToken})">
Map(Range&lt;int&gt;, FileTimeSection, CycleSamplingMode, ClStrip, IMessageHost, CancellationToken?)
</h3>
@@ -878,7 +774,7 @@ This method is thread-safe and can be called concurrently.</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Map(Range&lt;int&gt; stepSection, FileTimeSection relFileTimeSection, StepTimeShotUtil.CycleSamplingMode cycleSamplingMode, CancellationToken? cancellationToken = null)</code></pre>
<pre><code class="lang-csharp hljs">public void Map(Range&lt;int&gt; stepSection, FileTimeSection relFileTimeSection, StepTimeShotUtil.CycleSamplingMode cycleSamplingMode, ClStrip clStrip, IMessageHost messageHost, CancellationToken? cancellationToken = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -892,6 +788,10 @@ This method is thread-safe and can be called concurrently.</p>
<dt><code>cycleSamplingMode</code> <a class="xref" href="Hi.Mapping.StepTimeShotUtil.html">StepTimeShotUtil</a>.<a class="xref" href="Hi.Mapping.StepTimeShotUtil.CycleSamplingMode.html">CycleSamplingMode</a></dt>
<dd><p>The cycle sampling mode to use.</p>
</dd>
<dt><code>clStrip</code> <a class="xref" href="Hi.CutterLocations.ClStrips.ClStrip.html">ClStrip</a></dt>
<dd></dd>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</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><p>Optional cancellation token to cancel the operation.</p>
</dd>
@@ -910,8 +810,8 @@ This method is thread-safe and can be called concurrently.</p>
<a id="Hi_Mapping_TimeMapping_MapByActualTime_" data-uid="Hi.Mapping.TimeMapping.MapByActualTime*"></a>
<h3 id="Hi_Mapping_TimeMapping_MapByActualTime_System_String_Hi_Mapping_StepTimeShotUtil_CycleSamplingMode_Hi_MachiningProcs_SessionMessageHost_System_Nullable_System_Threading_CancellationToken__" data-uid="Hi.Mapping.TimeMapping.MapByActualTime(System.String,Hi.Mapping.StepTimeShotUtil.CycleSamplingMode,Hi.MachiningProcs.SessionMessageHost,System.Nullable{System.Threading.CancellationToken})">
MapByActualTime(string, CycleSamplingMode, SessionMessageHost, CancellationToken?)
<h3 id="Hi_Mapping_TimeMapping_MapByActualTime_System_String_Hi_Mapping_StepTimeShotUtil_CycleSamplingMode_Hi_CutterLocations_ClStrips_ClStrip_Hi_Common_Messages_IMessageHost_System_Nullable_System_Threading_CancellationToken__" data-uid="Hi.Mapping.TimeMapping.MapByActualTime(System.String,Hi.Mapping.StepTimeShotUtil.CycleSamplingMode,Hi.CutterLocations.ClStrips.ClStrip,Hi.Common.Messages.IMessageHost,System.Nullable{System.Threading.CancellationToken})">
MapByActualTime(string, CycleSamplingMode, ClStrip, IMessageHost, CancellationToken?)
</h3>
@@ -920,7 +820,7 @@ This method is thread-safe and can be called concurrently.</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void MapByActualTime(string timeShotRelFile, StepTimeShotUtil.CycleSamplingMode cycleSamplingMode, SessionMessageHost sessionMessageHost, CancellationToken? cancellationToken = null)</code></pre>
<pre><code class="lang-csharp hljs">public void MapByActualTime(string timeShotRelFile, StepTimeShotUtil.CycleSamplingMode cycleSamplingMode, ClStrip clStrip, IMessageHost messageHost, CancellationToken? cancellationToken = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -931,7 +831,9 @@ This method is thread-safe and can be called concurrently.</p>
<dt><code>cycleSamplingMode</code> <a class="xref" href="Hi.Mapping.StepTimeShotUtil.html">StepTimeShotUtil</a>.<a class="xref" href="Hi.Mapping.StepTimeShotUtil.CycleSamplingMode.html">CycleSamplingMode</a></dt>
<dd><p>The cycle sampling mode.</p>
</dd>
<dt><code>sessionMessageHost</code> <a class="xref" href="Hi.MachiningProcs.SessionMessageHost.html">SessionMessageHost</a></dt>
<dt><code>clStrip</code> <a class="xref" href="Hi.CutterLocations.ClStrips.ClStrip.html">ClStrip</a></dt>
<dd></dd>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>The session message host for logging.</p>
</dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a>?</dt>