HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/workflows/simulation-report.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
      <title>Workflow: Building a Simulation Report | HiAPI-C# 2025 </title>
      <meta name="viewport" content="width=device-width, initial-scale=1.0">
      <meta name="title" content="Workflow: Building a Simulation Report | 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="Workflow-SimulationReport">
          <h1 id="workflow-building-a-simulation-report">Workflow: Building a Simulation Report</h1>

<p>After a simulation has run, a report communicates the result: what the finished part looks like, how the machining loads evolved over the program, and whether the run was clean. This workflow covers how to turn a completed player session into a focused set of report captures — keeping the panels that carry result information and leaving out the navigation chrome.</p>
<pre><code class="lang-mermaid">flowchart TD
    Build[&quot;Build project&lt;br&gt;(equipment, job, options)&quot;]
    Run[&quot;Run simulation&quot;]
    Capture[&quot;Capture focused views&lt;br&gt;(canvas · strip charts · messages)&quot;]
    Assemble[&quot;Assemble report&quot;]

    Build --&gt; Run --&gt; Capture --&gt; Assemble
</code></pre>
<h2 id="1-build-and-run">1. Build and Run</h2>
<p>Stand up and run the project first — see <a href="basic-simulation.html">Basic Machining Simulation</a> for equipment, job, options, and the <code>Play*</code> run commands. A report is built from a <strong>completed</strong> run: the workpiece geometry is final and the strip charts span the whole program.</p>
<h2 id="2-what-to-capture--and-what-to-leave-out">2. What to Capture — and What to Leave Out</h2>
<p>The player screen carries more panels than a report needs. A good report keeps the panels that hold result information and drops the navigation chrome:</p>
<table>
<thead>
<tr>
<th>Panel</th>
<th>In a report?</th>
<th>Why</th>
</tr>
</thead>
<tbody>
<tr>
<td>Main 3D canvas</td>
<td><strong>Keep</strong></td>
<td>The finished part — the headline image</td>
</tr>
<tr>
<td><a class="xref" href="../anatomy/execution/strip-charts.html">Strip Charts</a></td>
<td><strong>Keep</strong></td>
<td>Machining loads / availability over the whole program</td>
</tr>
<tr>
<td><a class="xref" href="../anatomy/shell/session-message-panel.html">Session Messages</a></td>
<td><strong>Keep (optional)</strong></td>
<td>The run log — proof the run was clean</td>
</tr>
<tr>
<td>Control Tree column</td>
<td>Drop</td>
<td>Navigation only; no result content</td>
</tr>
<tr>
<td><a class="xref" href="../anatomy/execution/selected-step-info-panel.html">Selected-Step Info column</a></td>
<td>Drop</td>
<td>Single-step detail; not a whole-run summary</td>
</tr>
</tbody>
</table>
<p>Use the three region quick-toggles in the top toolbar to collapse the columns you are not capturing, so each kept panel gets the full width/height.</p>
<h2 id="3-main-3d-canvas--several-views">3. Main 3D Canvas — Several Views</h2>
<p>Capture the finished part from several angles. Use the <strong>View</strong> menu on the <a class="xref" href="../anatomy/widget/renderingcanvas-tool-bar.html">Rendering Canvas Tool Bar</a> to switch between the orthographic and isometric presets (Isometric, Front, Back, Left, Right, Top, Bottom).</p>
<ul>
<li><strong>Isometric + Top</strong> are the most informative for most parts.</li>
<li>Add <strong>Front / Right</strong> for thin or shallow parts, where the side profile carries the wall thickness.</li>
</ul>
<div class="TIP">
<h5>Tip</h5>
<p><strong>The tool-path overlay carries information too — capture both.</strong> The machined tool-path overlay (the CL strip) shows the machining coverage and the retract/plunge motion, but it can be dense enough to obscure the part shape underneath. It is worth capturing each view <strong>both ways</strong>: with the tool path on (machining coverage) and off (clean part). Toggle it with the <strong>Tool Path</strong> button on the <a class="xref" href="../anatomy/execution/execution-extended-renderingcanvas-tool-bar.html">Execution Extended RenderingCanvas Tool Bar</a> (and <strong>Path Points</strong> off with it). The workpiece geometry is a separate display flag, so it stays visible when the tool path is off.</p>
</div>
<h2 id="4-strip-charts--capture-wide">4. Strip Charts — Capture Wide</h2>
<p>The strip charts read best <strong>wide</strong>: at full width the whole-program time axis is legible and the per-series peaks are distinct. Before capturing, widen the right dock (drag its divider, or collapse the Selected-Step Info column so the charts fill the dock). See <a class="xref" href="../anatomy/execution/strip-charts.html">Strip Charts</a> for the chart types (Availability, Roughness, Color-Index) and their legends.</p>
<h2 id="5-session-messages--the-run-log">5. Session Messages — the Run Log</h2>
<p>The <a class="xref" href="../anatomy/shell/session-message-panel.html">Session Messages</a> panel's <strong>Shell / NC / Step</strong> tabs are the run log. <strong>Zero errors across all three tabs</strong> is the single strongest piece of report evidence that the run was clean. Use the panel's <strong>Export</strong> action to save the full log alongside the report.</p>
<h2 id="6-assemble">6. Assemble</h2>
<p>Combine the captures into the report: a multi-view montage of the finished part, the wide strip charts, and (optionally) the session log. Pair each with a one-line caption stating what it shows (part geometry, load history, clean run).</p>
<h2 id="see-also">See Also</h2>
<ul>
<li><a href="basic-simulation.html">Basic Machining Simulation</a> — build and run the project first</li>
<li><a class="xref" href="../anatomy/execution/strip-charts.html">Strip Charts</a> — chart types and legends</li>
<li><a class="xref" href="../anatomy/execution/execution-extended-renderingcanvas-tool-bar.html">Execution Extended RenderingCanvas Tool Bar</a> — the Tool Path / Path Points toggles</li>
<li><a class="xref" href="../anatomy/shell/session-message-panel.html">Session Message Panel</a> — Shell / NC / Step tabs and Export</li>
<li><a class="xref" href="../technique/scripting/session-shell.html">SessionShell</a> — SessionShell quick-reference</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>