212 lines
12 KiB
HTML
212 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Namespace Hi.NcParsers.InspectionSyntaxs | HiAPI-C# 2025 </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Namespace Hi.NcParsers.InspectionSyntaxs | 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.NcParsers.InspectionSyntaxs">
|
|
|
|
<h1 id="Hi_NcParsers_InspectionSyntaxs" data-uid="Hi.NcParsers.InspectionSyntaxs" class="text-break">Namespace Hi.NcParsers.InspectionSyntaxs</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.NcParsers.InspectionSyntaxs.CleanupSyntax.html">CleanupSyntax</a></dt>
|
|
<dd><p>Removes indicated JSON keys from <a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html#Hi_NcParsers_Syntaxs_SyntaxPiece_JsonObject">JsonObject</a>
|
|
after upstream syntaxes have consumed them.
|
|
Useful for cleaning up runtime-derived intermediate data
|
|
(e.g., <a class="xref" href="Hi.NcParsers.Keywords.ITransformationDef.html#Hi_NcParsers_Keywords_ITransformationDef_ProgramToMcTransform">ProgramToMcTransform</a>)
|
|
that should not persist in the final output.</p>
|
|
<p>
|
|
Place at the end of the syntax list, after all consumers have read the keys.
|
|
</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.NcParsers.InspectionSyntaxs.ProgramXyzBackfillSyntax.html">ProgramXyzBackfillSyntax</a></dt>
|
|
<dd><p>Debug / observability back-fill: writes
|
|
<a class="xref" href="Hi.NcParsers.Keywords.IProgramXyzDef.html#Hi_NcParsers_Keywords_IProgramXyzDef_ProgramXyz">ProgramXyz</a> onto blocks that did not have it
|
|
written by upstream logic syntaxes (e.g. <a class="xref" href="Hi.NcParsers.Initializers.HomeMcInitializer.html">HomeMcInitializer</a>
|
|
block, chain-change blocks that only updated MC via a rotary-only path),
|
|
<b>only when</b> the effective program position has changed from the
|
|
last block that stored a <a class="xref" href="Hi.NcParsers.Keywords.IProgramXyzDef.html#Hi_NcParsers_Keywords_IProgramXyzDef_ProgramXyz">ProgramXyz</a>.</p>
|
|
<p>
|
|
Skips the block entirely when either of these holds:
|
|
<ul><li>The block already has <a class="xref" href="Hi.NcParsers.Keywords.IProgramXyzDef.html#Hi_NcParsers_Keywords_IProgramXyzDef_ProgramXyz">ProgramXyz</a>
|
|
written — e.g. by <a class="xref" href="Hi.NcParsers.LogicSyntaxs.ProgramXyzSyntax.html">ProgramXyzSyntax</a>,
|
|
<a class="xref" href="Hi.NcParsers.LogicSyntaxs.G53p1RotaryPositionSyntax.html">G53p1RotaryPositionSyntax</a>,
|
|
<a class="xref" href="Hi.NcParsers.LogicSyntaxs.MachineCoordSelectSyntax.html">MachineCoordSelectSyntax</a>,
|
|
<a class="xref" href="Hi.NcParsers.LogicSyntaxs.ReferenceReturnSyntax.html">ReferenceReturnSyntax</a>,
|
|
<a class="xref" href="Hi.NcParsers.LogicSyntaxs.McAbcXyzFallbackSyntax.html">McAbcXyzFallbackSyntax</a>, or
|
|
<a class="xref" href="Hi.NcParsers.PostLogicSyntaxs.RadiusCompensationSyntax.html">RadiusCompensationSyntax</a>.</li><li>The effective value equals the last stored value (modal-only
|
|
block such as pure F / S / M / plane-select — no program motion).</li></ul>
|
|
|
|
<p>
|
|
Only back-fills the root block; <a class="xref" href="Hi.NcParsers.Keywords.CompoundMotion.html#Hi_NcParsers_Keywords_CompoundMotion_ItemsKey">ItemsKey</a>
|
|
items are intentionally skipped (they are managed by
|
|
<span class="xref">Hi.NcParsers.LogicSyntaxs.CompoundMotionSyntaxUtil</span> and per-cycle
|
|
syntaxes that already write the right per-item <code>ProgramXyz</code>).
|
|
</p>
|
|
<p>
|
|
Placement: end of <a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_NcSyntaxList">NcSyntaxList</a>, <b>after</b>
|
|
<a class="xref" href="Hi.NcParsers.InspectionSyntaxs.UnconsumedCheckSyntax.html">UnconsumedCheckSyntax</a>. Runs purely as a
|
|
bookkeeping pass — no other syntax / semantic in the default pipeline
|
|
reads the additional back-fill values it emits, so the runtime output
|
|
(<a class="xref" href="Hi.Numerical.Acts.IAct.html">IAct</a> stream) is unchanged whether
|
|
this syntax is present or not. The only observable effect is
|
|
additional <code>ProgramXyz</code> entries in the cached
|
|
<code>syntax-pieces</code> dump, which makes block-to-block debugging
|
|
and diffing easier.
|
|
</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html">SnapshotSyntax</a></dt>
|
|
<dd><p>Debug-time JsonObject capture: deep-clones every key on the current
|
|
<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html#Hi_NcParsers_Syntaxs_SyntaxPiece_JsonObject">JsonObject</a> (except the
|
|
<a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_SnapshotKey">SnapshotKey</a> envelope itself) into
|
|
<code>json[<a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_SnapshotKey">SnapshotKey</a>][<a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_SectionName">SectionName</a>]</code>,
|
|
leaving the rest of the block untouched.</p>
|
|
<p>
|
|
Insertable at any position in <a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_NcSyntaxList">NcSyntaxList</a> —
|
|
placement determines what stage the dump captures (e.g. drop after
|
|
the Parsing bundle for "after-parsing", drop after the Logic bundle
|
|
for "after-logic"). Two instances with different
|
|
<a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_SectionName">SectionName</a> values can coexist on the same pipeline and
|
|
their dumps end up under sibling keys of the same
|
|
<a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_SnapshotKey">SnapshotKey</a> envelope, so a single cache file shows the
|
|
data at every captured stage in one place.
|
|
</p>
|
|
<p>
|
|
Excluding the <a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_SnapshotKey">SnapshotKey</a> envelope from the clone keeps
|
|
each captured section flat: it reflects "everything else on the block
|
|
at that stage", and re-running through additional
|
|
<a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html">SnapshotSyntax</a> instances never nests past one level.
|
|
</p>
|
|
<p>
|
|
Set <a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_IsEnabled">IsEnabled</a> = <code>false</code> to keep the configuration
|
|
in place but skip the capture (no JSON mutation, no allocation) —
|
|
convenient for toggling a debug pipeline without removing the entries.
|
|
</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.NcParsers.InspectionSyntaxs.UnconsumedCheckSyntax.html">UnconsumedCheckSyntax</a></dt>
|
|
<dd><p>Emits diagnostic warnings for content remaining after all upstream
|
|
syntaxes have run: unconsumed <a class="xref" href="Hi.NcParsers.Keywords.IParsingDef.html#Hi_NcParsers_Keywords_IParsingDef_Parsing">Parsing</a> entries
|
|
and non-empty <a class="xref" href="Hi.NcParsers.Keywords.IUnparsedTextDef.html#Hi_NcParsers_Keywords_IUnparsedTextDef_UnparsedText">UnparsedText</a>.
|
|
Flags listed in <a class="xref" href="Hi.NcParsers.InspectionSyntaxs.UnconsumedCheckSyntax.html#Hi_NcParsers_InspectionSyntaxs_UnconsumedCheckSyntax_ExcludedFlags">ExcludedFlags</a> are silently ignored.
|
|
Must be placed at the end of <a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_NcSyntaxList">NcSyntaxList</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>
|