HiNC-Deploy/HiNC-2025-win-desktop-Deploy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html
iamboss 4556281c0a tune
2025-12-22 23:35:40 +08:00

1266 lines
42 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class MachiningEquipment | HiAPI-C# 2025 </title>
<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..">
<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 &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<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.Machining.MachiningEquipmentUtils.MachiningEquipment">
<h1 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment" class="text-break">
Class MachiningEquipment
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Machining.html">Machining</a>.<a class="xref" href="Hi.Machining.MachiningEquipmentUtils.html">MachiningEquipmentUtils</a></dd></dl>
<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>
<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>
</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">MachiningEquipment</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<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>
<div><a class="xref" href="Hi.Mech.Topo.IGetAnchor.html">IGetAnchor</a></div>
<div><a class="xref" href="Hi.Mech.Topo.IGetTopoIndex.html">IGetTopoIndex</a></div>
<div><a class="xref" href="Hi.Mech.IGetMachiningChain.html">IGetMachiningChain</a></div>
<div><a class="xref" href="Hi.Machining.MachiningEquipmentUtils.IGetMachiningEquipment.html">IGetMachiningEquipment</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.Disp.DispUtil.html#Hi_Disp_DispUtil_Display_Hi_Disp_IDisplayee_Hi_Disp_Bind_Hi_Geom_Mat4d_">DispUtil.Display(IDisplayee, Bind, Mat4d)</a>
</div>
<div>
<a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_GetMcXyz_AttacherAtProgramZero_Hi_Machining_MachiningEquipmentUtils_IMachiningEquipment_">MachiningEquipmentUtil.GetMcXyz_AttacherAtProgramZero(IMachiningEquipment)</a>
</div>
<div>
<a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_GetMcXyz_AttacherAtTableBuckleZero_Hi_Machining_MachiningEquipmentUtils_IMachiningEquipment_">MachiningEquipmentUtil.GetMcXyz_AttacherAtTableBuckleZero(IMachiningEquipment)</a>
</div>
<div>
<a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipmentUtil_RunByStep_Hi_Machining_MachiningEquipmentUtils_IMachiningEquipment_Hi_NcStepUtils_INcStep0_Hi_Machining_MachiningToolHouse_">MachiningEquipmentUtil.RunByStep(IMachiningEquipment, INcStep0, MachiningToolHouse)</a>
</div>
<div>
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate&lt;TSelf&gt;(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&lt;TSrc&gt;(TSrc, Action&lt;TSrc&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke&lt;TSrc, TDst&gt;(TSrc, Func&lt;TSrc, TDst&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Mech.Topo.TopoUtil.html#Hi_Mech_Topo_TopoUtil_Display_Hi_Mech_Topo_IGetAnchor_Hi_Disp_Bind_System_Collections_Generic_Dictionary_Hi_Mech_Topo_Anchor_Hi_Geom_Mat4d__">TopoUtil.Display(IGetAnchor, Bind, Dictionary&lt;Anchor, Mat4d&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Mech.Topo.TopoUtil.html#Hi_Mech_Topo_TopoUtil_ExpandToBox3d_Hi_Mech_Topo_IGetAnchor_Hi_Geom_Box3d_System_Collections_Generic_Dictionary_Hi_Mech_Topo_Anchor_Hi_Geom_Mat4d__">TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary&lt;Anchor, Mat4d&gt;)</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 class="section" id="constructors">Constructors
</h2>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment__ctor_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.#ctor*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment__ctor" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.#ctor">
MachiningEquipment()
</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 MachiningEquipment()</code></pre>
</div>
<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_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.#ctor(System.Xml.Linq.XElement,System.String,System.String)">
MachiningEquipment(XElement, string, string)
</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)</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>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_Asmb_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.Asmb*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_Asmb" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.Asmb">
Asmb
</h3>
<div class="markdown level1 summary"><p><a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_Asmb">Asmb</a> of the entire equipment.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Asmb Asmb { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Mech.Topo.Asmb.html">Asmb</a></dt>
<dd></dd>
</dl>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_BackgroundTemperature_C_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.BackgroundTemperature_C*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_BackgroundTemperature_C" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.BackgroundTemperature_C">
BackgroundTemperature_C
</h3>
<div class="markdown level1 summary"><p>Gets or sets the background temperature in Celsius.
This is a convenience property that converts between Celsius and Kelvin.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double BackgroundTemperature_C { 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.double">double</a></dt>
<dd></dd>
</dl>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_BackgroundTemperature_K_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.BackgroundTemperature_K*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_BackgroundTemperature_K" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.BackgroundTemperature_K">
BackgroundTemperature_K
</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>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double BackgroundTemperature_K { 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.double">double</a></dt>
<dd></dd>
</dl>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_CoolantHeatCondition_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.CoolantHeatCondition*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_CoolantHeatCondition" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.CoolantHeatCondition">
CoolantHeatCondition
</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>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CoolantHeatCondition CoolantHeatCondition { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Physics.CoolantHeatCondition.html">CoolantHeatCondition</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">
Fixture
</h3>
<div class="markdown level1 summary"><p>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_Machining_MachiningEquipmentUtils_MachiningEquipment_MachiningChain_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.MachiningChain*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_MachiningChain" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.MachiningChain">
MachiningChain
</h3>
<div class="markdown level1 summary"><p>Body of the equipment.</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_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">
MachiningTool
</h3>
<div class="markdown level1 summary"><p>Milling 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_Machining_MachiningEquipmentUtils_MachiningEquipment_SpindleCapability_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.SpindleCapability*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_SpindleCapability" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.SpindleCapability">
SpindleCapability
</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>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SpindleCapability SpindleCapability { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Milling.SpindleCapability.html">SpindleCapability</a></dt>
<dd></dd>
</dl>
<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">
TableToComp
</h3>
<div class="markdown level1 summary"><p>Transformer of the branch from table buckle to workpiece side buckle.
Note that the workpiece side buckle links to <a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_Fixture">Fixture</a> if fixture exist;
otherwise, it links to <a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_Workpiece">Workpiece</a> if workpiece exist.
If <a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_Workpiece">Workpiece</a> either <a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_Fixture">Fixture</a> do not exist, this property makes no effect.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ITransformer TableToComp { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></dt>
<dd></dd>
</dl>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_Workpiece_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.Workpiece*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_Workpiece" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.Workpiece">
Workpiece
</h3>
<div class="markdown level1 summary"><p>Workpiece.</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>
<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>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_Detect_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.Detect*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_Detect_System_Boolean_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.Detect(System.Boolean)">
Detect(bool)
</h3>
<div class="markdown level1 summary"><p>Performs collision detection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MechCollisionResult Detect(bool addFluteAndWorkpieceDetection)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>addFluteAndWorkpieceDetection</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>Whether to include flute and workpiece in detection.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Collision.MechCollisionResult.html">MechCollisionResult</a></dt>
<dd><p>Significant collision result.</p>
</dd>
</dl>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_Display_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.Display*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_Display_Hi_Disp_Bind_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.Display(Hi.Disp.Bind)">
Display(Bind)
</h3>
<div class="markdown level1 summary"><p>Display function called in <a class="xref" href="Hi.Disp.DispEngine.html">DispEngine</a> rendering loop.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Display(Bind bind)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>bind</code> <a class="xref" href="Hi.Disp.Bind.html">Bind</a></dt>
<dd><p>Bind with <a class="xref" href="Hi.Disp.DispEngine.html">DispEngine</a>. See <a class="xref" href="Hi.Disp.Bind.html">Bind</a>.</p>
</dd>
</dl>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_ExpandToBox3d_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.ExpandToBox3d*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_ExpandToBox3d_Hi_Geom_Box3d_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.ExpandToBox3d(Hi.Geom.Box3d)">
ExpandToBox3d(Box3d)
</h3>
<div class="markdown level1 summary"><p>Expands the destination box.
This function is usually used to compute the bounding box of elements.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void ExpandToBox3d(Box3d dst)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>dst</code> <a class="xref" href="Hi.Geom.Box3d.html">Box3d</a></dt>
<dd><p>Destination box</p>
</dd>
</dl>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_GetAnchor_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.GetAnchor*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_GetAnchor" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.GetAnchor">
GetAnchor()
</h3>
<div class="markdown level1 summary"><p>Get key anchor. (i.e. root anchor)</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Anchor GetAnchor()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Mech.Topo.Anchor.html">Anchor</a></dt>
<dd><p>key anchor</p>
</dd>
</dl>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_GetAnchoredDisplayeeList_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.GetAnchoredDisplayeeList*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_GetAnchoredDisplayeeList" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.GetAnchoredDisplayeeList">
GetAnchoredDisplayeeList()
</h3>
<div class="markdown level1 summary"><p>Gets a list of anchored displayable objects.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;IAnchoredDisplayee&gt; GetAnchoredDisplayeeList()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="Hi.Mech.Topo.IAnchoredDisplayee.html">IAnchoredDisplayee</a>&gt;</dt>
<dd><p>A list of <a class="xref" href="Hi.Mech.Topo.IAnchoredDisplayee.html">IAnchoredDisplayee</a> objects</p>
</dd>
</dl>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_GetAsmb_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.GetAsmb*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_GetAsmb" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.GetAsmb">
GetAsmb()
</h3>
<div class="markdown level1 summary"><p>Gets the key asmb.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Asmb GetAsmb()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Mech.Topo.Asmb.html">Asmb</a></dt>
<dd><p>The key asmb.</p>
</dd>
</dl>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_GetMachiningChain_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.GetMachiningChain*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_GetMachiningChain" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.GetMachiningChain">
GetMachiningChain()
</h3>
<div class="markdown level1 summary"><p>Gets the machining chain instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IMachiningChain GetMachiningChain()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Mech.IMachiningChain.html">IMachiningChain</a></dt>
<dd><p>The machining chain instance.</p>
</dd>
</dl>
<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>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_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">
GetProgramCl()
</h3>
<div class="markdown level1 summary"><p>Get CL (Cutter Location).
Where <a class="xref" href="Hi.Geom.DVec3d.html#Hi_Geom_DVec3d_Point">Point</a> is tool tip position; <a class="xref" href="Hi.Geom.DVec3d.html#Hi_Geom_DVec3d_Normal">Normal</a> is tool orientation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public DVec3d GetProgramCl()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Geom.DVec3d.html">DVec3d</a></dt>
<dd><p>CL</p>
</dd>
</dl>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_GetToolTipXyzOnProgramZero_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.GetToolTipXyzOnProgramZero*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_GetToolTipXyzOnProgramZero" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.GetToolTipXyzOnProgramZero">
GetToolTipXyzOnProgramZero()
</h3>
<div class="markdown level1 summary"><p>Get tool tip xyz from workpiece geom anchor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Vec3d GetToolTipXyzOnProgramZero()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a></dt>
<dd><p>if no <a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_MachiningTool">MachiningTool</a> or no <a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_Workpiece">Workpiece</a> equiping, return null;
otherwise, return the XYZ from workpiece geomanchor to tool tip.</p>
</dd>
</dl>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_GetTransformFromRootToProgramZero_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.GetTransformFromRootToProgramZero*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_GetTransformFromRootToProgramZero" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.GetTransformFromRootToProgramZero">
GetTransformFromRootToProgramZero()
</h3>
<div class="markdown level1 summary"><p>Gets the transform matrix from the root coordinate system to the program zero coordinate system.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Mat4d GetTransformFromRootToProgramZero()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Geom.Mat4d.html">Mat4d</a></dt>
<dd><p>A 4x4 transformation matrix representing the coordinate system transformation.</p>
</dd>
</dl>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_MakeXmlSource_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.MakeXmlSource*"></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>
<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>
<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>
</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>
</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>
</dd>
</dl>
<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>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_PrepareCollidableItems_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.PrepareCollidableItems*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_PrepareCollidableItems" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.PrepareCollidableItems">
PrepareCollidableItems()
</h3>
<div class="markdown level1 summary"><p>Prepares all collidable items for collision detection.
This method should be called before performing collision detection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void PrepareCollidableItems()</code></pre>
</div>
<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">
ResetCollisionFlags()
</h3>
<div class="markdown level1 summary"><p>Resets all collision flags to their default states.
This should be called after collision detection is complete.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void ResetCollisionFlags()</code></pre>
</div>
<a id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_Tooling_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.Tooling*"></a>
<h3 id="Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_Tooling_System_Int32_Hi_Machining_MachiningToolHouse_" data-uid="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.Tooling(System.Int32,Hi.Machining.MachiningToolHouse)">
Tooling(int, MachiningToolHouse)
</h3>
<div class="markdown level1 summary"><p>Set <a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_MachiningTool">MachiningTool</a> by <code class="paramref">toolId</code> and <code class="paramref">toolHouse</code>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool Tooling(int toolId, MachiningToolHouse toolHouse)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>toolId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>tool ID</p>
</dd>
<dt><code>toolHouse</code> <a class="xref" href="Hi.Machining.MachiningToolHouse.html">MachiningToolHouse</a></dt>
<dd><p>tool house</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>true if tool changed; otherwise, false.</p>
</dd>
</dl>
<h4 class="section">Exceptions</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Machining.ToolNotFoundException.html">ToolNotFoundException</a></dt>
<dd><p>Throw If <code class="paramref">toolId</code> does not exist on <code class="paramref">toolHouse</code>.</p>
</dd>
</dl>
</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>
Reference in New Issue View Git Blame Copy Permalink