This commit is contained in:
2025-11-05 02:26:02 +08:00
parent 83745faed9
commit 1bc680a51a
36 changed files with 689 additions and 689 deletions
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class TimeMapping | HiAPI-C# 2025 ">
<meta name="description" content="Provides mapping between machining steps and time-based measurements (shots), with support for XML serialization and asynchronous loading of measurement data.">
<meta name="description" content="Provides mapping between machining steps and time-based measurements (shots),">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,8 +97,7 @@ Class TimeMapping
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>Provides mapping between machining steps and time-based measurements (shots),
with support for XML serialization and asynchronous loading of measurement data.</p>
<div class="markdown summary"><p>Provides mapping between machining steps and time-based measurements (shots),</p>
</div>
<div class="markdown conceptual"></div>
@@ -188,8 +187,8 @@ with support for XML serialization and asynchronous loading of measurement data.
<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_String_" data-uid="Hi.Mapping.TimeMapping.#ctor(Hi.CutterLocations.ClStrips.ClStrip,Hi.Machining.MachiningToolHouse,System.String)">
TimeMapping(ClStrip, MachiningToolHouse, string)
<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>
@@ -198,7 +197,7 @@ with support for XML serialization and asynchronous loading of measurement data.
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TimeMapping(ClStrip clStrip, MachiningToolHouse millingToolHouse, string baseDirectory)</code></pre>
<pre><code class="lang-csharp hljs">public TimeMapping(ClStrip clStrip, MachiningToolHouse millingToolHouse, Func&lt;string&gt; baseDirectoryGetter)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -209,9 +208,8 @@ with support for XML serialization and asynchronous loading of measurement data.
<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>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The base directory for file paths.</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></dd>
</dl>
@@ -227,8 +225,8 @@ with support for XML serialization and asynchronous loading of measurement data.
<a id="Hi_Mapping_TimeMapping__ctor_" data-uid="Hi.Mapping.TimeMapping.#ctor*"></a>
<h3 id="Hi_Mapping_TimeMapping__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.Mapping.TimeMapping.#ctor(System.Xml.Linq.XElement,System.String)">
TimeMapping(XElement, string)
<h3 id="Hi_Mapping_TimeMapping__ctor_System_Xml_Linq_XElement_System_Func_System_String__" data-uid="Hi.Mapping.TimeMapping.#ctor(System.Xml.Linq.XElement,System.Func{System.String})">
TimeMapping(XElement, Func&lt;string&gt;)
</h3>
@@ -237,7 +235,7 @@ with support for XML serialization and asynchronous loading of measurement data.
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TimeMapping(XElement src, string baseDirectory)</code></pre>
<pre><code class="lang-csharp hljs">public TimeMapping(XElement src, Func&lt;string&gt; baseDirectoryGetter)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -245,9 +243,8 @@ with support for XML serialization and asynchronous loading of measurement data.
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
<dd><p>The XML element containing the mapping data.</p>
</dd>
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The base directory for resolving relative file paths.</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></dd>
</dl>
@@ -257,7 +254,7 @@ with support for XML serialization and asynchronous loading of measurement data.
<h4 class="section" id="Hi_Mapping_TimeMapping__ctor_System_Xml_Linq_XElement_System_String__remarks">Remarks</h4>
<h4 class="section" id="Hi_Mapping_TimeMapping__ctor_System_Xml_Linq_XElement_System_Func_System_String___remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>This constructor supports legacy XML formats and automatically converts them to the current format.
Legacy formats include:</p>
<ul>
@@ -286,7 +283,7 @@ All relative file paths in the mapping are resolved against this directory.</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string BaseDirectory { get; set; }</code></pre>
<pre><code class="lang-csharp hljs">public string BaseDirectory { get; }</code></pre>
</div>
@@ -306,6 +303,37 @@ All relative file paths in the mapping are resolved against this directory.</p>
<a id="Hi_Mapping_TimeMapping_BaseDirectoryGetter_" data-uid="Hi.Mapping.TimeMapping.BaseDirectoryGetter*"></a>
<h3 id="Hi_Mapping_TimeMapping_BaseDirectoryGetter" data-uid="Hi.Mapping.TimeMapping.BaseDirectoryGetter">
BaseDirectoryGetter
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Func&lt;string&gt; BaseDirectoryGetter { 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.func-1">Func</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd></dd>
</dl>
<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">
@@ -877,6 +905,43 @@ 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_Hi_Common_Range_System_Int32__System_String_Hi_Mapping_StepTimeShotUtil_CycleSamplingMode_System_Nullable_System_Threading_CancellationToken__" data-uid="Hi.Mapping.TimeMapping.MapByActualTime(Hi.Common.Range{System.Int32},System.String,Hi.Mapping.StepTimeShotUtil.CycleSamplingMode,System.Nullable{System.Threading.CancellationToken})">
MapByActualTime(Range&lt;int&gt;, string, CycleSamplingMode, 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 MapByActualTime(Range&lt;int&gt; stepSection, string timeShotRelFile, StepTimeShotUtil.CycleSamplingMode cycleSamplingMode, CancellationToken? cancellationToken = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>stepSection</code> <a class="xref" href="Hi.Common.Range-1.html">Range</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>&gt;</dt>
<dd></dd>
<dt><code>timeShotRelFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<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></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_Mapping_TimeMapping_WaitMapping_" data-uid="Hi.Mapping.TimeMapping.WaitMapping*"></a>
<h3 id="Hi_Mapping_TimeMapping_WaitMapping" data-uid="Hi.Mapping.TimeMapping.WaitMapping">