758 lines
23 KiB
HTML
758 lines
23 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Class NcTranslation | HiAPI-C# 2025 </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Class NcTranslation | HiAPI-C# 2025 ">
|
|
|
|
<meta name="description" content="Represents a translational transformer for NC machine tool axes. Provides functionality for linear motion with stroke and speed limits.">
|
|
<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 "{query}"">
|
|
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
|
<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.NcMech.Topo.NcTranslation">
|
|
|
|
|
|
|
|
<h1 id="Hi_NcMech_Topo_NcTranslation" data-uid="Hi.NcMech.Topo.NcTranslation" class="text-break">
|
|
Class NcTranslation
|
|
</h1>
|
|
|
|
<div class="facts text-secondary">
|
|
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcMech.html">NcMech</a>.<a class="xref" href="Hi.NcMech.Topo.html">Topo</a></dd></dl>
|
|
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
|
</div>
|
|
|
|
<div class="markdown summary"><p>Represents a translational transformer for NC machine tool axes.
|
|
Provides functionality for linear motion with stroke and speed limits.</p>
|
|
</div>
|
|
<div class="markdown conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class NcTranslation : DynamicTranslation, IGetInverseTransformer, INcTransformer, IDynamicRegular, IDynamicTransformer, ITransformer, IMakeXmlSource, INcStroke</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><a class="xref" href="Hi.Mech.Topo.DynamicTranslation.html">DynamicTranslation</a></div>
|
|
<div><span class="xref">NcTranslation</span></div>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl class="typelist implements">
|
|
<dt>Implements</dt>
|
|
<dd>
|
|
<div><a class="xref" href="Hi.Mech.Topo.IGetInverseTransformer.html">IGetInverseTransformer</a></div>
|
|
<div><a class="xref" href="Hi.NcMech.Topo.INcTransformer.html">INcTransformer</a></div>
|
|
<div><a class="xref" href="Hi.Mech.Topo.IDynamicRegular.html">IDynamicRegular</a></div>
|
|
<div><a class="xref" href="Hi.Mech.Topo.IDynamicTransformer.html">IDynamicTransformer</a></div>
|
|
<div><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></div>
|
|
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
|
<div><a class="xref" href="Hi.NcMech.Topo.INcStroke.html">INcStroke</a></div>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<dl class="typelist inheritedMembers">
|
|
<dt>Inherited Members</dt>
|
|
<dd>
|
|
<div>
|
|
<a class="xref" href="Hi.Mech.Topo.DynamicTranslation.html#Hi_Mech_Topo_DynamicTranslation_Set_Hi_Mech_Topo_DynamicTranslation_">DynamicTranslation.Set(DynamicTranslation)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Mech.Topo.DynamicTranslation.html#Hi_Mech_Topo_DynamicTranslation_Step">DynamicTranslation.Step</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Mech.Topo.DynamicTranslation.html#Hi_Mech_Topo_DynamicTranslation_GetMat">DynamicTranslation.GetMat()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Mech.Topo.DynamicTranslation.html#Hi_Mech_Topo_DynamicTranslation_GetMatInv">DynamicTranslation.GetMatInv()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Mech.Topo.DynamicTranslation.html#Hi_Mech_Topo_DynamicTranslation_GetInverseTransformer">DynamicTranslation.GetInverseTransformer()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Mech.Topo.DynamicTranslation.html#Hi_Mech_Topo_DynamicTranslation_Axis">DynamicTranslation.Axis</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Mech.Topo.DynamicTranslation.html#Hi_Mech_Topo_DynamicTranslation_Len">DynamicTranslation.Len</a>
|
|
</div>
|
|
<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<TSelf>(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<TSrc>(TSrc, Action<TSrc>)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)</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_NcMech_Topo_NcTranslation__ctor_" data-uid="Hi.NcMech.Topo.NcTranslation.#ctor*"></a>
|
|
|
|
<h3 id="Hi_NcMech_Topo_NcTranslation__ctor" data-uid="Hi.NcMech.Topo.NcTranslation.#ctor">
|
|
NcTranslation()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.NcMech.Topo.NcTranslation.html">NcTranslation</a> class.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public NcTranslation()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_NcMech_Topo_NcTranslation__ctor_" data-uid="Hi.NcMech.Topo.NcTranslation.#ctor*"></a>
|
|
|
|
<h3 id="Hi_NcMech_Topo_NcTranslation__ctor_Hi_Geom_Vec3d_System_Double_" data-uid="Hi.NcMech.Topo.NcTranslation.#ctor(Hi.Geom.Vec3d,System.Double)">
|
|
NcTranslation(Vec3d, double)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.NcMech.Topo.NcTranslation.html">NcTranslation</a> class with the specified translation vector and length.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public NcTranslation(Vec3d trans, double len = 0)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>trans</code> <a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a></dt>
|
|
<dd><p>The translation vector.</p>
|
|
</dd>
|
|
<dt><code>len</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
|
<dd><p>The translation length.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_NcMech_Topo_NcTranslation__ctor_" data-uid="Hi.NcMech.Topo.NcTranslation.#ctor*"></a>
|
|
|
|
<h3 id="Hi_NcMech_Topo_NcTranslation__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcMech.Topo.NcTranslation.#ctor(System.Xml.Linq.XElement)">
|
|
NcTranslation(XElement)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.NcMech.Topo.NcTranslation.html">NcTranslation</a> class from XML.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public NcTranslation(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><p>The XML source element.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="properties">Properties
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_NcMech_Topo_NcTranslation_KeyCode_" data-uid="Hi.NcMech.Topo.NcTranslation.KeyCode*"></a>
|
|
|
|
<h3 id="Hi_NcMech_Topo_NcTranslation_KeyCode" data-uid="Hi.NcMech.Topo.NcTranslation.KeyCode">
|
|
KeyCode
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the key code of the motion axis.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string KeyCode { 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_NcMech_Topo_NcTranslation_SpeedLimit_mmdmin_" data-uid="Hi.NcMech.Topo.NcTranslation.SpeedLimit_mmdmin*"></a>
|
|
|
|
<h3 id="Hi_NcMech_Topo_NcTranslation_SpeedLimit_mmdmin" data-uid="Hi.NcMech.Topo.NcTranslation.SpeedLimit_mmdmin">
|
|
SpeedLimit_mmdmin
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the speed limit in millimeters per minute.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public double SpeedLimit_mmdmin { 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_NcMech_Topo_NcTranslation_SpeedLimit_mmds_" data-uid="Hi.NcMech.Topo.NcTranslation.SpeedLimit_mmds*"></a>
|
|
|
|
<h3 id="Hi_NcMech_Topo_NcTranslation_SpeedLimit_mmds" data-uid="Hi.NcMech.Topo.NcTranslation.SpeedLimit_mmds">
|
|
SpeedLimit_mmds
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the speed limit in millimeters per second.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public double SpeedLimit_mmds { 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_NcMech_Topo_NcTranslation_StrokeMax_mm_" data-uid="Hi.NcMech.Topo.NcTranslation.StrokeMax_mm*"></a>
|
|
|
|
<h3 id="Hi_NcMech_Topo_NcTranslation_StrokeMax_mm" data-uid="Hi.NcMech.Topo.NcTranslation.StrokeMax_mm">
|
|
StrokeMax_mm
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the maximum stroke distance in millimeters.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public double StrokeMax_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_NcMech_Topo_NcTranslation_StrokeMin_mm_" data-uid="Hi.NcMech.Topo.NcTranslation.StrokeMin_mm*"></a>
|
|
|
|
<h3 id="Hi_NcMech_Topo_NcTranslation_StrokeMin_mm" data-uid="Hi.NcMech.Topo.NcTranslation.StrokeMin_mm">
|
|
StrokeMin_mm
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the minimum stroke distance in millimeters.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public double StrokeMin_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_NcMech_Topo_NcTranslation_XName_" data-uid="Hi.NcMech.Topo.NcTranslation.XName*"></a>
|
|
|
|
<h3 id="Hi_NcMech_Topo_NcTranslation_XName" data-uid="Hi.NcMech.Topo.NcTranslation.XName">
|
|
XName
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the XML element name for serialization.</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_NcMech_Topo_NcTranslation_Clone_" data-uid="Hi.NcMech.Topo.NcTranslation.Clone*"></a>
|
|
|
|
<h3 id="Hi_NcMech_Topo_NcTranslation_Clone" data-uid="Hi.NcMech.Topo.NcTranslation.Clone">
|
|
Clone()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Clones this instance.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override ITransformer Clone()</code></pre>
|
|
</div>
|
|
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></dt>
|
|
<dd><p>clone</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_NcMech_Topo_NcTranslation_GetKeyCode_" data-uid="Hi.NcMech.Topo.NcTranslation.GetKeyCode*"></a>
|
|
|
|
<h3 id="Hi_NcMech_Topo_NcTranslation_GetKeyCode" data-uid="Hi.NcMech.Topo.NcTranslation.GetKeyCode">
|
|
GetKeyCode()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Get key code of the motion axis.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string GetKeyCode()</code></pre>
|
|
</div>
|
|
|
|
|
|
<h4 class="section">Returns</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_NcMech_Topo_NcTranslation_GetSpeedLimit_" data-uid="Hi.NcMech.Topo.NcTranslation.GetSpeedLimit*"></a>
|
|
|
|
<h3 id="Hi_NcMech_Topo_NcTranslation_GetSpeedLimit" data-uid="Hi.NcMech.Topo.NcTranslation.GetSpeedLimit">
|
|
GetSpeedLimit()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Get speed limit.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public double GetSpeedLimit()</code></pre>
|
|
</div>
|
|
|
|
|
|
<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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section" id="Hi_NcMech_Topo_NcTranslation_GetSpeedLimit_remarks">Remarks</h4>
|
|
<div class="markdown level1 remarks"><p>Gets the speed limit in millimeters per second.</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<a id="Hi_NcMech_Topo_NcTranslation_GetStrokeMax_" data-uid="Hi.NcMech.Topo.NcTranslation.GetStrokeMax*"></a>
|
|
|
|
<h3 id="Hi_NcMech_Topo_NcTranslation_GetStrokeMax" data-uid="Hi.NcMech.Topo.NcTranslation.GetStrokeMax">
|
|
GetStrokeMax()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Get positivest stroke.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public double GetStrokeMax()</code></pre>
|
|
</div>
|
|
|
|
|
|
<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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section" id="Hi_NcMech_Topo_NcTranslation_GetStrokeMax_remarks">Remarks</h4>
|
|
<div class="markdown level1 remarks"><p>Gets the maximum stroke distance in millimeters.</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<a id="Hi_NcMech_Topo_NcTranslation_GetStrokeMin_" data-uid="Hi.NcMech.Topo.NcTranslation.GetStrokeMin*"></a>
|
|
|
|
<h3 id="Hi_NcMech_Topo_NcTranslation_GetStrokeMin" data-uid="Hi.NcMech.Topo.NcTranslation.GetStrokeMin">
|
|
GetStrokeMin()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Get negativest stroke.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public double GetStrokeMin()</code></pre>
|
|
</div>
|
|
|
|
|
|
<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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section" id="Hi_NcMech_Topo_NcTranslation_GetStrokeMin_remarks">Remarks</h4>
|
|
<div class="markdown level1 remarks"><p>Gets the minimum stroke distance in millimeters.</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<a id="Hi_NcMech_Topo_NcTranslation_MakeXmlSource_" data-uid="Hi.NcMech.Topo.NcTranslation.MakeXmlSource*"></a>
|
|
|
|
<h3 id="Hi_NcMech_Topo_NcTranslation_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcMech.Topo.NcTranslation.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 override 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_NcMech_Topo_NcTranslation_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>
|
|
|
|
|
|
|
|
|
|
|
|
</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>
|