HiNC-Deploy/HiNC-2025-win-desktop-Deploy
Archived
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
This repository has been archived on 2026-10-11. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
397a7a8cc48e7a4ed3d2f87c1e270f79ee773bec
HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.NcParsers.Dependencys.IMCodeDeclarationConfig.html
T

338 lines
13 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Interface IMCodeDeclarationConfig | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Interface IMCodeDeclarationConfig | HiAPI-C# 2025 ">
<meta name="description" content="Machine-declared M-code map: what each machine-specific (OEM/PLC) M-code does, as — possibly several effects per code (tool change, spindle direction, coolant) plus a note for behavior this simulation does not model. Consumed by , which expands declared codes into the canonical ISO flags ahead of the regular consumers. Machine-level (per-case parameter table) rather than brand vocabulary — implemented by , alongside the narrower face over the same storage.">
<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.IMCodeDeclarationConfig">
<h1 id="Hi_NcParsers_Dependencys_IMCodeDeclarationConfig" data-uid="Hi.NcParsers.Dependencys.IMCodeDeclarationConfig" class="text-break">
Interface IMCodeDeclarationConfig
</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>Machine-declared M-code map: what each machine-specific (OEM/PLC) M-code
does, as <a class="xref" href="Hi.NcParsers.Dependencys.MCodeEffects.html">MCodeEffects</a> — possibly several effects per code
(tool change, spindle direction, coolant) plus a note for behavior this
simulation does not model. Consumed by
<a class="xref" href="Hi.NcParsers.LogicSyntaxs.MCodeExpansionSyntax.html">MCodeExpansionSyntax</a>, which expands declared
codes into the canonical ISO flags ahead of the regular consumers.
Machine-level (per-case parameter table) rather than brand vocabulary —
implemented by <a class="xref" href="Hi.NcParsers.Dependencys.ControllerParameterTableBase.html">ControllerParameterTableBase</a>, alongside the
narrower <a class="xref" href="Hi.NcParsers.Dependencys.ISpindleControlConfig.html">ISpindleControlConfig</a> face over the same storage.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IMCodeDeclarationConfig : INcDependency, IMakeXmlSource</code></pre>
</div>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html#Hi_Common_XmlUtils_IMakeXmlSource_MakeXmlSource_System_String_System_String_System_Boolean_">IMakeXmlSource.MakeXmlSource(string, string, bool)</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_IMCodeDeclarationConfig_MCodeDeclarations_" data-uid="Hi.NcParsers.Dependencys.IMCodeDeclarationConfig.MCodeDeclarations*"></a>
<h3 id="Hi_NcParsers_Dependencys_IMCodeDeclarationConfig_MCodeDeclarations" data-uid="Hi.NcParsers.Dependencys.IMCodeDeclarationConfig.MCodeDeclarations">
MCodeDeclarations
</h3>
<div class="markdown level1 summary"><p>Declared machine M-codes. Key = M-code as parsed (e.g.
<code>&ldquo;M13&rdquo;</code>), matched case-insensitively; value = the effects the
code performs. Enumerable for UI/serialization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">IReadOnlyDictionary&lt;string, MCodeEffects&gt; MCodeDeclarations { 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.ireadonlydictionary-2">IReadOnlyDictionary</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a class="xref" href="Hi.NcParsers.Dependencys.MCodeEffects.html">MCodeEffects</a>&gt;</dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_NcParsers_Dependencys_IMCodeDeclarationConfig_DeclareMCode_" data-uid="Hi.NcParsers.Dependencys.IMCodeDeclarationConfig.DeclareMCode*"></a>
<h3 id="Hi_NcParsers_Dependencys_IMCodeDeclarationConfig_DeclareMCode_System_String_Hi_NcParsers_Dependencys_MCodeEffects_" data-uid="Hi.NcParsers.Dependencys.IMCodeDeclarationConfig.DeclareMCode(System.String,Hi.NcParsers.Dependencys.MCodeEffects)">
DeclareMCode(string, MCodeEffects)
</h3>
<div class="markdown level1 summary"><p>Adds or replaces the declaration for an M-code. The effects are
copied on store, so the caller may reuse or further mutate its
instance without coupling declarations to each other.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void DeclareMCode(string mCode, MCodeEffects effects)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>mCode</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>effects</code> <a class="xref" href="Hi.NcParsers.Dependencys.MCodeEffects.html">MCodeEffects</a></dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_Dependencys_IMCodeDeclarationConfig_RemoveMCodeDeclaration_" data-uid="Hi.NcParsers.Dependencys.IMCodeDeclarationConfig.RemoveMCodeDeclaration*"></a>
<h3 id="Hi_NcParsers_Dependencys_IMCodeDeclarationConfig_RemoveMCodeDeclaration_System_String_" data-uid="Hi.NcParsers.Dependencys.IMCodeDeclarationConfig.RemoveMCodeDeclaration(System.String)">
RemoveMCodeDeclaration(string)
</h3>
<div class="markdown level1 summary"><p>Removes the declaration for an M-code.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void RemoveMCodeDeclaration(string mCode)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>mCode</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_Dependencys_IMCodeDeclarationConfig_TryGetMCodeEffects_" data-uid="Hi.NcParsers.Dependencys.IMCodeDeclarationConfig.TryGetMCodeEffects*"></a>
<h3 id="Hi_NcParsers_Dependencys_IMCodeDeclarationConfig_TryGetMCodeEffects_System_String_Hi_NcParsers_Dependencys_MCodeEffects__" data-uid="Hi.NcParsers.Dependencys.IMCodeDeclarationConfig.TryGetMCodeEffects(System.String,Hi.NcParsers.Dependencys.MCodeEffects@)">
TryGetMCodeEffects(string, out MCodeEffects)
</h3>
<div class="markdown level1 summary"><p>Resolves a parsed flag to its declared effects. Returns false for
undeclared codes — ISO defaults are the consumers' concern, not
this config's. The returned instance is the live declaration:
treat it as read-only and reconfigure through
<a class="xref" href="Hi.NcParsers.Dependencys.IMCodeDeclarationConfig.html#Hi_NcParsers_Dependencys_IMCodeDeclarationConfig_DeclareMCode_System_String_Hi_NcParsers_Dependencys_MCodeEffects_">DeclareMCode(string, MCodeEffects)</a> instead of mutating it.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool TryGetMCodeEffects(string mCode, out MCodeEffects effects)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>mCode</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>effects</code> <a class="xref" href="Hi.NcParsers.Dependencys.MCodeEffects.html">MCodeEffects</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>
</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