HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/manual/runtime/step-fields.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
      <title>Step Field Reference | HiAPI-C# 2025 </title>
      <meta name="viewport" content="width=device-width, initial-scale=1.0">
      <meta name="title" content="Step Field Reference | HiAPI-C# 2025 ">
      
      
      <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="">
    <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="Doc-Step-Fields">
          <h1 id="step-field-reference">Step Field Reference</h1>

<blockquote>
<p>For the complete and up-to-date field reference, see <a class="xref" href="../../api/Hi.MachiningSteps.MachiningStep.html">MachiningStep</a>.</p>
<p>To assess the risk of tool breakage, also refer to &quot;<a href="../analysis/machinability.html">Evaluating Process Machinability</a>&quot;.</p>
</blockquote>
<p>This page summarizes the main output data for each simulation <a class="xref" href="step.html">step</a>, covering source line, kinematics, load, force/torque, power, thermal, and wear information to help quickly understand the machining state at each step.</p>
<p>Step data contains information for the time interval between two consecutive steps (i.e., from the previous step to the current step). Many fields are therefore simplified representations over that period. Common prefixes based on the simplification method include Average (Avg), Extremes (Min, Max), Range (Delta), and Maximum Absolute Value (MaxAbs).</p>
<h2 id="basic-source-information">Basic Source Information</h2>
<ul>
<li>FileNo / LineNo / FilePath / LineText / FlagsText: File/line information and flags of the corresponding source NC command.</li>
<li>StepIndex: Step sequence index.</li>
<li>ToolId: ID of the currently active tool.</li>
</ul>
<h2 id="time-and-motion">Time and Motion</h2>
<ul>
<li>EndTimecode: Simulated end-of-step timecode (formerly <code>AccumulatedTime</code>; step CSVs written with the legacy header are still read).</li>
<li>StepDuration: Duration of this step (default per-revolution mode: one step equals one spindle revolution).</li>
<li>BeginSpindleAngle_deg: Spindle angular displacement at the start of this step.</li>
<li>Cl (Cutter Location): Cutter location point (including IJK normal).</li>
<li>MC (X, Y, Z, A, B, C): Machine coordinates.</li>
<li>MoveOnProgramCoordinate, MovingLength_mm: Displacement vector and length in the program coordinate system.</li>
<li>Feedrate_mmdmin / SpindleSpeed_rpm / CuttingSpeed_mmds: Feed rate, spindle speed, and cutting speed.</li>
<li>FeedPerTooth_mm / FeedPerCycle_mm / ToothArcDuration_s / SpindleCyclePeriod_s: Feed per tooth/per cycle, tooth arc duration, and spindle cycle period.</li>
</ul>
<h2 id="cutting-engagement-and-material-removal-rate">Cutting Engagement and Material Removal Rate</h2>
<ul>
<li>IsTouched: Whether cutting engagement occurred.</li>
<li>CuttingWidth_mm (ae) / CuttingDepth_mm (ap): Cutting width / cutting depth.</li>
<li>Mrr_mm3ds: Material removal rate.</li>
<li>ProgramSideCusp_um, SideCuspList_um: Side cusp height and distribution estimated from program feed and radius.
<blockquote>
<p><strong>Reading tip — a <code>ProgramSideCusp_um</code> spike usually flags a rapid-move (G00) collision, not a finish result.</strong> The program-side cusp is computed from the <em>ideal program feedrate</em> while the cutter is engaged with the workpiece. A rapid traverse is not meant to touch material; when it does, the cusp formula is fed the (very high) rapid feedrate, so the value spikes far above any real cutting cusp. Treat an isolated cusp peak at a rapid/G00 line as a likely gouge/collision to investigate. The same engagement-during-rapid usually shows up alongside it as spikes in the availability ratios (yielding-stress / spindle-torque / spindle-power).</p>
</blockquote>
</li>
</ul>
<h2 id="chip">Chip</h2>
<ul>
<li>ChipThickness_mm (/um): Chip thickness.</li>
<li>ChipVolume_mm3: Chip volume.</li>
<li>ChipMass_mg: Chip mass.</li>
</ul>
<h2 id="force-and-torque-including-mapping-comparison">Force and Torque (Including Mapping Comparison)</h2>
<ul>
<li>Coordinate system note: Most fields in this section indicate their coordinate system (e.g., <code>[W]</code> workpiece, <code>[TR]</code> tool running, <code>[SR]</code> spindle rotation). For coordinate system definitions and diagrams, see &quot;<a href="../analysis/milling-physics-coordinates.html">Milling Physics Coordinate Systems</a>&quot;.</li>
<li>AvgForceToToolOnToolRunningCoordinate_N, MaxAbsForce_N: Average/maximum force.</li>
<li>Various average/maximum torques (about tool tip, about sensor point; in tool running / spindle rotation / workpiece program coordinate systems).</li>
<li>AvgAbsTorque_Nm: Average absolute torque.</li>
<li>Mapping comparison: AvgMomentXyByMapping_Nm, AvgAbsTorqueByMapping_Nm, error ratios, and symbolic error correlation metrics.</li>
</ul>
<h2 id="power-torque-and-energy-consumption">Power, Torque, and Energy Consumption</h2>
<ul>
<li>SpindleInputPower_W (input power): Energy entering the spindle.</li>
<li>SpindleOutputPower_W (output power): Energy acting on the cutting end after spindle energy losses — i.e., the energy causing workpiece and chip deformation and temperature change. Output power is typically proportional to input power, with the ratio being the energy efficiency set in the spindle configuration <a class="xref" href="../../api/Hi.Milling.SpindleCapability.html#Hi_Milling_SpindleCapability_EnergyEfficiency">EnergyEfficiency</a><small>(API)</small>.</li>
<li>MaxSpindlePowerRatio (maximum spindle power ratio): Input power / instantaneous maximum power based on spindle capability.</li>
<li>ContinueSpindlePowerRatio (continuous spindle power ratio): Input power / unlimited-duration maximum power based on spindle capability.</li>
<li>AccumulatedSpindleEnergyConsumption_kWh: Accumulated spindle energy consumption.</li>
<li>Max/Continue Spindle Torque Ratio: Instantaneous/continuous spindle torque ratios.
<blockquote>
<p><strong>Reading tip — a power / torque ratio over 100% means the spindle cannot supply the demanded load at the commanded rpm</strong>, so it droops: with feed held, rpm drops, feed-per-tooth rises, and forces climb further — a runaway loop that, left unchecked, grows the chip until the cutter breaks and the spindle/drive is overstressed and damaged — load damage, not a tool-vs-workpiece collision (see <a href="../analysis/nc-optimization-principles.html">NC optimization</a>). Read it by <em>duration</em>, not just height: a one-revolution (single-cycle) overshoot usually still completes the pass — it just leaves a slightly insufficient cut there — whereas a ratio that stays above 100% across many consecutive spindle revolutions is a genuine overload to fix. A high-load step typically also shows large cutter–workpiece engagement (CWE), large tip deflection, and more vibration/noise. Because the ratio is normalized by the spindle-capability curve, a placeholder/guessed spindle skews it — confirm against the real spindle's speed–power/torque curve before calling it overloaded.</p>
</blockquote>
</li>
</ul>
<h2 id="thermal-and-temperature">Thermal and Temperature</h2>
<ul>
<li>CutterBodyTemperature_C / CutterDermisTemperature_C / WorkpieceDermisTemperature_C / ChipTemperature_C: Cutter body, cutter surface, workpiece surface, and chip temperatures.</li>
<li>GetCutterDermisTemperature_C(depth_mm) / GetCutterDermisAvgTemperature_C(depth_mm): Cutter subsurface temperature / average temperature at a given depth.</li>
<li>ThermalStress_MPa / ThermalYieldRatio: Thermal stress and thermal yield ratio. For tool breakage risk assessment based on thermal yield ratio, see &quot;<a href="../analysis/machinability.html">Evaluating Process Machinability</a>&quot;.</li>
</ul>
<h2 id="wear-and-deflection">Wear and Deflection</h2>
<p>For wear models, evaluation metrics, and applicable scenarios, see &quot;<a href="../analysis/wear.html">Tool Life and Wear</a>&quot;.</p>
<ul>
<li>InstantCraterWear_um / AccumulatedCraterWear_um: Instantaneous/accumulated crater wear.</li>
<li>AccumulatedFlankWearDepth_um / AccumulatedFlankWearWidth_um: Accumulated flank wear depth/width.</li>
<li>Tip/Edge Deflection (um): Tool tip and bottom edge deflection (including maximum and delta values), as well as ReCutDepth_um (re-cut depth).</li>
</ul>

</article>

        <div class="contribution d-print-none">
        </div>

        <div class="next-article d-print-none border-top" id="nextArticle"></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>