HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.RapidCutMonitor.Sample.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
      <title>Struct RapidCutMonitor.Sample | HiAPI-C# 2025 </title>
      <meta name="viewport" content="width=device-width, initial-scale=1.0">
      <meta name="title" content="Struct RapidCutMonitor.Sample | HiAPI-C# 2025 ">
      
      <meta name="description" content="One built step as the monitor sees it — the few facts the fold needs, detached from  so the fold is testable on synthetic steps.">
      <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.MachiningProcs.RapidCutMonitor.Sample">



  <h1 id="Hi_MachiningProcs_RapidCutMonitor_Sample" data-uid="Hi.MachiningProcs.RapidCutMonitor.Sample" class="text-break">
Struct RapidCutMonitor.Sample  
  </h1>

  <div class="facts text-secondary">
    <dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.MachiningProcs.html">MachiningProcs</a></dd></dl>
  <dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
  </div>

  <div class="markdown summary"><p>One built step as the monitor sees it — the few facts the fold needs,
detached from <a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a> so the fold is testable on
synthetic steps.</p>
</div>
  <div class="markdown conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public readonly record struct RapidCutMonitor.Sample : IEquatable&lt;RapidCutMonitor.Sample&gt;</code></pre>
  </div>





  <dl class="typelist implements">
    <dt>Implements</dt>
    <dd>
      <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a>&lt;<a class="xref" href="Hi.MachiningProcs.RapidCutMonitor.html">RapidCutMonitor</a>.<a class="xref" href="Hi.MachiningProcs.RapidCutMonitor.Sample.html">Sample</a>&gt;</div>
    </dd>
  </dl>


  <dl class="typelist inheritedMembers">
    <dt>Inherited Members</dt>
    <dd>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.valuetype.equals">ValueType.Equals(object)</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.valuetype.gethashcode">ValueType.GetHashCode()</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.valuetype.tostring">ValueType.ToString()</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.gettype">object.GetType()</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
    </div>
  </dd></dl>

  <dl class="typelist extensionMethods">
    <dt>Extension Methods</dt>
    <dd>
  <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.Common.MaskUtil.html#Hi_Common_MaskUtil_GetMaskedValue__1___0___0_System_Boolean_">MaskUtil.GetMaskedValue&lt;T&gt;(T, T, bool)</a>
  </div>
  <div>
      <a class="xref" href="Hi.Common.MaskUtil.html#Hi_Common_MaskUtil_SetMask__1___0____0_System_Boolean_">MaskUtil.SetMask&lt;T&gt;(ref T, T, bool)</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_MachiningProcs_RapidCutMonitor_Sample__ctor_" data-uid="Hi.MachiningProcs.RapidCutMonitor.Sample.#ctor*"></a>

  <h3 id="Hi_MachiningProcs_RapidCutMonitor_Sample__ctor_System_Int32_System_Nullable_System_Int32__System_Object_Hi_NcParsers_ISentenceCarrier_System_Boolean_System_Boolean_System_Boolean_System_Double_System_Double_" data-uid="Hi.MachiningProcs.RapidCutMonitor.Sample.#ctor(System.Int32,System.Nullable{System.Int32},System.Object,Hi.NcParsers.ISentenceCarrier,System.Boolean,System.Boolean,System.Boolean,System.Double,System.Double)">
  Sample(int, int?, object, ISentenceCarrier, bool, bool, bool, double, double)
  
  </h3>

  <div class="markdown level1 summary"><p>One built step as the monitor sees it — the few facts the fold needs,
detached from <a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a> so the fold is testable on
synthetic steps.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public Sample(int StepIndex, int? LineNo, object LineKey, ISentenceCarrier Carrier, bool IsRapid, bool IsTouched, bool IsSpindleStopped, double RemovedVolume_mm3, double CuttingDepth_mm)</code></pre>
  </div>

  <h4 class="section">Parameters</h4>
  <dl class="parameters">
    <dt><code>StepIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
    <dd><p>Execution-order index of the step.</p>
</dd>
    <dt><code>LineNo</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
    <dd><p>NC line number, or null where the runner carries none (CSV / CL replay).</p>
</dd>
    <dt><code>LineKey</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
    <dd><p>Fold key: the line number when known, else the sentence, else the step index.</p>
</dd>
    <dt><code>Carrier</code> <a class="xref" href="Hi.NcParsers.ISentenceCarrier.html">ISentenceCarrier</a></dt>
    <dd><p>NC-source carrier of the step; anchors the report. May be null.</p>
</dd>
    <dt><code>IsRapid</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
    <dd><p>Whether the step was commanded as rapid traverse.</p>
</dd>
    <dt><code>IsTouched</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
    <dd><p>Whether the step touched the workpiece.</p>
</dd>
    <dt><code>IsSpindleStopped</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
    <dd><p>Whether the spindle was stopped on this step.</p>
</dd>
    <dt><code>RemovedVolume_mm3</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
    <dd><p>Stock removed by this step in mm³ (0 when untouched or unknown).</p>
</dd>
    <dt><code>CuttingDepth_mm</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
    <dd><p>Axial cutting depth of this step in mm (0 when untouched).</p>
</dd>
  </dl>












  <h2 class="section" id="properties">Properties
