Archived
deploy webservice static-file routing for docsite folder URLs, per-instance step-cache db, and constant-height panel title bars.
This commit is contained in:
@@ -6,7 +6,7 @@
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class PreSettingCommand | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Command for pre-settings before NC command running.">
|
||||
<meta name="description" content="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 ; saving never writes the bundle back. The class stays functional for API callers that construct it directly.">
|
||||
<link rel="icon" href="../img/HiAPI.favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
@@ -97,12 +97,19 @@ Class PreSettingCommand
|
||||
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Command for pre-settings before NC command running.</p>
|
||||
<div class="markdown summary"><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>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class PreSettingCommand : ITitleCommand, ISessionCommand, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">[CultureText("zh-Hant", "一般設定")]
|
||||
[CultureText("zh-Hans", "一般设定")]
|
||||
public class PreSettingCommand : ITitleCommand, ISessionCommand, IMakeXmlSource</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -215,8 +222,8 @@ Class PreSettingCommand
|
||||
|
||||
<a id="Hi_SessionCommands_PreSettingCommand__ctor_" data-uid="Hi.SessionCommands.PreSettingCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_SessionCommands_PreSettingCommand__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_System_Object__System_Object___" data-uid="Hi.SessionCommands.PreSettingCommand.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{System.Object},System.Object[])">
|
||||
PreSettingCommand(XElement, string, string, IProgress<object>, object[])
|
||||
<h3 id="Hi_SessionCommands_PreSettingCommand__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_Hi_Common_Messages_IMessage__System_Object___" data-uid="Hi.SessionCommands.PreSettingCommand.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{Hi.Common.Messages.IMessage},System.Object[])">
|
||||
PreSettingCommand(XElement, string, string, IProgress<IMessage>, object[])
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -225,7 +232,7 @@ Class PreSettingCommand
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public PreSettingCommand(XElement src, string baseDirectory, string relFile, IProgress<object> progress, object[] res)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public PreSettingCommand(XElement src, string baseDirectory, string relFile, IProgress<IMessage> progress, object[] res)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -239,7 +246,7 @@ Class PreSettingCommand
|
||||
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>Relative file path</p>
|
||||
</dd>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="Hi.Common.Messages.IMessage.html">IMessage</a>></dt>
|
||||
<dd><p>Progress reporter for nested preset XML.</p>
|
||||
</dd>
|
||||
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
@@ -358,19 +365,19 @@ Class PreSettingCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_SessionCommands_PreSettingCommand_EnableReadRuntimeGeom_" data-uid="Hi.SessionCommands.PreSettingCommand.EnableReadRuntimeGeom*"></a>
|
||||
<a id="Hi_SessionCommands_PreSettingCommand_EnableReadMeshedGeom_" data-uid="Hi.SessionCommands.PreSettingCommand.EnableReadMeshedGeom*"></a>
|
||||
|
||||
<h3 id="Hi_SessionCommands_PreSettingCommand_EnableReadRuntimeGeom" data-uid="Hi.SessionCommands.PreSettingCommand.EnableReadRuntimeGeom">
|
||||
EnableReadRuntimeGeom
|
||||
<h3 id="Hi_SessionCommands_PreSettingCommand_EnableReadMeshedGeom" data-uid="Hi.SessionCommands.PreSettingCommand.EnableReadMeshedGeom">
|
||||
EnableReadMeshedGeom
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets or sets whether to enable reading runtime geometry.</p>
|
||||
<div class="markdown level1 summary"><p>Gets or sets whether to enable reading meshed geometry.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool EnableReadRuntimeGeom { get; set; }</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public bool EnableReadMeshedGeom { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -454,19 +461,19 @@ Class PreSettingCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_SessionCommands_PreSettingCommand_RuntimeGeomFile_" data-uid="Hi.SessionCommands.PreSettingCommand.RuntimeGeomFile*"></a>
|
||||
<a id="Hi_SessionCommands_PreSettingCommand_MeshedGeomFile_" data-uid="Hi.SessionCommands.PreSettingCommand.MeshedGeomFile*"></a>
|
||||
|
||||
<h3 id="Hi_SessionCommands_PreSettingCommand_RuntimeGeomFile" data-uid="Hi.SessionCommands.PreSettingCommand.RuntimeGeomFile">
|
||||
RuntimeGeomFile
|
||||
<h3 id="Hi_SessionCommands_PreSettingCommand_MeshedGeomFile" data-uid="Hi.SessionCommands.PreSettingCommand.MeshedGeomFile">
|
||||
MeshedGeomFile
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets or sets the runtime geometry file path.</p>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the meshed geometry file path.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string RuntimeGeomFile { get; set; }</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public string MeshedGeomFile { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -522,21 +529,84 @@ Class PreSettingCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_SessionCommands_PreSettingCommand_GetCommandTitle_" data-uid="Hi.SessionCommands.PreSettingCommand.GetCommandTitle*"></a>
|
||||
<a id="Hi_SessionCommands_PreSettingCommand_ExpandToEntries_" data-uid="Hi.SessionCommands.PreSettingCommand.ExpandToEntries*"></a>
|
||||
|
||||
<h3 id="Hi_SessionCommands_PreSettingCommand_GetCommandTitle" data-uid="Hi.SessionCommands.PreSettingCommand.GetCommandTitle">
|
||||
GetCommandTitle()
|
||||
<h3 id="Hi_SessionCommands_PreSettingCommand_ExpandToEntries_System_Boolean_" data-uid="Hi.SessionCommands.PreSettingCommand.ExpandToEntries(System.Boolean)">
|
||||
ExpandToEntries(bool)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the title of the command.</p>
|
||||
<div class="markdown level1 summary"><p>Expands this bundle into the split single-setting commands, in the
|
||||
order the bundle applied them. <code class="paramref">isEnabled</code> — the
|
||||
enable state of the bundle's own list entry — is consumed into every
|
||||
split entry; the meshed-geometry read additionally keeps its own
|
||||
<a class="xref" href="Hi.SessionCommands.PreSettingCommand.html#Hi_SessionCommands_PreSettingCommand_EnableReadMeshedGeom">EnableReadMeshedGeom</a> flag (its entry is emitted only
|
||||
when the read is enabled or a file is set, as a
|
||||
<a class="xref" href="Hi.SessionCommands.RecordMeshedGeomCommand.html">RecordMeshedGeomCommand</a> in
|
||||
<a class="xref" href="Hi.SessionCommands.RecordMeshedGeomActionEnum.html#Hi_SessionCommands_RecordMeshedGeomActionEnum_Read">Read</a> mode).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string GetCommandTitle()</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public List<EnablingWrapper> ExpandToEntries(bool isEnabled)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>isEnabled</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p>Enable state of the bundle's list entry.</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.list-1">List</a><<a class="xref" href="Hi.SessionCommands.EnablingWrapper.html">EnablingWrapper</a>></dt>
|
||||
<dd><p>The split entries replacing the bundle.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_SessionCommands_PreSettingCommand_GetCommandTitle_" data-uid="Hi.SessionCommands.PreSettingCommand.GetCommandTitle*"></a>
|
||||
|
||||
<h3 id="Hi_SessionCommands_PreSettingCommand_GetCommandTitle_Hi_Common_ICommandTextSource_" data-uid="Hi.SessionCommands.PreSettingCommand.GetCommandTitle(Hi.Common.ICommandTextSource)">
|
||||
GetCommandTitle(ICommandTextSource)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the title of the command — one row in a command list or a
|
||||
mission tree — composed from the caller's vocabulary: the command owns
|
||||
the composition and degradation rules, the caller owns the language.</p>
|
||||
<p>
|
||||
The shape is <code>Name</code>, or <code>Name [detail]</code> once there is a
|
||||
detail worth showing. The NAME always leads and is never dropped:
|
||||
a row must say WHAT it is even when the detail is a title the user
|
||||
wrote, otherwise a newcomer cannot tell a command list from a
|
||||
script. The detail trails because these rows truncate from the
|
||||
right. An empty detail takes the bare-name form rather than
|
||||
rendering dangling brackets.
|
||||
</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string GetCommandTitle(ICommandTextSource text)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>text</code> <a class="xref" href="Hi.Common.ICommandTextSource.html">ICommandTextSource</a></dt>
|
||||
<dd><p>Culture-bearing vocabulary the static words are taken from.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
|
||||
Reference in New Issue
Block a user