HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.NcParsers.Keywords.IRadiusCompensationDef.html

336 lines
12 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Interface IRadiusCompensationDef | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Interface IRadiusCompensationDef | HiAPI-C# 2025 ">
<meta name="description" content="Radius compensation state written by . Property names are used as JSON keys via nameof. Managed commands (ISO): G41 (left), G42 (right), G40 (cancel). Heidenhain Klartext maps RL → G41, RR → G42, R0 → G40. When active, the tool path is offset perpendicular to the programmed path by ; determines left vs right. The root ProgramXyz retains the user-programmed position; MachineCoordinate is overwritten to reflect the compensated path.">
<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.NcParsers.Keywords.IRadiusCompensationDef">
<h1 id="Hi_NcParsers_Keywords_IRadiusCompensationDef" data-uid="Hi.NcParsers.Keywords.IRadiusCompensationDef" class="text-break">
Interface IRadiusCompensationDef
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcParsers.html">NcParsers</a>.<a class="xref" href="Hi.NcParsers.Keywords.html">Keywords</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>Radius compensation state written by
<a class="xref" href="Hi.NcParsers.PostLogicSyntaxs.RadiusCompensationSyntax.html">RadiusCompensationSyntax</a>.
Property names are used as JSON keys via <code>nameof</code>.</p>
<p>
Managed commands (ISO): G41 (left), G42 (right), G40 (cancel).
Heidenhain Klartext maps RL → G41, RR → G42, R0 → G40.
When active, the tool path is offset perpendicular to the programmed path
by <a class="xref" href="Hi.NcParsers.Keywords.IRadiusCompensationDef.html#Hi_NcParsers_Keywords_IRadiusCompensationDef_Radius_mm">Radius_mm</a>; <a class="xref" href="Hi.NcParsers.Keywords.IRadiusCompensationDef.html#Hi_NcParsers_Keywords_IRadiusCompensationDef_Side">Side</a> determines left vs right.
The root <code>ProgramXyz</code> retains the user-programmed position;
<code>MachineCoordinate</code> is overwritten to reflect the compensated path.
</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IRadiusCompensationDef</code></pre>
</div>
<dl class="typelist extensionMethods">
<dt>Extension Methods</dt>
<dd>
<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.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 id="Hi_NcParsers_Keywords_IRadiusCompensationDef_examples">Examples</h2>
<p>Active (G41 D5, radius 2.5 mm):</p>
<pre><code class="lang-csharp">"RadiusCompensation": {
"Side": "Left",
"Term": "G41",
"OffsetId": 5,
"Radius_mm": 2.5
}</code></pre>
<p>Cancelled (G40, modal D preserved):</p>
<pre><code class="lang-csharp">"RadiusCompensation": {
"Side": "None",
"Term": "G40",
"OffsetId": 5
}</code></pre>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_NcParsers_Keywords_IRadiusCompensationDef_OffsetId_" data-uid="Hi.NcParsers.Keywords.IRadiusCompensationDef.OffsetId*"></a>
<h3 id="Hi_NcParsers_Keywords_IRadiusCompensationDef_OffsetId" data-uid="Hi.NcParsers.Keywords.IRadiusCompensationDef.OffsetId">
OffsetId
</h3>
<div class="markdown level1 summary"><p>Offset number (Fanuc D number) selecting the radius in the tool offset table.
Modal — preserved across G40 blocks so the next G41/G42 without an explicit
D continues to reference the same row, matching real Fanuc/Siemens behaviour.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">int OffsetId { 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.int32">int</a></dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_Keywords_IRadiusCompensationDef_Radius_mm_" data-uid="Hi.NcParsers.Keywords.IRadiusCompensationDef.Radius_mm*"></a>
<h3 id="Hi_NcParsers_Keywords_IRadiusCompensationDef_Radius_mm" data-uid="Hi.NcParsers.Keywords.IRadiusCompensationDef.Radius_mm">
Radius_mm
</h3>
<div class="markdown level1 summary"><p>Unsigned compensation radius in mm, looked up from the tool offset table.
Real controller tool tables hold the radius as a non-negative geometry
value (wear/delta sits in a separate column); this property mirrors that
convention. Direction is encoded by <a class="xref" href="Hi.NcParsers.Keywords.IRadiusCompensationDef.html#Hi_NcParsers_Keywords_IRadiusCompensationDef_Side">Side</a>.
Omitted from the JSON section when <a class="xref" href="Hi.NcParsers.Keywords.IRadiusCompensationDef.html#Hi_NcParsers_Keywords_IRadiusCompensationDef_Side">Side</a> is
<a class="xref" href="Hi.NcParsers.Keywords.RadiusCompensation.html#Hi_NcParsers_Keywords_RadiusCompensation_SideNone">SideNone</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">double Radius_mm { 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_NcParsers_Keywords_IRadiusCompensationDef_Side_" data-uid="Hi.NcParsers.Keywords.IRadiusCompensationDef.Side*"></a>
<h3 id="Hi_NcParsers_Keywords_IRadiusCompensationDef_Side" data-uid="Hi.NcParsers.Keywords.IRadiusCompensationDef.Side">
Side
</h3>
<div class="markdown level1 summary"><p>Compensation direction: <a class="xref" href="Hi.NcParsers.Keywords.RadiusCompensation.html#Hi_NcParsers_Keywords_RadiusCompensation_SideNone">SideNone</a>,
<a class="xref" href="Hi.NcParsers.Keywords.RadiusCompensation.html#Hi_NcParsers_Keywords_RadiusCompensation_SideLeft">SideLeft</a>, or
<a class="xref" href="Hi.NcParsers.Keywords.RadiusCompensation.html#Hi_NcParsers_Keywords_RadiusCompensation_SideRight">SideRight</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">string Side { 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_NcParsers_Keywords_IRadiusCompensationDef_Term_" data-uid="Hi.NcParsers.Keywords.IRadiusCompensationDef.Term*"></a>
<h3 id="Hi_NcParsers_Keywords_IRadiusCompensationDef_Term" data-uid="Hi.NcParsers.Keywords.IRadiusCompensationDef.Term">
Term
</h3>
<div class="markdown level1 summary"><p>CNC term: &ldquo;G41&rdquo;, &ldquo;G42&rdquo;, or &ldquo;G40&rdquo;.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">string Term { 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>
</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>