</h2>


  <a id="Hi_MachiningProcs_RapidCutMonitor_Sample_Carrier_" data-uid="Hi.MachiningProcs.RapidCutMonitor.Sample.Carrier*"></a>

  <h3 id="Hi_MachiningProcs_RapidCutMonitor_Sample_Carrier" data-uid="Hi.MachiningProcs.RapidCutMonitor.Sample.Carrier">
  Carrier
  
  </h3>

  <div class="markdown level1 summary"><p>NC-source carrier of the step; anchors the report. May be null.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public ISentenceCarrier Carrier { get; init; }</code></pre>
  </div>





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








  <a id="Hi_MachiningProcs_RapidCutMonitor_Sample_CuttingDepth_mm_" data-uid="Hi.MachiningProcs.RapidCutMonitor.Sample.CuttingDepth_mm*"></a>

  <h3 id="Hi_MachiningProcs_RapidCutMonitor_Sample_CuttingDepth_mm" data-uid="Hi.MachiningProcs.RapidCutMonitor.Sample.CuttingDepth_mm">
  CuttingDepth_mm
  
  </h3>

  <div class="markdown level1 summary"><p>Axial cutting depth of this step in mm (0 when untouched).</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double CuttingDepth_mm { get; init; }</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_MachiningProcs_RapidCutMonitor_Sample_IsRapid_" data-uid="Hi.MachiningProcs.RapidCutMonitor.Sample.IsRapid*"></a>

  <h3 id="Hi_MachiningProcs_RapidCutMonitor_Sample_IsRapid" data-uid="Hi.MachiningProcs.RapidCutMonitor.Sample.IsRapid">
  IsRapid
  
  </h3>

  <div class="markdown level1 summary"><p>Whether the step was commanded as rapid traverse.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool IsRapid { get; init; }</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_MachiningProcs_RapidCutMonitor_Sample_IsSpindleStopped_" data-uid="Hi.MachiningProcs.RapidCutMonitor.Sample.IsSpindleStopped*"></a>

  <h3 id="Hi_MachiningProcs_RapidCutMonitor_Sample_IsSpindleStopped" data-uid="Hi.MachiningProcs.RapidCutMonitor.Sample.IsSpindleStopped">
  IsSpindleStopped
  
  </h3>

  <div class="markdown level1 summary"><p>Whether the spindle was stopped on this step.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool IsSpindleStopped { get; init; }</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_MachiningProcs_RapidCutMonitor_Sample_IsTouched_" data-uid="Hi.MachiningProcs.RapidCutMonitor.Sample.IsTouched*"></a>

  <h3 id="Hi_MachiningProcs_RapidCutMonitor_Sample_IsTouched" data-uid="Hi.MachiningProcs.RapidCutMonitor.Sample.IsTouched">
  IsTouched
  
  </h3>

  <div class="markdown level1 summary"><p>Whether the step touched the workpiece.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool IsTouched { get; init; }</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_MachiningProcs_RapidCutMonitor_Sample_LineKey_" data-uid="Hi.MachiningProcs.RapidCutMonitor.Sample.LineKey*"></a>

  <h3 id="Hi_MachiningProcs_RapidCutMonitor_Sample_LineKey" data-uid="Hi.MachiningProcs.RapidCutMonitor.Sample.LineKey">
  LineKey
  
  </h3>

  <div class="markdown level1 summary"><p>Fold key: the line number when known, else the sentence, else the step index.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public object LineKey { get; init; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
    <dd></dd>
  </dl>








  <a id="Hi_MachiningProcs_RapidCutMonitor_Sample_LineNo_" data-uid="Hi.MachiningProcs.RapidCutMonitor.Sample.LineNo*"></a>

  <h3 id="Hi_MachiningProcs_RapidCutMonitor_Sample_LineNo" data-uid="Hi.MachiningProcs.RapidCutMonitor.Sample.LineNo">
  LineNo
  
  </h3>

  <div class="markdown level1 summary"><p>NC line number, or null where the runner carries none (CSV / CL replay).</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public int? LineNo { get; init; }</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_MachiningProcs_RapidCutMonitor_Sample_RemovedVolume_mm3_" data-uid="Hi.MachiningProcs.RapidCutMonitor.Sample.RemovedVolume_mm3*"></a>

  <h3 id="Hi_MachiningProcs_RapidCutMonitor_Sample_RemovedVolume_mm3" data-uid="Hi.MachiningProcs.RapidCutMonitor.Sample.RemovedVolume_mm3">
  RemovedVolume_mm3
  
  </h3>

  <div class="markdown level1 summary"><p>Stock removed by this step in mm³ (0 when untouched or unknown).</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double RemovedVolume_mm3 { get; init; }</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_MachiningProcs_RapidCutMonitor_Sample_StepIndex_" data-uid="Hi.MachiningProcs.RapidCutMonitor.Sample.StepIndex*"></a>

  <h3 id="Hi_MachiningProcs_RapidCutMonitor_Sample_StepIndex" data-uid="Hi.MachiningProcs.RapidCutMonitor.Sample.StepIndex">
  StepIndex
  
  </h3>

  <div class="markdown level1 summary"><p>Execution-order index of the step.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public int StepIndex { get; init; }</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>









</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>