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

deploy.

Browse Source
This commit is contained in:
iamboss
2026-09-09 17:35:23 +08:00
parent 2a98ae7556
commit 161af68fe3
1271 changed files with 58251 additions and 98639 deletions
Download Patch File Download Diff File Expand all files Collapse all files
App/wwwroot/HiAPI-docsite/api/Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html
+30 -276
View File
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class MachiningEquipment | HiAPI-C# 2025 ">
<meta name="description" content="Machining Equipment. Include the machining chain, workpiece, tool and fixture, etc..">
<meta name="description" content="The runtime (execution) face of the machining equipment: the topology instance the runner drives — tool-change graph surgery, collision detection, live axis poses. Materialised from the authored face () and NEVER serialized: runtime data cannot reach the project file by construction.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,12 +97,16 @@ Class MachiningEquipment
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>Machining Equipment. Include the machining chain, workpiece, tool and fixture, etc..</p>
<div class="markdown summary"><p>The runtime (execution) face of the machining equipment: the topology
instance the runner drives — tool-change graph surgery, collision
detection, live axis poses. Materialised from the authored face
(<a class="xref" href="Hi.Machining.MachiningEquipmentUtils.SetupEquipment.html#Hi_Machining_MachiningEquipmentUtils_SetupEquipment_MaterialiseMachiningEquipment_System_String_System_IProgress_Hi_Common_Messages_IMessage__">MaterialiseMachiningEquipment(string, IProgress&lt;IMessage&gt;)</a>) and NEVER
serialized: runtime data cannot reach the project file by construction.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class MachiningEquipment : IMachiningEquipment, IDisplayee, IExpandToBox3d, IMakeXmlSource, IGetAnchoredDisplayeeList, IGetProgramCl, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetMachiningChain, IGetMachiningEquipment</code></pre>
<pre><code class="lang-csharp hljs">public class MachiningEquipment : IMachiningEquipment, IDisplayee, IExpandToBox3d, IGetAnchoredDisplayeeList, IGetProgramCl, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetMachiningChain, IGetMachiningEquipment</code></pre>
</div>
@@ -122,7 +126,6 @@ Class MachiningEquipment
<div><a class="xref" href="Hi.Machining.MachiningEquipmentUtils.IMachiningEquipment.html">IMachiningEquipment</a></div>
<div><a class="xref" href="Hi.Disp.IDisplayee.html">IDisplayee</a></div>
<div><a class="xref" href="Hi.Geom.IExpandToBox3d.html">IExpandToBox3d</a></div>
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
<div><a class="xref" href="Hi.Mech.Topo.IGetAnchoredDisplayeeList.html">IGetAnchoredDisplayeeList</a></div>
<div><a class="xref" href="Hi.CutterLocations.IGetProgramCl.html">IGetProgramCl</a></div>
<div><a class="xref" href="Hi.Mech.Topo.IGetAsmb.html">IGetAsmb</a></div>
@@ -245,48 +248,6 @@ Class MachiningEquipment
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment__ctor_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.#ctor*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_Hi_Common_Messages_IMessage__" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{Hi.Common.Messages.IMessage})">
MachiningEquipment(XElement, string, string, IProgress&lt;IMessage&gt;)
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html">MachiningEquipment</a> class from XML data.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MachiningEquipment(XElement src, string baseDirectory, string relFile, IProgress&lt;IMessage&gt; progress)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<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 equipment configuration.</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>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The relative file path for XML serialization.</p>
</dd>
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a>&lt;<a class="xref" href="Hi.Common.Messages.IMessage.html">IMessage</a>&gt;</dt>
<dd><p>Progress reporter for diagnostic messages emitted during construction.</p>
</dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
@@ -363,8 +324,9 @@ This is a convenience property that converts between Celsius and Kelvin.</p>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the background temperature in Kelvin.
This represents the ambient temperature of the machining environment.</p>
<div class="markdown level1 summary"><p>Gets or sets the background temperature in Kelvin. Runtime-stamped
from the authored face at materialise; the authored value's home is
<a class="xref" href="Hi.Machining.MachiningEquipmentUtils.SetupEquipment.html#Hi_Machining_MachiningEquipmentUtils_SetupEquipment_BackgroundTemperature_K">BackgroundTemperature_K</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -396,8 +358,10 @@ This represents the ambient temperature of the machining environment.</p>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the coolant heat condition settings.
This includes coolant temperature and heat transfer coefficients.</p>
<div class="markdown level1 summary"><p>Gets or sets the coolant heat condition settings. Runtime-stamped from
the authored face at materialise (shared reference — the runtime only
reads it); the authored home is
<a class="xref" href="Hi.Machining.MachiningEquipmentUtils.SetupEquipment.html#Hi_Machining_MachiningEquipmentUtils_SetupEquipment_CoolantHeatCondition">CoolantHeatCondition</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -422,41 +386,6 @@ This includes coolant temperature and heat transfer coefficients.</p>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_CoolantHeatConditionFile_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.CoolantHeatConditionFile*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_CoolantHeatConditionFile" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.CoolantHeatConditionFile">
CoolantHeatConditionFile
</h3>
<div class="markdown level1 summary"><p>Gets or sets the file path of the coolant heat condition
(WorkpieceMaterial pattern: when set, XML IO externalizes
<a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_CoolantHeatCondition">CoolantHeatCondition</a> to this side-file; when null the
condition serializes inline).</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string CoolantHeatConditionFile { 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_Machining_MachiningEquipmentUtils_MachiningEquipment_Fixture_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.Fixture*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_Fixture" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.Fixture">
@@ -521,39 +450,6 @@ condition serializes inline).</p>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_MachiningChainFile_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.MachiningChainFile*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_MachiningChainFile" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.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_Machining_MachiningEquipmentUtils_MachiningEquipment_MachiningTool_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.MachiningTool*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_MachiningTool" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.MachiningTool">
@@ -593,8 +489,10 @@ This is used for XML serialization and file management.</p>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the spindle capability configuration.
This defines the operational capabilities and limits of the spindle.</p>
<div class="markdown level1 summary"><p>Gets or sets the spindle capability configuration. Runtime-stamped from
the authored face at materialise (shared reference — the runtime only
reads it); the authored home is
<a class="xref" href="Hi.Machining.MachiningEquipmentUtils.SetupEquipment.html#Hi_Machining_MachiningEquipmentUtils_SetupEquipment_SpindleCapability">SpindleCapability</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -619,39 +517,6 @@ This defines the operational capabilities and limits of the spindle.</p>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_SpindleCapabilityFile_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.SpindleCapabilityFile*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_SpindleCapabilityFile" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.SpindleCapabilityFile">
SpindleCapabilityFile
</h3>
<div class="markdown level1 summary"><p>Gets or sets the file path of the spindle capability configuration.
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 SpindleCapabilityFile { 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_Machining_MachiningEquipmentUtils_MachiningEquipment_TableToComp_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.TableToComp*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_TableToComp" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.TableToComp">
@@ -751,38 +616,6 @@ If <a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_XName_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.XName*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_XName" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.XName">
XName
</h3>
<div class="markdown level1 summary"><p>Name for XML IO.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string XName { 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>
<h2 class="section" id="methods">Methods
</h2>
@@ -1032,7 +865,7 @@ This function is usually used to compute the bounding box of elements.</p>
</h3>
<div class="markdown level1 summary"><p>Get <a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html">MachiningEquipment</a>.</p>
<div class="markdown level1 summary"><p>Get the runtime <a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html">MachiningEquipment</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -1058,42 +891,6 @@ This function is usually used to compute the bounding box of elements.</p>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_GetMillingEquipment_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.GetMillingEquipment*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_GetMillingEquipment" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.GetMillingEquipment">
GetMillingEquipment()
</h3>
<div class="markdown level1 summary"><p>Source-compatible delegate for callers written against the pre-rename
name — the interface's default member is not reachable through a
concrete-typed reference, so it is restated here.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Obsolete(&quot;Renamed to GetMachiningEquipment.&quot;)]
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>This equipment.</p>
</dd>
</dl>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_GetProgramCl_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.GetProgramCl*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_GetProgramCl" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.GetProgramCl">
@@ -1195,39 +992,34 @@ otherwise, return the XYZ from workpiece geomanchor to tool tip.</p>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_MakeXmlSource_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.MakeXmlSource*"></a>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_IsCollisionRed_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.IsCollisionRed*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.MakeXmlSource(System.String,System.String,System.Boolean)">
MakeXmlSource(string, string, bool)
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_IsCollisionRed_System_Object_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.IsCollisionRed(System.Object)">
IsCollisionRed(object)
</h3>
<div class="markdown level1 summary"><p>Creates an XML representation of the object.
This method may also generate additional resources such as related files.</p>
<div class="markdown level1 summary"><p>Whether the latest <a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_Detect_System_Boolean_">Detect(bool)</a> pass flagged
<code class="paramref">item</code> as colliding. Display paths use this through
<a class="xref" href="Hi.NcMech.Solids.CollisionRedScope.html">CollisionRedScope</a> to paint the part red.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)</code></pre>
<pre><code class="lang-csharp hljs">public bool IsCollisionRed(object item)</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>The base directory for resolving relative paths</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>
<dt><code>item</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>A displayed item (typically a <a class="xref" href="Hi.NcMech.Solids.Solid.html">Solid</a>).</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
<dd><p>An XML element representing the object's state</p>
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>true if the item is currently collision-red.</p>
</dd>
</dl>
@@ -1237,11 +1029,6 @@ This method may also generate additional resources such as related files.</p>
<h4 class="section" id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_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>
@@ -1274,39 +1061,6 @@ This method should be called before performing collision detection.</p>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_Reg_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.Reg*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_Reg_Hi_Common_XmlUtils_XFactory_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.Reg(Hi.Common.XmlUtils.XFactory)">
Reg(XFactory)
</h3>
<div class="markdown level1 summary"><p>Registers this type's deserializer with the given <a class="xref" href="Hi.Common.XmlUtils.XFactory.html">XFactory</a>
and chains <code>Reg(factory)</code> on dependents. Idempotent.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void Reg(XFactory factory = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>factory</code> <a class="xref" href="Hi.Common.XmlUtils.XFactory.html">XFactory</a></dt>
<dd></dd>
</dl>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_ResetCollisionFlags_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.ResetCollisionFlags*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_ResetCollisionFlags" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.ResetCollisionFlags">