Archived
286 lines
14 KiB
HTML
286 lines
14 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Namespace Hi.SessionCommands | HiAPI-C# 2025 </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Namespace Hi.SessionCommands | 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="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.SessionCommands">
|
|
|
|
<h1 id="Hi_SessionCommands" data-uid="Hi.SessionCommands" class="text-break">Namespace Hi.SessionCommands</h1>
|
|
<div class="markdown level0 summary"></div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="markdown level0 remarks"></div>
|
|
|
|
<h3 id="classes">
|
|
Classes
|
|
</h3>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.CollisionDetectionCommand.html">CollisionDetectionCommand</a></dt>
|
|
<dd><p>Command that turns collision detection on or off for the session. One of
|
|
the single-setting successors of the legacy <a class="xref" href="Hi.SessionCommands.PreSettingCommand.html">PreSettingCommand</a>
|
|
bundle.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.CommandCatalogAttribute.html">CommandCatalogAttribute</a></dt>
|
|
<dd><p>Marks an <a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a> as user-addable: GUIs build their
|
|
“Add Command” catalog from the commands carrying this attribute, grouped
|
|
by <a class="xref" href="Hi.SessionCommands.CommandCatalogAttribute.html#Hi_SessionCommands_CommandCatalogAttribute_Category">Category</a>. A command WITHOUT this attribute stays loadable
|
|
from project files (its <code>Reg</code> registration is unaffected) but is not
|
|
offered for creation.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.CommandFieldAttribute.html">CommandFieldAttribute</a></dt>
|
|
<dd><p>Marks a session-command property as a directly editable scalar field, so
|
|
generic editors (e.g. the web UI's fallback command panel) can render and
|
|
update it without a hand-written per-command editor. Supported property
|
|
types: <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a> and
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.EnablingWrapper.html">EnablingWrapper</a></dt>
|
|
<dd><p>Wrapper for session commands that provides enable/disable functionality.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.ExportMeshedGeomToStlCommand.html">ExportMeshedGeomToStlCommand</a></dt>
|
|
<dd><p>Command to call <a class="xref" href="Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_ExportMeshedGeomToStl_System_String_System_Double_">ExportMeshedGeomToStl(string, double)</a>.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.GeomDiffCommand.html">GeomDiffCommand</a></dt>
|
|
<dd><p>Command for calculating geometric differences between workpieces.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.Lang.html">Lang</a></dt>
|
|
<dd><p>Language package class for command flow.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.ListCommand.html">ListCommand</a></dt>
|
|
<dd><p>A command that contains and executes a list of other commands.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.MachiningMotionResolutionCommand.html">MachiningMotionResolutionCommand</a></dt>
|
|
<dd><p>Command for setting machining motion resolution for the milling process.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.MachiningResolutionCommand.html">MachiningResolutionCommand</a></dt>
|
|
<dd><p>Command that sets the session's machining resolution — the meshing
|
|
resolution of material removal. One of the single-setting successors of
|
|
the legacy <a class="xref" href="Hi.SessionCommands.PreSettingCommand.html">PreSettingCommand</a> bundle.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.NcCodeCommand.html">NcCodeCommand</a></dt>
|
|
<dd><p>Command for executing NC code directly.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.NcFileCommand.html">NcFileCommand</a></dt>
|
|
<dd><p>Command for executing an NC program file (<code>Nc</code> is the umbrella term:
|
|
brand controller code, NX-CL or CSV). The runner is picked by
|
|
<a class="xref" href="Hi.SessionCommands.NcFileCommand.html#Hi_SessionCommands_NcFileCommand_NcKind">NcKind</a> — <a class="xref" href="Hi.MachiningProcs.NcKind.html#Hi_MachiningProcs_NcKind_Auto">Auto</a>
|
|
(the default) detects by file extension: <code>.cl</code>/<code>.cls</code>/<code>.clsf</code>
|
|
play as NX-CL, <code>.csv</code> as CSV, anything else as brand NC code.
|
|
The GUI labels it “Program File”.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.NcOptOptionCommand.html">NcOptOptionCommand</a></dt>
|
|
<dd><p>Command for NC optimization options.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.OptimizeToFilesCommand.html">OptimizeToFilesCommand</a></dt>
|
|
<dd><p>Command to call <a class="xref" href="Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_OptimizeToFiles_System_String_">OptimizeToFiles(string)</a>.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.PauseOnFailureCommand.html">PauseOnFailureCommand</a></dt>
|
|
<dd><p>Command that turns pause-on-failure on or off for the session. One of the
|
|
single-setting successors of the legacy <a class="xref" href="Hi.SessionCommands.PreSettingCommand.html">PreSettingCommand</a>
|
|
bundle.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.PhysicsCommand.html">PhysicsCommand</a></dt>
|
|
<dd><p>Command that turns physics simulation on or off for the session. One of
|
|
the single-setting successors of the legacy <a class="xref" href="Hi.SessionCommands.PreSettingCommand.html">PreSettingCommand</a>
|
|
bundle.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.PostExecutionCommand.html">PostExecutionCommand</a></dt>
|
|
<dd><p>Command for post-execution actions after NC command running.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.PreSettingCommand.html">PreSettingCommand</a></dt>
|
|
<dd><p>Legacy bundle of pre-settings applied before NC command running,
|
|
superseded by the single-setting commands (machining resolution, motion
|
|
resolution, collision detection, pause on failure, physics). Loading a
|
|
project expands a saved instance into those commands via
|
|
<a class="xref" href="Hi.SessionCommands.PreSettingCommand.html#Hi_SessionCommands_PreSettingCommand_ExpandToEntries_System_Boolean_">ExpandToEntries(bool)</a>; saving never writes the bundle back. The
|
|
class stays functional for API callers that construct it directly.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.RecordMeshedGeomCommand.html">RecordMeshedGeomCommand</a></dt>
|
|
<dd><p>Command for recording meshed geometry to/from file.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.ScriptCommand.html">ScriptCommand</a></dt>
|
|
<dd><p>Command for executing C# scripts in the milling process.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.WriteShotFilesCommand.html">WriteShotFilesCommand</a></dt>
|
|
<dd><p>Command to call <a class="xref" href="Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_WriteShotFiles_System_String_System_Double_">WriteShotFiles(string, double)</a>.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.WriteStepFilesCommand.html">WriteStepFilesCommand</a></dt>
|
|
<dd><p>Command to call <a class="xref" href="Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_WriteStepFiles_System_String_">WriteStepFiles(string)</a>.</p>
|
|
</dd>
|
|
</dl>
|
|
<h3 id="interfaces">
|
|
Interfaces
|
|
</h3>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a></dt>
|
|
<dd><p>Interface for commands that can be executed in a machining session.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.ITitleCommand.html">ITitleCommand</a></dt>
|
|
<dd><p><a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a> with title.</p>
|
|
</dd>
|
|
</dl>
|
|
<h3 id="enums">
|
|
Enums
|
|
</h3>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.CommandCategory.html">CommandCategory</a></dt>
|
|
<dd><p>Category of a session command in user-facing command catalogs (the GUI
|
|
“Add Command” listings). Declaration order is the display order.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.SessionCommands.RecordMeshedGeomActionEnum.html">RecordMeshedGeomActionEnum</a></dt>
|
|
<dd><p>Action of the <a class="xref" href="Hi.SessionCommands.RecordMeshedGeomCommand.html">RecordMeshedGeomCommand</a>.</p>
|
|
</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>
|