Archived
deploy.
This commit is contained in:
@@ -0,0 +1,212 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>SessionShell | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="SessionShell | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="Glossary-SessionShell">
|
||||
<h1 id="sessionshell">SessionShell</h1>
|
||||
|
||||
<p><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html">SessionShell</a> is the global scope of the HiNC scripting engine: a script names its members directly, with no object reference and no <code>using</code>. Everything a script does to a session — start a playback, set a resolution, export a file, train a coefficient, read a step — is a member of this one type.</p>
|
||||
<p>The complete and current list of commands, properties and events is the generated <a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html">SessionShell</a> reference. This page is the map onto it — which family does what, and which workflow reaches for it. The members are deliberately not re-listed here: a hand-copied index of an API drifts the moment the API changes, and nothing in the build can catch it.</p>
|
||||
<h2 id="command-families">Command Families</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Family</th>
|
||||
<th>What it does</th>
|
||||
<th>Where it is used</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><strong>Playback</strong></td>
|
||||
<td>Runs a program — NC files and NC strings, CSV-driven playback, cutter-location files, and tool teleports. Parse-only variants return the action sequence without pacing it.</td>
|
||||
<td><a class="xref" href="../../workflows/basic-simulation.html">Workflow: Basic Machining Simulation</a>, <a class="xref" href="cutter-location-playback.html">Cutter-Location (CL) Playback</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Player control</strong></td>
|
||||
<td>Paces, pauses and resets the running player: the checkpoints a script inserts into a playback.</td>
|
||||
<td><a class="xref" href="../../workflows/basic-simulation.html">Workflow: Basic Machining Simulation</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Resolution and cache</strong></td>
|
||||
<td>Workpiece entity resolution, motion resolution mode, display cache size. The largest single influence a script has on run time.</td>
|
||||
<td><a class="xref" href="../../workflows/basic-simulation.html">Workflow: Basic Machining Simulation</a>, <a class="xref" href="../simulation-performance/cpu-usage.html">CPU Usage During Simulation</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Physics switches</strong></td>
|
||||
<td>Whether milling force, wear effect and collision detection are evaluated; angular divisions per revolution; initial spindle temperature; whether a failure or a collision pauses the run.</td>
|
||||
<td><a class="xref" href="../../workflows/force-training.html">Workflow: Milling Force Parameter Training</a>, <a class="xref" href="../../workflows/geometry-validation.html">Workflow: Geometry Validation</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Data export</strong></td>
|
||||
<td>Step-level CSV and waveform (shot) CSV, both accepting the <code>[NcName]</code> template.</td>
|
||||
<td><a class="xref" href="../../workflows/basic-simulation.html">Workflow: Basic Machining Simulation</a>, <a class="xref" href="../../workflows/force-training.html">Workflow: Milling Force Parameter Training</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Sensor mapping</strong></td>
|
||||
<td>Puts measured data alongside the simulated run: one-to-one and series mapping from CSV, time-range selection written into NC comments, and clearing what was mapped.</td>
|
||||
<td><a class="xref" href="../../workflows/sensor-mapping.html">Workflow: Sensor Data Mapping</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Training</strong></td>
|
||||
<td>Trains milling coefficients from mapped data, calibrates existing ones, and loads cutting parameters into the workpiece.</td>
|
||||
<td><a class="xref" href="../../workflows/force-training.html">Workflow: Milling Force Parameter Training</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Optimization</strong></td>
|
||||
<td>The optimizer's file output and its whole settings surface — feed-rate and re-interpolation switches, feed and acceleration limits, the four safety factors, the target force, the preserve ranges that exempt lines, and the per-step log.</td>
|
||||
<td><a class="xref" href="../../workflows/nc-optimization.html">Workflow: NC Optimization</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Geometry</strong></td>
|
||||
<td>Reads, writes and exports meshed geometry (STL / OBJ / PLY), compares the cut against a target, removes disconnected residual material, and scans for defects.</td>
|
||||
<td><a class="xref" href="../../workflows/geometry-validation.html">Workflow: Geometry Validation</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Messages</strong></td>
|
||||
<td>The four message severities and the file export, all routed through <a class="xref" href="shell-progress.html">ShellProgress</a>.</td>
|
||||
<td>all workflows</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Step access</strong></td>
|
||||
<td>Reads a step by index, reports the step count, and registers custom step variables.</td>
|
||||
<td><a class="xref" href="step.html">Step</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Events</strong></td>
|
||||
<td>Per-step hooks that fire as a step is built or selected.</td>
|
||||
<td><a class="xref" href="../../workflows/nc-optimization.html">Workflow: NC Optimization</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Runtime management</strong></td>
|
||||
<td>Clears event handlers, buffers and runtime state, and carries data between scripts through the <code>Global</code> dictionary.</td>
|
||||
<td><a class="xref" href="script-command.html">Script Commands</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Tool setup</strong></td>
|
||||
<td>Adjusts contour shift angle and smart-holder observation height at run time.</td>
|
||||
<td><a class="xref" href="../measurement/smart-holder-training.html">Smart Tool Holder Coefficient Training</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="what-the-generated-reference-does-not-say">What the Generated Reference Does Not Say</h2>
|
||||
<ul>
|
||||
<li><strong>Tool setup is for a mismatch, not for configuration.</strong> Those members exist for the case where the actual installation differs from the configured tool. Where the two agree, set the value in the tool configuration file instead — a script that sets it is silently overriding what everyone else reads.</li>
|
||||
<li><strong>The geometry family answers to hidden legacy names.</strong> <code>WriteRuntimeGeom</code> / <code>ReadRuntimeGeom</code> / <code>ExportRuntimeGeomTo*</code> / <code>ScanRuntimeGeomInfDefect</code> still run in existing player scripts as aliases of the <code>MeshedGeom</code> names; new scripts use the new names. The full mapping is in <a href="../../release-note/upgrading-to-3.2/breaking-changes.html#5-renames-with-no-shim">Renames with no shim</a>.</li>
|
||||
<li><strong>Resetting the runtime does not clear the record.</strong> Event handlers, buffers and runtime state go; messages already recorded stay — see <a class="xref" href="shell-progress.html">ShellProgress</a>.</li>
|
||||
</ul>
|
||||
<h2 id="see-also">See Also</h2>
|
||||
<ul>
|
||||
<li><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html">SessionShell</a> — the generated reference this page maps</li>
|
||||
<li><a class="xref" href="script-command.html">Script Commands</a> — the syntax and lifecycle a command runs inside</li>
|
||||
<li><a class="xref" href="step.html">Step</a> — the data model the step-access family returns</li>
|
||||
<li><a class="xref" href="shell-progress.html">ShellProgress</a> — the message host the message family writes to</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>
|
||||
Reference in New Issue
Block a user