726 lines
32 KiB
HTML
726 lines
32 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Glossary: SessionShell Quick-Reference | HiAPI-C# 2025 </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Glossary: SessionShell Quick-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 "{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="glossary-sessionshell-quick-reference">Glossary: SessionShell Quick-Reference</h1>
|
|
|
|
<p><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html">SessionShell</a> is the global scope for all HiNC script commands. This page organizes every command by category with a one-line description and links to the workflow where each is typically used.</p>
|
|
<hr>
|
|
<h2 id="simulation-control">Simulation Control</h2>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Command</th>
|
|
<th>Description</th>
|
|
<th>Used In</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_PlayNcFile_">PlayNcFile</a></td>
|
|
<td>Execute an NC file</td>
|
|
<td><a class="xref" href="../../workflows/basic-simulation.html">Workflow: Basic Machining Simulation</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_PlayNc_">PlayNc</a></td>
|
|
<td>Execute NC code from a string</td>
|
|
<td><a class="xref" href="../../workflows/basic-simulation.html">Workflow: Basic Machining Simulation</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_PlayCsvFile_">PlayCsvFile</a></td>
|
|
<td>Drive simulation from a CSV file</td>
|
|
<td><a class="xref" href="../../workflows/basic-simulation.html">Workflow: Basic Machining Simulation</a>, <a class="xref" href="../../workflows/sensor-mapping.html">Workflow: Sensor Data Mapping</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_RunNcFile_">RunNcFile</a></td>
|
|
<td>Parse NC file and return action sequence (no auto-pacing)</td>
|
|
<td>—</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_RunNc_">RunNc</a></td>
|
|
<td>Parse NC string and return action sequence (no auto-pacing)</td>
|
|
<td>—</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_Pace_">Pace</a></td>
|
|
<td>Insert a pausable checkpoint during playback</td>
|
|
<td><a class="xref" href="../../workflows/basic-simulation.html">Workflow: Basic Machining Simulation</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_Pause_">Pause</a></td>
|
|
<td>Pause player execution</td>
|
|
<td><a class="xref" href="../../workflows/basic-simulation.html">Workflow: Basic Machining Simulation</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_Reset_">Reset</a></td>
|
|
<td>Reset player state</td>
|
|
<td><a class="xref" href="../../workflows/basic-simulation.html">Workflow: Basic Machining Simulation</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_PlayAct_">PlayAct</a></td>
|
|
<td>Execute a custom action object</td>
|
|
<td>—</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_PlayToolingTeleport_">PlayToolingTeleport</a></td>
|
|
<td>Teleport a tool to a new position</td>
|
|
<td>—</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_PlayClTeleport_">PlayClTeleport</a></td>
|
|
<td>Teleport tool to a specified CL position and orientation</td>
|
|
<td>—</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<hr>
|
|
<h2 id="configuration--resolution">Configuration — Resolution</h2>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Command</th>
|
|
<th>Description</th>
|
|
<th>Used In</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_MachiningResolution_mm">MachiningResolution_mm</a></td>
|
|
<td>Set workpiece entity resolution (power-of-2 cube width in mm)</td>
|
|
<td><a class="xref" href="../../workflows/basic-simulation.html">Workflow: Basic Machining Simulation</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_DispCache_Mb">DispCache_Mb</a></td>
|
|
<td>Set display cache size (Mb)</td>
|
|
<td><a class="xref" href="../../workflows/basic-simulation.html">Workflow: Basic Machining Simulation</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_MachiningMotionResolution">MachiningMotionResolution</a></td>
|
|
<td>Set machining motion resolution mode</td>
|
|
<td><a class="xref" href="../../workflows/basic-simulation.html">Workflow: Basic Machining Simulation</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<hr>
|
|
<h2 id="configuration--physics">Configuration — Physics</h2>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Command</th>
|
|
<th>Description</th>
|
|
<th>Used In</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_EnablePhysics">EnablePhysics</a></td>
|
|
<td>Enable/disable milling force evaluation</td>
|
|
<td><a class="xref" href="../../workflows/force-training.html">Workflow: Milling Force Parameter Training</a>, <a class="xref" href="../../workflows/nc-optimization.html">Workflow: NC Optimization</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_EnableWearEffect">EnableWearEffect</a></td>
|
|
<td>Enable/disable tool wear effects</td>
|
|
<td>—</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_MillingForceCycleDivisionNum">MillingForceCycleDivisionNum</a></td>
|
|
<td>Divisions per revolution for force calculation</td>
|
|
<td><a class="xref" href="../../workflows/force-training.html">Workflow: Milling Force Parameter Training</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_InitSpindleTemperature_C">InitSpindleTemperature_C</a></td>
|
|
<td>Initial spindle temperature (°C)</td>
|
|
<td>—</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_EnablePauseOnFailure">EnablePauseOnFailure</a></td>
|
|
<td>Pause execution on failure</td>
|
|
<td><a class="xref" href="../../workflows/geometry-validation.html">Workflow: Geometry Validation</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_EnableCollisionDetection">EnableCollisionDetection</a></td>
|
|
<td>Enable collision detection</td>
|
|
<td><a class="xref" href="../../workflows/geometry-validation.html">Workflow: Geometry Validation</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_EnablePauseOnCollision">EnablePauseOnCollision</a></td>
|
|
<td>Pause on collision</td>
|
|
<td><a class="xref" href="../../workflows/geometry-validation.html">Workflow: Geometry Validation</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<hr>
|
|
<h2 id="data-export">Data Export</h2>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Command</th>
|
|
<th>Description</th>
|
|
<th>Used In</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_WriteShotFiles_">WriteShotFiles</a></td>
|
|
<td>Export waveform (shot) data CSV at given time resolution</td>
|
|
<td><a class="xref" href="../../workflows/force-training.html">Workflow: Milling Force Parameter Training</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_WriteStepFiles_">WriteStepFiles</a></td>
|
|
<td>Export step-level data CSV</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>
|
|
</tbody>
|
|
</table>
|
|
<hr>
|
|
<h2 id="data-mapping">Data Mapping</h2>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Command</th>
|
|
<th>Description</th>
|
|
<th>Used In</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_MapSingleByCsvFile_">MapSingleByCsvFile</a></td>
|
|
<td>One-to-one time-interpolation mapping from CSV</td>
|
|
<td><a class="xref" href="../../workflows/sensor-mapping.html">Workflow: Sensor Data Mapping</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_MapSeriesByCsvFile_">MapSeriesByCsvFile</a></td>
|
|
<td>One-to-many series mapping from CSV (via ActualTime)</td>
|
|
<td><a class="xref" href="../../workflows/sensor-mapping.html">Workflow: Sensor Data Mapping</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_AddTimeDataByFile_">AddTimeDataByFile</a></td>
|
|
<td>Specify input data with time range for local mapping</td>
|
|
<td><a class="xref" href="../../workflows/sensor-mapping.html">Workflow: Sensor Data Mapping</a>, <a class="xref" href="../../workflows/force-training.html">Workflow: Milling Force Parameter Training</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_ClearTimeMappingData_">ClearTimeMappingData</a></td>
|
|
<td>Clear all mapping data</td>
|
|
<td><a class="xref" href="../../workflows/sensor-mapping.html">Workflow: Sensor Data Mapping</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_BeginSelection_">BeginSelection</a></td>
|
|
<td>Set range mapping start point (in NC comments)</td>
|
|
<td><a class="xref" href="../../workflows/sensor-mapping.html">Workflow: Sensor Data Mapping</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_EndSelection_">EndSelection</a></td>
|
|
<td>Set range mapping end point (in NC comments)</td>
|
|
<td><a class="xref" href="../../workflows/sensor-mapping.html">Workflow: Sensor Data Mapping</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_LineSelection_">LineSelection</a></td>
|
|
<td>Single-line data mapping (in NC comments)</td>
|
|
<td><a class="xref" href="../../workflows/sensor-mapping.html">Workflow: Sensor Data Mapping</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_EnableMapOnSelectionEnd">EnableMapOnSelectionEnd</a></td>
|
|
<td>Auto-trigger mapping when selection ends (default: true)</td>
|
|
<td><a class="xref" href="../../workflows/sensor-mapping.html">Workflow: Sensor Data Mapping</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<hr>
|
|
<h2 id="training">Training</h2>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Command</th>
|
|
<th>Description</th>
|
|
<th>Used In</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_TrainMillingPara_">TrainMillingPara</a></td>
|
|
<td>Train new milling coefficients from mapped data</td>
|
|
<td><a class="xref" href="../../workflows/force-training.html">Workflow: Milling Force Parameter Training</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_ReTrainMillingPara_">ReTrainMillingPara</a></td>
|
|
<td>Calibrate existing milling coefficients (10% original / 90% new)</td>
|
|
<td><a class="xref" href="../../workflows/force-training.html">Workflow: Milling Force Parameter Training</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_LoadCuttingParaByFile_">LoadCuttingParaByFile</a></td>
|
|
<td>Load cutting parameters from file into workpiece</td>
|
|
<td><a class="xref" href="../../workflows/force-training.html">Workflow: Milling Force Parameter Training</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_MillingCycleDivisionNum">MillingCycleDivisionNum</a></td>
|
|
<td>Number of angular divisions per revolution</td>
|
|
<td><a class="xref" href="../../workflows/force-training.html">Workflow: Milling Force Parameter Training</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<hr>
|
|
<h2 id="optimization">Optimization</h2>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Command</th>
|
|
<th>Description</th>
|
|
<th>Used In</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_OptimizeToFiles_">OptimizeToFiles</a></td>
|
|
<td>Output optimized NC files</td>
|
|
<td><a class="xref" href="../../workflows/nc-optimization.html">Workflow: NC Optimization</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_OptEnableFeedrate">OptEnableFeedrate</a></td>
|
|
<td>Enable sequential feed rate optimization</td>
|
|
<td><a class="xref" href="../../workflows/nc-optimization.html">Workflow: NC Optimization</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_OptEnableInterpolation">OptEnableInterpolation</a></td>
|
|
<td>Enable re-interpolation</td>
|
|
<td><a class="xref" href="../../workflows/nc-optimization.html">Workflow: NC Optimization</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_OptFeedrateAssignmentRatio">OptFeedrateAssignmentRatio</a></td>
|
|
<td>Feed rate assignment ratio for re-interpolation</td>
|
|
<td><a class="xref" href="../../workflows/nc-optimization.html">Workflow: NC Optimization</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_OptRapidFeed_mmdmin">OptRapidFeed_mmdmin</a></td>
|
|
<td>Non-cutting region feed rate (mm/min)</td>
|
|
<td><a class="xref" href="../../workflows/nc-optimization.html">Workflow: NC Optimization</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_OptMinFeedrate_mmdmin">OptMinFeedrate_mmdmin</a></td>
|
|
<td>Minimum cutting feed rate (mm/min)</td>
|
|
<td><a class="xref" href="../../workflows/nc-optimization.html">Workflow: NC Optimization</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_OptMaxFeedrate_mmdmin">OptMaxFeedrate_mmdmin</a></td>
|
|
<td>Maximum cutting feed rate (mm/min)</td>
|
|
<td><a class="xref" href="../../workflows/nc-optimization.html">Workflow: NC Optimization</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_OptMaxAcceleration_mmds2">OptMaxAcceleration_mmds2</a></td>
|
|
<td>Acceleration/deceleration limit (mm/s²)</td>
|
|
<td><a class="xref" href="../../workflows/nc-optimization.html">Workflow: NC Optimization</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_OptExtendedPreDistance_mm">OptExtendedPreDistance_mm</a></td>
|
|
<td>Pre-distance for cutting region calculation (mm)</td>
|
|
<td><a class="xref" href="../../workflows/nc-optimization.html">Workflow: NC Optimization</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_OptExtendedPostDistance_mm">OptExtendedPostDistance_mm</a></td>
|
|
<td>Post-distance for cutting region calculation (mm)</td>
|
|
<td><a class="xref" href="../../workflows/nc-optimization.html">Workflow: NC Optimization</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_OptSpindlePowerSafetyFactor">OptSpindlePowerSafetyFactor</a></td>
|
|
<td>Spindle power safety factor</td>
|
|
<td><a class="xref" href="../../workflows/nc-optimization.html">Workflow: NC Optimization</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_OptSpindleTorqueSafetyFactor">OptSpindleTorqueSafetyFactor</a></td>
|
|
<td>Spindle torque safety factor</td>
|
|
<td><a class="xref" href="../../workflows/nc-optimization.html">Workflow: NC Optimization</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_OptThermalYieldSafetyFactor">OptThermalYieldSafetyFactor</a></td>
|
|
<td>Thermal yield safety factor</td>
|
|
<td><a class="xref" href="../../workflows/nc-optimization.html">Workflow: NC Optimization</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_OptPreferedForce_N">OptPreferedForce_N</a></td>
|
|
<td>Target cutting force (N)</td>
|
|
<td><a class="xref" href="../../workflows/nc-optimization.html">Workflow: NC Optimization</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_Preserve_">Preserve</a></td>
|
|
<td>Disable optimization for a single NC line</td>
|
|
<td><a class="xref" href="../../workflows/nc-optimization.html">Workflow: NC Optimization</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_BeginPreserve_">BeginPreserve</a></td>
|
|
<td>Begin optimization-disabled range</td>
|
|
<td><a class="xref" href="../../workflows/nc-optimization.html">Workflow: NC Optimization</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_EndPreserve_">EndPreserve</a></td>
|
|
<td>End optimization-disabled range</td>
|
|
<td><a class="xref" href="../../workflows/nc-optimization.html">Workflow: NC Optimization</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_EnableIndividualStepAdjustmentLog_">EnableIndividualStepAdjustmentLog</a></td>
|
|
<td>Enable per-step optimization log file</td>
|
|
<td><a class="xref" href="../../workflows/nc-optimization.html">Workflow: NC Optimization</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_EmbeddedLogMode_">EmbeddedLogMode</a></td>
|
|
<td>Set embedded log verbosity (None / SimpleLog / FullLog)</td>
|
|
<td><a class="xref" href="../../workflows/nc-optimization.html">Workflow: NC Optimization</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<hr>
|
|
<h2 id="geometry">Geometry</h2>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Command</th>
|
|
<th>Description</th>
|
|
<th>Used In</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_WriteRuntimeGeom_">WriteRuntimeGeom</a></td>
|
|
<td>Save runtime geometry to file</td>
|
|
<td><a class="xref" href="../../workflows/basic-simulation.html">Workflow: Basic Machining Simulation</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_ReadRuntimeGeom_">ReadRuntimeGeom</a></td>
|
|
<td>Load runtime geometry from file</td>
|
|
<td><a class="xref" href="../../workflows/basic-simulation.html">Workflow: Basic Machining Simulation</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_WriteRuntimeGeomToStl_">WriteRuntimeGeomToStl</a></td>
|
|
<td>Export runtime geometry to STL</td>
|
|
<td><a class="xref" href="../../workflows/basic-simulation.html">Workflow: Basic Machining Simulation</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_WriteRuntimeGeomToObj_">WriteRuntimeGeomToObj</a></td>
|
|
<td>Export runtime geometry to Wavefront OBJ (per-vertex RGB)</td>
|
|
<td><a class="xref" href="../../workflows/basic-simulation.html">Workflow: Basic Machining Simulation</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_WriteRuntimeGeomToPly_">WriteRuntimeGeomToPly</a></td>
|
|
<td>Export runtime geometry to binary PLY (per-vertex RGB)</td>
|
|
<td><a class="xref" href="../../workflows/basic-simulation.html">Workflow: Basic Machining Simulation</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_Diff_">Diff</a></td>
|
|
<td>Compare simulated geometry against target</td>
|
|
<td><a class="xref" href="../../workflows/geometry-validation.html">Workflow: Geometry Validation</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_RemoveFlyPiece_">RemoveFlyPiece</a></td>
|
|
<td>Remove disconnected residual material</td>
|
|
<td><a class="xref" href="../../workflows/geometry-validation.html">Workflow: Geometry Validation</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_ScanRuntimeGeomInfDefect_">ScanRuntimeGeomInfDefect</a></td>
|
|
<td>Scan for infinite edge cut defects</td>
|
|
<td><a class="xref" href="../../workflows/geometry-validation.html">Workflow: Geometry Validation</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_ClearDefectDisplayee_">ClearDefectDisplayee</a></td>
|
|
<td>Clear defect visualization markers</td>
|
|
<td><a class="xref" href="../../workflows/geometry-validation.html">Workflow: Geometry Validation</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<hr>
|
|
<h2 id="events">Events</h2>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Command</th>
|
|
<th>Description</th>
|
|
<th>Used In</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_SessionStepBuilt">SessionStepBuilt</a></td>
|
|
<td>Fired when a machining step is built</td>
|
|
<td><a class="xref" href="../../workflows/nc-optimization.html">Workflow: NC Optimization</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_SessionStepSelected">SessionStepSelected</a></td>
|
|
<td>Fired when a machining step is selected</td>
|
|
<td>—</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<hr>
|
|
<h2 id="messages">Messages</h2>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Command</th>
|
|
<th>Description</th>
|
|
<th>Used In</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_Message_">Message</a></td>
|
|
<td>Display a general message</td>
|
|
<td>All workflows</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_ProgressMessage_">ProgressMessage</a></td>
|
|
<td>Display a progress message</td>
|
|
<td>All workflows</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_WarningMessage_">WarningMessage</a></td>
|
|
<td>Display a warning message</td>
|
|
<td>All workflows</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_ErrorMessage_">ErrorMessage</a></td>
|
|
<td>Display an error message</td>
|
|
<td>All workflows</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_AppendMessagesToFile_">AppendMessagesToFile</a></td>
|
|
<td>Export messages to file (optional tag filter)</td>
|
|
<td>All workflows</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_SessionProgress">SessionProgress</a></td>
|
|
<td>Session message host object</td>
|
|
<td><a class="xref" href="session-progress.html">Glossary: Session Progress (Messages)</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<hr>
|
|
<h2 id="step-data-access">Step Data Access</h2>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Command</th>
|
|
<th>Description</th>
|
|
<th>Used In</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_GetMillingStep_">GetMillingStep</a></td>
|
|
<td>Get step by index</td>
|
|
<td><a class="xref" href="../../workflows/basic-simulation.html">Workflow: Basic Machining Simulation</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_StepCount">StepCount</a></td>
|
|
<td>Total step count</td>
|
|
<td><a class="xref" href="../../workflows/basic-simulation.html">Workflow: Basic Machining Simulation</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_RegisterStepVariable_">RegisterStepVariable</a></td>
|
|
<td>Register a custom step variable</td>
|
|
<td><a class="xref" href="machining-step.html">Glossary: Machining Step</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<hr>
|
|
<h2 id="runtime-management">Runtime Management</h2>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Command</th>
|
|
<th>Description</th>
|
|
<th>Used In</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_ResetRuntime_">ResetRuntime</a></td>
|
|
<td>Clear event handlers, buffers, and runtime state</td>
|
|
<td><a class="xref" href="../../workflows/basic-simulation.html">Workflow: Basic Machining Simulation</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_MachiningSession">MachiningSession</a></td>
|
|
<td>Get the current machining session object</td>
|
|
<td>—</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<hr>
|
|
<h2 id="properties--workpiece-and-fixture">Properties — Workpiece and Fixture</h2>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Command</th>
|
|
<th>Description</th>
|
|
<th>Used In</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_Workpiece">Workpiece</a></td>
|
|
<td>Get/set the workpiece object</td>
|
|
<td><a class="xref" href="../../workflows/basic-simulation.html">Workflow: Basic Machining Simulation</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_Fixture">Fixture</a></td>
|
|
<td>Get/set the fixture object</td>
|
|
<td><a class="xref" href="../../workflows/basic-simulation.html">Workflow: Basic Machining Simulation</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_Global">Global</a></td>
|
|
<td>Global variable dictionary for cross-script data sharing</td>
|
|
<td><a class="xref" href="script-command.html">Glossary: Script Commands</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<hr>
|
|
<h2 id="tool-setup">Tool Setup</h2>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Command</th>
|
|
<th>Description</th>
|
|
<th>Used In</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_GetUniformContourTrayShiftAngle_deg_">GetUniformContourTrayShiftAngle_deg</a></td>
|
|
<td>Get tool contour shift angle (deg)</td>
|
|
<td>—</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_SetUniformContourTrayShiftAngle_deg_">SetUniformContourTrayShiftAngle_deg</a></td>
|
|
<td>Set tool contour shift angle (deg)</td>
|
|
<td>—</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_GetStickMachiningToolObservationHeight_mm_">GetStickMachiningToolObservationHeight_mm</a></td>
|
|
<td>Get smart tool holder observation height (mm)</td>
|
|
<td>—</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_SetStickMachiningToolObservationHeight_mm_">SetStickMachiningToolObservationHeight_mm</a></td>
|
|
<td>Set smart tool holder observation height (mm)</td>
|
|
<td>—</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div class="NOTE">
|
|
<h5>Note</h5>
|
|
<p>Tool setup commands are for dynamic adjustment when actual installation conditions differ from defaults. Typically, configure these in the tool configuration file instead.</p>
|
|
</div>
|
|
<hr>
|
|
<h2 id="see-also">See Also</h2>
|
|
<ul>
|
|
<li><a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html">SessionShell</a> — full API documentation</li>
|
|
<li><a class="xref" href="script-command.html">Glossary: Script Commands</a> — what is a script command</li>
|
|
<li><a class="xref" href="machining-step.html">Glossary: Machining Step</a> — step data model</li>
|
|
<li><a class="xref" href="session-progress.html">Glossary: Session Progress (Messages)</a> — message system</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>
|