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.NcParsers.Dependencys.ControllerParameterTableBase.html

939 lines
33 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class ControllerParameterTableBase | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class ControllerParameterTableBase | HiAPI-C# 2025 ">
<meta name="description" content="Base class for brand-specific controller parameter tables. Provides shared data structures, XML IO, and implementations. Subclasses define brand-specific parameter numbers, XML attribute names, and derived convenience properties.">
<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.Dependencys.ControllerParameterTableBase">
<h1 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase" class="text-break">
Class ControllerParameterTableBase
</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.Dependencys.html">Dependencys</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>Base class for brand-specific controller parameter tables.
Provides shared data structures, XML IO, and <a class="xref" href="Hi.NcParsers.Dependencys.IHomeMcConfig.html">IHomeMcConfig</a></p>
<ul>
<li><a class="xref" href="Hi.NcParsers.Dependencys.IMachineAxisConfig.html">IMachineAxisConfig</a> implementations.
Subclasses define brand-specific parameter numbers, XML attribute names,
and derived convenience properties.</li>
</ul>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract class ControllerParameterTableBase : IHomeMcConfig, IMachineAxisConfig, IRapidFeedrateConfig, INcDependency, IMakeXmlSource</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">ControllerParameterTableBase</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="Hi.NcParsers.Dependencys.IHomeMcConfig.html">IHomeMcConfig</a></div>
<div><a class="xref" href="Hi.NcParsers.Dependencys.IMachineAxisConfig.html">IMachineAxisConfig</a></div>
<div><a class="xref" href="Hi.NcParsers.Dependencys.IRapidFeedrateConfig.html">IRapidFeedrateConfig</a></div>
<div><a class="xref" href="Hi.NcParsers.Dependencys.INcDependency.html">INcDependency</a></div>
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
</dd>
</dl>
<dl class="typelist derived">
<dt>Derived</dt>
<dd>
<div><a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.html">FanucParameterTable</a></div>
<div><a class="xref" href="Hi.NcParsers.Dependencys.Heidenhain.HeidenhainParameterTable.html">HeidenhainParameterTable</a></div>
<div><a class="xref" href="Hi.NcParsers.Dependencys.Siemens.SiemensMachineDataTable.html">SiemensMachineDataTable</a></div>
<div><a class="xref" href="Hi.NcParsers.Dependencys.Syntec.SyntecParameterTable.html">SyntecParameterTable</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.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 class="section" id="properties">Properties
</h2>
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_AxisNames_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.AxisNames*"></a>
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_AxisNames" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.AxisNames">
AxisNames
</h3>
<div class="markdown level1 summary"><p>Gets the configured axis names in order.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IEnumerable&lt;string&gt; AxisNames { 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.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_AxisParams_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.AxisParams*"></a>
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_AxisParams" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.AxisParams">
AxisParams
</h3>
<div class="markdown level1 summary"><p>Per-axis float parameters. Outer key = parameter number, inner key = axis name.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Dictionary&lt;int, Dictionary&lt;string, double&gt;&gt; AxisParams { 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.collections.generic.dictionary-2">Dictionary</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.dictionary-2">Dictionary</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>&gt;&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_AxisTypeParamId_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.AxisTypeParamId*"></a>
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_AxisTypeParamId" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.AxisTypeParamId">
AxisTypeParamId
</h3>
<div class="markdown level1 summary"><p>Parameter/MD/MP number for axis type (linear/rotary/spindle).</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected abstract int AxisTypeParamId { 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.int32">int</a></dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_IdAttributeName_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.IdAttributeName*"></a>
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_IdAttributeName" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.IdAttributeName">
IdAttributeName
</h3>
<div class="markdown level1 summary"><p>XML attribute name for the parameter ID (&ldquo;ParamId&rdquo;, &ldquo;MdId&rdquo;, &ldquo;MpId&rdquo;).</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected abstract string IdAttributeName { 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>
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_IntAxisParams_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.IntAxisParams*"></a>
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_IntAxisParams" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.IntAxisParams">
IntAxisParams
</h3>
<div class="markdown level1 summary"><p>Per-axis integer parameters. Outer key = parameter number, inner key = axis name.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Dictionary&lt;int, Dictionary&lt;string, int&gt;&gt; IntAxisParams { 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.collections.generic.dictionary-2">Dictionary</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.dictionary-2">Dictionary</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>&gt;&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_RapidRateParamId_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.RapidRateParamId*"></a>
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_RapidRateParamId" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.RapidRateParamId">
RapidRateParamId
</h3>
<div class="markdown level1 summary"><p>Parameter/MD/MP number for rapid traverse rate per axis.
Null if not defined for this controller brand.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected virtual int? RapidRateParamId { 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.int32">int</a>?</dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_ReferencePositionParamId_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.ReferencePositionParamId*"></a>
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_ReferencePositionParamId" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.ReferencePositionParamId">
ReferencePositionParamId
</h3>
<div class="markdown level1 summary"><p>Parameter/MD/MP number for reference position (G28 home).</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected abstract int ReferencePositionParamId { 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.int32">int</a></dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_SystemParams_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.SystemParams*"></a>
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_SystemParams" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.SystemParams">
SystemParams
</h3>
<div class="markdown level1 summary"><p>System-wide parameters. Key = parameter number.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Dictionary&lt;int, double&gt; SystemParams { 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.collections.generic.dictionary-2">Dictionary</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>&gt;</dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_AxisParam_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.AxisParam*"></a>
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_AxisParam_System_Int32_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.AxisParam(System.Int32)">
AxisParam(int)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Dictionary&lt;string, double&gt; AxisParam(int paramId)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>paramId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.dictionary-2">Dictionary</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_ConfigureRotaryAxis_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.ConfigureRotaryAxis*"></a>
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_ConfigureRotaryAxis_System_String_System_Double_System_Double_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.ConfigureRotaryAxis(System.String,System.Double,System.Double)">
ConfigureRotaryAxis(string, double, double)
</h3>
<div class="markdown level1 summary"><p>Configures a rotary axis with home position and rapid rate.
Sets axis type to <a class="xref" href="Hi.NcParsers.Dependencys.AxisType.html#Hi_NcParsers_Dependencys_AxisType_Rotary">Rotary</a>, home position
via <a class="xref" href="Hi.NcParsers.Dependencys.ControllerParameterTableBase.html#Hi_NcParsers_Dependencys_ControllerParameterTableBase_SetHomePosition_System_String_System_Double_">SetHomePosition(string, double)</a>, and per-axis rapid rate
(if <a class="xref" href="Hi.NcParsers.Dependencys.ControllerParameterTableBase.html#Hi_NcParsers_Dependencys_ControllerParameterTableBase_RapidRateParamId">RapidRateParamId</a> is defined for this brand).
Use <a class="xref" href="Hi.NcParsers.Dependencys.ControllerParameterTableBase.html#Hi_NcParsers_Dependencys_ControllerParameterTableBase_RemoveAxis_System_String_">RemoveAxis(string)</a> to remove the axis entirely.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void ConfigureRotaryAxis(string axisName, double homePosition_deg = 0, double rapidRate_degdmin = 36000)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>axisName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Axis name (e.g., &ldquo;A&rdquo;, &ldquo;B&rdquo;, &ldquo;C&rdquo;).</p>
</dd>
<dt><code>homePosition_deg</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>Home position in degrees (default 0).</p>
</dd>
<dt><code>rapidRate_degdmin</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>Rapid traverse rate in deg/min (default 36000).</p>
</dd>
</dl>
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_GetAxisRapidRate_mmdmin_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.GetAxisRapidRate_mmdmin*"></a>
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_GetAxisRapidRate_mmdmin_System_String_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.GetAxisRapidRate_mmdmin(System.String)">
GetAxisRapidRate_mmdmin(string)
</h3>
<div class="markdown level1 summary"><p>Gets rapid traverse feedrate for a specific axis
in mm/min (or deg/min for rotary).
Returns a default value if the axis is not configured.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double GetAxisRapidRate_mmdmin(string axisName)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>axisName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</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_Dependencys_ControllerParameterTableBase_GetHomePosition_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.GetHomePosition*"></a>
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_GetHomePosition_System_String_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.GetHomePosition(System.String)">
GetHomePosition(string)
</h3>
<div class="markdown level1 summary"><p>Gets the home position for a specific axis.
Returns null if the axis has no home position configured.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double? GetHomePosition(string axisName)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>axisName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</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_Dependencys_ControllerParameterTableBase_IntAxisParam_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.IntAxisParam*"></a>
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_IntAxisParam_System_Int32_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.IntAxisParam(System.Int32)">
IntAxisParam(int)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Dictionary&lt;string, int&gt; IntAxisParam(int paramId)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>paramId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.dictionary-2">Dictionary</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_IsRotaryAxis_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.IsRotaryAxis*"></a>
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_IsRotaryAxis_System_String_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.IsRotaryAxis(System.String)">
IsRotaryAxis(string)
</h3>
<div class="markdown level1 summary"><p>Returns true if the axis is rotary or spindle, false if linear.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsRotaryAxis(string axisName)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>axisName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></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></dd>
</dl>
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_MakeXmlSource_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.MakeXmlSource*"></a>
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.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 abstract 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_NcParsers_Dependencys_ControllerParameterTableBase_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_NcParsers_Dependencys_ControllerParameterTableBase_ReadXml_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.ReadXml*"></a>
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_ReadXml_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.ReadXml(System.Xml.Linq.XElement)">
ReadXml(XElement)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected void ReadXml(XElement src)</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></dd>
</dl>
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_RemoveAxis_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.RemoveAxis*"></a>
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_RemoveAxis_System_String_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.RemoveAxis(System.String)">
RemoveAxis(string)
</h3>
<div class="markdown level1 summary"><p>Removes an axis from the configuration.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void RemoveAxis(string axisName)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>axisName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_SetAxis_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.SetAxis*"></a>
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_SetAxis_System_String_Hi_NcParsers_Dependencys_AxisType_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.SetAxis(System.String,Hi.NcParsers.Dependencys.AxisType)">
SetAxis(string, AxisType)
</h3>
<div class="markdown level1 summary"><p>Adds or updates an axis with the specified type.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void SetAxis(string axisName, AxisType type)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>axisName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>type</code> <a class="xref" href="Hi.NcParsers.Dependencys.AxisType.html">AxisType</a></dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_SetHomePosition_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.SetHomePosition*"></a>
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_SetHomePosition_System_String_System_Double_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.SetHomePosition(System.String,System.Double)">
SetHomePosition(string, double)
</h3>
<div class="markdown level1 summary"><p>Sets the home position for a specific axis.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void SetHomePosition(string axisName, double value)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>axisName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>value</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_WriteXml_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.WriteXml*"></a>
<h3 id="Hi_NcParsers_Dependencys_ControllerParameterTableBase_WriteXml_System_String_" data-uid="Hi.NcParsers.Dependencys.ControllerParameterTableBase.WriteXml(System.String)">
WriteXml(string)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected XElement WriteXml(string xName)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>xName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></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></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