Archived
479 lines
18 KiB
HTML
479 lines
18 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Class ControllerPresetWriter | HiAPI-C# 2025 </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Class ControllerPresetWriter | HiAPI-C# 2025 ">
|
|
|
|
<meta name="description" content="Writes the built-in brand controller presets out as standalone resource files. A controller resource file is one serialized — the whole pipeline (dependencies, segmenter, initializers, syntaxes, semantics) that decides how a brand's NC code is interpreted. The shipped copies live under Resource/Controller/ so the Object Management Load browser starts populated; they are regenerable snapshots, not the source of truth — the brand properties on are. Writing needs no registration. Reading a file back does: call first, otherwise XFactory.GenListSkippingUnloadable drops every unregistered pipeline entry and hands back a silently hollow runner.">
|
|
<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.ControllerPresetWriter">
|
|
|
|
|
|
|
|
<h1 id="Hi_NcParsers_ControllerPresetWriter" data-uid="Hi.NcParsers.ControllerPresetWriter" class="text-break">
|
|
Class ControllerPresetWriter
|
|
</h1>
|
|
|
|
<div class="facts text-secondary">
|
|
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcParsers.html">NcParsers</a></dd></dl>
|
|
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
|
</div>
|
|
|
|
<div class="markdown summary"><p>Writes the built-in brand controller presets out as standalone
|
|
<a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a> resource files.</p>
|
|
<p>
|
|
A controller resource file is one serialized <a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a> — the
|
|
whole pipeline (dependencies, segmenter, initializers, syntaxes, semantics)
|
|
that decides how a brand's NC code is interpreted. The shipped copies live
|
|
under <code>Resource/Controller/</code> so the Object Management <em>Load</em>
|
|
browser starts populated; they are regenerable snapshots, not the source of
|
|
truth — the brand properties on <a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a> are.
|
|
</p>
|
|
<p>
|
|
Writing needs no <a class="xref" href="Hi.Common.XmlUtils.XFactory.html">XFactory</a> registration. Reading a file back
|
|
does: call <a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_Reg_Hi_Common_XmlUtils_XFactory_">Reg(XFactory)</a> first, otherwise
|
|
<code>XFactory.GenListSkippingUnloadable</code> drops every unregistered pipeline
|
|
entry and hands back a silently hollow runner.
|
|
</p>
|
|
</div>
|
|
<div class="markdown conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static class ControllerPresetWriter</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="typelist inheritance">
|
|
<dt>Inheritance</dt>
|
|
<dd>
|
|
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
|
<div><span class="xref">ControllerPresetWriter</span></div>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<dl class="typelist inheritedMembers">
|
|
<dt>Inherited Members</dt>
|
|
<dd>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="fields">Fields
|
|
</h2>
|
|
|
|
|
|
|
|
<h3 id="Hi_NcParsers_ControllerPresetWriter_FileExtension" data-uid="Hi.NcParsers.ControllerPresetWriter.FileExtension">
|
|
FileExtension
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Canonical extension of a serialized <a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a> — named after
|
|
the controller it describes rather than the class that implements it. The
|
|
Controller tree's Object Management menu filters on it, so a file written
|
|
here is visible in its Load browser; the older <code>.SoftNcRunner</code>
|
|
extension stays loadable there for assets already saved under it.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public const string FileExtension = ".Controller"</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Field Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Hi_NcParsers_ControllerPresetWriter_ResourceCategoryFolder" data-uid="Hi.NcParsers.ControllerPresetWriter.ResourceCategoryFolder">
|
|
ResourceCategoryFolder
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Resource category folder the presets are shipped under, relative to the
|
|
resource root (i.e. <code>Resource/Controller</code>).</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public const string ResourceCategoryFolder = "Controller"</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Field Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="properties">Properties
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_NcParsers_ControllerPresetWriter_BrandNames_" data-uid="Hi.NcParsers.ControllerPresetWriter.BrandNames*"></a>
|
|
|
|
<h3 id="Hi_NcParsers_ControllerPresetWriter_BrandNames" data-uid="Hi.NcParsers.ControllerPresetWriter.BrandNames">
|
|
BrandNames
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Brand tokens <a class="xref" href="Hi.NcParsers.ControllerPresetWriter.html#Hi_NcParsers_ControllerPresetWriter_CreateBrandPreset_System_String_">CreateBrandPreset(string)</a> understands, in the order
|
|
<a class="xref" href="Hi.NcParsers.ControllerPresetWriter.html#Hi_NcParsers_ControllerPresetWriter_WriteAllBrandPresetFiles_System_String_">WriteAllBrandPresetFiles(string)</a> writes them.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static IReadOnlyList<string> BrandNames { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlylist-1">IReadOnlyList</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="methods">Methods
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_NcParsers_ControllerPresetWriter_CreateBrandPreset_" data-uid="Hi.NcParsers.ControllerPresetWriter.CreateBrandPreset*"></a>
|
|
|
|
<h3 id="Hi_NcParsers_ControllerPresetWriter_CreateBrandPreset_System_String_" data-uid="Hi.NcParsers.ControllerPresetWriter.CreateBrandPreset(System.String)">
|
|
CreateBrandPreset(string)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets a fresh brand preset runner, or <code>null</code> when
|
|
<code class="paramref">brand</code> is not one of <a class="xref" href="Hi.NcParsers.ControllerPresetWriter.html#Hi_NcParsers_ControllerPresetWriter_BrandNames">BrandNames</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static SoftNcRunner CreateBrandPreset(string brand)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>brand</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>One of the <a class="xref" href="Hi.NcParsers.Dependencys.CncBrandDependency.html">CncBrandDependency</a> brand tokens.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section" id="Hi_NcParsers_ControllerPresetWriter_CreateBrandPreset_System_String__remarks">Remarks</h4>
|
|
<div class="markdown level1 remarks"><p>Each brand property builds a new instance per read, so the returned runner
|
|
is safe to mutate before writing.</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<a id="Hi_NcParsers_ControllerPresetWriter_GetBrandPresetFileName_" data-uid="Hi.NcParsers.ControllerPresetWriter.GetBrandPresetFileName*"></a>
|
|
|
|
<h3 id="Hi_NcParsers_ControllerPresetWriter_GetBrandPresetFileName_System_String_" data-uid="Hi.NcParsers.ControllerPresetWriter.GetBrandPresetFileName(System.String)">
|
|
GetBrandPresetFileName(string)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Builds the file name a brand preset is shipped under, e.g.
|
|
<code>Fanuc.default.Controller</code> — the <a class="xref" href="Hi.Common.ResourceDefaultMarker.html">ResourceDefaultMarker</a>
|
|
token declares the file system-owned, so the resource seeder may refresh
|
|
it on version updates. The runner carries no name of its own, so the
|
|
file name is the only identity a resource browser can show.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static string GetBrandPresetFileName(string brand)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>brand</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>One of the <a class="xref" href="Hi.NcParsers.Dependencys.CncBrandDependency.html">CncBrandDependency</a> brand tokens.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_NcParsers_ControllerPresetWriter_WriteAllBrandPresetFiles_" data-uid="Hi.NcParsers.ControllerPresetWriter.WriteAllBrandPresetFiles*"></a>
|
|
|
|
<h3 id="Hi_NcParsers_ControllerPresetWriter_WriteAllBrandPresetFiles_System_String_" data-uid="Hi.NcParsers.ControllerPresetWriter.WriteAllBrandPresetFiles(System.String)">
|
|
WriteAllBrandPresetFiles(string)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Writes every brand preset in <a class="xref" href="Hi.NcParsers.ControllerPresetWriter.html#Hi_NcParsers_ControllerPresetWriter_BrandNames">BrandNames</a> into
|
|
<code class="paramref">targetDirectory</code> and returns the written file paths.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static IReadOnlyList<string> WriteAllBrandPresetFiles(string targetDirectory)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>targetDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>Directory to write into, e.g. an absolute path ending in <code>Resource/Controller</code>.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlylist-1">IReadOnlyList</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_NcParsers_ControllerPresetWriter_WriteBrandPresetFile_" data-uid="Hi.NcParsers.ControllerPresetWriter.WriteBrandPresetFile*"></a>
|
|
|
|
<h3 id="Hi_NcParsers_ControllerPresetWriter_WriteBrandPresetFile_System_String_System_String_" data-uid="Hi.NcParsers.ControllerPresetWriter.WriteBrandPresetFile(System.String,System.String)">
|
|
WriteBrandPresetFile(string, string)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Writes one brand preset into <code class="paramref">targetDirectory</code> and returns
|
|
the written file path. Missing directories are created.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static string WriteBrandPresetFile(string brand, string targetDirectory)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>brand</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>One of the <a class="xref" href="Hi.NcParsers.Dependencys.CncBrandDependency.html">CncBrandDependency</a> brand tokens.</p>
|
|
</dd>
|
|
<dt><code>targetDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>Directory to write into, e.g. an absolute path ending in <code>Resource/Controller</code>.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Exceptions</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentexception">ArgumentException</a></dt>
|
|
<dd><p><code class="paramref">brand</code> is not a known brand.</p>
|
|
</dd>
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></dt>
|
|
<dd><p><code class="paramref">targetDirectory</code> is null or blank.</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>
|