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

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
      <title>Class MCodeEffects | HiAPI-C# 2025 </title>
      <meta name="viewport" content="width=device-width, initial-scale=1.0">
      <meta name="title" content="Class MCodeEffects | HiAPI-C# 2025 ">
      
      <meta name="description" content="What one machine-declared M-code does. Real-machine OEM M-codes are frequently composite — e.g. an M13 that means &amp;ldquo;spindle CW + flood coolant on&amp;rdquo; — so a declaration carries every effect the code performs rather than a single meaning, and additionally an  for the parts this simulation does not model. Declaring only the known parts and staying loud about the rest keeps a composite code from being half-consumed silently. Stored per machine in  and consumed by , which expands the declared code into the canonical ISO flags the regular consumers already understand.">
      <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.MCodeEffects">



  <h1 id="Hi_NcParsers_Dependencys_MCodeEffects" data-uid="Hi.NcParsers.Dependencys.MCodeEffects" class="text-break">
Class MCodeEffects  
  </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>What one machine-declared M-code does. Real-machine OEM M-codes are
frequently composite — e.g. an <code>M13</code> that means &ldquo;spindle CW +
flood coolant on&rdquo; — so a declaration carries every effect the code
performs rather than a single meaning, and additionally an
<a class="xref" href="Hi.NcParsers.Dependencys.MCodeEffects.html#Hi_NcParsers_Dependencys_MCodeEffects_UnmodeledNote">UnmodeledNote</a> for the parts this simulation does not
model. Declaring only the known parts and staying loud about the rest
keeps a composite code from being half-consumed silently.
Stored per machine in
<a class="xref" href="Hi.NcParsers.Dependencys.ControllerParameterTableBase.html#Hi_NcParsers_Dependencys_ControllerParameterTableBase_MCodeDeclarations">MCodeDeclarations</a> and
consumed by <a class="xref" href="Hi.NcParsers.LogicSyntaxs.MCodeExpansionSyntax.html">MCodeExpansionSyntax</a>, which
expands the declared code into the canonical ISO flags the regular
consumers already understand.</p>
</div>
  <div class="markdown conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class MCodeEffects</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">MCodeEffects</span></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_MCodeEffects_CoolantMode_" data-uid="Hi.NcParsers.Dependencys.MCodeEffects.CoolantMode*"></a>

  <h3 id="Hi_NcParsers_Dependencys_MCodeEffects_CoolantMode" data-uid="Hi.NcParsers.Dependencys.MCodeEffects.CoolantMode">
  CoolantMode
  
  </h3>

  <div class="markdown level1 summary"><p>Coolant mode the code commands (expands to
<code>M07</code>/<code>M08</code>/<code>M09</code>): one of
<a class="xref" href="Hi.NcParsers.Keywords.Coolant.html#Hi_NcParsers_Keywords_Coolant_Mist">Mist</a>, <a class="xref" href="Hi.NcParsers.Keywords.Coolant.html#Hi_NcParsers_Keywords_Coolant_Flood">Flood</a>,
<a class="xref" href="Hi.NcParsers.Keywords.Coolant.html#Hi_NcParsers_Keywords_Coolant_Off">Off</a>. <code>null</code>/empty when the code does
not touch coolant.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public string CoolantMode { 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_Dependencys_MCodeEffects_IsEmpty_" data-uid="Hi.NcParsers.Dependencys.MCodeEffects.IsEmpty*"></a>

  <h3 id="Hi_NcParsers_Dependencys_MCodeEffects_IsEmpty" data-uid="Hi.NcParsers.Dependencys.MCodeEffects.IsEmpty">
  IsEmpty
  
  </h3>

  <div class="markdown level1 summary"><p>True when the declaration carries no effect and no note — such an
entry means &ldquo;consume this code silently; it is irrelevant to
simulation&rdquo;.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool IsEmpty { 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.boolean">bool</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcParsers_Dependencys_MCodeEffects_IsSpindleDirectionOnly_" data-uid="Hi.NcParsers.Dependencys.MCodeEffects.IsSpindleDirectionOnly*"></a>

  <h3 id="Hi_NcParsers_Dependencys_MCodeEffects_IsSpindleDirectionOnly" data-uid="Hi.NcParsers.Dependencys.MCodeEffects.IsSpindleDirectionOnly">
  IsSpindleDirectionOnly
  
  </h3>

  <div class="markdown level1 summary"><p>True when <a class="xref" href="Hi.NcParsers.Dependencys.MCodeEffects.html#Hi_NcParsers_Dependencys_MCodeEffects_SpindleDirection">SpindleDirection</a> is the declaration's sole
content. The two consumption paths partition on this: only such
declarations resolve through
<a class="xref" href="Hi.NcParsers.Dependencys.ISpindleControlConfig.html#Hi_NcParsers_Dependencys_ISpindleControlConfig_TryResolveDirection_System_String_Hi_Numerical_SpindleDirection__">TryResolveDirection(string, out SpindleDirection)</a> (whose
caller consumes the whole flag in place, preserving legacy
behavior), and <a class="xref" href="Hi.NcParsers.LogicSyntaxs.MCodeExpansionSyntax.html">MCodeExpansionSyntax</a>
deliberately skips them and expands only composite declarations,
so no effect is swallowed and nothing is translated twice.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool IsSpindleDirectionOnly { 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.boolean">bool</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcParsers_Dependencys_MCodeEffects_IsToolChange_" data-uid="Hi.NcParsers.Dependencys.MCodeEffects.IsToolChange*"></a>

  <h3 id="Hi_NcParsers_Dependencys_MCodeEffects_IsToolChange" data-uid="Hi.NcParsers.Dependencys.MCodeEffects.IsToolChange">
  IsToolChange
  
  </h3>

  <div class="markdown level1 summary"><p>The code performs a tool change (expands to <code>M06</code>) — the
machine-configurable trigger real controllers declare via e.g.
Siemens MD22560 <code>$MC_TOOL_CHANGE_M_CODE</code>.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool IsToolChange { 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.boolean">bool</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcParsers_Dependencys_MCodeEffects_SpindleDirection_" data-uid="Hi.NcParsers.Dependencys.MCodeEffects.SpindleDirection*"></a>

  <h3 id="Hi_NcParsers_Dependencys_MCodeEffects_SpindleDirection" data-uid="Hi.NcParsers.Dependencys.MCodeEffects.SpindleDirection">
  SpindleDirection
  
  </h3>

  <div class="markdown level1 summary"><p>Spindle direction the code commands (expands to
<code>M03</code>/<code>M04</code>/<code>M05</code>), or <code>null</code> when the code
does not touch the spindle.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public SpindleDirection? SpindleDirection { get; set; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="Hi.Numerical.SpindleDirection.html">SpindleDirection</a>?</dt>
    <dd></dd>
  </dl>








  <a id="Hi_NcParsers_Dependencys_MCodeEffects_UnmodeledNote_" data-uid="Hi.NcParsers.Dependencys.MCodeEffects.UnmodeledNote*"></a>

  <h3 id="Hi_NcParsers_Dependencys_MCodeEffects_UnmodeledNote" data-uid="Hi.NcParsers.Dependencys.MCodeEffects.UnmodeledNote">
  UnmodeledNote
  
  </h3>

  <div class="markdown level1 summary"><p>Free-text description of what the code additionally does on the
real machine that this simulation does not model (e.g. &ldquo;chip
conveyor forward&rdquo;). When set, consuming the code emits one
informational diagnostic per occurrence instead of staying silent
— a declaration must not downgrade the visible
<code>Parsing&ndash;Unconsumed</code> warning into nothing.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public string UnmodeledNote { 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>








  <h2 class="section" id="methods">Methods
</h2>


  <a id="Hi_NcParsers_Dependencys_MCodeEffects_Clone_" data-uid="Hi.NcParsers.Dependencys.MCodeEffects.Clone*"></a>

  <h3 id="Hi_NcParsers_Dependencys_MCodeEffects_Clone" data-uid="Hi.NcParsers.Dependencys.MCodeEffects.Clone">
  Clone()
  
  </h3>

  <div class="markdown level1 summary"><p>Returns an independent copy of this declaration.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public MCodeEffects Clone()</code></pre>
  </div>


  <h4 class="section">Returns</h4>
  <dl class="parameters">
    <dt><a class="xref" href="Hi.NcParsers.Dependencys.MCodeEffects.html">MCodeEffects</a></dt>
    <dd></dd>
  </dl>











  <a id="Hi_NcParsers_Dependencys_MCodeEffects_NormalizeCoolantMode_" data-uid="Hi.NcParsers.Dependencys.MCodeEffects.NormalizeCoolantMode*"></a>

  <h3 id="Hi_NcParsers_Dependencys_MCodeEffects_NormalizeCoolantMode_System_String_" data-uid="Hi.NcParsers.Dependencys.MCodeEffects.NormalizeCoolantMode(System.String)">
  NormalizeCoolantMode(string)
  
  </h3>

  <div class="markdown level1 summary"><p>Maps a raw coolant-mode string to the canonical
<a class="xref" href="Hi.NcParsers.Keywords.Coolant.html">Coolant</a> constant (case-insensitive), or <code>null</code>
when the value names no known mode.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public static string NormalizeCoolantMode(string value)</code></pre>
  </div>

  <h4 class="section">Parameters</h4>
  <dl class="parameters">
    <dt><code>value</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.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>