fix SoftNcRunner GM code normalization.
This commit is contained in:
@@ -581,6 +581,57 @@ boundary.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Common_Collections_LazyLinkedList_1_PrependSource_" data-uid="Hi.Common.Collections.LazyLinkedList`1.PrependSource*"></a>
|
||||
|
||||
<h3 id="Hi_Common_Collections_LazyLinkedList_1_PrependSource_System_Collections_Generic_IEnumerable__0__" data-uid="Hi.Common.Collections.LazyLinkedList`1.PrependSource(System.Collections.Generic.IEnumerable{`0})">
|
||||
PrependSource(IEnumerable<T>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Prepends a new source ahead of the current source's remaining items.
|
||||
On the next on-demand materialization (triggered by
|
||||
<a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html#Hi_Common_Collections_LazyLinkedListNode_1_Next">Next</a> on the present tail or
|
||||
<a class="xref" href="Hi.Common.Collections.LazyLinkedList-1.html#Hi_Common_Collections_LazyLinkedList_1_First">First</a> on an empty list), <code class="paramref">src</code> is
|
||||
yielded first; once exhausted, the previous source's untouched tail
|
||||
resumes. The materialized prefix of the list — including the present
|
||||
tail — is unaffected, so this is the natural way to splice extra
|
||||
items in immediately after the current tail (for example, inlining
|
||||
an M98 subprogram's blocks after the host node so the rest of the
|
||||
pipeline picks them up via ordinary <code>walkNode.Next</code> traversal).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void PrependSource(IEnumerable<T> src)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></dt>
|
||||
<dd><p>The source to insert ahead of the remaining items.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_Common_Collections_LazyLinkedList_1_PrependSource_System_Collections_Generic_IEnumerable__0___remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>Constraint: the caller must treat the present tail as the splice
|
||||
point. There is no way to prepend “after some interior node” — the
|
||||
prepended items are queued ahead of whatever the current source
|
||||
would have produced next. Use this when the splice point coincides
|
||||
with the tail at the moment of the call (which is how
|
||||
<code>SoftNcRunner</code>'s pipeline drives node-by-node lazy
|
||||
materialization in lock-step with syntax/semantic processing).</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
|
||||
@@ -103,7 +103,7 @@ Apply absolute file path.</p>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class LocalProjectService : IProjectService, IMachiningProjectGetter, IMachiningStepHost, IGetMachiningEquipment, IDisposable</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class LocalProjectService : IProjectService, IMachiningProjectGetter, IMachiningService, IGetMachiningEquipment, IDisposable</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -122,7 +122,7 @@ Apply absolute file path.</p>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.MachiningProcs.IProjectService.html">IProjectService</a></div>
|
||||
<div><a class="xref" href="Hi.MachiningProcs.IMachiningProjectGetter.html">IMachiningProjectGetter</a></div>
|
||||
<div><a class="xref" href="Hi.MachiningSteps.IMachiningStepHost.html">IMachiningStepHost</a></div>
|
||||
<div><a class="xref" href="Hi.MachiningSteps.IMachiningService.html">IMachiningService</a></div>
|
||||
<div><a class="xref" href="Hi.Machining.MachiningEquipmentUtils.IGetMachiningEquipment.html">IGetMachiningEquipment</a></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
|
||||
</dd>
|
||||
@@ -564,7 +564,7 @@ Will be removed when <a class="xref" href="Hi.Numerical.FilePlayers.HardNcRunner
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>global variable for <a class="xref" href="Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_RuntimeApi">RuntimeApi</a>.
|
||||
<div class="markdown level1 summary"><p>global variable for <a class="xref" href="Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_SessionShell">SessionShell</a>.
|
||||
Not save on XML.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
@@ -1168,38 +1168,6 @@ Updates related components when changed.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_LocalProjectService_RuntimeApi_" data-uid="Hi.MachiningProcs.LocalProjectService.RuntimeApi*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_LocalProjectService_RuntimeApi" data-uid="Hi.MachiningProcs.LocalProjectService.RuntimeApi">
|
||||
RuntimeApi
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the shell API for interacting with this machining process.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public RuntimeApi RuntimeApi { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_LocalProjectService_SessionProgress_" data-uid="Hi.MachiningProcs.LocalProjectService.SessionProgress*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_LocalProjectService_SessionProgress" data-uid="Hi.MachiningProcs.LocalProjectService.SessionProgress">
|
||||
@@ -1232,6 +1200,38 @@ Updates related components when changed.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_LocalProjectService_SessionShell_" data-uid="Hi.MachiningProcs.LocalProjectService.SessionShell*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_LocalProjectService_SessionShell" data-uid="Hi.MachiningProcs.LocalProjectService.SessionShell">
|
||||
SessionShell
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the shell API for interacting with this machining process.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public SessionShell SessionShell { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.MachiningProcs.SessionShell.html">SessionShell</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_LocalProjectService_StepPropertyAccessDictionary_" data-uid="Hi.MachiningProcs.LocalProjectService.StepPropertyAccessDictionary*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_LocalProjectService_StepPropertyAccessDictionary" data-uid="Hi.MachiningProcs.LocalProjectService.StepPropertyAccessDictionary">
|
||||
@@ -1714,6 +1714,38 @@ Clear the state from previous session (if existed).</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_LocalProjectService_GetSessionShell_" data-uid="Hi.MachiningProcs.LocalProjectService.GetSessionShell*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_LocalProjectService_GetSessionShell" data-uid="Hi.MachiningProcs.LocalProjectService.GetSessionShell">
|
||||
GetSessionShell()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Returns the session shell that exposes the runtime surface of the active machining session.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ISessionShell GetSessionShell()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.SessionShellUtils.ISessionShell.html">ISessionShell</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_LocalProjectService_LoadProject_" data-uid="Hi.MachiningProcs.LocalProjectService.LoadProject*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_LocalProjectService_LoadProject_System_String_" data-uid="Hi.MachiningProcs.LocalProjectService.LoadProject(System.String)">
|
||||
|
||||
@@ -186,8 +186,8 @@ Class MachiningActRunner
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningActRunner__ctor_" data-uid="Hi.MachiningProcs.MachiningActRunner.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningActRunner__ctor_Hi_MachiningProcs_SessionProgress_System_Action_System_Collections_Generic_IEnumerable_Hi_MillingSteps_MillingStepLuggage___System_Func_Hi_Machining_MachiningToolHouse__System_Func_Hi_Machining_MachiningEquipmentUtils_MachiningEquipment__System_Func_Hi_NcMech_Workpieces_WorkpieceService__System_Action_Hi_ScriptApiUtils_ICsScriptApi_" data-uid="Hi.MachiningProcs.MachiningActRunner.#ctor(Hi.MachiningProcs.SessionProgress,System.Action{System.Collections.Generic.IEnumerable{Hi.MillingSteps.MillingStepLuggage}},System.Func{Hi.Machining.MachiningToolHouse},System.Func{Hi.Machining.MachiningEquipmentUtils.MachiningEquipment},System.Func{Hi.NcMech.Workpieces.WorkpieceService},System.Action,Hi.ScriptApiUtils.ICsScriptApi)">
|
||||
MachiningActRunner(SessionProgress, Action<IEnumerable<MillingStepLuggage>>, Func<MachiningToolHouse>, Func<MachiningEquipment>, Func<WorkpieceService>, Action, ICsScriptApi)
|
||||
<h3 id="Hi_MachiningProcs_MachiningActRunner__ctor_Hi_MachiningProcs_SessionProgress_System_Action_System_Collections_Generic_IEnumerable_Hi_MillingSteps_MillingStepLuggage___System_Func_Hi_Machining_MachiningToolHouse__System_Func_Hi_Machining_MachiningEquipmentUtils_MachiningEquipment__System_Func_Hi_NcMech_Workpieces_WorkpieceService__System_Action_" data-uid="Hi.MachiningProcs.MachiningActRunner.#ctor(Hi.MachiningProcs.SessionProgress,System.Action{System.Collections.Generic.IEnumerable{Hi.MillingSteps.MillingStepLuggage}},System.Func{Hi.Machining.MachiningToolHouse},System.Func{Hi.Machining.MachiningEquipmentUtils.MachiningEquipment},System.Func{Hi.NcMech.Workpieces.WorkpieceService},System.Action)">
|
||||
MachiningActRunner(SessionProgress, Action<IEnumerable<MillingStepLuggage>>, Func<MachiningToolHouse>, Func<MachiningEquipment>, Func<WorkpieceService>, Action)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -196,7 +196,7 @@ Class MachiningActRunner
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MachiningActRunner(SessionProgress sessionProgress, Action<IEnumerable<MillingStepLuggage>> stepStorageWriter, Func<MachiningToolHouse> machiningToolHouseGetter, Func<MachiningEquipment> machiningEquipmentGetter, Func<WorkpieceService> workpieceServiceGetter, Action resetMillingStepLuggageDbAction, ICsScriptApi shellApi)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public MachiningActRunner(SessionProgress sessionProgress, Action<IEnumerable<MillingStepLuggage>> stepStorageWriter, Func<MachiningToolHouse> machiningToolHouseGetter, Func<MachiningEquipment> machiningEquipmentGetter, Func<WorkpieceService> workpieceServiceGetter, Action resetMillingStepLuggageDbAction)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -218,9 +218,6 @@ Class MachiningActRunner
|
||||
</dd>
|
||||
<dt><code>resetMillingStepLuggageDbAction</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action">Action</a></dt>
|
||||
<dd><p>Action to reset the milling step luggage database.</p>
|
||||
</dd>
|
||||
<dt><code>shellApi</code> <a class="xref" href="Hi.ScriptApiUtils.ICsScriptApi.html">ICsScriptApi</a></dt>
|
||||
<dd><p>The C# script API for the milling session.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -825,8 +822,8 @@ This property is provided as a member value getter and should not be modified.</
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningActRunner_ProcAct_" data-uid="Hi.MachiningProcs.MachiningActRunner.ProcAct*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningActRunner_ProcAct_Hi_Numerical_Acts_IAct_Hi_MachiningProcs_MachiningSession_Hi_MachiningSteps_IMachiningStepHost_Hi_NcParsers_IGetSentence_System_Threading_CancellationToken_" data-uid="Hi.MachiningProcs.MachiningActRunner.ProcAct(Hi.Numerical.Acts.IAct,Hi.MachiningProcs.MachiningSession,Hi.MachiningSteps.IMachiningStepHost,Hi.NcParsers.IGetSentence,System.Threading.CancellationToken)">
|
||||
ProcAct(IAct, MachiningSession, IMachiningStepHost, IGetSentence, CancellationToken)
|
||||
<h3 id="Hi_MachiningProcs_MachiningActRunner_ProcAct_Hi_Numerical_Acts_IAct_Hi_MachiningProcs_MachiningSession_Hi_MachiningSteps_IMachiningService_Hi_NcParsers_IGetSentence_System_Threading_CancellationToken_" data-uid="Hi.MachiningProcs.MachiningActRunner.ProcAct(Hi.Numerical.Acts.IAct,Hi.MachiningProcs.MachiningSession,Hi.MachiningSteps.IMachiningService,Hi.NcParsers.IGetSentence,System.Threading.CancellationToken)">
|
||||
ProcAct(IAct, MachiningSession, IMachiningService, IGetSentence, CancellationToken)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -835,7 +832,7 @@ This property is provided as a member value getter and should not be modified.</
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<object> ProcAct(IAct act, MachiningSession machiningSession, IMachiningStepHost host, IGetSentence sourceCommand, CancellationToken cancellationToken)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<object> ProcAct(IAct act, MachiningSession machiningSession, IMachiningService host, IGetSentence sourceCommand, CancellationToken cancellationToken)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -846,7 +843,7 @@ This property is provided as a member value getter and should not be modified.</
|
||||
<dt><code>machiningSession</code> <a class="xref" href="Hi.MachiningProcs.MachiningSession.html">MachiningSession</a></dt>
|
||||
<dd><p>The milling session.</p>
|
||||
</dd>
|
||||
<dt><code>host</code> <a class="xref" href="Hi.MachiningSteps.IMachiningStepHost.html">IMachiningStepHost</a></dt>
|
||||
<dt><code>host</code> <a class="xref" href="Hi.MachiningSteps.IMachiningService.html">IMachiningService</a></dt>
|
||||
<dd><p>The milling step host.</p>
|
||||
</dd>
|
||||
<dt><code>sourceCommand</code> <a class="xref" href="Hi.NcParsers.IGetSentence.html">IGetSentence</a></dt>
|
||||
|
||||
@@ -529,7 +529,7 @@ Class MachiningProject
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IShellCommand PlayerCommand { get; set; }</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public ISessionCommand PlayerCommand { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -538,7 +538,7 @@ Class MachiningProject
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.ShellCommands.IShellCommand.html">IShellCommand</a></dt>
|
||||
<dt><a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -219,38 +219,6 @@ and managing session state. Implements <a class="xref" href="https://learn.micro
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningSession_Data_" data-uid="Hi.MachiningProcs.MachiningSession.Data*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningSession_Data" data-uid="Hi.MachiningProcs.MachiningSession.Data">
|
||||
Data
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets or sets the data dictionary for the player session.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Dictionary<object, object> Data { get; set; }</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.dictionary-2">Dictionary</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningProcs_MachiningSession_FileIndexOnRunCommand_" data-uid="Hi.MachiningProcs.MachiningSession.FileIndexOnRunCommand*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningProcs_MachiningSession_FileIndexOnRunCommand" data-uid="Hi.MachiningProcs.MachiningSession.FileIndexOnRunCommand">
|
||||
@@ -259,8 +227,19 @@ and managing session state. Implements <a class="xref" href="https://learn.micro
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>File index counter, auto-incremented per <a class="xref" href="Hi.Numerical.IControlRunner.html#Hi_Numerical_IControlRunner_RunControlLines_System_String_System_Collections_Generic_IEnumerable_System_String__Hi_MachiningProcs_MachiningSession_Hi_MachiningProcs_SessionProgress_System_Threading_CancellationToken_">RunControlLines(string, IEnumerable<string>, MachiningSession, SessionProgress, CancellationToken)</a>
|
||||
call within this session. Replaces the previous per-runner counter so that file
|
||||
indices are scoped to a session and reset naturally when a new session begins.</p>
|
||||
call within this session.</p>
|
||||
<p>
|
||||
<b>Legacy use only.</b> Read and incremented by
|
||||
<code>HardNcRunner</code> and <code>CsvRunner</code>. <a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a>
|
||||
no longer touches this field — it allocates file indices through
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.FileIndexCounterDependency.html">FileIndexCounterDependency</a>,
|
||||
which both the runner and inlined-subprogram syntaxes
|
||||
(<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.html">SubProgramCallSyntax</a>) share so
|
||||
every loaded file (top-level program plus every M98 / M198 inline,
|
||||
including each <code>L</code> repetition) gets a distinct index.
|
||||
Do not introduce new readers; the field will be removed once the
|
||||
legacy runners retire.
|
||||
</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -591,10 +570,10 @@ Takes effect during internal optimization process.</p>
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Tools already surfaced via “MillingCutter.FluteMaterial not set”
|
||||
<div class="markdown level1 summary"><p>Tools already surfaced via “<a class="xref" href="Hi.Milling.Cutters.MillingCutter.html#Hi_Milling_Cutters_MillingCutter_FluteMaterial">FluteMaterial</a> not set”
|
||||
warning. Keyed by <a class="xref" href="Hi.Machining.IMachiningTool.html">IMachiningTool</a> reference so the dedup is stable
|
||||
across the two emission points: <a class="xref" href="Hi.MachiningProcs.MachiningActRunner.html#Hi_MachiningProcs_MachiningActRunner_ProcAct_Hi_Numerical_Acts_IAct_Hi_MachiningProcs_MachiningSession_Hi_MachiningSteps_IMachiningStepHost_Hi_NcParsers_IGetSentence_System_Threading_CancellationToken_">ProcAct(IAct, MachiningSession, IMachiningStepHost, IGetSentence, CancellationToken)</a> at each
|
||||
IActTooling, and <code>BeginSession</code> for the tool that may already
|
||||
across the two emission points: <a class="xref" href="Hi.MachiningProcs.MachiningActRunner.html#Hi_MachiningProcs_MachiningActRunner_ProcAct_Hi_Numerical_Acts_IAct_Hi_MachiningProcs_MachiningSession_Hi_MachiningSteps_IMachiningService_Hi_NcParsers_IGetSentence_System_Threading_CancellationToken_">ProcAct(IAct, MachiningSession, IMachiningService, IGetSentence, CancellationToken)</a> at each
|
||||
<a class="xref" href="Hi.Numerical.Acts.IActTooling.html">IActTooling</a>, and <code>BeginSession</code> for the tool that may already
|
||||
be equipped before the session begins (which has no tool ID to dedup with).
|
||||
Reference equality is more precise than tool ID — the same tool object equipped
|
||||
twice should warn once, regardless of how it was reached.</p>
|
||||
|
||||
+289
-287
File diff suppressed because it is too large
Load Diff
+261
-261
File diff suppressed because it is too large
Load Diff
@@ -163,17 +163,6 @@ for each subsequent file so that <code>Previous</code>/<code>Next</code> connect
|
||||
<dt><a class="xref" href="Hi.MachiningProcs.ProxyProjectService.html">ProxyProjectService</a></dt>
|
||||
<dd><p>Delegate (User-based) Project Service.
|
||||
Apply relative file path from <a class="xref" href="Hi.MachiningProcs.ProxyProjectService.html#Hi_MachiningProcs_ProxyProjectService_AdminDirectory">AdminDirectory</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
|
||||
<dd><p>Runtime API for machining operations.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.MachiningProcs.RuntimeController.html">RuntimeController</a></dt>
|
||||
<dd><p>Provides a C# scripting API for controlling and manipulating the milling course.
|
||||
Allows for runtime control of milling operations, geometry manipulation, and data analysis.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
@@ -190,6 +179,20 @@ such as source commands, machining steps, exceptions, and tagged messages.</p>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.MachiningProcs.SessionProgress.html">SessionProgress</a></dt>
|
||||
<dd><p>Represents a host for managing milling messages with thread-safe operations and stable index tracking.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.MachiningProcs.SessionShell.html">SessionShell</a></dt>
|
||||
<dd><p>End-user-facing facade for a machining session: aggregates session lifecycle,
|
||||
NC playback, optimization, geometry I/O, and scripting infrastructure into a
|
||||
single delegation surface. Used as the C# script globals object and as the
|
||||
concrete target of <a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a> implementations.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.MachiningProcs.SessionShellController.html">SessionShellController</a></dt>
|
||||
<dd><p>HTTP controller exposing <a class="xref" href="Hi.MachiningProcs.SessionShell.html">SessionShell</a> over the web API.
|
||||
Each action delegates to the underlying <a class="xref" href="Hi.MachiningProcs.SessionShell.html">SessionShell</a> instance owned by <span class="xref">Hi.MachiningProcs.SessionShellController.LocalProjectService</span>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
|
||||
+56
-20
@@ -2,9 +2,9 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Interface IMachiningStepHost | HiAPI-C# 2025 </title>
|
||||
<title>Interface IMachiningService | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Interface IMachiningStepHost | HiAPI-C# 2025 ">
|
||||
<meta name="title" content="Interface IMachiningService | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Represents a host interface for milling steps that provides access to milling equipment and related resources.">
|
||||
<link rel="icon" href="../img/HiAPI.favicon.ico">
|
||||
@@ -84,12 +84,12 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.MachiningSteps.IMachiningStepHost">
|
||||
<article data-uid="Hi.MachiningSteps.IMachiningService">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_MachiningSteps_IMachiningStepHost" data-uid="Hi.MachiningSteps.IMachiningStepHost" class="text-break">
|
||||
Interface IMachiningStepHost
|
||||
<h1 id="Hi_MachiningSteps_IMachiningService" data-uid="Hi.MachiningSteps.IMachiningService" class="text-break">
|
||||
Interface IMachiningService
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
@@ -102,7 +102,7 @@ Interface IMachiningStepHost
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public interface IMachiningStepHost : IGetMachiningEquipment</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public interface IMachiningService : IGetMachiningEquipment</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -153,9 +153,9 @@ Interface IMachiningStepHost
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_MachiningSteps_IMachiningStepHost_ClStrip_" data-uid="Hi.MachiningSteps.IMachiningStepHost.ClStrip*"></a>
|
||||
<a id="Hi_MachiningSteps_IMachiningService_ClStrip_" data-uid="Hi.MachiningSteps.IMachiningService.ClStrip*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningSteps_IMachiningStepHost_ClStrip" data-uid="Hi.MachiningSteps.IMachiningStepHost.ClStrip">
|
||||
<h3 id="Hi_MachiningSteps_IMachiningService_ClStrip" data-uid="Hi.MachiningSteps.IMachiningService.ClStrip">
|
||||
ClStrip
|
||||
|
||||
</h3>
|
||||
@@ -185,9 +185,9 @@ Interface IMachiningStepHost
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningSteps_IMachiningStepHost_DictionaryColorGuide_" data-uid="Hi.MachiningSteps.IMachiningStepHost.DictionaryColorGuide*"></a>
|
||||
<a id="Hi_MachiningSteps_IMachiningService_DictionaryColorGuide_" data-uid="Hi.MachiningSteps.IMachiningService.DictionaryColorGuide*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningSteps_IMachiningStepHost_DictionaryColorGuide" data-uid="Hi.MachiningSteps.IMachiningStepHost.DictionaryColorGuide">
|
||||
<h3 id="Hi_MachiningSteps_IMachiningService_DictionaryColorGuide" data-uid="Hi.MachiningSteps.IMachiningService.DictionaryColorGuide">
|
||||
DictionaryColorGuide
|
||||
|
||||
</h3>
|
||||
@@ -217,9 +217,9 @@ Interface IMachiningStepHost
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningSteps_IMachiningStepHost_MachiningEquipment_" data-uid="Hi.MachiningSteps.IMachiningStepHost.MachiningEquipment*"></a>
|
||||
<a id="Hi_MachiningSteps_IMachiningService_MachiningEquipment_" data-uid="Hi.MachiningSteps.IMachiningService.MachiningEquipment*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningSteps_IMachiningStepHost_MachiningEquipment" data-uid="Hi.MachiningSteps.IMachiningStepHost.MachiningEquipment">
|
||||
<h3 id="Hi_MachiningSteps_IMachiningService_MachiningEquipment" data-uid="Hi.MachiningSteps.IMachiningService.MachiningEquipment">
|
||||
MachiningEquipment
|
||||
|
||||
</h3>
|
||||
@@ -249,9 +249,9 @@ Interface IMachiningStepHost
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningSteps_IMachiningStepHost_MachiningSession_" data-uid="Hi.MachiningSteps.IMachiningStepHost.MachiningSession*"></a>
|
||||
<a id="Hi_MachiningSteps_IMachiningService_MachiningSession_" data-uid="Hi.MachiningSteps.IMachiningService.MachiningSession*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningSteps_IMachiningStepHost_MachiningSession" data-uid="Hi.MachiningSteps.IMachiningStepHost.MachiningSession">
|
||||
<h3 id="Hi_MachiningSteps_IMachiningService_MachiningSession" data-uid="Hi.MachiningSteps.IMachiningService.MachiningSession">
|
||||
MachiningSession
|
||||
|
||||
</h3>
|
||||
@@ -281,9 +281,9 @@ Interface IMachiningStepHost
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningSteps_IMachiningStepHost_MachiningToolHouse_" data-uid="Hi.MachiningSteps.IMachiningStepHost.MachiningToolHouse*"></a>
|
||||
<a id="Hi_MachiningSteps_IMachiningService_MachiningToolHouse_" data-uid="Hi.MachiningSteps.IMachiningService.MachiningToolHouse*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningSteps_IMachiningStepHost_MachiningToolHouse" data-uid="Hi.MachiningSteps.IMachiningStepHost.MachiningToolHouse">
|
||||
<h3 id="Hi_MachiningSteps_IMachiningService_MachiningToolHouse" data-uid="Hi.MachiningSteps.IMachiningService.MachiningToolHouse">
|
||||
MachiningToolHouse
|
||||
|
||||
</h3>
|
||||
@@ -313,9 +313,9 @@ Interface IMachiningStepHost
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningSteps_IMachiningStepHost_MillingStepLuggageReader_" data-uid="Hi.MachiningSteps.IMachiningStepHost.MillingStepLuggageReader*"></a>
|
||||
<a id="Hi_MachiningSteps_IMachiningService_MillingStepLuggageReader_" data-uid="Hi.MachiningSteps.IMachiningService.MillingStepLuggageReader*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningSteps_IMachiningStepHost_MillingStepLuggageReader" data-uid="Hi.MachiningSteps.IMachiningStepHost.MillingStepLuggageReader">
|
||||
<h3 id="Hi_MachiningSteps_IMachiningService_MillingStepLuggageReader" data-uid="Hi.MachiningSteps.IMachiningService.MillingStepLuggageReader">
|
||||
MillingStepLuggageReader
|
||||
|
||||
</h3>
|
||||
@@ -345,9 +345,9 @@ Interface IMachiningStepHost
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MachiningSteps_IMachiningStepHost_TimeMapping_" data-uid="Hi.MachiningSteps.IMachiningStepHost.TimeMapping*"></a>
|
||||
<a id="Hi_MachiningSteps_IMachiningService_TimeMapping_" data-uid="Hi.MachiningSteps.IMachiningService.TimeMapping*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningSteps_IMachiningStepHost_TimeMapping" data-uid="Hi.MachiningSteps.IMachiningStepHost.TimeMapping">
|
||||
<h3 id="Hi_MachiningSteps_IMachiningService_TimeMapping" data-uid="Hi.MachiningSteps.IMachiningService.TimeMapping">
|
||||
TimeMapping
|
||||
|
||||
</h3>
|
||||
@@ -377,6 +377,42 @@ Interface IMachiningStepHost
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_MachiningSteps_IMachiningService_GetSessionShell_" data-uid="Hi.MachiningSteps.IMachiningService.GetSessionShell*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningSteps_IMachiningService_GetSessionShell" data-uid="Hi.MachiningSteps.IMachiningService.GetSessionShell">
|
||||
GetSessionShell()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Returns the session shell that exposes the runtime surface of the active machining session.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">ISessionShell GetSessionShell()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.SessionShellUtils.ISessionShell.html">ISessionShell</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
@@ -200,8 +200,8 @@ The duration-based step property is based on the duration from previous-step to
|
||||
|
||||
<a id="Hi_MachiningSteps_MachiningStep__ctor_" data-uid="Hi.MachiningSteps.MachiningStep.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_MachiningSteps_MachiningStep__ctor_Hi_MachiningSteps_IMachiningStepHost_System_Int32_Hi_NcParsers_IGetSentence_Hi_MachiningSteps_MachineMotionStep_Hi_MillingSteps_MillingInstance_Hi_MachiningSteps_MachiningStep_CollidedKeyPair___" data-uid="Hi.MachiningSteps.MachiningStep.#ctor(Hi.MachiningSteps.IMachiningStepHost,System.Int32,Hi.NcParsers.IGetSentence,Hi.MachiningSteps.MachineMotionStep,Hi.MillingSteps.MillingInstance,Hi.MachiningSteps.MachiningStep.CollidedKeyPair[])">
|
||||
MachiningStep(IMachiningStepHost, int, IGetSentence, MachineMotionStep, MillingInstance, CollidedKeyPair[])
|
||||
<h3 id="Hi_MachiningSteps_MachiningStep__ctor_Hi_MachiningSteps_IMachiningService_System_Int32_Hi_NcParsers_IGetSentence_Hi_MachiningSteps_MachineMotionStep_Hi_MillingSteps_MillingInstance_Hi_MachiningSteps_MachiningStep_CollidedKeyPair___" data-uid="Hi.MachiningSteps.MachiningStep.#ctor(Hi.MachiningSteps.IMachiningService,System.Int32,Hi.NcParsers.IGetSentence,Hi.MachiningSteps.MachineMotionStep,Hi.MillingSteps.MillingInstance,Hi.MachiningSteps.MachiningStep.CollidedKeyPair[])">
|
||||
MachiningStep(IMachiningService, int, IGetSentence, MachineMotionStep, MillingInstance, CollidedKeyPair[])
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -210,12 +210,12 @@ The duration-based step property is based on the duration from previous-step to
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MachiningStep(IMachiningStepHost host, int stepIndex, IGetSentence sourceCommand, MachineMotionStep machineMotionStep, MillingInstance millingInstance, MachiningStep.CollidedKeyPair[] collidedKeyPairs)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public MachiningStep(IMachiningService host, int stepIndex, IGetSentence sourceCommand, MachineMotionStep machineMotionStep, MillingInstance millingInstance, MachiningStep.CollidedKeyPair[] collidedKeyPairs)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>host</code> <a class="xref" href="Hi.MachiningSteps.IMachiningStepHost.html">IMachiningStepHost</a></dt>
|
||||
<dt><code>host</code> <a class="xref" href="Hi.MachiningSteps.IMachiningService.html">IMachiningService</a></dt>
|
||||
<dd><p>The host of the milling step.</p>
|
||||
</dd>
|
||||
<dt><code>stepIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
@@ -2057,7 +2057,7 @@ public double? FrictionPower_W { get; }</code></pre>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IMachiningStepHost Host { get; set; }</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public IMachiningService Host { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -2066,7 +2066,7 @@ public double? FrictionPower_W { get; }</code></pre>
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.MachiningSteps.IMachiningStepHost.html">IMachiningStepHost</a></dt>
|
||||
<dt><a class="xref" href="Hi.MachiningSteps.IMachiningService.html">IMachiningService</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -140,7 +140,7 @@ Interfaces
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.MachiningSteps.IMachiningStepHost.html">IMachiningStepHost</a></dt>
|
||||
<dt><a class="xref" href="Hi.MachiningSteps.IMachiningService.html">IMachiningService</a></dt>
|
||||
<dd><p>Represents a host interface for milling steps that provides access to milling equipment and related resources.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -950,6 +950,48 @@ The forced item is workpiece.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MillingForces_MillingForceLuggage_NoCut_" data-uid="Hi.MillingForces.MillingForceLuggage.NoCut*"></a>
|
||||
|
||||
<h3 id="Hi_MillingForces_MillingForceLuggage_NoCut_System_Int32_" data-uid="Hi.MillingForces.MillingForceLuggage.NoCut(System.Int32)">
|
||||
NoCut(int)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Builds a luggage representing a physically-computed “no cut” state
|
||||
(paired with <a class="xref" href="Hi.MillingForces.MillingPhysicsBrief.html#Hi_MillingForces_MillingPhysicsBrief_NoCut_System_Int32_">NoCut(int)</a>): the three
|
||||
per-rotation force lists are each filled with <a class="xref" href="Hi.Geom.Vec3d.html#Hi_Geom_Vec3d_Zero">Zero</a>
|
||||
of length <code class="paramref">rotationDivisionNum</code>. <code>StepIndex</code>
|
||||
is left at default; the caller assigns it.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static MillingForceLuggage NoCut(int rotationDivisionNum)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>rotationDivisionNum</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>Length of each per-rotation list.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.MillingForces.MillingForceLuggage.html">MillingForceLuggage</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MillingForces_MillingForceLuggage_ToCuttingForcesString_" data-uid="Hi.MillingForces.MillingForceLuggage.ToCuttingForcesString*"></a>
|
||||
|
||||
<h3 id="Hi_MillingForces_MillingForceLuggage_ToCuttingForcesString" data-uid="Hi.MillingForces.MillingForceLuggage.ToCuttingForcesString">
|
||||
|
||||
@@ -1910,6 +1910,51 @@ In multi thread, call it before going to un-safe area.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MillingForces_MillingPhysicsBrief_NoCut_" data-uid="Hi.MillingForces.MillingPhysicsBrief.NoCut*"></a>
|
||||
|
||||
<h3 id="Hi_MillingForces_MillingPhysicsBrief_NoCut_System_Int32_" data-uid="Hi.MillingForces.MillingPhysicsBrief.NoCut(System.Int32)">
|
||||
NoCut(int)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Builds a brief representing a physically-computed “no cut” state
|
||||
— i.e. <code>EnablePhysics=true</code> but the step has no engagement
|
||||
(<code>IsTouched=false</code>). This is semantically distinct from a
|
||||
<code>null</code> brief which means “physics was not computed at all”.
|
||||
All forces, moments, ratios, chip dimensions and deflections are
|
||||
zero; relief-face colliding speed is set to a negative sentinel
|
||||
so <a class="xref" href="Hi.MillingForces.MillingPhysicsBrief.html#Hi_MillingForces_MillingPhysicsBrief_IsReliefFaceCollided">IsReliefFaceCollided</a> returns <code>false</code> rather
|
||||
than <code>null</code>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static MillingPhysicsBrief NoCut(int rotationDivisionNum)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>rotationDivisionNum</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The rotation division count this brief reports.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.MillingForces.MillingPhysicsBrief.html">MillingPhysicsBrief</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_MillingForces_MillingPhysicsBrief_PowerWithoutFriction_W_" data-uid="Hi.MillingForces.MillingPhysicsBrief.PowerWithoutFriction_W*"></a>
|
||||
|
||||
<h3 id="Hi_MillingForces_MillingPhysicsBrief_PowerWithoutFriction_W" data-uid="Hi.MillingForces.MillingPhysicsBrief.PowerWithoutFriction_W">
|
||||
|
||||
@@ -326,7 +326,18 @@ The value is for human viewing.</p>
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets or sets the rake face physics brief containing force and other physical calculations.</p>
|
||||
<div class="markdown level1 summary"><p>Gets the rake face physics brief containing force and other
|
||||
physical calculations. Tri-state contract:</p>
|
||||
<ul><li><code>null</code> — physics not computed
|
||||
(<code>EnablePhysics=false</code>, or no tool, or spindle not
|
||||
rotating).</li><li>non-null with computed forces — physics
|
||||
computed on an engaged step (<code>IsTouched=true</code>).
|
||||
</li><li>non-null with all-zero forces / ratios —
|
||||
physics computed on a no-engagement step
|
||||
(<code>EnablePhysics=true</code>, <code>IsTouched=false</code>);
|
||||
produced via <a class="xref" href="Hi.MillingForces.MillingPhysicsBrief.html#Hi_MillingForces_MillingPhysicsBrief_NoCut_System_Int32_">NoCut(int)</a>.
|
||||
Use <a class="xref" href="Hi.MillingSteps.MillingInstance.html#Hi_MillingSteps_MillingInstance_IsTouched">IsTouched</a> to distinguish this from a
|
||||
real cut whose forces happen to be near zero.</li></ul>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
|
||||
+1
-1
@@ -130,7 +130,7 @@ following real Fanuc parameter numbering.</p>
|
||||
<div><a class="xref" href="Hi.NcParsers.Dependencys.IIsoCoordinateConfig.html">IIsoCoordinateConfig</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.Dependencys.INcDependency.html">INcDependency</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
+2
-2
@@ -102,7 +102,7 @@ runtime-state JSON sections:</p>
|
||||
<ul><li><span class="term"><code>#5001-#5003</code></span>Block-end position X/Y/Z (workpiece) → previous block's <a class="xref" href="Hi.NcParsers.Keywords.IProgramXyzDef.html#Hi_NcParsers_Keywords_IProgramXyzDef_ProgramXyz">ProgramXyz</a>.</li><li><span class="term"><code>#5021-#5023</code></span>Current machine position X/Y/Z → previous block's <a class="xref" href="Hi.NcParsers.Keywords.MachineCoordinateState.html">MachineCoordinateState</a>.</li><li><span class="term"><code>#5041-#5043</code></span>Current absolute position X/Y/Z → previous block's <a class="xref" href="Hi.NcParsers.Keywords.IProgramXyzDef.html#Hi_NcParsers_Keywords_IProgramXyzDef_ProgramXyz">ProgramXyz</a>.</li></ul>
|
||||
<p>
|
||||
Stateless. Configured on
|
||||
<a class="xref" href="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.html#Hi_NcParsers_LogicSyntaxs_VariableEvaluatorSyntax_RuntimeVariableLookups">RuntimeVariableLookups</a> rather than
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html#Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax_RuntimeVariableLookups">RuntimeVariableLookups</a> rather than
|
||||
<code>NcDependencyList</code> because the read needs the block node for
|
||||
<a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html#Hi_Common_Collections_LazyLinkedListNode_1_Previous">Previous</a> access — there is no
|
||||
long-lived dependency object that owns this data.
|
||||
@@ -128,7 +128,7 @@ long-lived dependency object that owns this data.
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IRuntimeVariableLookup.html">IRuntimeVariableLookup</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IRuntimeVariableLookup.html">IRuntimeVariableLookup</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
+2
-2
@@ -98,7 +98,7 @@ Class FanucToolOffsetVariableLookup
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Fanuc-side adapter that exposes a wrapped <a class="xref" href="Hi.NcParsers.Dependencys.Generic.ToolOffsetTable.html">ToolOffsetTable</a>
|
||||
as an <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a> following Fanuc Memory C tool offset
|
||||
as an <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a> following Fanuc Memory C tool offset
|
||||
addressing: <code>#2001+N → effective height of offset N</code>
|
||||
(geometry − wear).</p>
|
||||
<p>
|
||||
@@ -131,7 +131,7 @@ up immediately in lookups via this adapter.
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.NcParsers.Dependencys.INcDependency.html">INcDependency</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
+1
-1
@@ -138,7 +138,7 @@ for the call-frame topic.
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.NcParsers.Dependencys.INcDependency.html">INcDependency</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -108,7 +108,7 @@ runtime-state JSON sections:</p>
|
||||
<ul><li><span class="term"><code>#5001-#5003</code></span>Block-end position X/Y/Z (workpiece) → previous block's <a class="xref" href="Hi.NcParsers.Keywords.IProgramXyzDef.html#Hi_NcParsers_Keywords_IProgramXyzDef_ProgramXyz">ProgramXyz</a>.</li><li><span class="term"><code>#5021-#5023</code></span>Current machine position X/Y/Z → previous block's <a class="xref" href="Hi.NcParsers.Keywords.MachineCoordinateState.html">MachineCoordinateState</a>.</li><li><span class="term"><code>#5041-#5043</code></span>Current absolute position X/Y/Z → previous block's <a class="xref" href="Hi.NcParsers.Keywords.IProgramXyzDef.html#Hi_NcParsers_Keywords_IProgramXyzDef_ProgramXyz">ProgramXyz</a>.</li></ul>
|
||||
<p>
|
||||
Stateless. Configured on
|
||||
<a class="xref" href="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.html#Hi_NcParsers_LogicSyntaxs_VariableEvaluatorSyntax_RuntimeVariableLookups">RuntimeVariableLookups</a> rather than
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html#Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax_RuntimeVariableLookups">RuntimeVariableLookups</a> rather than
|
||||
<code>NcDependencyList</code> because the read needs the block node for
|
||||
<a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html#Hi_Common_Collections_LazyLinkedListNode_1_Previous">Previous</a> access — there is no
|
||||
long-lived dependency object that owns this data.
|
||||
@@ -118,7 +118,7 @@ long-lived dependency object that owns this data.
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.FanucToolOffsetVariableLookup.html">FanucToolOffsetVariableLookup</a></dt>
|
||||
<dd><p>Fanuc-side adapter that exposes a wrapped <a class="xref" href="Hi.NcParsers.Dependencys.Generic.ToolOffsetTable.html">ToolOffsetTable</a>
|
||||
as an <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a> following Fanuc Memory C tool offset
|
||||
as an <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a> following Fanuc Memory C tool offset
|
||||
addressing: <code>#2001+N → effective height of offset N</code>
|
||||
(geometry − wear).</p>
|
||||
<p>
|
||||
|
||||
+450
@@ -0,0 +1,450 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class SubProgramFolderConfig | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class SubProgramFolderConfig | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Folder lookup configuration for : where to find an O&lt;n&gt; file when the host program executes M98 P_ L_ () or M198 P_ (, modelling Fanuc's external storage call — memory card, USB, DNC drive — whose only difference from M98 is the search root). Either path may be absolute or relative; when relative, it resolves against the host file's parent directory at lookup time. Either may be null — a null falls back to ; a null falls back to the host file's parent directory.">
|
||||
<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.Dependencys.Generic.SubProgramFolderConfig">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig" data-uid="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig" class="text-break">
|
||||
Class SubProgramFolderConfig
|
||||
</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>.<a class="xref" href="Hi.NcParsers.Dependencys.html">Dependencys</a>.<a class="xref" href="Hi.NcParsers.Dependencys.Generic.html">Generic</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Folder lookup configuration for
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.html">SubProgramCallSyntax</a>: where to find an
|
||||
<code>O<n></code> file when the host program executes <code>M98 P_ L_</code>
|
||||
(<a class="xref" href="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.html#Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_InternalFolder">InternalFolder</a>) or <code>M198 P_</code>
|
||||
(<a class="xref" href="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.html#Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_ExternalFolder">ExternalFolder</a>, modelling Fanuc's external storage call —
|
||||
memory card, USB, DNC drive — whose only difference from M98 is the
|
||||
search root).</p>
|
||||
<p>
|
||||
Either path may be absolute or relative; when relative, it resolves
|
||||
against the host file's parent directory at lookup time. Either may
|
||||
be null — a null <a class="xref" href="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.html#Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_ExternalFolder">ExternalFolder</a> falls back to
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.html#Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_InternalFolder">InternalFolder</a>; a null <a class="xref" href="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.html#Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_InternalFolder">InternalFolder</a>
|
||||
falls back to the host file's parent directory.
|
||||
</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class SubProgramFolderConfig : INcDependency, IMakeXmlSource</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">SubProgramFolderConfig</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.NcParsers.Dependencys.INcDependency.html">INcDependency</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></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>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig__ctor_" data-uid="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig__ctor" data-uid="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.#ctor">
|
||||
SubProgramFolderConfig()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance with the default <code>“NC”</code> internal folder and null external folder.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public SubProgramFolderConfig()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig__ctor_" data-uid="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.#ctor(System.Xml.Linq.XElement)">
|
||||
SubProgramFolderConfig(XElement)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Loads <a class="xref" href="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.html#Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_InternalFolder">InternalFolder</a> / <a class="xref" href="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.html#Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_ExternalFolder">ExternalFolder</a>
|
||||
from XML produced by <a class="xref" href="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.html#Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_MakeXmlSource_System_String_System_String_System_Boolean_">MakeXmlSource(string, string, bool)</a>; either child
|
||||
element may be absent.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public SubProgramFolderConfig(XElement src)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
|
||||
<dd><p>Root element named <a class="xref" href="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.html#Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_XName">XName</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_ExternalFolder_" data-uid="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.ExternalFolder*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_ExternalFolder" data-uid="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.ExternalFolder">
|
||||
ExternalFolder
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Folder for <code>M198 P_</code> lookup, modelling Fanuc's “subprogram on
|
||||
external storage” semantics. Absolute or relative. Null means
|
||||
“fall back to <a class="xref" href="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.html#Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_InternalFolder">InternalFolder</a>” — a simulator-friendly
|
||||
default for projects that don't actually distinguish internal vs
|
||||
external storage on disk.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string ExternalFolder { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</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_Dependencys_Generic_SubProgramFolderConfig_InternalFolder_" data-uid="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.InternalFolder*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_InternalFolder" data-uid="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.InternalFolder">
|
||||
InternalFolder
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Folder for <code>M98 P_</code> lookup. Absolute or relative; relative is
|
||||
resolved against the host file's parent directory at use time.
|
||||
Null means “use the host file's parent directory directly”.
|
||||
Default <code>“NC”</code> mirrors a typical project layout where the main
|
||||
program sits beside an <code>NC/</code> subdirectory of subprograms.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string InternalFolder { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</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_Dependencys_Generic_SubProgramFolderConfig_XName_" data-uid="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.XName*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_XName" data-uid="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>XML element name used to register this dependency with <a class="xref" href="Hi.Common.XmlUtils.XFactory.html">XFactory</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string XName { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_MakeXmlSource_" data-uid="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Creates an XML representation of the object.
|
||||
This method may also generate additional resources such as related files.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The base directory for resolving relative paths</p>
|
||||
</dd>
|
||||
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The relative file path for the XML source</p>
|
||||
</dd>
|
||||
<dt><code>exhibitionOnly</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p>if true, the extended file creation is suppressed.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
|
||||
<dd><p>An XML element representing the object's state</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
@@ -140,20 +140,20 @@ hardware-faithful alternatives that map to real controller parameters.
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.html">NcKinematicsDependency</a></dt>
|
||||
<dd><p>Provides <a class="xref" href="Hi.Numerical.Xyzabc.IMachineKinematics.html">IMachineKinematics</a> as an <a class="xref" href="Hi.NcParsers.Dependencys.INcDependency.html">INcDependency</a>
|
||||
for <a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a>.<a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_NcDependencyList">NcDependencyList</a>.</p>
|
||||
<dt><a class="xref" href="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.html">SubProgramFolderConfig</a></dt>
|
||||
<dd><p>Folder lookup configuration for
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.html">SubProgramCallSyntax</a>: where to find an
|
||||
<code>O<n></code> file when the host program executes <code>M98 P_ L_</code>
|
||||
(<a class="xref" href="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.html#Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_InternalFolder">InternalFolder</a>) or <code>M198 P_</code>
|
||||
(<a class="xref" href="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.html#Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_ExternalFolder">ExternalFolder</a>, modelling Fanuc's external storage call —
|
||||
memory card, USB, DNC drive — whose only difference from M98 is the
|
||||
search root).</p>
|
||||
<p>
|
||||
The actual kinematics instance is resolved at runtime via
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.html#Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_KinematicsProvider">KinematicsProvider</a>. This supports scenarios where
|
||||
the machine tool is loaded or changed after the runner is configured
|
||||
(e.g., XML config loaded first, kinematics assigned later).
|
||||
</p>
|
||||
<p>
|
||||
Consumed by <a class="xref" href="Hi.NcParsers.LogicSyntaxs.G53p1RotaryPositionSyntax.html">G53p1RotaryPositionSyntax</a>,
|
||||
<a class="xref" href="Hi.NcParsers.LogicSyntaxs.IsoG68p2TiltSyntax.html">IsoG68p2TiltSyntax</a>, and
|
||||
<a class="xref" href="Hi.NcParsers.Semantics.McLinearMotionSemantic.html">McLinearMotionSemantic</a> via
|
||||
<code>dependencyList.OfType<IMachineKinematics>()</code>.
|
||||
Either path may be absolute or relative; when relative, it resolves
|
||||
against the host file's parent directory at lookup time. Either may
|
||||
be null — a null <a class="xref" href="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.html#Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_ExternalFolder">ExternalFolder</a> falls back to
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.html#Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_InternalFolder">InternalFolder</a>; a null <a class="xref" href="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.html#Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_InternalFolder">InternalFolder</a>
|
||||
falls back to the host file's parent directory.
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -171,7 +171,7 @@ that lives in the <code>SyntaxPiece</code> JSON dataflow and is bounded by call
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Clears the volatile subset owned by this dependency. Called by
|
||||
<code>RuntimeApi.PowerReset()</code> for every <a class="xref" href="Hi.NcParsers.Dependencys.IPowerResettable.html">IPowerResettable</a> in
|
||||
<code>SessionShell.PowerReset()</code> for every <a class="xref" href="Hi.NcParsers.Dependencys.IPowerResettable.html">IPowerResettable</a> in
|
||||
the active <code>NcDependencyList</code>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
+409
@@ -0,0 +1,409 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class FileIndexCounterDependency | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class FileIndexCounterDependency | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Per-session monotonically-increasing file index allocator. Holds the counter as a private field; returns the next unused value and increments. rewinds to 0 — the owning calls on the same edge that initializes a fresh , so a controller power-reset clears both the syntax-piece pipeline and this counter in lock-step. Two consumers share one allocator: allocates one index per top-level NC file that streams through the runner. allocates a fresh index for each inlined subprogram invocation, including each L repetition — distinct indices ensure (FileIndex, LineIndex) pairs stay unique across overlapping subprogram line ranges. Holding the counter on this dependency rather than on avoids a duplicate source-of-truth: the dep is the single seam through which syntaxes reach the counter, and there is no third reader that would benefit from session-state visibility.">
|
||||
<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.Dependencys.SystemWired.FileIndexCounterDependency">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_Dependencys_SystemWired_FileIndexCounterDependency" data-uid="Hi.NcParsers.Dependencys.SystemWired.FileIndexCounterDependency" class="text-break">
|
||||
Class FileIndexCounterDependency
|
||||
</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>.<a class="xref" href="Hi.NcParsers.Dependencys.html">Dependencys</a>.<a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.html">SystemWired</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Per-session monotonically-increasing file index allocator. Holds the
|
||||
counter as a private field; <a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.FileIndexCounterDependency.html#Hi_NcParsers_Dependencys_SystemWired_FileIndexCounterDependency_Allocate">Allocate()</a> returns the next
|
||||
unused value and increments. <a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.FileIndexCounterDependency.html#Hi_NcParsers_Dependencys_SystemWired_FileIndexCounterDependency_Reset">Reset()</a> rewinds to 0 — the
|
||||
owning <a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_RunControlLines_System_String_System_Collections_Generic_IEnumerable_System_String__Hi_MachiningProcs_MachiningSession_Hi_MachiningProcs_SessionProgress_System_Threading_CancellationToken_">RunControlLines(string, IEnumerable<string>, MachiningSession, SessionProgress, CancellationToken)</a> calls
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.FileIndexCounterDependency.html#Hi_NcParsers_Dependencys_SystemWired_FileIndexCounterDependency_Reset">Reset()</a> on the same edge that initializes a fresh
|
||||
<a class="xref" href="Hi.MachiningProcs.NcRunnerSessionState.html">NcRunnerSessionState</a>, so a controller
|
||||
power-reset clears both the syntax-piece pipeline and this counter
|
||||
in lock-step.</p>
|
||||
<p>
|
||||
Two consumers share one allocator:
|
||||
<ul><li><a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_RunControlLines_System_String_System_Collections_Generic_IEnumerable_System_String__Hi_MachiningProcs_MachiningSession_Hi_MachiningProcs_SessionProgress_System_Threading_CancellationToken_">RunControlLines(string, IEnumerable<string>, MachiningSession, SessionProgress, CancellationToken)</a> allocates one
|
||||
index per top-level NC file that streams through the runner.</li><li><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.html">SubProgramCallSyntax</a> allocates a
|
||||
fresh index for each inlined subprogram invocation, including
|
||||
each <code>L</code> repetition — distinct indices ensure
|
||||
<code>(FileIndex, LineIndex)</code> pairs stay unique across overlapping
|
||||
subprogram line ranges.</li></ul>
|
||||
Holding the counter on this dependency rather than on
|
||||
<a class="xref" href="Hi.MachiningProcs.NcRunnerSessionState.html">NcRunnerSessionState</a> avoids a duplicate
|
||||
source-of-truth: the dep is the single seam through which syntaxes
|
||||
reach the counter, and there is no third reader that would benefit
|
||||
from session-state visibility.
|
||||
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class FileIndexCounterDependency : INcDependency, IMakeXmlSource</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">FileIndexCounterDependency</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.NcParsers.Dependencys.INcDependency.html">INcDependency</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></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>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_FileIndexCounterDependency__ctor_" data-uid="Hi.NcParsers.Dependencys.SystemWired.FileIndexCounterDependency.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_FileIndexCounterDependency__ctor" data-uid="Hi.NcParsers.Dependencys.SystemWired.FileIndexCounterDependency.#ctor">
|
||||
FileIndexCounterDependency()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance with the counter at 0.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FileIndexCounterDependency()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_FileIndexCounterDependency_XName_" data-uid="Hi.NcParsers.Dependencys.SystemWired.FileIndexCounterDependency.XName*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_FileIndexCounterDependency_XName" data-uid="Hi.NcParsers.Dependencys.SystemWired.FileIndexCounterDependency.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>XML element name used to register this dependency with <a class="xref" href="Hi.Common.XmlUtils.XFactory.html">XFactory</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string XName { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_FileIndexCounterDependency_Allocate_" data-uid="Hi.NcParsers.Dependencys.SystemWired.FileIndexCounterDependency.Allocate*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_FileIndexCounterDependency_Allocate" data-uid="Hi.NcParsers.Dependencys.SystemWired.FileIndexCounterDependency.Allocate">
|
||||
Allocate()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Returns the next unused file index and post-increments the
|
||||
counter. First call after construction or <a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.FileIndexCounterDependency.html#Hi_NcParsers_Dependencys_SystemWired_FileIndexCounterDependency_Reset">Reset()</a>
|
||||
returns 0.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int Allocate()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_FileIndexCounterDependency_MakeXmlSource_" data-uid="Hi.NcParsers.Dependencys.SystemWired.FileIndexCounterDependency.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_FileIndexCounterDependency_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.Dependencys.SystemWired.FileIndexCounterDependency.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Runtime-only dependency — the live counter value is per-session
|
||||
and not meaningful to persist; serialization writes only the
|
||||
empty element so the dependency survives an XML round-trip with
|
||||
the counter implicitly reset to 0.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>exhibitionOnly</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_FileIndexCounterDependency_Reset_" data-uid="Hi.NcParsers.Dependencys.SystemWired.FileIndexCounterDependency.Reset*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_FileIndexCounterDependency_Reset" data-uid="Hi.NcParsers.Dependencys.SystemWired.FileIndexCounterDependency.Reset">
|
||||
Reset()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Rewinds the counter to 0. Called by
|
||||
<a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_RunControlLines_System_String_System_Collections_Generic_IEnumerable_System_String__Hi_MachiningProcs_MachiningSession_Hi_MachiningProcs_SessionProgress_System_Threading_CancellationToken_">RunControlLines(string, IEnumerable<string>, MachiningSession, SessionProgress, CancellationToken)</a> on the same edge that
|
||||
initializes a fresh session pipeline so a single brand-preset
|
||||
runner can be reused across sessions without leaking file
|
||||
indices from the previous session.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void Reset()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
+29
-29
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency">
|
||||
<article data-uid="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency" class="text-break">
|
||||
<h1 id="Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency" data-uid="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency" class="text-break">
|
||||
Class NcKinematicsDependency
|
||||
</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>.<a class="xref" href="Hi.NcParsers.Dependencys.html">Dependencys</a>.<a class="xref" href="Hi.NcParsers.Dependencys.Generic.html">Generic</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcParsers.html">NcParsers</a>.<a class="xref" href="Hi.NcParsers.Dependencys.html">Dependencys</a>.<a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.html">SystemWired</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -101,7 +101,7 @@ Class NcKinematicsDependency
|
||||
for <a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a>.<a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_NcDependencyList">NcDependencyList</a>.</p>
|
||||
<p>
|
||||
The actual kinematics instance is resolved at runtime via
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.html#Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_KinematicsProvider">KinematicsProvider</a>. This supports scenarios where
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.html#Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_KinematicsProvider">KinematicsProvider</a>. This supports scenarios where
|
||||
the machine tool is loaded or changed after the runner is configured
|
||||
(e.g., XML config loaded first, kinematics assigned later).
|
||||
</p>
|
||||
@@ -199,14 +199,14 @@ Consumed by <a class="xref" href="Hi.NcParsers.LogicSyntaxs.G53p1RotaryPositionS
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency__ctor_" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.#ctor*"></a>
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency__ctor_" data-uid="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency__ctor" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.#ctor">
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency__ctor" data-uid="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.#ctor">
|
||||
NcKinematicsDependency()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance with no <a class="xref" href="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.html#Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_KinematicsProvider">KinematicsProvider</a>; assign one before the runner queries kinematics.</p>
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance with no <a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.html#Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_KinematicsProvider">KinematicsProvider</a>; assign one before the runner queries kinematics.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -226,14 +226,14 @@ Consumed by <a class="xref" href="Hi.NcParsers.LogicSyntaxs.G53p1RotaryPositionS
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency__ctor_" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.#ctor*"></a>
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency__ctor_" data-uid="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency__ctor_System_Func_Hi_Numerical_Xyzabc_IMachineKinematics__" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.#ctor(System.Func{Hi.Numerical.Xyzabc.IMachineKinematics})">
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency__ctor_System_Func_Hi_Numerical_Xyzabc_IMachineKinematics__" data-uid="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.#ctor(System.Func{Hi.Numerical.Xyzabc.IMachineKinematics})">
|
||||
NcKinematicsDependency(Func<IMachineKinematics>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance with the given <a class="xref" href="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.html#Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_KinematicsProvider">KinematicsProvider</a>.</p>
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance with the given <a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.html#Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_KinematicsProvider">KinematicsProvider</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -263,9 +263,9 @@ Consumed by <a class="xref" href="Hi.NcParsers.LogicSyntaxs.G53p1RotaryPositionS
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_KinematicsProvider_" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.KinematicsProvider*"></a>
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_KinematicsProvider_" data-uid="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.KinematicsProvider*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_KinematicsProvider" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.KinematicsProvider">
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_KinematicsProvider" data-uid="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.KinematicsProvider">
|
||||
KinematicsProvider
|
||||
|
||||
</h3>
|
||||
@@ -296,9 +296,9 @@ Null provider or null return means kinematics is not yet available.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_XName_" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.XName*"></a>
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_XName_" data-uid="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.XName*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_XName" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.XName">
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_XName" data-uid="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
@@ -332,9 +332,9 @@ Null provider or null return means kinematics is not yet available.</p>
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_MakeXmlSource_" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.MakeXmlSource*"></a>
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_MakeXmlSource_" data-uid="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
@@ -374,7 +374,7 @@ This method may also generate additional resources such as related files.</p>
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<h4 class="section" id="Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
@@ -383,9 +383,9 @@ Since the folder can be moving with the configuration file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_McAbcToMat_" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.McAbcToMat*"></a>
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_McAbcToMat_" data-uid="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.McAbcToMat*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_McAbcToMat_Hi_Geom_Vec3d_" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.McAbcToMat(Hi.Geom.Vec3d)">
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_McAbcToMat_Hi_Geom_Vec3d_" data-uid="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.McAbcToMat(Hi.Geom.Vec3d)">
|
||||
McAbcToMat(Vec3d)
|
||||
|
||||
</h3>
|
||||
@@ -423,9 +423,9 @@ the tilt matrix is the transformation matrix from table to attacher.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_McToMat_" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.McToMat*"></a>
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_McToMat_" data-uid="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.McToMat*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_McToMat_Hi_Geom_DVec3d_" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.McToMat(Hi.Geom.DVec3d)">
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_McToMat_Hi_Geom_DVec3d_" data-uid="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.McToMat(Hi.Geom.DVec3d)">
|
||||
McToMat(DVec3d)
|
||||
|
||||
</h3>
|
||||
@@ -462,9 +462,9 @@ the tilt matrix is the transformation matrix from table to attacher.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_McToPn_" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.McToPn*"></a>
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_McToPn_" data-uid="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.McToPn*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_McToPn_Hi_Geom_DVec3d_" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.McToPn(Hi.Geom.DVec3d)">
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_McToPn_Hi_Geom_DVec3d_" data-uid="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.McToPn(Hi.Geom.DVec3d)">
|
||||
McToPn(DVec3d)
|
||||
|
||||
</h3>
|
||||
@@ -502,9 +502,9 @@ The Pn is from table buckle to tool attacher.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_OrientationToMcAbc_" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.OrientationToMcAbc*"></a>
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_OrientationToMcAbc_" data-uid="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.OrientationToMcAbc*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_OrientationToMcAbc_Hi_Geom_Mat4d_Hi_Geom_Vec3d__" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.OrientationToMcAbc(Hi.Geom.Mat4d,Hi.Geom.Vec3d@)">
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_OrientationToMcAbc_Hi_Geom_Mat4d_Hi_Geom_Vec3d__" data-uid="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.OrientationToMcAbc(Hi.Geom.Mat4d,Hi.Geom.Vec3d@)">
|
||||
OrientationToMcAbc(Mat4d, out Vec3d)
|
||||
|
||||
</h3>
|
||||
@@ -546,9 +546,9 @@ the solution only fit the orientation part of the <code class="paramref">tiltMat
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_OrientationToMcAbc_" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.OrientationToMcAbc*"></a>
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_OrientationToMcAbc_" data-uid="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.OrientationToMcAbc*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_OrientationToMcAbc_Hi_Geom_Vec3d_Hi_Geom_Vec3d__" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.OrientationToMcAbc(Hi.Geom.Vec3d,Hi.Geom.Vec3d@)">
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_OrientationToMcAbc_Hi_Geom_Vec3d_Hi_Geom_Vec3d__" data-uid="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.OrientationToMcAbc(Hi.Geom.Vec3d,Hi.Geom.Vec3d@)">
|
||||
OrientationToMcAbc(Vec3d, out Vec3d)
|
||||
|
||||
</h3>
|
||||
@@ -596,9 +596,9 @@ likely to converge for tilt configurations such as <code>G68.2 I180 J90 K0</code
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_PnToMc_" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.PnToMc*"></a>
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_PnToMc_" data-uid="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.PnToMc*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_PnToMc_Hi_Geom_DVec3d_Hi_Geom_DVec3d__" data-uid="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.PnToMc(Hi.Geom.DVec3d,Hi.Geom.DVec3d@)">
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_PnToMc_Hi_Geom_DVec3d_Hi_Geom_DVec3d__" data-uid="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.PnToMc(Hi.Geom.DVec3d,Hi.Geom.DVec3d@)">
|
||||
PnToMc(DVec3d, out DVec3d)
|
||||
|
||||
</h3>
|
||||
+443
@@ -0,0 +1,443 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class ProjectFolderDependency | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class ProjectFolderDependency | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Exposes the absolute base directory of the project that owns this runner. Resolved at runtime via ; the host (e.g. LocalProjectService, a test harness) wires the provider to its known project root after the runner is constructed, because itself does not retain the baseDirectory argument it sees during XML deserialization. Consumed by syntaxes that need to resolve a project-relative path to an absolute file system location — e.g. for O&lt;n&gt; subprogram lookup under . Reading is not a substitute: that path is relative and resolving it via Path.GetFullPath would anchor against the process working directory, not the project root.">
|
||||
<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.Dependencys.SystemWired.ProjectFolderDependency">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_Dependencys_SystemWired_ProjectFolderDependency" data-uid="Hi.NcParsers.Dependencys.SystemWired.ProjectFolderDependency" class="text-break">
|
||||
Class ProjectFolderDependency
|
||||
</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>.<a class="xref" href="Hi.NcParsers.Dependencys.html">Dependencys</a>.<a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.html">SystemWired</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Exposes the absolute base directory of the project that owns this
|
||||
runner. Resolved at runtime via <a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.ProjectFolderDependency.html#Hi_NcParsers_Dependencys_SystemWired_ProjectFolderDependency_BaseDirectoryProvider">BaseDirectoryProvider</a>;
|
||||
the host (e.g. <code>LocalProjectService</code>, a test harness) wires the
|
||||
provider to its known project root after the runner is constructed,
|
||||
because <a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a> itself does not retain the
|
||||
<code>baseDirectory</code> argument it sees during XML deserialization.</p>
|
||||
<p>
|
||||
Consumed by syntaxes that need to resolve a project-relative path
|
||||
to an absolute file system location — e.g.
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.html">SubProgramCallSyntax</a> for <code>O<n></code>
|
||||
subprogram lookup under
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.html#Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_InternalFolder">InternalFolder</a>.
|
||||
Reading <a class="xref" href="Hi.NcParsers.Sentence.html#Hi_NcParsers_Sentence_FilePath">FilePath</a> is not a substitute: that
|
||||
path is relative and resolving it via <code>Path.GetFullPath</code> would
|
||||
anchor against the process working directory, not the project root.
|
||||
</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ProjectFolderDependency : INcDependency, IMakeXmlSource</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">ProjectFolderDependency</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.NcParsers.Dependencys.INcDependency.html">INcDependency</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></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>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_ProjectFolderDependency__ctor_" data-uid="Hi.NcParsers.Dependencys.SystemWired.ProjectFolderDependency.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_ProjectFolderDependency__ctor" data-uid="Hi.NcParsers.Dependencys.SystemWired.ProjectFolderDependency.#ctor">
|
||||
ProjectFolderDependency()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance with no <a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.ProjectFolderDependency.html#Hi_NcParsers_Dependencys_SystemWired_ProjectFolderDependency_BaseDirectoryProvider">BaseDirectoryProvider</a>; the host assigns one before queries.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ProjectFolderDependency()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_ProjectFolderDependency__ctor_" data-uid="Hi.NcParsers.Dependencys.SystemWired.ProjectFolderDependency.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_ProjectFolderDependency__ctor_System_Func_System_String__" data-uid="Hi.NcParsers.Dependencys.SystemWired.ProjectFolderDependency.#ctor(System.Func{System.String})">
|
||||
ProjectFolderDependency(Func<string>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance with the given <a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.ProjectFolderDependency.html#Hi_NcParsers_Dependencys_SystemWired_ProjectFolderDependency_BaseDirectoryProvider">BaseDirectoryProvider</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ProjectFolderDependency(Func<string> provider)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>provider</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
||||
<dd><p>Delegate that resolves the absolute base directory at lookup time.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_ProjectFolderDependency_BaseDirectory_" data-uid="Hi.NcParsers.Dependencys.SystemWired.ProjectFolderDependency.BaseDirectory*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_ProjectFolderDependency_BaseDirectory" data-uid="Hi.NcParsers.Dependencys.SystemWired.ProjectFolderDependency.BaseDirectory">
|
||||
BaseDirectory
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>The live absolute base directory, or null when
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.ProjectFolderDependency.html#Hi_NcParsers_Dependencys_SystemWired_ProjectFolderDependency_BaseDirectoryProvider">BaseDirectoryProvider</a> is unset or returns null.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string BaseDirectory { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_ProjectFolderDependency_BaseDirectoryProvider_" data-uid="Hi.NcParsers.Dependencys.SystemWired.ProjectFolderDependency.BaseDirectoryProvider*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_ProjectFolderDependency_BaseDirectoryProvider" data-uid="Hi.NcParsers.Dependencys.SystemWired.ProjectFolderDependency.BaseDirectoryProvider">
|
||||
BaseDirectoryProvider
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Runtime provider for the absolute project base directory.
|
||||
Public so cross-assembly hosts (e.g. <code>LocalProjectService</code>
|
||||
in HiNc) can wire it after the runner is constructed — same
|
||||
host-wired posture as <a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.html#Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_KinematicsProvider">KinematicsProvider</a>.
|
||||
Null provider or null return means the host has not configured
|
||||
a base directory yet — consumers should treat this as a
|
||||
configuration error and surface a diagnostic rather than
|
||||
silently falling back.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Func<string> BaseDirectoryProvider { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_ProjectFolderDependency_XName_" data-uid="Hi.NcParsers.Dependencys.SystemWired.ProjectFolderDependency.XName*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_ProjectFolderDependency_XName" data-uid="Hi.NcParsers.Dependencys.SystemWired.ProjectFolderDependency.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>XML element name used to register this dependency with <a class="xref" href="Hi.Common.XmlUtils.XFactory.html">XFactory</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string XName { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_ProjectFolderDependency_MakeXmlSource_" data-uid="Hi.NcParsers.Dependencys.SystemWired.ProjectFolderDependency.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_ProjectFolderDependency_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.Dependencys.SystemWired.ProjectFolderDependency.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Runtime-only dependency — the <a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.ProjectFolderDependency.html#Hi_NcParsers_Dependencys_SystemWired_ProjectFolderDependency_BaseDirectoryProvider">BaseDirectoryProvider</a>
|
||||
is wired per-host and is not meaningful to persist; serialization
|
||||
writes only the empty element so the dependency survives an XML
|
||||
round-trip.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>exhibitionOnly</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
|
||||
<dd></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>
|
||||
+400
@@ -0,0 +1,400 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class SegmenterDependency | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class SegmenterDependency | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Exposes the active to syntaxes that need to re-segment auxiliary NC text mid-pipeline (e.g., reading an O&lt;n&gt; subprogram file and re-using the host runner's segmenter so the inlined blocks are split with the same rules). The actual segmenter is resolved at runtime via ; wires the provider to its own at the start of each session run, so this dependency can sit in without participating in XML serialization (see ).">
|
||||
<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.Dependencys.SystemWired.SegmenterDependency">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_Dependencys_SystemWired_SegmenterDependency" data-uid="Hi.NcParsers.Dependencys.SystemWired.SegmenterDependency" class="text-break">
|
||||
Class SegmenterDependency
|
||||
</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>.<a class="xref" href="Hi.NcParsers.Dependencys.html">Dependencys</a>.<a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.html">SystemWired</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Exposes the active <a class="xref" href="Hi.NcParsers.Segmenters.ISegmenter.html">ISegmenter</a> to syntaxes that need to
|
||||
re-segment auxiliary NC text mid-pipeline (e.g.,
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.html">SubProgramCallSyntax</a> reading an <code>O<n></code>
|
||||
subprogram file and re-using the host runner's segmenter so the inlined
|
||||
blocks are split with the same rules).</p>
|
||||
<p>
|
||||
The actual segmenter is resolved at runtime via
|
||||
<span class="xref">Hi.NcParsers.Dependencys.SystemWired.SegmenterDependency.SegmenterProvider</span>; <a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_RunControlLines_System_String_System_Collections_Generic_IEnumerable_System_String__Hi_MachiningProcs_MachiningSession_Hi_MachiningProcs_SessionProgress_System_Threading_CancellationToken_">RunControlLines(string, IEnumerable<string>, MachiningSession, SessionProgress, CancellationToken)</a>
|
||||
wires the provider to its own <a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_Segmenter">Segmenter</a> at the
|
||||
start of each session run, so this dependency can sit in
|
||||
<a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_NcDependencyList">NcDependencyList</a> without participating in XML
|
||||
serialization (see <a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.SegmenterDependency.html#Hi_NcParsers_Dependencys_SystemWired_SegmenterDependency_MakeXmlSource_System_String_System_String_System_Boolean_">MakeXmlSource(string, string, bool)</a>).
|
||||
</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class SegmenterDependency : INcDependency, IMakeXmlSource</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">SegmenterDependency</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.NcParsers.Dependencys.INcDependency.html">INcDependency</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></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>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_SegmenterDependency__ctor_" data-uid="Hi.NcParsers.Dependencys.SystemWired.SegmenterDependency.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_SegmenterDependency__ctor" data-uid="Hi.NcParsers.Dependencys.SystemWired.SegmenterDependency.#ctor">
|
||||
SegmenterDependency()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance with no <span class="xref">Hi.NcParsers.Dependencys.SystemWired.SegmenterDependency.SegmenterProvider</span>; the host runner assigns one before queries.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public SegmenterDependency()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_SegmenterDependency__ctor_" data-uid="Hi.NcParsers.Dependencys.SystemWired.SegmenterDependency.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_SegmenterDependency__ctor_System_Func_Hi_NcParsers_Segmenters_ISegmenter__" data-uid="Hi.NcParsers.Dependencys.SystemWired.SegmenterDependency.#ctor(System.Func{Hi.NcParsers.Segmenters.ISegmenter})">
|
||||
SegmenterDependency(Func<ISegmenter>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance with the given <span class="xref">Hi.NcParsers.Dependencys.SystemWired.SegmenterDependency.SegmenterProvider</span>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public SegmenterDependency(Func<ISegmenter> provider)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>provider</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a class="xref" href="Hi.NcParsers.Segmenters.ISegmenter.html">ISegmenter</a>></dt>
|
||||
<dd><p>Delegate that resolves the live <a class="xref" href="Hi.NcParsers.Segmenters.ISegmenter.html">ISegmenter</a> at lookup time.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_SegmenterDependency_Segmenter_" data-uid="Hi.NcParsers.Dependencys.SystemWired.SegmenterDependency.Segmenter*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_SegmenterDependency_Segmenter" data-uid="Hi.NcParsers.Dependencys.SystemWired.SegmenterDependency.Segmenter">
|
||||
Segmenter
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>The live segmenter, or null when <span class="xref">Hi.NcParsers.Dependencys.SystemWired.SegmenterDependency.SegmenterProvider</span> is
|
||||
unset or returns null.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ISegmenter Segmenter { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.NcParsers.Segmenters.ISegmenter.html">ISegmenter</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_SegmenterDependency_XName_" data-uid="Hi.NcParsers.Dependencys.SystemWired.SegmenterDependency.XName*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_SegmenterDependency_XName" data-uid="Hi.NcParsers.Dependencys.SystemWired.SegmenterDependency.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>XML element name used to register this dependency with <a class="xref" href="Hi.Common.XmlUtils.XFactory.html">XFactory</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string XName { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_SegmenterDependency_MakeXmlSource_" data-uid="Hi.NcParsers.Dependencys.SystemWired.SegmenterDependency.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_SegmenterDependency_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.Dependencys.SystemWired.SegmenterDependency.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Runtime-only dependency — the <span class="xref">Hi.NcParsers.Dependencys.SystemWired.SegmenterDependency.SegmenterProvider</span> is wired
|
||||
per session and is not meaningful to persist; serialization writes only
|
||||
the empty element so the dependency survives an XML round-trip.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>exhibitionOnly</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
|
||||
<dd></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>
|
||||
+404
@@ -0,0 +1,404 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class SyntaxPieceLayerDependency | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class SyntaxPieceLayerDependency | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Exposes the per-session layer chain (one per pipeline stage, owned by ) to syntaxes that need to inject additional source pieces mid-pipeline — most notably , which inlines a subprogram file's blocks back into layers[0] immediately after the M98 host node so the entire syntax pipeline naturally re-processes them. The actual layer list is resolved at runtime via ; wires the provider to the active session's at the start of each call. Index 0 is the source layer (init seed + sentence-derived pieces); indices 1..N are post-NcSyntax layers — same convention as .">
|
||||
<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.Dependencys.SystemWired.SyntaxPieceLayerDependency">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_Dependencys_SystemWired_SyntaxPieceLayerDependency" data-uid="Hi.NcParsers.Dependencys.SystemWired.SyntaxPieceLayerDependency" class="text-break">
|
||||
Class SyntaxPieceLayerDependency
|
||||
</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>.<a class="xref" href="Hi.NcParsers.Dependencys.html">Dependencys</a>.<a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.html">SystemWired</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Exposes the per-session <a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a> layer chain (one
|
||||
<a class="xref" href="Hi.Common.Collections.LazyLinkedList-1.html">LazyLinkedList<T></a> per pipeline stage, owned by
|
||||
<a class="xref" href="Hi.MachiningProcs.NcRunnerSessionState.html">NcRunnerSessionState</a>) to syntaxes that need
|
||||
to inject additional source pieces mid-pipeline — most notably
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.html">SubProgramCallSyntax</a>, which inlines a subprogram
|
||||
file's blocks back into <code>layers[0]</code> immediately after the M98 host
|
||||
node so the entire syntax pipeline naturally re-processes them.</p>
|
||||
<p>
|
||||
The actual layer list is resolved at runtime via
|
||||
<span class="xref">Hi.NcParsers.Dependencys.SystemWired.SyntaxPieceLayerDependency.LayersProvider</span>; <a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_RunControlLines_System_String_System_Collections_Generic_IEnumerable_System_String__Hi_MachiningProcs_MachiningSession_Hi_MachiningProcs_SessionProgress_System_Threading_CancellationToken_">RunControlLines(string, IEnumerable<string>, MachiningSession, SessionProgress, CancellationToken)</a>
|
||||
wires the provider to the active session's
|
||||
<a class="xref" href="Hi.MachiningProcs.NcRunnerSessionState.html#Hi_MachiningProcs_NcRunnerSessionState_SyntaxPieceLayers">SyntaxPieceLayers</a> at
|
||||
the start of each call. Index 0 is the source layer (init seed +
|
||||
sentence-derived pieces); indices 1..N are post-NcSyntax layers — same
|
||||
convention as <a class="xref" href="Hi.MachiningProcs.NcRunnerSessionState.html">NcRunnerSessionState</a>.
|
||||
</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class SyntaxPieceLayerDependency : INcDependency, IMakeXmlSource</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">SyntaxPieceLayerDependency</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.NcParsers.Dependencys.INcDependency.html">INcDependency</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></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>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_SyntaxPieceLayerDependency__ctor_" data-uid="Hi.NcParsers.Dependencys.SystemWired.SyntaxPieceLayerDependency.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_SyntaxPieceLayerDependency__ctor" data-uid="Hi.NcParsers.Dependencys.SystemWired.SyntaxPieceLayerDependency.#ctor">
|
||||
SyntaxPieceLayerDependency()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance with no <span class="xref">Hi.NcParsers.Dependencys.SystemWired.SyntaxPieceLayerDependency.LayersProvider</span>; the host runner assigns one before queries.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public SyntaxPieceLayerDependency()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_SyntaxPieceLayerDependency__ctor_" data-uid="Hi.NcParsers.Dependencys.SystemWired.SyntaxPieceLayerDependency.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_SyntaxPieceLayerDependency__ctor_System_Func_System_Collections_Generic_List_Hi_Common_Collections_LazyLinkedList_Hi_NcParsers_Syntaxs_SyntaxPiece____" data-uid="Hi.NcParsers.Dependencys.SystemWired.SyntaxPieceLayerDependency.#ctor(System.Func{System.Collections.Generic.List{Hi.Common.Collections.LazyLinkedList{Hi.NcParsers.Syntaxs.SyntaxPiece}}})">
|
||||
SyntaxPieceLayerDependency(Func<List<LazyLinkedList<SyntaxPiece>>>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance with the given <span class="xref">Hi.NcParsers.Dependencys.SystemWired.SyntaxPieceLayerDependency.LayersProvider</span>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public SyntaxPieceLayerDependency(Func<List<LazyLinkedList<SyntaxPiece>>> provider)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>provider</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a><<a class="xref" href="Hi.Common.Collections.LazyLinkedList-1.html">LazyLinkedList</a><<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a>>>></dt>
|
||||
<dd><p>Delegate that resolves the live layer chain at lookup time.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_SyntaxPieceLayerDependency_Layers_" data-uid="Hi.NcParsers.Dependencys.SystemWired.SyntaxPieceLayerDependency.Layers*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_SyntaxPieceLayerDependency_Layers" data-uid="Hi.NcParsers.Dependencys.SystemWired.SyntaxPieceLayerDependency.Layers">
|
||||
Layers
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>The live layer chain, or null when <span class="xref">Hi.NcParsers.Dependencys.SystemWired.SyntaxPieceLayerDependency.LayersProvider</span> is
|
||||
unset or returns null. Layer 0 is the source layer; layers 1..N are
|
||||
post-NcSyntax layers.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public List<LazyLinkedList<SyntaxPiece>> Layers { 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.list-1">List</a><<a class="xref" href="Hi.Common.Collections.LazyLinkedList-1.html">LazyLinkedList</a><<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a>>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_SyntaxPieceLayerDependency_XName_" data-uid="Hi.NcParsers.Dependencys.SystemWired.SyntaxPieceLayerDependency.XName*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_SyntaxPieceLayerDependency_XName" data-uid="Hi.NcParsers.Dependencys.SystemWired.SyntaxPieceLayerDependency.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>XML element name used to register this dependency with <a class="xref" href="Hi.Common.XmlUtils.XFactory.html">XFactory</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string XName { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Dependencys_SystemWired_SyntaxPieceLayerDependency_MakeXmlSource_" data-uid="Hi.NcParsers.Dependencys.SystemWired.SyntaxPieceLayerDependency.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Dependencys_SystemWired_SyntaxPieceLayerDependency_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.Dependencys.SystemWired.SyntaxPieceLayerDependency.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Runtime-only dependency — the <span class="xref">Hi.NcParsers.Dependencys.SystemWired.SyntaxPieceLayerDependency.LayersProvider</span> is wired
|
||||
per session and is not meaningful to persist; serialization writes only
|
||||
the empty element so the dependency survives an XML round-trip.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>exhibitionOnly</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
|
||||
<dd></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>
|
||||
@@ -0,0 +1,223 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Namespace Hi.NcParsers.Dependencys.SystemWired | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Namespace Hi.NcParsers.Dependencys.SystemWired | 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.Dependencys.SystemWired">
|
||||
|
||||
<h1 id="Hi_NcParsers_Dependencys_SystemWired" data-uid="Hi.NcParsers.Dependencys.SystemWired" class="text-break">Namespace Hi.NcParsers.Dependencys.SystemWired</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.Dependencys.SystemWired.FileIndexCounterDependency.html">FileIndexCounterDependency</a></dt>
|
||||
<dd><p>Per-session monotonically-increasing file index allocator. Holds the
|
||||
counter as a private field; <a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.FileIndexCounterDependency.html#Hi_NcParsers_Dependencys_SystemWired_FileIndexCounterDependency_Allocate">Allocate()</a> returns the next
|
||||
unused value and increments. <a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.FileIndexCounterDependency.html#Hi_NcParsers_Dependencys_SystemWired_FileIndexCounterDependency_Reset">Reset()</a> rewinds to 0 — the
|
||||
owning <a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_RunControlLines_System_String_System_Collections_Generic_IEnumerable_System_String__Hi_MachiningProcs_MachiningSession_Hi_MachiningProcs_SessionProgress_System_Threading_CancellationToken_">RunControlLines(string, IEnumerable<string>, MachiningSession, SessionProgress, CancellationToken)</a> calls
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.FileIndexCounterDependency.html#Hi_NcParsers_Dependencys_SystemWired_FileIndexCounterDependency_Reset">Reset()</a> on the same edge that initializes a fresh
|
||||
<a class="xref" href="Hi.MachiningProcs.NcRunnerSessionState.html">NcRunnerSessionState</a>, so a controller
|
||||
power-reset clears both the syntax-piece pipeline and this counter
|
||||
in lock-step.</p>
|
||||
<p>
|
||||
Two consumers share one allocator:
|
||||
<ul><li><a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_RunControlLines_System_String_System_Collections_Generic_IEnumerable_System_String__Hi_MachiningProcs_MachiningSession_Hi_MachiningProcs_SessionProgress_System_Threading_CancellationToken_">RunControlLines(string, IEnumerable<string>, MachiningSession, SessionProgress, CancellationToken)</a> allocates one
|
||||
index per top-level NC file that streams through the runner.</li><li><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.html">SubProgramCallSyntax</a> allocates a
|
||||
fresh index for each inlined subprogram invocation, including
|
||||
each <code>L</code> repetition — distinct indices ensure
|
||||
<code>(FileIndex, LineIndex)</code> pairs stay unique across overlapping
|
||||
subprogram line ranges.</li></ul>
|
||||
Holding the counter on this dependency rather than on
|
||||
<a class="xref" href="Hi.MachiningProcs.NcRunnerSessionState.html">NcRunnerSessionState</a> avoids a duplicate
|
||||
source-of-truth: the dep is the single seam through which syntaxes
|
||||
reach the counter, and there is no third reader that would benefit
|
||||
from session-state visibility.
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.html">NcKinematicsDependency</a></dt>
|
||||
<dd><p>Provides <a class="xref" href="Hi.Numerical.Xyzabc.IMachineKinematics.html">IMachineKinematics</a> as an <a class="xref" href="Hi.NcParsers.Dependencys.INcDependency.html">INcDependency</a>
|
||||
for <a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a>.<a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_NcDependencyList">NcDependencyList</a>.</p>
|
||||
<p>
|
||||
The actual kinematics instance is resolved at runtime via
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.html#Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_KinematicsProvider">KinematicsProvider</a>. This supports scenarios where
|
||||
the machine tool is loaded or changed after the runner is configured
|
||||
(e.g., XML config loaded first, kinematics assigned later).
|
||||
</p>
|
||||
<p>
|
||||
Consumed by <a class="xref" href="Hi.NcParsers.LogicSyntaxs.G53p1RotaryPositionSyntax.html">G53p1RotaryPositionSyntax</a>,
|
||||
<a class="xref" href="Hi.NcParsers.LogicSyntaxs.IsoG68p2TiltSyntax.html">IsoG68p2TiltSyntax</a>, and
|
||||
<a class="xref" href="Hi.NcParsers.Semantics.McLinearMotionSemantic.html">McLinearMotionSemantic</a> via
|
||||
<code>dependencyList.OfType<IMachineKinematics>()</code>.
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.ProjectFolderDependency.html">ProjectFolderDependency</a></dt>
|
||||
<dd><p>Exposes the absolute base directory of the project that owns this
|
||||
runner. Resolved at runtime via <a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.ProjectFolderDependency.html#Hi_NcParsers_Dependencys_SystemWired_ProjectFolderDependency_BaseDirectoryProvider">BaseDirectoryProvider</a>;
|
||||
the host (e.g. <code>LocalProjectService</code>, a test harness) wires the
|
||||
provider to its known project root after the runner is constructed,
|
||||
because <a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a> itself does not retain the
|
||||
<code>baseDirectory</code> argument it sees during XML deserialization.</p>
|
||||
<p>
|
||||
Consumed by syntaxes that need to resolve a project-relative path
|
||||
to an absolute file system location — e.g.
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.html">SubProgramCallSyntax</a> for <code>O<n></code>
|
||||
subprogram lookup under
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.html#Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_InternalFolder">InternalFolder</a>.
|
||||
Reading <a class="xref" href="Hi.NcParsers.Sentence.html#Hi_NcParsers_Sentence_FilePath">FilePath</a> is not a substitute: that
|
||||
path is relative and resolving it via <code>Path.GetFullPath</code> would
|
||||
anchor against the process working directory, not the project root.
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.SegmenterDependency.html">SegmenterDependency</a></dt>
|
||||
<dd><p>Exposes the active <a class="xref" href="Hi.NcParsers.Segmenters.ISegmenter.html">ISegmenter</a> to syntaxes that need to
|
||||
re-segment auxiliary NC text mid-pipeline (e.g.,
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.html">SubProgramCallSyntax</a> reading an <code>O<n></code>
|
||||
subprogram file and re-using the host runner's segmenter so the inlined
|
||||
blocks are split with the same rules).</p>
|
||||
<p>
|
||||
The actual segmenter is resolved at runtime via
|
||||
<span class="xref">Hi.NcParsers.Dependencys.SystemWired.SegmenterDependency.SegmenterProvider</span>; <a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_RunControlLines_System_String_System_Collections_Generic_IEnumerable_System_String__Hi_MachiningProcs_MachiningSession_Hi_MachiningProcs_SessionProgress_System_Threading_CancellationToken_">RunControlLines(string, IEnumerable<string>, MachiningSession, SessionProgress, CancellationToken)</a>
|
||||
wires the provider to its own <a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_Segmenter">Segmenter</a> at the
|
||||
start of each session run, so this dependency can sit in
|
||||
<a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_NcDependencyList">NcDependencyList</a> without participating in XML
|
||||
serialization (see <a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.SegmenterDependency.html#Hi_NcParsers_Dependencys_SystemWired_SegmenterDependency_MakeXmlSource_System_String_System_String_System_Boolean_">MakeXmlSource(string, string, bool)</a>).
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.SyntaxPieceLayerDependency.html">SyntaxPieceLayerDependency</a></dt>
|
||||
<dd><p>Exposes the per-session <a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a> layer chain (one
|
||||
<a class="xref" href="Hi.Common.Collections.LazyLinkedList-1.html">LazyLinkedList<T></a> per pipeline stage, owned by
|
||||
<a class="xref" href="Hi.MachiningProcs.NcRunnerSessionState.html">NcRunnerSessionState</a>) to syntaxes that need
|
||||
to inject additional source pieces mid-pipeline — most notably
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.html">SubProgramCallSyntax</a>, which inlines a subprogram
|
||||
file's blocks back into <code>layers[0]</code> immediately after the M98 host
|
||||
node so the entire syntax pipeline naturally re-processes them.</p>
|
||||
<p>
|
||||
The actual layer list is resolved at runtime via
|
||||
<span class="xref">Hi.NcParsers.Dependencys.SystemWired.SyntaxPieceLayerDependency.LayersProvider</span>; <a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_RunControlLines_System_String_System_Collections_Generic_IEnumerable_System_String__Hi_MachiningProcs_MachiningSession_Hi_MachiningProcs_SessionProgress_System_Threading_CancellationToken_">RunControlLines(string, IEnumerable<string>, MachiningSession, SessionProgress, CancellationToken)</a>
|
||||
wires the provider to the active session's
|
||||
<a class="xref" href="Hi.MachiningProcs.NcRunnerSessionState.html#Hi_MachiningProcs_NcRunnerSessionState_SyntaxPieceLayers">SyntaxPieceLayers</a> at
|
||||
the start of each call. Index 0 is the source layer (init seed +
|
||||
sentence-derived pieces); indices 1..N are post-NcSyntax layers — same
|
||||
convention as <a class="xref" href="Hi.MachiningProcs.NcRunnerSessionState.html">NcRunnerSessionState</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>
|
||||
+23
-23
@@ -84,20 +84,20 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult">
|
||||
<article data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_LogicSyntaxs_Evaluation_EvalResult" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult" class="text-break">
|
||||
<h1 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_EvalResult" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult" class="text-break">
|
||||
Struct EvalResult
|
||||
</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>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.html">LogicSyntaxs</a>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcParsers.html">NcParsers</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.html">EvaluationSyntaxs</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Outcome of evaluating an <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a>. Either a successful
|
||||
<div class="markdown summary"><p>Outcome of evaluating an <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a>. Either a successful
|
||||
numeric value, or a failure with an error code matching the diagnostic
|
||||
catalogue used by reading / evaluator syntaxes.</p>
|
||||
</div>
|
||||
@@ -114,7 +114,7 @@ catalogue used by reading / evaluator syntaxes.</p>
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult.html">EvalResult</a>></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult.html">EvalResult</a>></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -179,14 +179,14 @@ catalogue used by reading / evaluator syntaxes.</p>
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_EvalResult__ctor_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult.#ctor*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_EvalResult__ctor_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_EvalResult__ctor_System_Nullable_System_Double__System_String_System_String_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult.#ctor(System.Nullable{System.Double},System.String,System.String)">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_EvalResult__ctor_System_Nullable_System_Double__System_String_System_String_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult.#ctor(System.Nullable{System.Double},System.String,System.String)">
|
||||
EvalResult(double?, string, string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Outcome of evaluating an <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a>. Either a successful
|
||||
<div class="markdown level1 summary"><p>Outcome of evaluating an <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a>. Either a successful
|
||||
numeric value, or a failure with an error code matching the diagnostic
|
||||
catalogue used by reading / evaluator syntaxes.</p>
|
||||
</div>
|
||||
@@ -221,9 +221,9 @@ catalogue used by reading / evaluator syntaxes.</p>
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_EvalResult_ErrorCode_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult.ErrorCode*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_EvalResult_ErrorCode_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult.ErrorCode*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_EvalResult_ErrorCode" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult.ErrorCode">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_EvalResult_ErrorCode" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult.ErrorCode">
|
||||
ErrorCode
|
||||
|
||||
</h3>
|
||||
@@ -252,9 +252,9 @@ catalogue used by reading / evaluator syntaxes.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_EvalResult_ErrorMessage_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult.ErrorMessage*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_EvalResult_ErrorMessage_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult.ErrorMessage*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_EvalResult_ErrorMessage" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult.ErrorMessage">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_EvalResult_ErrorMessage" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult.ErrorMessage">
|
||||
ErrorMessage
|
||||
|
||||
</h3>
|
||||
@@ -283,14 +283,14 @@ catalogue used by reading / evaluator syntaxes.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_EvalResult_IsSuccess_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult.IsSuccess*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_EvalResult_IsSuccess_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult.IsSuccess*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_EvalResult_IsSuccess" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult.IsSuccess">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_EvalResult_IsSuccess" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult.IsSuccess">
|
||||
IsSuccess
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p><code>true</code> when <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult.html#Hi_NcParsers_LogicSyntaxs_Evaluation_EvalResult_ErrorCode">ErrorCode</a> is <code>null</code>.</p>
|
||||
<div class="markdown level1 summary"><p><code>true</code> when <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult.html#Hi_NcParsers_EvaluationSyntaxs_Evaluation_EvalResult_ErrorCode">ErrorCode</a> is <code>null</code>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -315,9 +315,9 @@ catalogue used by reading / evaluator syntaxes.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_EvalResult_Value_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult.Value*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_EvalResult_Value_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult.Value*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_EvalResult_Value" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult.Value">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_EvalResult_Value" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult.Value">
|
||||
Value
|
||||
|
||||
</h3>
|
||||
@@ -350,9 +350,9 @@ catalogue used by reading / evaluator syntaxes.</p>
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_EvalResult_Failure_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult.Failure*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_EvalResult_Failure_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult.Failure*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_EvalResult_Failure_System_String_System_String_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult.Failure(System.String,System.String)">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_EvalResult_Failure_System_String_System_String_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult.Failure(System.String,System.String)">
|
||||
Failure(string, string)
|
||||
|
||||
</h3>
|
||||
@@ -375,7 +375,7 @@ catalogue used by reading / evaluator syntaxes.</p>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult.html">EvalResult</a></dt>
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult.html">EvalResult</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
@@ -389,9 +389,9 @@ catalogue used by reading / evaluator syntaxes.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_EvalResult_Success_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult.Success*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_EvalResult_Success_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult.Success*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_EvalResult_Success_System_Double_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult.Success(System.Double)">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_EvalResult_Success_System_Double_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult.Success(System.Double)">
|
||||
Success(double)
|
||||
|
||||
</h3>
|
||||
@@ -412,7 +412,7 @@ catalogue used by reading / evaluator syntaxes.</p>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult.html">EvalResult</a></dt>
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult.html">EvalResult</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
+7
-7
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.IRuntimeVariableLookup">
|
||||
<article data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IRuntimeVariableLookup">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_LogicSyntaxs_Evaluation_IRuntimeVariableLookup" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.IRuntimeVariableLookup" class="text-break">
|
||||
<h1 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_IRuntimeVariableLookup" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IRuntimeVariableLookup" class="text-break">
|
||||
Interface IRuntimeVariableLookup
|
||||
</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>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.html">LogicSyntaxs</a>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcParsers.html">NcParsers</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.html">EvaluationSyntaxs</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -103,12 +103,12 @@ traceback into runtime-state sections like <code>MachineCoordinateState</code>
|
||||
/ <code>ProgramXyz</code>) and the dependency list (so the lookup can read
|
||||
from sibling dependencies without holding a static reference).</p>
|
||||
<p>
|
||||
Distinguished from <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a>: that one is for
|
||||
Distinguished from <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a>: that one is for
|
||||
long-lived dependencies that already hold their own data (parameter
|
||||
tables, tool-offset wrappers, retained-variable tables) and need no
|
||||
block context. <code>IRuntimeVariableLookup</code> is for context-sensitive
|
||||
resolutions configured declaratively on
|
||||
<a class="xref" href="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.html#Hi_NcParsers_LogicSyntaxs_VariableEvaluatorSyntax_RuntimeVariableLookups">RuntimeVariableLookups</a>.
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html#Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax_RuntimeVariableLookups">RuntimeVariableLookups</a>.
|
||||
</p>
|
||||
<p>
|
||||
Implementations should be brand-specific (e.g. Fanuc <code>#5001-#5043</code>
|
||||
@@ -163,9 +163,9 @@ the evaluator's chain can fall through to the next lookup.
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_IRuntimeVariableLookup_Get_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.IRuntimeVariableLookup.Get*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_IRuntimeVariableLookup_Get_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IRuntimeVariableLookup.Get*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_IRuntimeVariableLookup_Get_System_String_Hi_Common_Collections_LazyLinkedListNode_Hi_NcParsers_Syntaxs_SyntaxPiece__System_Collections_Generic_IReadOnlyList_Hi_NcParsers_Dependencys_INcDependency__" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.IRuntimeVariableLookup.Get(System.String,Hi.Common.Collections.LazyLinkedListNode{Hi.NcParsers.Syntaxs.SyntaxPiece},System.Collections.Generic.IReadOnlyList{Hi.NcParsers.Dependencys.INcDependency})">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_IRuntimeVariableLookup_Get_System_String_Hi_Common_Collections_LazyLinkedListNode_Hi_NcParsers_Syntaxs_SyntaxPiece__System_Collections_Generic_IReadOnlyList_Hi_NcParsers_Dependencys_INcDependency__" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IRuntimeVariableLookup.Get(System.String,Hi.Common.Collections.LazyLinkedListNode{Hi.NcParsers.Syntaxs.SyntaxPiece},System.Collections.Generic.IReadOnlyList{Hi.NcParsers.Dependencys.INcDependency})">
|
||||
Get(string, LazyLinkedListNode<SyntaxPiece>, IReadOnlyList<INcDependency>)
|
||||
|
||||
</h3>
|
||||
+6
-6
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup">
|
||||
<article data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_LogicSyntaxs_Evaluation_IVariableLookup" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup" class="text-break">
|
||||
<h1 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_IVariableLookup" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup" class="text-break">
|
||||
Interface IVariableLookup
|
||||
</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>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.html">LogicSyntaxs</a>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcParsers.html">NcParsers</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.html">EvaluationSyntaxs</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -107,7 +107,7 @@ and parse the prefix locally; chain them at the call site by trying each
|
||||
in priority order until one returns a non-<code>null</code> value.
|
||||
</p>
|
||||
<p>
|
||||
A returned <code>null</code> is treated by <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionEvaluator.html">NcExpressionEvaluator</a>
|
||||
A returned <code>null</code> is treated by <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionEvaluator.html">NcExpressionEvaluator</a>
|
||||
as vacant and surfaces as a <code>Variable--Vacant</code> failure when the
|
||||
value is consumed in arithmetic context.
|
||||
</p>
|
||||
@@ -159,9 +159,9 @@ value is consumed in arithmetic context.
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_IVariableLookup_Get_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup.Get*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_IVariableLookup_Get_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup.Get*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_IVariableLookup_Get_System_String_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup.Get(System.String)">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_IVariableLookup_Get_System_String_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup.Get(System.String)">
|
||||
Get(string)
|
||||
|
||||
</h3>
|
||||
+329
@@ -0,0 +1,329 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class LocalVariableLookup | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class LocalVariableLookup | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Reads Fanuc-style local macro variables (#1-#33) from Vars.Local on the current JSON, walking until the entry is found. Self-gates the id range so the evaluator's chain can fall through to the next lookup for out-of-range keys. Stateless and dependency-free — instances are interchangeable.">
|
||||
<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.EvaluationSyntaxs.Evaluation.LocalVariableLookup">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_LocalVariableLookup" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.LocalVariableLookup" class="text-break">
|
||||
Class LocalVariableLookup
|
||||
</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>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.html">EvaluationSyntaxs</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Reads Fanuc-style local macro variables (<code>#1-#33</code>) from
|
||||
<code>Vars.Local</code> on the current <a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a> JSON,
|
||||
walking <a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html#Hi_Common_Collections_LazyLinkedListNode_1_Previous">Previous</a> until the entry
|
||||
is found. Self-gates the id range so the evaluator's
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html#Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax_RuntimeVariableLookups">RuntimeVariableLookups</a> chain can
|
||||
fall through to the next lookup for out-of-range keys.</p>
|
||||
<p>
|
||||
Stateless and dependency-free — instances are interchangeable.
|
||||
</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class LocalVariableLookup : IRuntimeVariableLookup</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">LocalVariableLookup</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IRuntimeVariableLookup.html">IRuntimeVariableLookup</a></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>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="fields">Fields
|
||||
</h2>
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_LocalVariableLookup_LocalMax" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.LocalVariableLookup.LocalMax">
|
||||
LocalMax
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Inclusive upper bound of the macro-local range (<code>#33</code>).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const int LocalMax = 33</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Field Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_LocalVariableLookup_LocalMin" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.LocalVariableLookup.LocalMin">
|
||||
LocalMin
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Inclusive lower bound of the macro-local range (<code>#1</code>).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const int LocalMin = 1</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Field Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_LocalVariableLookup_Get_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.LocalVariableLookup.Get*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_LocalVariableLookup_Get_System_String_Hi_Common_Collections_LazyLinkedListNode_Hi_NcParsers_Syntaxs_SyntaxPiece__System_Collections_Generic_IReadOnlyList_Hi_NcParsers_Dependencys_INcDependency__" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.LocalVariableLookup.Get(System.String,Hi.Common.Collections.LazyLinkedListNode{Hi.NcParsers.Syntaxs.SyntaxPiece},System.Collections.Generic.IReadOnlyList{Hi.NcParsers.Dependencys.INcDependency})">
|
||||
Get(string, LazyLinkedListNode<SyntaxPiece>, IReadOnlyList<INcDependency>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Returns the value of the variable identified by <code class="paramref">key</code>
|
||||
in the context of <code class="paramref">node</code> and
|
||||
<code class="paramref">dependencies</code>, or <code>null</code> if the key is outside
|
||||
this lookup's range or the value is vacant.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public double? Get(string key, LazyLinkedListNode<SyntaxPiece> node, IReadOnlyList<INcDependency> dependencies)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>key</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>node</code> <a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html">LazyLinkedListNode</a><<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>dependencies</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlylist-1">IReadOnlyList</a><<a class="xref" href="Hi.NcParsers.Dependencys.INcDependency.html">INcDependency</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>?</dt>
|
||||
<dd></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>
|
||||
+20
-20
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcBinaryExpr">
|
||||
<article data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcBinaryExpr">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcBinaryExpr" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcBinaryExpr" class="text-break">
|
||||
<h1 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcBinaryExpr" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcBinaryExpr" class="text-break">
|
||||
Class NcBinaryExpr
|
||||
</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>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.html">LogicSyntaxs</a>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcParsers.html">NcParsers</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.html">EvaluationSyntaxs</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -112,7 +112,7 @@ Class NcBinaryExpr
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a></div>
|
||||
<div><span class="xref">NcBinaryExpr</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -120,8 +120,8 @@ Class NcBinaryExpr
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a>></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcBinaryExpr.html">NcBinaryExpr</a>></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a>></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcBinaryExpr.html">NcBinaryExpr</a>></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -183,9 +183,9 @@ Class NcBinaryExpr
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcBinaryExpr__ctor_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcBinaryExpr.#ctor*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcBinaryExpr__ctor_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcBinaryExpr.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcBinaryExpr__ctor_Hi_NcParsers_LogicSyntaxs_Evaluation_NcBinaryOp_Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpr_Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpr_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcBinaryExpr.#ctor(Hi.NcParsers.LogicSyntaxs.Evaluation.NcBinaryOp,Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr,Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr)">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcBinaryExpr__ctor_Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcBinaryOp_Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpr_Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpr_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcBinaryExpr.#ctor(Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcBinaryOp,Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr,Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr)">
|
||||
NcBinaryExpr(NcBinaryOp, NcExpr, NcExpr)
|
||||
|
||||
</h3>
|
||||
@@ -200,11 +200,11 @@ Class NcBinaryExpr
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>Op</code> <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcBinaryOp.html">NcBinaryOp</a></dt>
|
||||
<dt><code>Op</code> <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcBinaryOp.html">NcBinaryOp</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Left</code> <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a></dt>
|
||||
<dt><code>Left</code> <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Right</code> <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a></dt>
|
||||
<dt><code>Right</code> <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
@@ -223,9 +223,9 @@ Class NcBinaryExpr
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcBinaryExpr_Left_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcBinaryExpr.Left*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcBinaryExpr_Left_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcBinaryExpr.Left*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcBinaryExpr_Left" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcBinaryExpr.Left">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcBinaryExpr_Left" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcBinaryExpr.Left">
|
||||
Left
|
||||
|
||||
</h3>
|
||||
@@ -243,7 +243,7 @@ Class NcBinaryExpr
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a></dt>
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
@@ -254,9 +254,9 @@ Class NcBinaryExpr
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcBinaryExpr_Op_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcBinaryExpr.Op*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcBinaryExpr_Op_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcBinaryExpr.Op*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcBinaryExpr_Op" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcBinaryExpr.Op">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcBinaryExpr_Op" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcBinaryExpr.Op">
|
||||
Op
|
||||
|
||||
</h3>
|
||||
@@ -274,7 +274,7 @@ Class NcBinaryExpr
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcBinaryOp.html">NcBinaryOp</a></dt>
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcBinaryOp.html">NcBinaryOp</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
@@ -285,9 +285,9 @@ Class NcBinaryExpr
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcBinaryExpr_Right_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcBinaryExpr.Right*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcBinaryExpr_Right_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcBinaryExpr.Right*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcBinaryExpr_Right" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcBinaryExpr.Right">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcBinaryExpr_Right" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcBinaryExpr.Right">
|
||||
Right
|
||||
|
||||
</h3>
|
||||
@@ -305,7 +305,7 @@ Class NcBinaryExpr
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a></dt>
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
+8
-8
@@ -84,17 +84,17 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcBinaryOp">
|
||||
<article data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcBinaryOp">
|
||||
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcBinaryOp" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcBinaryOp" class="text-break">
|
||||
<h1 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcBinaryOp" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcBinaryOp" class="text-break">
|
||||
Enum NcBinaryOp
|
||||
</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>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.html">LogicSyntaxs</a>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcParsers.html">NcParsers</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.html">EvaluationSyntaxs</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -145,23 +145,23 @@ Enum NcBinaryOp
|
||||
<h2 id="fields">Fields
|
||||
</h2>
|
||||
<dl class="parameters">
|
||||
<dt id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcBinaryOp_Add"><code>Add = 0</code></dt>
|
||||
<dt id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcBinaryOp_Add"><code>Add = 0</code></dt>
|
||||
|
||||
<dd><p><code>a + b</code>.</p>
|
||||
</dd>
|
||||
<dt id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcBinaryOp_Divide"><code>Divide = 3</code></dt>
|
||||
<dt id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcBinaryOp_Divide"><code>Divide = 3</code></dt>
|
||||
|
||||
<dd><p><code>a / b</code>.</p>
|
||||
</dd>
|
||||
<dt id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcBinaryOp_Mod"><code>Mod = 4</code></dt>
|
||||
<dt id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcBinaryOp_Mod"><code>Mod = 4</code></dt>
|
||||
|
||||
<dd><p><code>a MOD b</code> (truncated remainder, sign of <code>a</code>).</p>
|
||||
</dd>
|
||||
<dt id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcBinaryOp_Multiply"><code>Multiply = 2</code></dt>
|
||||
<dt id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcBinaryOp_Multiply"><code>Multiply = 2</code></dt>
|
||||
|
||||
<dd><p><code>a * b</code>.</p>
|
||||
</dd>
|
||||
<dt id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcBinaryOp_Subtract"><code>Subtract = 1</code></dt>
|
||||
<dt id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcBinaryOp_Subtract"><code>Subtract = 1</code></dt>
|
||||
|
||||
<dd><p><code>a - b</code>.</p>
|
||||
</dd>
|
||||
+12
-12
@@ -84,22 +84,22 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr">
|
||||
<article data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpr" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr" class="text-break">
|
||||
<h1 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpr" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr" class="text-break">
|
||||
Class NcExpr
|
||||
</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>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.html">LogicSyntaxs</a>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcParsers.html">NcParsers</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.html">EvaluationSyntaxs</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>AST root for a Fanuc Custom Macro B value expression. Concrete leaves
|
||||
and combinators sit alongside <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionParser.html">NcExpressionParser</a>; walking
|
||||
is the job of <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionEvaluator.html">NcExpressionEvaluator</a>.</p>
|
||||
and combinators sit alongside <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionParser.html">NcExpressionParser</a>; walking
|
||||
is the job of <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionEvaluator.html">NcExpressionEvaluator</a>.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
@@ -121,19 +121,19 @@ is the job of <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpre
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a>></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a>></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist derived">
|
||||
<dt>Derived</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcBinaryExpr.html">NcBinaryExpr</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcFunctionExpr.html">NcFunctionExpr</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcIndirectVariableExpr.html">NcIndirectVariableExpr</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcLiteralExpr.html">NcLiteralExpr</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcUnaryExpr.html">NcUnaryExpr</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcVariableExpr.html">NcVariableExpr</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcBinaryExpr.html">NcBinaryExpr</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcFunctionExpr.html">NcFunctionExpr</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcIndirectVariableExpr.html">NcIndirectVariableExpr</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcLiteralExpr.html">NcLiteralExpr</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcUnaryExpr.html">NcUnaryExpr</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcVariableExpr.html">NcVariableExpr</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+18
-18
@@ -84,30 +84,30 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionEvaluator">
|
||||
<article data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionEvaluator">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpressionEvaluator" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionEvaluator" class="text-break">
|
||||
<h1 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpressionEvaluator" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionEvaluator" class="text-break">
|
||||
Class NcExpressionEvaluator
|
||||
</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>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.html">LogicSyntaxs</a>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcParsers.html">NcParsers</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.html">EvaluationSyntaxs</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Walks an <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a> AST and produces an <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult.html">EvalResult</a>.
|
||||
Resolves <code>#nnn</code> via an <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a>; built-in function
|
||||
<div class="markdown summary"><p>Walks an <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a> AST and produces an <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult.html">EvalResult</a>.
|
||||
Resolves <code>#nnn</code> via an <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a>; built-in function
|
||||
names are matched case-insensitively against a fixed table.</p>
|
||||
<p>
|
||||
Phase-1 supports: <code>SIN COS TAN ASIN ACOS ATAN SQRT ABS ROUND FIX FUP LN
|
||||
EXP POW</code>. Trigonometric arguments and results are in degrees, matching
|
||||
Fanuc Custom Macro B convention. Unknown function names surface as
|
||||
<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionEvaluator.html#Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpressionEvaluator_UnsupportedFunctionCode">UnsupportedFunctionCode</a>; arity mismatches as
|
||||
<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionEvaluator.html#Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpressionEvaluator_ArgumentMismatchCode">ArgumentMismatchCode</a>; division / MOD by zero and domain
|
||||
errors (e.g. <code>SQRT[-1]</code>) as <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionEvaluator.html#Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpressionEvaluator_MathErrorCode">MathErrorCode</a>; vacant
|
||||
operands as <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionEvaluator.html#Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpressionEvaluator_VacantErrorCode">VacantErrorCode</a>.
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionEvaluator.html#Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpressionEvaluator_UnsupportedFunctionCode">UnsupportedFunctionCode</a>; arity mismatches as
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionEvaluator.html#Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpressionEvaluator_ArgumentMismatchCode">ArgumentMismatchCode</a>; division / MOD by zero and domain
|
||||
errors (e.g. <code>SQRT[-1]</code>) as <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionEvaluator.html#Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpressionEvaluator_MathErrorCode">MathErrorCode</a>; vacant
|
||||
operands as <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionEvaluator.html#Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpressionEvaluator_VacantErrorCode">VacantErrorCode</a>.
|
||||
</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
@@ -187,7 +187,7 @@ operands as <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpress
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpressionEvaluator_ArgumentMismatchCode" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionEvaluator.ArgumentMismatchCode">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpressionEvaluator_ArgumentMismatchCode" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionEvaluator.ArgumentMismatchCode">
|
||||
ArgumentMismatchCode
|
||||
|
||||
</h3>
|
||||
@@ -218,7 +218,7 @@ operands as <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpress
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpressionEvaluator_MathErrorCode" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionEvaluator.MathErrorCode">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpressionEvaluator_MathErrorCode" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionEvaluator.MathErrorCode">
|
||||
MathErrorCode
|
||||
|
||||
</h3>
|
||||
@@ -249,7 +249,7 @@ operands as <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpress
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpressionEvaluator_UnsupportedFunctionCode" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionEvaluator.UnsupportedFunctionCode">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpressionEvaluator_UnsupportedFunctionCode" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionEvaluator.UnsupportedFunctionCode">
|
||||
UnsupportedFunctionCode
|
||||
|
||||
</h3>
|
||||
@@ -280,7 +280,7 @@ operands as <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpress
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpressionEvaluator_VacantErrorCode" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionEvaluator.VacantErrorCode">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpressionEvaluator_VacantErrorCode" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionEvaluator.VacantErrorCode">
|
||||
VacantErrorCode
|
||||
|
||||
</h3>
|
||||
@@ -314,9 +314,9 @@ operands as <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpress
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpressionEvaluator_Evaluate_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionEvaluator.Evaluate*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpressionEvaluator_Evaluate_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionEvaluator.Evaluate*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpressionEvaluator_Evaluate_Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpr_Hi_NcParsers_LogicSyntaxs_Evaluation_IVariableLookup_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionEvaluator.Evaluate(Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr,Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup)">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpressionEvaluator_Evaluate_Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpr_Hi_NcParsers_EvaluationSyntaxs_Evaluation_IVariableLookup_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionEvaluator.Evaluate(Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr,Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup)">
|
||||
Evaluate(NcExpr, IVariableLookup)
|
||||
|
||||
</h3>
|
||||
@@ -331,15 +331,15 @@ operands as <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpress
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>expr</code> <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a></dt>
|
||||
<dt><code>expr</code> <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>variables</code> <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a></dt>
|
||||
<dt><code>variables</code> <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult.html">EvalResult</a></dt>
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult.html">EvalResult</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
+7
-7
@@ -84,21 +84,21 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionParser">
|
||||
<article data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionParser">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpressionParser" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionParser" class="text-break">
|
||||
<h1 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpressionParser" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionParser" class="text-break">
|
||||
Class NcExpressionParser
|
||||
</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>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.html">LogicSyntaxs</a>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcParsers.html">NcParsers</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.html">EvaluationSyntaxs</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Recursive-descent parser for Fanuc Custom Macro B value expressions.
|
||||
Pure: takes a string, produces an <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a> AST. Performs no
|
||||
Pure: takes a string, produces an <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a> AST. Performs no
|
||||
variable lookup and no evaluation.</p>
|
||||
<p>Grammar (highest precedence last):</p>
|
||||
<pre><code class="lang-csharp">expr := term (('+' | '-') term)*
|
||||
@@ -194,9 +194,9 @@ rejects with an arity error.
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpressionParser_TryParse_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionParser.TryParse*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpressionParser_TryParse_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionParser.TryParse*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpressionParser_TryParse_System_String_Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpr__System_String__" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionParser.TryParse(System.String,Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr@,System.String@)">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpressionParser_TryParse_System_String_Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpr__System_String__" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionParser.TryParse(System.String,Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr@,System.String@)">
|
||||
TryParse(string, out NcExpr, out string)
|
||||
|
||||
</h3>
|
||||
@@ -216,7 +216,7 @@ describes the syntax problem.</p>
|
||||
<dl class="parameters">
|
||||
<dt><code>source</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>expr</code> <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a></dt>
|
||||
<dt><code>expr</code> <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>error</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
+14
-14
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcFunctionExpr">
|
||||
<article data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcFunctionExpr">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcFunctionExpr" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcFunctionExpr" class="text-break">
|
||||
<h1 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcFunctionExpr" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcFunctionExpr" class="text-break">
|
||||
Class NcFunctionExpr
|
||||
</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>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.html">LogicSyntaxs</a>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcParsers.html">NcParsers</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.html">EvaluationSyntaxs</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -112,7 +112,7 @@ Class NcFunctionExpr
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a></div>
|
||||
<div><span class="xref">NcFunctionExpr</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -120,8 +120,8 @@ Class NcFunctionExpr
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a>></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcFunctionExpr.html">NcFunctionExpr</a>></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a>></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcFunctionExpr.html">NcFunctionExpr</a>></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -183,9 +183,9 @@ Class NcFunctionExpr
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcFunctionExpr__ctor_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcFunctionExpr.#ctor*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcFunctionExpr__ctor_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcFunctionExpr.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcFunctionExpr__ctor_System_String_System_Collections_Generic_IReadOnlyList_Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpr__" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcFunctionExpr.#ctor(System.String,System.Collections.Generic.IReadOnlyList{Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr})">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcFunctionExpr__ctor_System_String_System_Collections_Generic_IReadOnlyList_Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpr__" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcFunctionExpr.#ctor(System.String,System.Collections.Generic.IReadOnlyList{Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr})">
|
||||
NcFunctionExpr(string, IReadOnlyList<NcExpr>)
|
||||
|
||||
</h3>
|
||||
@@ -202,7 +202,7 @@ Class NcFunctionExpr
|
||||
<dl class="parameters">
|
||||
<dt><code>Name</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Args</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlylist-1">IReadOnlyList</a><<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a>></dt>
|
||||
<dt><code>Args</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlylist-1">IReadOnlyList</a><<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
@@ -221,9 +221,9 @@ Class NcFunctionExpr
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcFunctionExpr_Args_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcFunctionExpr.Args*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcFunctionExpr_Args_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcFunctionExpr.Args*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcFunctionExpr_Args" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcFunctionExpr.Args">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcFunctionExpr_Args" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcFunctionExpr.Args">
|
||||
Args
|
||||
|
||||
</h3>
|
||||
@@ -241,7 +241,7 @@ Class NcFunctionExpr
|
||||
|
||||
<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="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a>></dt>
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlylist-1">IReadOnlyList</a><<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
@@ -252,9 +252,9 @@ Class NcFunctionExpr
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcFunctionExpr_Name_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcFunctionExpr.Name*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcFunctionExpr_Name_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcFunctionExpr.Name*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcFunctionExpr_Name" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcFunctionExpr.Name">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcFunctionExpr_Name" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcFunctionExpr.Name">
|
||||
Name
|
||||
|
||||
</h3>
|
||||
+16
-16
@@ -84,22 +84,22 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcIndirectVariableExpr">
|
||||
<article data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcIndirectVariableExpr">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcIndirectVariableExpr" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcIndirectVariableExpr" class="text-break">
|
||||
<h1 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcIndirectVariableExpr" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcIndirectVariableExpr" class="text-break">
|
||||
Class NcIndirectVariableExpr
|
||||
</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>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.html">LogicSyntaxs</a>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcParsers.html">NcParsers</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.html">EvaluationSyntaxs</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Indirect variable reference <code>#[expr]</code>. The inner expression is
|
||||
evaluated and truncated toward zero to obtain an integer; the lookup key
|
||||
is then <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcIndirectVariableExpr.html#Hi_NcParsers_LogicSyntaxs_Evaluation_NcIndirectVariableExpr_Prefix">Prefix</a> concatenated with that integer
|
||||
is then <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcIndirectVariableExpr.html#Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcIndirectVariableExpr_Prefix">Prefix</a> concatenated with that integer
|
||||
(e.g. <code>Prefix="#"</code>, computed <code>124</code> → <code>"#124"</code>).</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
@@ -115,7 +115,7 @@ is then <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcIndirectVar
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a></div>
|
||||
<div><span class="xref">NcIndirectVariableExpr</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -123,8 +123,8 @@ is then <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcIndirectVar
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a>></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcIndirectVariableExpr.html">NcIndirectVariableExpr</a>></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a>></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcIndirectVariableExpr.html">NcIndirectVariableExpr</a>></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -186,16 +186,16 @@ is then <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcIndirectVar
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcIndirectVariableExpr__ctor_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcIndirectVariableExpr.#ctor*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcIndirectVariableExpr__ctor_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcIndirectVariableExpr.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcIndirectVariableExpr__ctor_System_String_Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpr_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcIndirectVariableExpr.#ctor(System.String,Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr)">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcIndirectVariableExpr__ctor_System_String_Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpr_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcIndirectVariableExpr.#ctor(System.String,Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr)">
|
||||
NcIndirectVariableExpr(string, NcExpr)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Indirect variable reference <code>#[expr]</code>. The inner expression is
|
||||
evaluated and truncated toward zero to obtain an integer; the lookup key
|
||||
is then <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcIndirectVariableExpr.html#Hi_NcParsers_LogicSyntaxs_Evaluation_NcIndirectVariableExpr_Prefix">Prefix</a> concatenated with that integer
|
||||
is then <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcIndirectVariableExpr.html#Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcIndirectVariableExpr_Prefix">Prefix</a> concatenated with that integer
|
||||
(e.g. <code>Prefix="#"</code>, computed <code>124</code> → <code>"#124"</code>).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
@@ -208,7 +208,7 @@ is then <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcIndirectVar
|
||||
<dl class="parameters">
|
||||
<dt><code>Prefix</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Index</code> <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a></dt>
|
||||
<dt><code>Index</code> <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
@@ -227,9 +227,9 @@ is then <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcIndirectVar
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcIndirectVariableExpr_Index_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcIndirectVariableExpr.Index*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcIndirectVariableExpr_Index_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcIndirectVariableExpr.Index*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcIndirectVariableExpr_Index" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcIndirectVariableExpr.Index">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcIndirectVariableExpr_Index" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcIndirectVariableExpr.Index">
|
||||
Index
|
||||
|
||||
</h3>
|
||||
@@ -247,7 +247,7 @@ is then <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcIndirectVar
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a></dt>
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
@@ -258,9 +258,9 @@ is then <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcIndirectVar
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcIndirectVariableExpr_Prefix_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcIndirectVariableExpr.Prefix*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcIndirectVariableExpr_Prefix_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcIndirectVariableExpr.Prefix*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcIndirectVariableExpr_Prefix" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcIndirectVariableExpr.Prefix">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcIndirectVariableExpr_Prefix" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcIndirectVariableExpr.Prefix">
|
||||
Prefix
|
||||
|
||||
</h3>
|
||||
+10
-10
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcLiteralExpr">
|
||||
<article data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcLiteralExpr">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcLiteralExpr" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcLiteralExpr" class="text-break">
|
||||
<h1 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcLiteralExpr" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcLiteralExpr" class="text-break">
|
||||
Class NcLiteralExpr
|
||||
</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>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.html">LogicSyntaxs</a>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcParsers.html">NcParsers</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.html">EvaluationSyntaxs</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -112,7 +112,7 @@ Class NcLiteralExpr
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a></div>
|
||||
<div><span class="xref">NcLiteralExpr</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -120,8 +120,8 @@ Class NcLiteralExpr
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a>></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcLiteralExpr.html">NcLiteralExpr</a>></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a>></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcLiteralExpr.html">NcLiteralExpr</a>></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -183,9 +183,9 @@ Class NcLiteralExpr
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcLiteralExpr__ctor_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcLiteralExpr.#ctor*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcLiteralExpr__ctor_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcLiteralExpr.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcLiteralExpr__ctor_System_Double_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcLiteralExpr.#ctor(System.Double)">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcLiteralExpr__ctor_System_Double_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcLiteralExpr.#ctor(System.Double)">
|
||||
NcLiteralExpr(double)
|
||||
|
||||
</h3>
|
||||
@@ -219,9 +219,9 @@ Class NcLiteralExpr
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcLiteralExpr_Value_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcLiteralExpr.Value*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcLiteralExpr_Value_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcLiteralExpr.Value*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcLiteralExpr_Value" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcLiteralExpr.Value">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcLiteralExpr_Value" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcLiteralExpr.Value">
|
||||
Value
|
||||
|
||||
</h3>
|
||||
+16
-16
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcUnaryExpr">
|
||||
<article data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcUnaryExpr">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcUnaryExpr" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcUnaryExpr" class="text-break">
|
||||
<h1 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcUnaryExpr" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcUnaryExpr" class="text-break">
|
||||
Class NcUnaryExpr
|
||||
</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>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.html">LogicSyntaxs</a>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcParsers.html">NcParsers</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.html">EvaluationSyntaxs</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -112,7 +112,7 @@ Class NcUnaryExpr
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a></div>
|
||||
<div><span class="xref">NcUnaryExpr</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -120,8 +120,8 @@ Class NcUnaryExpr
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a>></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcUnaryExpr.html">NcUnaryExpr</a>></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a>></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcUnaryExpr.html">NcUnaryExpr</a>></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -183,9 +183,9 @@ Class NcUnaryExpr
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcUnaryExpr__ctor_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcUnaryExpr.#ctor*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcUnaryExpr__ctor_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcUnaryExpr.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcUnaryExpr__ctor_Hi_NcParsers_LogicSyntaxs_Evaluation_NcUnaryOp_Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpr_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcUnaryExpr.#ctor(Hi.NcParsers.LogicSyntaxs.Evaluation.NcUnaryOp,Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr)">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcUnaryExpr__ctor_Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcUnaryOp_Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpr_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcUnaryExpr.#ctor(Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcUnaryOp,Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr)">
|
||||
NcUnaryExpr(NcUnaryOp, NcExpr)
|
||||
|
||||
</h3>
|
||||
@@ -200,9 +200,9 @@ Class NcUnaryExpr
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>Op</code> <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcUnaryOp.html">NcUnaryOp</a></dt>
|
||||
<dt><code>Op</code> <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcUnaryOp.html">NcUnaryOp</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Operand</code> <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a></dt>
|
||||
<dt><code>Operand</code> <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
@@ -221,9 +221,9 @@ Class NcUnaryExpr
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcUnaryExpr_Op_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcUnaryExpr.Op*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcUnaryExpr_Op_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcUnaryExpr.Op*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcUnaryExpr_Op" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcUnaryExpr.Op">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcUnaryExpr_Op" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcUnaryExpr.Op">
|
||||
Op
|
||||
|
||||
</h3>
|
||||
@@ -241,7 +241,7 @@ Class NcUnaryExpr
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcUnaryOp.html">NcUnaryOp</a></dt>
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcUnaryOp.html">NcUnaryOp</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
@@ -252,9 +252,9 @@ Class NcUnaryExpr
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcUnaryExpr_Operand_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcUnaryExpr.Operand*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcUnaryExpr_Operand_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcUnaryExpr.Operand*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcUnaryExpr_Operand" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcUnaryExpr.Operand">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcUnaryExpr_Operand" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcUnaryExpr.Operand">
|
||||
Operand
|
||||
|
||||
</h3>
|
||||
@@ -272,7 +272,7 @@ Class NcUnaryExpr
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a></dt>
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
+5
-5
@@ -84,17 +84,17 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcUnaryOp">
|
||||
<article data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcUnaryOp">
|
||||
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcUnaryOp" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcUnaryOp" class="text-break">
|
||||
<h1 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcUnaryOp" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcUnaryOp" class="text-break">
|
||||
Enum NcUnaryOp
|
||||
</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>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.html">LogicSyntaxs</a>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcParsers.html">NcParsers</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.html">EvaluationSyntaxs</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -145,11 +145,11 @@ Enum NcUnaryOp
|
||||
<h2 id="fields">Fields
|
||||
</h2>
|
||||
<dl class="parameters">
|
||||
<dt id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcUnaryOp_Minus"><code>Minus = 1</code></dt>
|
||||
<dt id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcUnaryOp_Minus"><code>Minus = 1</code></dt>
|
||||
|
||||
<dd><p>Negation: <code>-expr</code>.</p>
|
||||
</dd>
|
||||
<dt id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcUnaryOp_Plus"><code>Plus = 0</code></dt>
|
||||
<dt id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcUnaryOp_Plus"><code>Plus = 0</code></dt>
|
||||
|
||||
<dd><p>Identity: <code>+expr</code>.</p>
|
||||
</dd>
|
||||
+14
-14
@@ -84,21 +84,21 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcVariableExpr">
|
||||
<article data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcVariableExpr">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcVariableExpr" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcVariableExpr" class="text-break">
|
||||
<h1 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcVariableExpr" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcVariableExpr" class="text-break">
|
||||
Class NcVariableExpr
|
||||
</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>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.html">LogicSyntaxs</a>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcParsers.html">NcParsers</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.html">EvaluationSyntaxs</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Direct variable reference; <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcVariableExpr.html#Hi_NcParsers_LogicSyntaxs_Evaluation_NcVariableExpr_Key">Key</a> is the raw source token
|
||||
(e.g. <code>"#124"</code>) passed verbatim to <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup.html#Hi_NcParsers_LogicSyntaxs_Evaluation_IVariableLookup_Get_System_String_">Get(string)</a>.</p>
|
||||
<div class="markdown summary"><p>Direct variable reference; <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcVariableExpr.html#Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcVariableExpr_Key">Key</a> is the raw source token
|
||||
(e.g. <code>"#124"</code>) passed verbatim to <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup.html#Hi_NcParsers_EvaluationSyntaxs_Evaluation_IVariableLookup_Get_System_String_">Get(string)</a>.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
@@ -113,7 +113,7 @@ Class NcVariableExpr
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a></div>
|
||||
<div><span class="xref">NcVariableExpr</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -121,8 +121,8 @@ Class NcVariableExpr
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a>></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcVariableExpr.html">NcVariableExpr</a>></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a>></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcVariableExpr.html">NcVariableExpr</a>></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -184,15 +184,15 @@ Class NcVariableExpr
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcVariableExpr__ctor_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcVariableExpr.#ctor*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcVariableExpr__ctor_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcVariableExpr.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcVariableExpr__ctor_System_String_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcVariableExpr.#ctor(System.String)">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcVariableExpr__ctor_System_String_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcVariableExpr.#ctor(System.String)">
|
||||
NcVariableExpr(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Direct variable reference; <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcVariableExpr.html#Hi_NcParsers_LogicSyntaxs_Evaluation_NcVariableExpr_Key">Key</a> is the raw source token
|
||||
(e.g. <code>"#124"</code>) passed verbatim to <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup.html#Hi_NcParsers_LogicSyntaxs_Evaluation_IVariableLookup_Get_System_String_">Get(string)</a>.</p>
|
||||
<div class="markdown level1 summary"><p>Direct variable reference; <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcVariableExpr.html#Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcVariableExpr_Key">Key</a> is the raw source token
|
||||
(e.g. <code>"#124"</code>) passed verbatim to <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup.html#Hi_NcParsers_EvaluationSyntaxs_Evaluation_IVariableLookup_Get_System_String_">Get(string)</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -221,9 +221,9 @@ Class NcVariableExpr
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcVariableExpr_Key_" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcVariableExpr.Key*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcVariableExpr_Key_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcVariableExpr.Key*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_Evaluation_NcVariableExpr_Key" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation.NcVariableExpr.Key">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcVariableExpr_Key" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcVariableExpr.Key">
|
||||
Key
|
||||
|
||||
</h3>
|
||||
+266
@@ -0,0 +1,266 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class VolatileVariableLookup | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class VolatileVariableLookup | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Reads Fanuc-style non-retained common variables (#100-#499) from Vars.Volatile on the current JSON, walking until the entry is found. Self-gates the id range so the evaluator's chain can fall through to the next lookup for out-of-range keys. Stateless and dependency-free — instances are interchangeable. Reads use the same dict-merge carry that writes; the two stay decoupled (read side here; write side in the reader).">
|
||||
<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.EvaluationSyntaxs.Evaluation.VolatileVariableLookup">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_VolatileVariableLookup" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.VolatileVariableLookup" class="text-break">
|
||||
Class VolatileVariableLookup
|
||||
</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>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.html">EvaluationSyntaxs</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.html">Evaluation</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Reads Fanuc-style non-retained common variables (<code>#100-#499</code>)
|
||||
from <code>Vars.Volatile</code> on the current <a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a>
|
||||
JSON, walking <a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html#Hi_Common_Collections_LazyLinkedListNode_1_Previous">Previous</a> until the
|
||||
entry is found. Self-gates the id range so the evaluator's
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html#Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax_RuntimeVariableLookups">RuntimeVariableLookups</a> chain can
|
||||
fall through to the next lookup for out-of-range keys.</p>
|
||||
<p>
|
||||
Stateless and dependency-free — instances are interchangeable.
|
||||
Reads use the same dict-merge carry that
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.html">VolatileVariableReadingSyntax</a> writes; the two stay
|
||||
decoupled (read side here; write side in the reader).
|
||||
</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class VolatileVariableLookup : IRuntimeVariableLookup</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">VolatileVariableLookup</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IRuntimeVariableLookup.html">IRuntimeVariableLookup</a></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>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_VolatileVariableLookup_Get_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.VolatileVariableLookup.Get*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_VolatileVariableLookup_Get_System_String_Hi_Common_Collections_LazyLinkedListNode_Hi_NcParsers_Syntaxs_SyntaxPiece__System_Collections_Generic_IReadOnlyList_Hi_NcParsers_Dependencys_INcDependency__" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.VolatileVariableLookup.Get(System.String,Hi.Common.Collections.LazyLinkedListNode{Hi.NcParsers.Syntaxs.SyntaxPiece},System.Collections.Generic.IReadOnlyList{Hi.NcParsers.Dependencys.INcDependency})">
|
||||
Get(string, LazyLinkedListNode<SyntaxPiece>, IReadOnlyList<INcDependency>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Returns the value of the variable identified by <code class="paramref">key</code>
|
||||
in the context of <code class="paramref">node</code> and
|
||||
<code class="paramref">dependencies</code>, or <code>null</code> if the key is outside
|
||||
this lookup's range or the value is vacant.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public double? Get(string key, LazyLinkedListNode<SyntaxPiece> node, IReadOnlyList<INcDependency> dependencies)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>key</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>node</code> <a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html">LazyLinkedListNode</a><<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>dependencies</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlylist-1">IReadOnlyList</a><<a class="xref" href="Hi.NcParsers.Dependencys.INcDependency.html">INcDependency</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>?</dt>
|
||||
<dd></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>
|
||||
+63
-34
@@ -2,9 +2,9 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Namespace Hi.NcParsers.LogicSyntaxs.Evaluation | HiAPI-C# 2025 </title>
|
||||
<title>Namespace Hi.NcParsers.EvaluationSyntaxs.Evaluation | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Namespace Hi.NcParsers.LogicSyntaxs.Evaluation | HiAPI-C# 2025 ">
|
||||
<meta name="title" content="Namespace Hi.NcParsers.EvaluationSyntaxs.Evaluation | HiAPI-C# 2025 ">
|
||||
|
||||
|
||||
<link rel="icon" href="../img/HiAPI.favicon.ico">
|
||||
@@ -84,9 +84,9 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation">
|
||||
<article data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation">
|
||||
|
||||
<h1 id="Hi_NcParsers_LogicSyntaxs_Evaluation" data-uid="Hi.NcParsers.LogicSyntaxs.Evaluation" class="text-break">Namespace Hi.NcParsers.LogicSyntaxs.Evaluation</h1>
|
||||
<h1 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation" class="text-break">Namespace Hi.NcParsers.EvaluationSyntaxs.Evaluation</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="markdown level0 remarks"></div>
|
||||
@@ -95,37 +95,50 @@
|
||||
Classes
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcBinaryExpr.html">NcBinaryExpr</a></dt>
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.LocalVariableLookup.html">LocalVariableLookup</a></dt>
|
||||
<dd><p>Reads Fanuc-style local macro variables (<code>#1-#33</code>) from
|
||||
<code>Vars.Local</code> on the current <a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a> JSON,
|
||||
walking <a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html#Hi_Common_Collections_LazyLinkedListNode_1_Previous">Previous</a> until the entry
|
||||
is found. Self-gates the id range so the evaluator's
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html#Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax_RuntimeVariableLookups">RuntimeVariableLookups</a> chain can
|
||||
fall through to the next lookup for out-of-range keys.</p>
|
||||
<p>
|
||||
Stateless and dependency-free — instances are interchangeable.
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcBinaryExpr.html">NcBinaryExpr</a></dt>
|
||||
<dd><p>Binary arithmetic on two operands (<code>+ - * /</code> or <code>MOD</code>).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a></dt>
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a></dt>
|
||||
<dd><p>AST root for a Fanuc Custom Macro B value expression. Concrete leaves
|
||||
and combinators sit alongside <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionParser.html">NcExpressionParser</a>; walking
|
||||
is the job of <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionEvaluator.html">NcExpressionEvaluator</a>.</p>
|
||||
and combinators sit alongside <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionParser.html">NcExpressionParser</a>; walking
|
||||
is the job of <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionEvaluator.html">NcExpressionEvaluator</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionEvaluator.html">NcExpressionEvaluator</a></dt>
|
||||
<dd><p>Walks an <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a> AST and produces an <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult.html">EvalResult</a>.
|
||||
Resolves <code>#nnn</code> via an <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a>; built-in function
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionEvaluator.html">NcExpressionEvaluator</a></dt>
|
||||
<dd><p>Walks an <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a> AST and produces an <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult.html">EvalResult</a>.
|
||||
Resolves <code>#nnn</code> via an <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a>; built-in function
|
||||
names are matched case-insensitively against a fixed table.</p>
|
||||
<p>
|
||||
Phase-1 supports: <code>SIN COS TAN ASIN ACOS ATAN SQRT ABS ROUND FIX FUP LN
|
||||
EXP POW</code>. Trigonometric arguments and results are in degrees, matching
|
||||
Fanuc Custom Macro B convention. Unknown function names surface as
|
||||
<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionEvaluator.html#Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpressionEvaluator_UnsupportedFunctionCode">UnsupportedFunctionCode</a>; arity mismatches as
|
||||
<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionEvaluator.html#Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpressionEvaluator_ArgumentMismatchCode">ArgumentMismatchCode</a>; division / MOD by zero and domain
|
||||
errors (e.g. <code>SQRT[-1]</code>) as <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionEvaluator.html#Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpressionEvaluator_MathErrorCode">MathErrorCode</a>; vacant
|
||||
operands as <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionEvaluator.html#Hi_NcParsers_LogicSyntaxs_Evaluation_NcExpressionEvaluator_VacantErrorCode">VacantErrorCode</a>.
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionEvaluator.html#Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpressionEvaluator_UnsupportedFunctionCode">UnsupportedFunctionCode</a>; arity mismatches as
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionEvaluator.html#Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpressionEvaluator_ArgumentMismatchCode">ArgumentMismatchCode</a>; division / MOD by zero and domain
|
||||
errors (e.g. <code>SQRT[-1]</code>) as <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionEvaluator.html#Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpressionEvaluator_MathErrorCode">MathErrorCode</a>; vacant
|
||||
operands as <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionEvaluator.html#Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcExpressionEvaluator_VacantErrorCode">VacantErrorCode</a>.
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionParser.html">NcExpressionParser</a></dt>
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionParser.html">NcExpressionParser</a></dt>
|
||||
<dd><p>Recursive-descent parser for Fanuc Custom Macro B value expressions.
|
||||
Pure: takes a string, produces an <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a> AST. Performs no
|
||||
Pure: takes a string, produces an <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a> AST. Performs no
|
||||
variable lookup and no evaluation.</p>
|
||||
<p>Grammar (highest precedence last):</p>
|
||||
<pre><code class="lang-csharp">expr := term (('+' | '-') term)*
|
||||
@@ -147,40 +160,56 @@ rejects with an arity error.
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcFunctionExpr.html">NcFunctionExpr</a></dt>
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcFunctionExpr.html">NcFunctionExpr</a></dt>
|
||||
<dd><p>Built-in function call like <code>SIN[x]</code>, <code>SQRT[x]</code>, <code>ATAN[a]/[b]</code>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcIndirectVariableExpr.html">NcIndirectVariableExpr</a></dt>
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcIndirectVariableExpr.html">NcIndirectVariableExpr</a></dt>
|
||||
<dd><p>Indirect variable reference <code>#[expr]</code>. The inner expression is
|
||||
evaluated and truncated toward zero to obtain an integer; the lookup key
|
||||
is then <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcIndirectVariableExpr.html#Hi_NcParsers_LogicSyntaxs_Evaluation_NcIndirectVariableExpr_Prefix">Prefix</a> concatenated with that integer
|
||||
is then <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcIndirectVariableExpr.html#Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcIndirectVariableExpr_Prefix">Prefix</a> concatenated with that integer
|
||||
(e.g. <code>Prefix="#"</code>, computed <code>124</code> → <code>"#124"</code>).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcLiteralExpr.html">NcLiteralExpr</a></dt>
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcLiteralExpr.html">NcLiteralExpr</a></dt>
|
||||
<dd><p>Numeric literal (e.g. <code>1.5</code>, <code>15.</code>, <code>.5</code>, <code>1e-3</code>).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcUnaryExpr.html">NcUnaryExpr</a></dt>
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcUnaryExpr.html">NcUnaryExpr</a></dt>
|
||||
<dd><p>Unary <code>+</code> or <code>-</code> applied to an operand.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcVariableExpr.html">NcVariableExpr</a></dt>
|
||||
<dd><p>Direct variable reference; <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcVariableExpr.html#Hi_NcParsers_LogicSyntaxs_Evaluation_NcVariableExpr_Key">Key</a> is the raw source token
|
||||
(e.g. <code>"#124"</code>) passed verbatim to <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup.html#Hi_NcParsers_LogicSyntaxs_Evaluation_IVariableLookup_Get_System_String_">Get(string)</a>.</p>
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcVariableExpr.html">NcVariableExpr</a></dt>
|
||||
<dd><p>Direct variable reference; <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcVariableExpr.html#Hi_NcParsers_EvaluationSyntaxs_Evaluation_NcVariableExpr_Key">Key</a> is the raw source token
|
||||
(e.g. <code>"#124"</code>) passed verbatim to <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup.html#Hi_NcParsers_EvaluationSyntaxs_Evaluation_IVariableLookup_Get_System_String_">Get(string)</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.VolatileVariableLookup.html">VolatileVariableLookup</a></dt>
|
||||
<dd><p>Reads Fanuc-style non-retained common variables (<code>#100-#499</code>)
|
||||
from <code>Vars.Volatile</code> on the current <a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a>
|
||||
JSON, walking <a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html#Hi_Common_Collections_LazyLinkedListNode_1_Previous">Previous</a> until the
|
||||
entry is found. Self-gates the id range so the evaluator's
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html#Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax_RuntimeVariableLookups">RuntimeVariableLookups</a> chain can
|
||||
fall through to the next lookup for out-of-range keys.</p>
|
||||
<p>
|
||||
Stateless and dependency-free — instances are interchangeable.
|
||||
Reads use the same dict-merge carry that
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.html">VolatileVariableReadingSyntax</a> writes; the two stay
|
||||
decoupled (read side here; write side in the reader).
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<h3 id="structs">
|
||||
Structs
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult.html">EvalResult</a></dt>
|
||||
<dd><p>Outcome of evaluating an <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html">NcExpr</a>. Either a successful
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult.html">EvalResult</a></dt>
|
||||
<dd><p>Outcome of evaluating an <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html">NcExpr</a>. Either a successful
|
||||
numeric value, or a failure with an error code matching the diagnostic
|
||||
catalogue used by reading / evaluator syntaxes.</p>
|
||||
</dd>
|
||||
@@ -189,19 +218,19 @@ catalogue used by reading / evaluator syntaxes.</p>
|
||||
Interfaces
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IRuntimeVariableLookup.html">IRuntimeVariableLookup</a></dt>
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IRuntimeVariableLookup.html">IRuntimeVariableLookup</a></dt>
|
||||
<dd><p>Stateless variable lookup that needs per-block runtime context — the
|
||||
current <a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a> node (for <a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html#Hi_Common_Collections_LazyLinkedListNode_1_Previous">Previous</a>
|
||||
traceback into runtime-state sections like <code>MachineCoordinateState</code>
|
||||
/ <code>ProgramXyz</code>) and the dependency list (so the lookup can read
|
||||
from sibling dependencies without holding a static reference).</p>
|
||||
<p>
|
||||
Distinguished from <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a>: that one is for
|
||||
Distinguished from <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a>: that one is for
|
||||
long-lived dependencies that already hold their own data (parameter
|
||||
tables, tool-offset wrappers, retained-variable tables) and need no
|
||||
block context. <code>IRuntimeVariableLookup</code> is for context-sensitive
|
||||
resolutions configured declaratively on
|
||||
<a class="xref" href="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.html#Hi_NcParsers_LogicSyntaxs_VariableEvaluatorSyntax_RuntimeVariableLookups">RuntimeVariableLookups</a>.
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html#Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax_RuntimeVariableLookups">RuntimeVariableLookups</a>.
|
||||
</p>
|
||||
<p>
|
||||
Implementations should be brand-specific (e.g. Fanuc <code>#5001-#5043</code>
|
||||
@@ -211,7 +240,7 @@ the evaluator's chain can fall through to the next lookup.
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a></dt>
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a></dt>
|
||||
<dd><p>Resolves a Custom Macro B variable reference to its current numeric value,
|
||||
or <code>null</code> for vacant (Fanuc <code><vacant></code>) and out-of-scope alike.</p>
|
||||
<p>
|
||||
@@ -222,7 +251,7 @@ and parse the prefix locally; chain them at the call site by trying each
|
||||
in priority order until one returns a non-<code>null</code> value.
|
||||
</p>
|
||||
<p>
|
||||
A returned <code>null</code> is treated by <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionEvaluator.html">NcExpressionEvaluator</a>
|
||||
A returned <code>null</code> is treated by <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionEvaluator.html">NcExpressionEvaluator</a>
|
||||
as vacant and surfaces as a <code>Variable--Vacant</code> failure when the
|
||||
value is consumed in arithmetic context.
|
||||
</p>
|
||||
@@ -232,12 +261,12 @@ value is consumed in arithmetic context.
|
||||
Enums
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcBinaryOp.html">NcBinaryOp</a></dt>
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcBinaryOp.html">NcBinaryOp</a></dt>
|
||||
<dd><p>Binary operators allowed in Fanuc Custom Macro B value expressions.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcUnaryOp.html">NcUnaryOp</a></dt>
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcUnaryOp.html">NcUnaryOp</a></dt>
|
||||
<dd><p>Unary operators allowed in Fanuc Custom Macro B value expressions.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
+569
@@ -0,0 +1,569 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class FanucSystemControlVariableSyntax | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class FanucSystemControlVariableSyntax | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Consumes Fanuc-style system-control variable assignments (#3000-#3999) — alarm trigger (#3000), millisecond and hour clocks (#3001 / #3002), single-block / feed-hold bypass flags (#3003 / #3004), pause-with-message (#3006), mirror-image flags (#3007), date / time (#3011 / #3012), tool-life data (#3030 / #3032), etc. Every id in this range is a controller-side state variable — its authoritative value lives on the real hardware (RTC, alarm bus, override switches, …) and an NC write at most triggers a side effect (clock reset, alarm raise, message-pause prompt). Offline simulation has none of that machinery, so this syntax does not emulate the effect. Instead it: records the literal write on the block JSON under Vars.SystemControl (round-trip and cache-dump visibility);emits a FanucSystemControl--Unsupported so the user knows the assignment was recognised but its controller-side effect is not simulated. Message-severity (not Warning) because these writes are safe no-ops offline — every consumed assignment would emit a Warning per block, which would be noisy without signalling anything the user must act on;removes the entry from Parsing.Assignments so it does not re-surface as a generic Parsing--Unconsumed diagnostic. The dictionary carries forward block-by-block (same dict-merge pattern as ) so a downstream consumer can read the most recent recorded value via SyntaxPiece linkage. Only literal numeric RHS values are consumed; non-literal RHS (e.g. #3002 = #500) is left in Parsing.Assignments for to resolve, mirroring the retained / volatile reading syntaxes. Fanuc-family only — Siemens uses named system variables ($AC_TIME, $A_DAY, …) and Heidenhain uses FN18: SYSREAD; neither flows through Parsing.Assignments.#nnn.">
|
||||
<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.EvaluationSyntaxs.FanucSystemControlVariableSyntax">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_EvaluationSyntaxs_FanucSystemControlVariableSyntax" data-uid="Hi.NcParsers.EvaluationSyntaxs.FanucSystemControlVariableSyntax" class="text-break">
|
||||
Class FanucSystemControlVariableSyntax
|
||||
</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>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.html">EvaluationSyntaxs</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Consumes Fanuc-style system-control variable assignments
|
||||
(<code>#3000-#3999</code>) — alarm trigger (<code>#3000</code>), millisecond and
|
||||
hour clocks (<code>#3001</code> / <code>#3002</code>), single-block / feed-hold
|
||||
bypass flags (<code>#3003</code> / <code>#3004</code>), pause-with-message
|
||||
(<code>#3006</code>), mirror-image flags (<code>#3007</code>), date / time
|
||||
(<code>#3011</code> / <code>#3012</code>), tool-life data (<code>#3030</code> /
|
||||
<code>#3032</code>), etc.</p>
|
||||
<p>
|
||||
Every id in this range is a controller-side state variable — its
|
||||
authoritative value lives on the real hardware (RTC, alarm bus,
|
||||
override switches, …) and an NC write at most triggers a side effect
|
||||
(clock reset, alarm raise, message-pause prompt). Offline simulation
|
||||
has none of that machinery, so this syntax does <b>not</b> emulate the
|
||||
effect. Instead it:
|
||||
</p>
|
||||
<ol><li>records the literal write on the block JSON under
|
||||
<code>Vars.SystemControl</code> (round-trip and cache-dump visibility);</li><li>emits a <code>FanucSystemControl--Unsupported</code>
|
||||
<a class="xref" href="Hi.NcParsers.NcDiagnosticProgress.html#Hi_NcParsers_NcDiagnosticProgress_UnsupportedMessage_Hi_NcParsers_Sentence_System_String_System_String_System_Object_">UnsupportedMessage(Sentence, string, string, object)</a>
|
||||
so the user knows the assignment was recognised but its controller-side
|
||||
effect is not simulated. Message-severity (not Warning) because these
|
||||
writes are safe no-ops offline — every consumed assignment would emit
|
||||
a Warning per block, which would be noisy without signalling anything
|
||||
the user must act on;</li><li>removes the entry from <code>Parsing.Assignments</code> so it does not
|
||||
re-surface as a generic <code>Parsing--Unconsumed</code> diagnostic.</li></ol>
|
||||
<p>
|
||||
The dictionary carries forward block-by-block (same dict-merge pattern
|
||||
as <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.html">VolatileVariableReadingSyntax</a>) so a downstream consumer
|
||||
can read the most recent recorded value via <code>SyntaxPiece</code> linkage.
|
||||
</p>
|
||||
<p>
|
||||
Only literal numeric RHS values are consumed; non-literal RHS
|
||||
(e.g. <code>#3002 = #500</code>) is left in <code>Parsing.Assignments</code> for
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax</a> to resolve, mirroring the
|
||||
retained / volatile reading syntaxes.
|
||||
</p>
|
||||
<p>
|
||||
Fanuc-family only — Siemens uses named system variables
|
||||
(<code>$AC_TIME</code>, <code>$A_DAY</code>, …) and Heidenhain uses
|
||||
<code>FN18: SYSREAD</code>; neither flows through <code>Parsing.Assignments.#nnn</code>.
|
||||
</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class FanucSystemControlVariableSyntax : ISituNcSyntax, INcSyntax, IMakeXmlSource</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">FanucSystemControlVariableSyntax</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.NcParsers.Syntaxs.ISituNcSyntax.html">ISituNcSyntax</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.Syntaxs.INcSyntax.html">INcSyntax</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></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>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_FanucSystemControlVariableSyntax__ctor_" data-uid="Hi.NcParsers.EvaluationSyntaxs.FanucSystemControlVariableSyntax.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_FanucSystemControlVariableSyntax__ctor" data-uid="Hi.NcParsers.EvaluationSyntaxs.FanucSystemControlVariableSyntax.#ctor">
|
||||
FanucSystemControlVariableSyntax()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Default constructor.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FanucSystemControlVariableSyntax()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_FanucSystemControlVariableSyntax__ctor_" data-uid="Hi.NcParsers.EvaluationSyntaxs.FanucSystemControlVariableSyntax.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_FanucSystemControlVariableSyntax__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.EvaluationSyntaxs.FanucSystemControlVariableSyntax.#ctor(System.Xml.Linq.XElement)">
|
||||
FanucSystemControlVariableSyntax(XElement)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Loads from an XML element produced by <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.FanucSystemControlVariableSyntax.html#Hi_NcParsers_EvaluationSyntaxs_FanucSystemControlVariableSyntax_MakeXmlSource_System_String_System_String_System_Boolean_">MakeXmlSource(string, string, bool)</a>. No state to deserialise.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FanucSystemControlVariableSyntax(XElement src)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="fields">Fields
|
||||
</h2>
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_FanucSystemControlVariableSyntax_SystemControlMax" data-uid="Hi.NcParsers.EvaluationSyntaxs.FanucSystemControlVariableSyntax.SystemControlMax">
|
||||
SystemControlMax
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Inclusive upper bound of the system-control range (<code>#3999</code>).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const int SystemControlMax = 3999</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Field Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_FanucSystemControlVariableSyntax_SystemControlMin" data-uid="Hi.NcParsers.EvaluationSyntaxs.FanucSystemControlVariableSyntax.SystemControlMin">
|
||||
SystemControlMin
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Inclusive lower bound of the system-control range (<code>#3000</code>).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const int SystemControlMin = 3000</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Field Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_FanucSystemControlVariableSyntax_UnsupportedDiagId" data-uid="Hi.NcParsers.EvaluationSyntaxs.FanucSystemControlVariableSyntax.UnsupportedDiagId">
|
||||
UnsupportedDiagId
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Diagnostic id emitted for every consumed <code>#3000-#3999</code>
|
||||
assignment — recognised by the parser, ignored by simulation.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const string UnsupportedDiagId = "FanucSystemControl--Unsupported"</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_EvaluationSyntaxs_FanucSystemControlVariableSyntax_Name_" data-uid="Hi.NcParsers.EvaluationSyntaxs.FanucSystemControlVariableSyntax.Name*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_FanucSystemControlVariableSyntax_Name" data-uid="Hi.NcParsers.EvaluationSyntaxs.FanucSystemControlVariableSyntax.Name">
|
||||
Name
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Syntax kind name (typically the concrete type name).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Name { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_FanucSystemControlVariableSyntax_XName_" data-uid="Hi.NcParsers.EvaluationSyntaxs.FanucSystemControlVariableSyntax.XName*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_FanucSystemControlVariableSyntax_XName" data-uid="Hi.NcParsers.EvaluationSyntaxs.FanucSystemControlVariableSyntax.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>XML element name for <a class="xref" href="Hi.Common.XmlUtils.XFactory.html#Hi_Common_XmlUtils_XFactory_Regs">Regs</a> registration.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string XName { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_FanucSystemControlVariableSyntax_Build_" data-uid="Hi.NcParsers.EvaluationSyntaxs.FanucSystemControlVariableSyntax.Build*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_FanucSystemControlVariableSyntax_Build_Hi_Common_Collections_LazyLinkedListNode_Hi_NcParsers_Syntaxs_SyntaxPiece__System_Collections_Generic_List_Hi_NcParsers_Dependencys_INcDependency__Hi_NcParsers_NcDiagnosticProgress_" data-uid="Hi.NcParsers.EvaluationSyntaxs.FanucSystemControlVariableSyntax.Build(Hi.Common.Collections.LazyLinkedListNode{Hi.NcParsers.Syntaxs.SyntaxPiece},System.Collections.Generic.List{Hi.NcParsers.Dependencys.INcDependency},Hi.NcParsers.NcDiagnosticProgress)">
|
||||
Build(LazyLinkedListNode<SyntaxPiece>, List<INcDependency>, NcDiagnosticProgress)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Build syntax arrangement into the
|
||||
<code class="paramref">syntaxPieceNode</code> in-place.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void Build(LazyLinkedListNode<SyntaxPiece> syntaxPieceNode, List<INcDependency> ncDependencyList, NcDiagnosticProgress ncDiagnosticProgress)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>syntaxPieceNode</code> <a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html">LazyLinkedListNode</a><<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>ncDependencyList</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a><<a class="xref" href="Hi.NcParsers.Dependencys.INcDependency.html">INcDependency</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>ncDiagnosticProgress</code> <a class="xref" href="Hi.NcParsers.NcDiagnosticProgress.html">NcDiagnosticProgress</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_FanucSystemControlVariableSyntax_MakeXmlSource_" data-uid="Hi.NcParsers.EvaluationSyntaxs.FanucSystemControlVariableSyntax.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_FanucSystemControlVariableSyntax_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.EvaluationSyntaxs.FanucSystemControlVariableSyntax.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Creates an XML representation of the object.
|
||||
This method may also generate additional resources such as related files.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The base directory for resolving relative paths</p>
|
||||
</dd>
|
||||
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The relative file path for the XML source</p>
|
||||
</dd>
|
||||
<dt><code>exhibitionOnly</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p>if true, the extended file creation is suppressed.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
|
||||
<dd><p>An XML element representing the object's state</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_NcParsers_EvaluationSyntaxs_FanucSystemControlVariableSyntax_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
+19
-19
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.NcParsers.LogicSyntaxs.RetainedCommonVariableReadingSyntax">
|
||||
<article data-uid="Hi.NcParsers.EvaluationSyntaxs.RetainedCommonVariableReadingSyntax">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_LogicSyntaxs_RetainedCommonVariableReadingSyntax" data-uid="Hi.NcParsers.LogicSyntaxs.RetainedCommonVariableReadingSyntax" class="text-break">
|
||||
<h1 id="Hi_NcParsers_EvaluationSyntaxs_RetainedCommonVariableReadingSyntax" data-uid="Hi.NcParsers.EvaluationSyntaxs.RetainedCommonVariableReadingSyntax" class="text-break">
|
||||
Class RetainedCommonVariableReadingSyntax
|
||||
</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>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.html">LogicSyntaxs</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcParsers.html">NcParsers</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.html">EvaluationSyntaxs</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -103,14 +103,14 @@ and writing them straight to a registered
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.html">RetainedCommonVariableTable</a>.</p>
|
||||
<p>
|
||||
No SyntaxPiece JSON mirror is created — the table is the single source of
|
||||
truth for retained values, and <a class="xref" href="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax</a> reads
|
||||
truth for retained values, and <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax</a> reads
|
||||
from the table directly. The hincproj round-trip preserves writes across
|
||||
project sessions.
|
||||
</p>
|
||||
<p>
|
||||
Only literal numeric RHS values are consumed by this syntax
|
||||
(<code>#500 = 1.234</code> ✓; <code>#600 = #500 + 1</code> ✗). Non-literal RHS entries
|
||||
are left untouched in <code>Parsing.Assignments</code>; <a class="xref" href="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax</a>
|
||||
are left untouched in <code>Parsing.Assignments</code>; <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax</a>
|
||||
resolves them and writes the result through the same table. The two
|
||||
syntaxes are decoupled.
|
||||
</p>
|
||||
@@ -206,9 +206,9 @@ runner's <code>NcDependencyList</code>, this syntax is a no-op.
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_RetainedCommonVariableReadingSyntax__ctor_" data-uid="Hi.NcParsers.LogicSyntaxs.RetainedCommonVariableReadingSyntax.#ctor*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_RetainedCommonVariableReadingSyntax__ctor_" data-uid="Hi.NcParsers.EvaluationSyntaxs.RetainedCommonVariableReadingSyntax.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_RetainedCommonVariableReadingSyntax__ctor" data-uid="Hi.NcParsers.LogicSyntaxs.RetainedCommonVariableReadingSyntax.#ctor">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_RetainedCommonVariableReadingSyntax__ctor" data-uid="Hi.NcParsers.EvaluationSyntaxs.RetainedCommonVariableReadingSyntax.#ctor">
|
||||
RetainedCommonVariableReadingSyntax()
|
||||
|
||||
</h3>
|
||||
@@ -233,14 +233,14 @@ runner's <code>NcDependencyList</code>, this syntax is a no-op.
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_RetainedCommonVariableReadingSyntax__ctor_" data-uid="Hi.NcParsers.LogicSyntaxs.RetainedCommonVariableReadingSyntax.#ctor*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_RetainedCommonVariableReadingSyntax__ctor_" data-uid="Hi.NcParsers.EvaluationSyntaxs.RetainedCommonVariableReadingSyntax.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_RetainedCommonVariableReadingSyntax__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.LogicSyntaxs.RetainedCommonVariableReadingSyntax.#ctor(System.Xml.Linq.XElement)">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_RetainedCommonVariableReadingSyntax__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.EvaluationSyntaxs.RetainedCommonVariableReadingSyntax.#ctor(System.Xml.Linq.XElement)">
|
||||
RetainedCommonVariableReadingSyntax(XElement)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Loads from an XML element produced by <a class="xref" href="Hi.NcParsers.LogicSyntaxs.RetainedCommonVariableReadingSyntax.html#Hi_NcParsers_LogicSyntaxs_RetainedCommonVariableReadingSyntax_MakeXmlSource_System_String_System_String_System_Boolean_">MakeXmlSource(string, string, bool)</a>. No state to deserialise.</p>
|
||||
<div class="markdown level1 summary"><p>Loads from an XML element produced by <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.RetainedCommonVariableReadingSyntax.html#Hi_NcParsers_EvaluationSyntaxs_RetainedCommonVariableReadingSyntax_MakeXmlSource_System_String_System_String_System_Boolean_">MakeXmlSource(string, string, bool)</a>. No state to deserialise.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -269,9 +269,9 @@ runner's <code>NcDependencyList</code>, this syntax is a no-op.
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_RetainedCommonVariableReadingSyntax_Name_" data-uid="Hi.NcParsers.LogicSyntaxs.RetainedCommonVariableReadingSyntax.Name*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_RetainedCommonVariableReadingSyntax_Name_" data-uid="Hi.NcParsers.EvaluationSyntaxs.RetainedCommonVariableReadingSyntax.Name*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_RetainedCommonVariableReadingSyntax_Name" data-uid="Hi.NcParsers.LogicSyntaxs.RetainedCommonVariableReadingSyntax.Name">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_RetainedCommonVariableReadingSyntax_Name" data-uid="Hi.NcParsers.EvaluationSyntaxs.RetainedCommonVariableReadingSyntax.Name">
|
||||
Name
|
||||
|
||||
</h3>
|
||||
@@ -301,9 +301,9 @@ runner's <code>NcDependencyList</code>, this syntax is a no-op.
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_RetainedCommonVariableReadingSyntax_XName_" data-uid="Hi.NcParsers.LogicSyntaxs.RetainedCommonVariableReadingSyntax.XName*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_RetainedCommonVariableReadingSyntax_XName_" data-uid="Hi.NcParsers.EvaluationSyntaxs.RetainedCommonVariableReadingSyntax.XName*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_RetainedCommonVariableReadingSyntax_XName" data-uid="Hi.NcParsers.LogicSyntaxs.RetainedCommonVariableReadingSyntax.XName">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_RetainedCommonVariableReadingSyntax_XName" data-uid="Hi.NcParsers.EvaluationSyntaxs.RetainedCommonVariableReadingSyntax.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
@@ -337,9 +337,9 @@ runner's <code>NcDependencyList</code>, this syntax is a no-op.
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_RetainedCommonVariableReadingSyntax_Build_" data-uid="Hi.NcParsers.LogicSyntaxs.RetainedCommonVariableReadingSyntax.Build*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_RetainedCommonVariableReadingSyntax_Build_" data-uid="Hi.NcParsers.EvaluationSyntaxs.RetainedCommonVariableReadingSyntax.Build*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_RetainedCommonVariableReadingSyntax_Build_Hi_Common_Collections_LazyLinkedListNode_Hi_NcParsers_Syntaxs_SyntaxPiece__System_Collections_Generic_List_Hi_NcParsers_Dependencys_INcDependency__Hi_NcParsers_NcDiagnosticProgress_" data-uid="Hi.NcParsers.LogicSyntaxs.RetainedCommonVariableReadingSyntax.Build(Hi.Common.Collections.LazyLinkedListNode{Hi.NcParsers.Syntaxs.SyntaxPiece},System.Collections.Generic.List{Hi.NcParsers.Dependencys.INcDependency},Hi.NcParsers.NcDiagnosticProgress)">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_RetainedCommonVariableReadingSyntax_Build_Hi_Common_Collections_LazyLinkedListNode_Hi_NcParsers_Syntaxs_SyntaxPiece__System_Collections_Generic_List_Hi_NcParsers_Dependencys_INcDependency__Hi_NcParsers_NcDiagnosticProgress_" data-uid="Hi.NcParsers.EvaluationSyntaxs.RetainedCommonVariableReadingSyntax.Build(Hi.Common.Collections.LazyLinkedListNode{Hi.NcParsers.Syntaxs.SyntaxPiece},System.Collections.Generic.List{Hi.NcParsers.Dependencys.INcDependency},Hi.NcParsers.NcDiagnosticProgress)">
|
||||
Build(LazyLinkedListNode<SyntaxPiece>, List<INcDependency>, NcDiagnosticProgress)
|
||||
|
||||
</h3>
|
||||
@@ -374,9 +374,9 @@ runner's <code>NcDependencyList</code>, this syntax is a no-op.
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_RetainedCommonVariableReadingSyntax_MakeXmlSource_" data-uid="Hi.NcParsers.LogicSyntaxs.RetainedCommonVariableReadingSyntax.MakeXmlSource*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_RetainedCommonVariableReadingSyntax_MakeXmlSource_" data-uid="Hi.NcParsers.EvaluationSyntaxs.RetainedCommonVariableReadingSyntax.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_RetainedCommonVariableReadingSyntax_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.LogicSyntaxs.RetainedCommonVariableReadingSyntax.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_RetainedCommonVariableReadingSyntax_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.EvaluationSyntaxs.RetainedCommonVariableReadingSyntax.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
@@ -416,7 +416,7 @@ This method may also generate additional resources such as related files.</p>
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_NcParsers_LogicSyntaxs_RetainedCommonVariableReadingSyntax_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<h4 class="section" id="Hi_NcParsers_EvaluationSyntaxs_RetainedCommonVariableReadingSyntax_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
+474
@@ -0,0 +1,474 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class SubProgramCallSyntax | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class SubProgramCallSyntax | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Inlines a Fanuc-style subprogram into the source layer when an M98 or M198 host block is reached. M98 P_ L_ reads the matching O&lt;P&gt; file from ; M198 P_ reads from (Fanuc external-storage call — same mechanism as M98, different lookup root). The file is segmented through the host runner's segmenter () and the resulting s are prepended into layers[0] via ; the rest of the pipeline picks them up through ordinary walkNode.Next traversal as if they had always been part of the host file. Pipeline placement: first child of the Fanuc Evaluation . By the time this runs, / (each a ) have written a Parsing.M98 / Parsing.M198 sub-object carrying the captured P / L parameters. Note: those sub-objects are this syntax's only trigger — "M98" / "M198" never reach Parsing.Flags, because the parameterized match has already consumed the text by the time runs. Filename lookup uses a fallback chain: O{P:D4}.NC, O{P}.NC, O{P:D4}, O{P}, {P:D4}.NC, {P}.NC — first match wins. Case-insensitive match is delegated to the host filesystem (Windows is, Linux is not). L &gt; 1 inlines the same subprogram L times in series. Each repetition is a fresh segmentation pass so each block gets its own with an independent JSON object — the downstream pipeline mutates JSON in place and would clobber sibling repetitions if instances were shared. Not yet supported: M99 P{seq} early return inside a subprogram, partial-program calls (M98 P{seq}{prog} split encoding), and arg binding (G65 macro is a separate syntax).">
|
||||
<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.EvaluationSyntaxs.SubProgramCallSyntax">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_EvaluationSyntaxs_SubProgramCallSyntax" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax" class="text-break">
|
||||
Class SubProgramCallSyntax
|
||||
</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>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.html">EvaluationSyntaxs</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Inlines a Fanuc-style subprogram into the source layer when an M98 or
|
||||
M198 host block is reached. <code>M98 P_ L_</code> reads the matching
|
||||
<code>O<P></code> file from <a class="xref" href="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.html#Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_InternalFolder">InternalFolder</a>;
|
||||
<code>M198 P_</code> reads from <a class="xref" href="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.html#Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_ExternalFolder">ExternalFolder</a>
|
||||
(Fanuc external-storage call — same mechanism as M98, different lookup
|
||||
root). The file is segmented through the host runner's segmenter
|
||||
(<a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.SegmenterDependency.html">SegmenterDependency</a>) and the resulting
|
||||
<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a>s are prepended into <code>layers[0]</code> via
|
||||
<a class="xref" href="Hi.Common.Collections.LazyLinkedList-1.html#Hi_Common_Collections_LazyLinkedList_1_PrependSource_System_Collections_Generic_IEnumerable__0__">PrependSource(IEnumerable<T>)</a>; the rest of the
|
||||
pipeline picks them up through ordinary <code>walkNode.Next</code>
|
||||
traversal as if they had always been part of the host file.</p>
|
||||
<p>
|
||||
Pipeline placement: first child of the Fanuc <code>Evaluation</code>
|
||||
<a class="xref" href="Hi.NcParsers.Syntaxs.BundleSyntax.html">BundleSyntax</a>. By the time this runs,
|
||||
<a class="xref" href="Hi.NcParsers.Syntaxs.FanucSyntaxUtil.html#Hi_NcParsers_Syntaxs_FanucSyntaxUtil_M98Syntax">M98Syntax</a> /
|
||||
<a class="xref" href="Hi.NcParsers.Syntaxs.FanucSyntaxUtil.html#Hi_NcParsers_Syntaxs_FanucSyntaxUtil_M198Syntax">M198Syntax</a>
|
||||
(each a <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.ParameterizedFlagSyntax.html">ParameterizedFlagSyntax</a>) have written a
|
||||
<code>Parsing.M98</code> / <code>Parsing.M198</code> sub-object carrying the
|
||||
captured <code>P</code> / <code>L</code> parameters. Note: those sub-objects
|
||||
are this syntax's only trigger — <code>"M98"</code> / <code>"M198"</code>
|
||||
never reach <code>Parsing.Flags</code>, because the parameterized
|
||||
match has already consumed the text by the time
|
||||
<a class="xref" href="Hi.NcParsers.ParsingSyntaxs.NumberedFlagSyntax.html">NumberedFlagSyntax</a> runs.
|
||||
</p>
|
||||
<p>
|
||||
Filename lookup uses a fallback chain:
|
||||
<code>O{P:D4}.NC</code>, <code>O{P}.NC</code>, <code>O{P:D4}</code>, <code>O{P}</code>,
|
||||
<code>{P:D4}.NC</code>, <code>{P}.NC</code> — first match wins. Case-insensitive
|
||||
match is delegated to the host filesystem (Windows is, Linux is not).
|
||||
</p>
|
||||
<p>
|
||||
L > 1 inlines the same subprogram <code>L</code> times in series. Each
|
||||
repetition is a fresh segmentation pass so each block gets its own
|
||||
<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a> with an independent JSON object — the
|
||||
downstream pipeline mutates JSON in place and would clobber sibling
|
||||
repetitions if instances were shared.
|
||||
</p>
|
||||
<p>
|
||||
Not yet supported: <code>M99 P{seq}</code> early return inside a
|
||||
subprogram, partial-program calls (<code>M98 P{seq}{prog}</code> split
|
||||
encoding), and arg binding (G65 macro is a separate syntax).
|
||||
</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class SubProgramCallSyntax : ISituNcSyntax, INcSyntax, IMakeXmlSource</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">SubProgramCallSyntax</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.NcParsers.Syntaxs.ISituNcSyntax.html">ISituNcSyntax</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.Syntaxs.INcSyntax.html">INcSyntax</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></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>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_SubProgramCallSyntax__ctor_" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_SubProgramCallSyntax__ctor" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.#ctor">
|
||||
SubProgramCallSyntax()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Parameterless instance for bundle composition (no XML state).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public SubProgramCallSyntax()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_SubProgramCallSyntax__ctor_" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_SubProgramCallSyntax__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.#ctor(System.Xml.Linq.XElement)">
|
||||
SubProgramCallSyntax(XElement)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>XML ctor (no child elements; reserved for forward compatibility).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public SubProgramCallSyntax(XElement src)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
|
||||
<dd><p>Root element named <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.html#Hi_NcParsers_EvaluationSyntaxs_SubProgramCallSyntax_XName">XName</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_SubProgramCallSyntax_Name_" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.Name*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_SubProgramCallSyntax_Name" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.Name">
|
||||
Name
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Syntax kind name (typically the concrete type name).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Name { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_SubProgramCallSyntax_XName_" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.XName*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_SubProgramCallSyntax_XName" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>XML element name used to register this syntax with <a class="xref" href="Hi.Common.XmlUtils.XFactory.html">XFactory</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string XName { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_SubProgramCallSyntax_Build_" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.Build*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_SubProgramCallSyntax_Build_Hi_Common_Collections_LazyLinkedListNode_Hi_NcParsers_Syntaxs_SyntaxPiece__System_Collections_Generic_List_Hi_NcParsers_Dependencys_INcDependency__Hi_NcParsers_NcDiagnosticProgress_" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.Build(Hi.Common.Collections.LazyLinkedListNode{Hi.NcParsers.Syntaxs.SyntaxPiece},System.Collections.Generic.List{Hi.NcParsers.Dependencys.INcDependency},Hi.NcParsers.NcDiagnosticProgress)">
|
||||
Build(LazyLinkedListNode<SyntaxPiece>, List<INcDependency>, NcDiagnosticProgress)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Build syntax arrangement into the
|
||||
<code class="paramref">syntaxPieceNode</code> in-place.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void Build(LazyLinkedListNode<SyntaxPiece> syntaxPieceNode, List<INcDependency> ncDependencyList, NcDiagnosticProgress ncDiagnosticProgress)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>syntaxPieceNode</code> <a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html">LazyLinkedListNode</a><<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>ncDependencyList</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a><<a class="xref" href="Hi.NcParsers.Dependencys.INcDependency.html">INcDependency</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>ncDiagnosticProgress</code> <a class="xref" href="Hi.NcParsers.NcDiagnosticProgress.html">NcDiagnosticProgress</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_SubProgramCallSyntax_MakeXmlSource_" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_SubProgramCallSyntax_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Creates an XML representation of the object.
|
||||
This method may also generate additional resources such as related files.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The base directory for resolving relative paths</p>
|
||||
</dd>
|
||||
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The relative file path for the XML source</p>
|
||||
</dd>
|
||||
<dt><code>exhibitionOnly</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p>if true, the extended file creation is suppressed.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
|
||||
<dd><p>An XML element representing the object's state</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_NcParsers_EvaluationSyntaxs_SubProgramCallSyntax_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
+466
@@ -0,0 +1,466 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class SubProgramReturnSyntax | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class SubProgramReturnSyntax | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Consumes Fanuc-style M99 subprogram-return blocks. In the inline model used by , a plain M99 at the end of a subprogram is implicit: the inlined blocks are followed in layers[0] by the caller's next block, so the natural pipeline traversal already does the "return". This syntax therefore only consumes the M99 flag (so doesn't warn) and records a section for cache-dump visibility. M99 P{seq} (return to caller's N{seq} sequence number) is captured in but not yet honoured — the subprogram tail still proceeds straight into the caller's next block. Implementing the jump requires a forward scan of the post-host caller blocks for a matching N{seq} head index, then dropping the intervening blocks; deferred until the caller-side walk semantics are designed. Pipeline placement: anywhere after Parsing has populated Parsing.M99. Conventionally placed alongside at the head of the Evaluation bundle so call/return live next to each other. Detection is on the Parsing.M99 sub-object written by (a ) — the keyword "M99" never reaches Parsing.Flags because the parameterized match has already consumed the text by the time runs.">
|
||||
<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.EvaluationSyntaxs.SubProgramReturnSyntax">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_EvaluationSyntaxs_SubProgramReturnSyntax" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramReturnSyntax" class="text-break">
|
||||
Class SubProgramReturnSyntax
|
||||
</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>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.html">EvaluationSyntaxs</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Consumes Fanuc-style <code>M99</code> subprogram-return blocks.</p>
|
||||
<p>
|
||||
In the inline model used by <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.html">SubProgramCallSyntax</a>, a
|
||||
plain <code>M99</code> at the end of a subprogram is implicit: the
|
||||
inlined blocks are followed in <code>layers[0]</code> by the caller's
|
||||
next block, so the natural pipeline traversal already does the
|
||||
"return". This syntax therefore only consumes the M99 flag (so
|
||||
<a class="xref" href="Hi.NcParsers.InspectionSyntaxs.UnconsumedCheckSyntax.html">UnconsumedCheckSyntax</a> doesn't warn)
|
||||
and records a <a class="xref" href="Hi.NcParsers.Keywords.SubProgramReturn.html">SubProgramReturn</a> section for cache-dump
|
||||
visibility.
|
||||
</p>
|
||||
<p>
|
||||
<code>M99 P{seq}</code> (return to caller's <code>N{seq}</code> sequence
|
||||
number) is captured in <a class="xref" href="Hi.NcParsers.Keywords.SubProgramReturn.html#Hi_NcParsers_Keywords_SubProgramReturn_P">P</a> but not yet
|
||||
honoured — the subprogram tail still proceeds straight into the
|
||||
caller's next block. Implementing the jump requires a forward scan
|
||||
of the post-host caller blocks for a matching <code>N{seq}</code> head
|
||||
index, then dropping the intervening blocks; deferred until the
|
||||
caller-side walk semantics are designed.
|
||||
</p>
|
||||
<p>
|
||||
Pipeline placement: anywhere after Parsing has populated
|
||||
<code>Parsing.M99</code>. Conventionally placed alongside
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.html">SubProgramCallSyntax</a> at the head of the Evaluation
|
||||
bundle so call/return live next to each other.
|
||||
</p>
|
||||
<p>
|
||||
Detection is on the <code>Parsing.M99</code> sub-object written by
|
||||
<a class="xref" href="Hi.NcParsers.Syntaxs.FanucSyntaxUtil.html#Hi_NcParsers_Syntaxs_FanucSyntaxUtil_M99Syntax">M99Syntax</a>
|
||||
(a <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.ParameterizedFlagSyntax.html">ParameterizedFlagSyntax</a>) — the keyword
|
||||
<code>"M99"</code> never reaches <code>Parsing.Flags</code> because the
|
||||
parameterized match has already consumed the text by the time
|
||||
<a class="xref" href="Hi.NcParsers.ParsingSyntaxs.NumberedFlagSyntax.html">NumberedFlagSyntax</a> runs.
|
||||
</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class SubProgramReturnSyntax : ISituNcSyntax, INcSyntax, IMakeXmlSource</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">SubProgramReturnSyntax</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.NcParsers.Syntaxs.ISituNcSyntax.html">ISituNcSyntax</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.Syntaxs.INcSyntax.html">INcSyntax</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></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>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_SubProgramReturnSyntax__ctor_" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramReturnSyntax.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_SubProgramReturnSyntax__ctor" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramReturnSyntax.#ctor">
|
||||
SubProgramReturnSyntax()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Parameterless instance for bundle composition (no XML state).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public SubProgramReturnSyntax()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_SubProgramReturnSyntax__ctor_" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramReturnSyntax.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_SubProgramReturnSyntax__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramReturnSyntax.#ctor(System.Xml.Linq.XElement)">
|
||||
SubProgramReturnSyntax(XElement)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>XML ctor (no child elements; reserved for forward compatibility).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public SubProgramReturnSyntax(XElement src)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
|
||||
<dd><p>Root element named <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.SubProgramReturnSyntax.html#Hi_NcParsers_EvaluationSyntaxs_SubProgramReturnSyntax_XName">XName</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_SubProgramReturnSyntax_Name_" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramReturnSyntax.Name*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_SubProgramReturnSyntax_Name" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramReturnSyntax.Name">
|
||||
Name
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Syntax kind name (typically the concrete type name).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Name { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_SubProgramReturnSyntax_XName_" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramReturnSyntax.XName*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_SubProgramReturnSyntax_XName" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramReturnSyntax.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>XML element name used to register this syntax with <a class="xref" href="Hi.Common.XmlUtils.XFactory.html">XFactory</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string XName { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_SubProgramReturnSyntax_Build_" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramReturnSyntax.Build*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_SubProgramReturnSyntax_Build_Hi_Common_Collections_LazyLinkedListNode_Hi_NcParsers_Syntaxs_SyntaxPiece__System_Collections_Generic_List_Hi_NcParsers_Dependencys_INcDependency__Hi_NcParsers_NcDiagnosticProgress_" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramReturnSyntax.Build(Hi.Common.Collections.LazyLinkedListNode{Hi.NcParsers.Syntaxs.SyntaxPiece},System.Collections.Generic.List{Hi.NcParsers.Dependencys.INcDependency},Hi.NcParsers.NcDiagnosticProgress)">
|
||||
Build(LazyLinkedListNode<SyntaxPiece>, List<INcDependency>, NcDiagnosticProgress)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Build syntax arrangement into the
|
||||
<code class="paramref">syntaxPieceNode</code> in-place.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void Build(LazyLinkedListNode<SyntaxPiece> syntaxPieceNode, List<INcDependency> ncDependencyList, NcDiagnosticProgress ncDiagnosticProgress)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>syntaxPieceNode</code> <a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html">LazyLinkedListNode</a><<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>ncDependencyList</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a><<a class="xref" href="Hi.NcParsers.Dependencys.INcDependency.html">INcDependency</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>ncDiagnosticProgress</code> <a class="xref" href="Hi.NcParsers.NcDiagnosticProgress.html">NcDiagnosticProgress</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_SubProgramReturnSyntax_MakeXmlSource_" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramReturnSyntax.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_SubProgramReturnSyntax_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.EvaluationSyntaxs.SubProgramReturnSyntax.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Creates an XML representation of the object.
|
||||
This method may also generate additional resources such as related files.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The base directory for resolving relative paths</p>
|
||||
</dd>
|
||||
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The relative file path for the XML source</p>
|
||||
</dd>
|
||||
<dt><code>exhibitionOnly</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p>if true, the extended file creation is suppressed.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
|
||||
<dd><p>An XML element representing the object's state</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_NcParsers_EvaluationSyntaxs_SubProgramReturnSyntax_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
+81
-48
@@ -6,7 +6,7 @@
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class VariableEvaluatorSyntax | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Resolves Custom Macro B variable references and bracket expressions on a single block by walking the parser-stage residue and replacing each reference with its evaluated numeric value. Two passes per block: Parsing.Assignments.#nnn entries with a non-literal RHS are evaluated in iteration order. Successful results are written to Vars.Volatile for #100-#499 or to the registered RetainedCommonVariableTable for #500-#999, and the entry is removed. Iteration order matters: an earlier RHS may set a variable that a later RHS reads. Failures (vacant operand, unsupported function, parse error) emit a VariableExpression--Unevaluated error and leave the entry in place; out-of-range ids are likewise left in place. Every string-typed value reachable from Parsing.&lt;tag&gt; (axis tags, canned-cycle sub-objects like Parsing.G81, Parsing.G54.1, etc.) is parsed; on a successful evaluation the string is replaced with a numeric . Failures silently leave the original string and rely on downstream at consumer sites to surface VariableExpression--Unevaluated only if the tag is actually read. Lookup chain (first non-null wins): Block-local Vars.Local with traceback (#1-#33).Block-local Vars.Volatile with traceback (#100-#499).Each in the runner's NcDependencyList, in registration order (e.g. RetainedCommonVariableTable, FanucParameterTable, FanucToolOffsetTable).Each in , in list order (e.g. FanucPositionVariableLookup). Each lookup is responsible for its own id-range gating — id ranges are not hard-coded inside this syntax. Adding a new variable surface (Heidenhain Q parameters, Siemens GUDs, modal G/F/T reads) is additive: register an on a dependency or push an onto the per-preset list.">
|
||||
<meta name="description" content="Pure expression normalizer for Custom Macro B syntax. Walks the parser-stage residue on a single block and inlines numeric values wherever a Fanuc-style variable reference or bracket expression appears — but does not write to any specific store. Routing &ldquo;where the resolved literal lands&rdquo; stays in the brand-specific reader syntaxes (, 's reader, , …) which run after this syntax on the same block. Two passes per block: Assignments normalize — Parsing.Assignments.#nnn entries whose RHS is non-literal (e.g. "#500+1", "SQRT[#100]") are evaluated via the and the RHS string is replaced with the resolved literal (round-trip-safe "R"-format). The entry stays in Parsing.Assignments so downstream reader syntaxes consume it as a pure-literal assignment. Iteration follows source order (Parsing.Assignments insertion order). Parsing tree substitution — every string-typed value reachable from Parsing.&lt;tag&gt; (axis tags, canned-cycle sub-objects) is parsed; on a successful evaluation the string is replaced with a numeric . Failures silently leave the original string and rely on downstream at consumer sites to surface VariableExpression--Unevaluated only if the tag is actually read. Lookup chain (first non-null wins, configured per brand preset via + instances on NcDependencyList): Current block's own resolved assignments — built-in to ; covers same-block forward references in source order (an earlier #nnn=literal is visible to a later RHS that mentions #nnn).Each in , in list order. Typical contents for a Fanuc-family preset: (#1-#33), (#100-#499), (#5001-#5043).Each on the runner's NcDependencyList, in registration order (, , ). Each lookup self-gates its id range; the evaluator stays brand- and range-agnostic. Adding a new variable surface is additive: register an on a dependency or push an onto the per-preset list. Same-block forward reference — when an Assignment RHS references a #nnn that is also being assigned later in the same block (i.e. listed in Parsing.Assignments after the RHS being evaluated), the cannot pick up the not-yet-resolved value and falls back to traceback / dependency-table reads — effectively the pre-block value. A VariableEvaluator--SameBlockForwardReference warning is emitted per such RHS so the user is told the source-order semantics were not honoured. Practical impact is near-zero for typical CAM-emitted NC (one assignment per line).">
|
||||
<link rel="icon" href="../img/HiAPI.favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
@@ -84,54 +84,84 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax">
|
||||
<article data-uid="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_LogicSyntaxs_VariableEvaluatorSyntax" data-uid="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax" class="text-break">
|
||||
<h1 id="Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax" data-uid="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax" class="text-break">
|
||||
Class VariableEvaluatorSyntax
|
||||
</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>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.html">LogicSyntaxs</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcParsers.html">NcParsers</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.html">EvaluationSyntaxs</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Resolves Custom Macro B variable references and bracket expressions on
|
||||
a single block by walking the parser-stage residue and replacing each
|
||||
reference with its evaluated numeric value.</p>
|
||||
<div class="markdown summary"><p>Pure expression normalizer for Custom Macro B syntax. Walks the
|
||||
parser-stage residue on a single block and inlines numeric values
|
||||
wherever a Fanuc-style variable reference or bracket expression
|
||||
appears — but does <b>not</b> write to any specific store. Routing
|
||||
“where the resolved literal lands” stays in the brand-specific
|
||||
reader syntaxes (<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.html">VolatileVariableReadingSyntax</a>,
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.html">RetainedCommonVariableTable</a>'s reader,
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.FanucSystemControlVariableSyntax.html">FanucSystemControlVariableSyntax</a>, …) which run
|
||||
<i>after</i> this syntax on the same block.</p>
|
||||
<p>
|
||||
Two passes per block:
|
||||
</p>
|
||||
<ol><li>
|
||||
<code>Parsing.Assignments.#nnn</code> entries with a non-literal RHS are
|
||||
evaluated in iteration order. Successful results are written to
|
||||
<code>Vars.Volatile</code> for <code>#100-#499</code> or to the registered
|
||||
<code>RetainedCommonVariableTable</code> for <code>#500-#999</code>, and the
|
||||
entry is removed. Iteration order matters: an earlier RHS may set a
|
||||
variable that a later RHS reads. Failures (vacant operand, unsupported
|
||||
function, parse error) emit a <code>VariableExpression--Unevaluated</code>
|
||||
error and leave the entry in place; out-of-range ids are likewise left
|
||||
in place.
|
||||
<b>Assignments normalize</b> — <code>Parsing.Assignments.#nnn</code> entries
|
||||
whose RHS is non-literal (e.g. <code>"#500+1"</code>, <code>"SQRT[#100]"</code>)
|
||||
are evaluated via the <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax.ChainLookup</a> and the RHS string is
|
||||
replaced with the resolved literal (round-trip-safe
|
||||
<code>"R"</code>-format). The entry stays in <code>Parsing.Assignments</code> so
|
||||
downstream reader syntaxes consume it as a pure-literal assignment.
|
||||
Iteration follows source order (Parsing.Assignments insertion order).
|
||||
</li><li>
|
||||
Every string-typed value reachable from <code>Parsing.<tag></code>
|
||||
(axis tags, canned-cycle sub-objects like <code>Parsing.G81</code>,
|
||||
<code>Parsing.G54.1</code>, etc.) is parsed; on a successful evaluation the
|
||||
string is replaced with a numeric <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.json.nodes.jsonvalue">JsonValue</a>. Failures
|
||||
silently leave the original string and rely on downstream
|
||||
<b>Parsing tree substitution</b> — every string-typed value reachable
|
||||
from <code>Parsing.<tag></code> (axis tags, canned-cycle sub-objects)
|
||||
is parsed; on a successful evaluation the string is replaced with a
|
||||
numeric <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.json.nodes.jsonvalue">JsonValue</a>. Failures silently leave the original
|
||||
string and rely on downstream
|
||||
<a class="xref" href="Hi.NcParsers.SoftNcUtil.html#Hi_NcParsers_SoftNcUtil_GetParsedDouble_System_Text_Json_Nodes_JsonObject_System_String_Hi_NcParsers_Sentence_Hi_NcParsers_NcDiagnosticProgress_">GetParsedDouble(JsonObject, string, Sentence, NcDiagnosticProgress)</a> at consumer sites to surface
|
||||
<code>VariableExpression--Unevaluated</code> only if the tag is actually read.
|
||||
</li></ol>
|
||||
<p>
|
||||
Lookup chain (first non-null wins):
|
||||
Lookup chain (first non-null wins, configured per brand preset via
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html#Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax_RuntimeVariableLookups">RuntimeVariableLookups</a> + <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a>
|
||||
instances on <code>NcDependencyList</code>):
|
||||
</p>
|
||||
<ol><li>Block-local <code>Vars.Local</code> with <a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html#Hi_Common_Collections_LazyLinkedListNode_1_Previous">Previous</a> traceback (<code>#1-#33</code>).</li><li>Block-local <code>Vars.Volatile</code> with traceback (<code>#100-#499</code>).</li><li>Each <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a> in the runner's <code>NcDependencyList</code>, in registration order (e.g. <code>RetainedCommonVariableTable</code>, <code>FanucParameterTable</code>, <code>FanucToolOffsetTable</code>).</li><li>Each <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IRuntimeVariableLookup.html">IRuntimeVariableLookup</a> in <a class="xref" href="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.html#Hi_NcParsers_LogicSyntaxs_VariableEvaluatorSyntax_RuntimeVariableLookups">RuntimeVariableLookups</a>, in list order (e.g. <code>FanucPositionVariableLookup</code>).</li></ol>
|
||||
<ol><li><b>Current block's own resolved assignments</b> — built-in to
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax.ChainLookup</a>; covers same-block forward references in
|
||||
source order (an earlier <code>#nnn=literal</code> is visible to a later
|
||||
RHS that mentions <code>#nnn</code>).</li><li>Each <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IRuntimeVariableLookup.html">IRuntimeVariableLookup</a> in
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html#Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax_RuntimeVariableLookups">RuntimeVariableLookups</a>, in list order. Typical contents
|
||||
for a Fanuc-family preset:
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.LocalVariableLookup.html">LocalVariableLookup</a> (<code>#1-#33</code>),
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.VolatileVariableLookup.html">VolatileVariableLookup</a> (<code>#100-#499</code>),
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.FanucPositionVariableLookup.html">FanucPositionVariableLookup</a>
|
||||
(<code>#5001-#5043</code>).</li><li>Each <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a> on the runner's
|
||||
<code>NcDependencyList</code>, in registration order
|
||||
(<a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.html">RetainedCommonVariableTable</a>,
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.html">FanucParameterTable</a>,
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.FanucToolOffsetVariableLookup.html">FanucToolOffsetVariableLookup</a>).</li></ol>
|
||||
<p>
|
||||
Each lookup is responsible for its own id-range gating — id ranges are
|
||||
not hard-coded inside this syntax. Adding a new variable surface
|
||||
(Heidenhain Q parameters, Siemens GUDs, modal G/F/T reads) is additive:
|
||||
register an <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a> on a dependency or push an
|
||||
<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IRuntimeVariableLookup.html">IRuntimeVariableLookup</a> onto the per-preset list.
|
||||
Each lookup self-gates its id range; the evaluator stays brand- and
|
||||
range-agnostic. Adding a new variable surface is additive: register
|
||||
an <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a> on a dependency or push an
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IRuntimeVariableLookup.html">IRuntimeVariableLookup</a> onto the per-preset list.
|
||||
</p>
|
||||
<p>
|
||||
<b>Same-block forward reference</b> — when an Assignment RHS
|
||||
references a <code>#nnn</code> that is <i>also</i> being assigned later in
|
||||
the same block (i.e. listed in <code>Parsing.Assignments</code> after the
|
||||
RHS being evaluated), the <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax.ChainLookup</a> cannot pick up
|
||||
the not-yet-resolved value and falls back to traceback /
|
||||
dependency-table reads — effectively the pre-block value. A
|
||||
<code>VariableEvaluator--SameBlockForwardReference</code> warning is
|
||||
emitted per such RHS so the user is told the source-order semantics
|
||||
were not honoured. Practical impact is near-zero for typical
|
||||
CAM-emitted NC (one assignment per line).
|
||||
</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
@@ -221,9 +251,9 @@ register an <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariable
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_VariableEvaluatorSyntax__ctor_" data-uid="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.#ctor*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax__ctor_" data-uid="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_VariableEvaluatorSyntax__ctor" data-uid="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.#ctor">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax__ctor" data-uid="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.#ctor">
|
||||
VariableEvaluatorSyntax()
|
||||
|
||||
</h3>
|
||||
@@ -248,14 +278,14 @@ register an <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariable
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_VariableEvaluatorSyntax__ctor_" data-uid="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.#ctor*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax__ctor_" data-uid="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_VariableEvaluatorSyntax__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.#ctor(System.Xml.Linq.XElement)">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.#ctor(System.Xml.Linq.XElement)">
|
||||
VariableEvaluatorSyntax(XElement)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Loads from an XML element produced by <a class="xref" href="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.html#Hi_NcParsers_LogicSyntaxs_VariableEvaluatorSyntax_MakeXmlSource_System_String_System_String_System_Boolean_">MakeXmlSource(string, string, bool)</a>. No state to deserialise.</p>
|
||||
<div class="markdown level1 summary"><p>Loads from an XML element produced by <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html#Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax_MakeXmlSource_System_String_System_String_System_Boolean_">MakeXmlSource(string, string, bool)</a>. No state to deserialise.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -284,9 +314,9 @@ register an <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariable
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_VariableEvaluatorSyntax_Name_" data-uid="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.Name*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax_Name_" data-uid="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.Name*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_VariableEvaluatorSyntax_Name" data-uid="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.Name">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax_Name" data-uid="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.Name">
|
||||
Name
|
||||
|
||||
</h3>
|
||||
@@ -316,16 +346,19 @@ register an <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariable
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_VariableEvaluatorSyntax_RuntimeVariableLookups_" data-uid="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.RuntimeVariableLookups*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax_RuntimeVariableLookups_" data-uid="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.RuntimeVariableLookups*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_VariableEvaluatorSyntax_RuntimeVariableLookups" data-uid="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.RuntimeVariableLookups">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax_RuntimeVariableLookups" data-uid="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.RuntimeVariableLookups">
|
||||
RuntimeVariableLookups
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Per-preset list of context-sensitive lookups (typically position
|
||||
reads that need <a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html#Hi_Common_Collections_LazyLinkedListNode_1_Previous">Previous</a>). Walked
|
||||
in list order after all dependency-bound <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a>s.</p>
|
||||
<div class="markdown level1 summary"><p>Per-preset list of context-sensitive lookups (block-local
|
||||
<code>Vars.Local</code> / <code>Vars.Volatile</code>, position reads,
|
||||
runtime-state reads). Walked in list order, before the
|
||||
dependency-bound <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a>s. Brand presets
|
||||
configure this — instances are not XML-serialised because they
|
||||
are brand-determined behaviour, not project state.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -339,7 +372,7 @@ in list order after all dependency-bound <a class="xref" href="Hi.NcParsers.Logi
|
||||
|
||||
<h4 class="section">Property Value</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.NcParsers.LogicSyntaxs.Evaluation.IRuntimeVariableLookup.html">IRuntimeVariableLookup</a>></dt>
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a><<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IRuntimeVariableLookup.html">IRuntimeVariableLookup</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
@@ -350,9 +383,9 @@ in list order after all dependency-bound <a class="xref" href="Hi.NcParsers.Logi
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_VariableEvaluatorSyntax_XName_" data-uid="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.XName*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax_XName_" data-uid="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.XName*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_VariableEvaluatorSyntax_XName" data-uid="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.XName">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax_XName" data-uid="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
@@ -386,9 +419,9 @@ in list order after all dependency-bound <a class="xref" href="Hi.NcParsers.Logi
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_VariableEvaluatorSyntax_Build_" data-uid="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.Build*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax_Build_" data-uid="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.Build*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_VariableEvaluatorSyntax_Build_Hi_Common_Collections_LazyLinkedListNode_Hi_NcParsers_Syntaxs_SyntaxPiece__System_Collections_Generic_List_Hi_NcParsers_Dependencys_INcDependency__Hi_NcParsers_NcDiagnosticProgress_" data-uid="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.Build(Hi.Common.Collections.LazyLinkedListNode{Hi.NcParsers.Syntaxs.SyntaxPiece},System.Collections.Generic.List{Hi.NcParsers.Dependencys.INcDependency},Hi.NcParsers.NcDiagnosticProgress)">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax_Build_Hi_Common_Collections_LazyLinkedListNode_Hi_NcParsers_Syntaxs_SyntaxPiece__System_Collections_Generic_List_Hi_NcParsers_Dependencys_INcDependency__Hi_NcParsers_NcDiagnosticProgress_" data-uid="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.Build(Hi.Common.Collections.LazyLinkedListNode{Hi.NcParsers.Syntaxs.SyntaxPiece},System.Collections.Generic.List{Hi.NcParsers.Dependencys.INcDependency},Hi.NcParsers.NcDiagnosticProgress)">
|
||||
Build(LazyLinkedListNode<SyntaxPiece>, List<INcDependency>, NcDiagnosticProgress)
|
||||
|
||||
</h3>
|
||||
@@ -423,9 +456,9 @@ in list order after all dependency-bound <a class="xref" href="Hi.NcParsers.Logi
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_VariableEvaluatorSyntax_MakeXmlSource_" data-uid="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.MakeXmlSource*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax_MakeXmlSource_" data-uid="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_VariableEvaluatorSyntax_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
@@ -465,7 +498,7 @@ This method may also generate additional resources such as related files.</p>
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_NcParsers_LogicSyntaxs_VariableEvaluatorSyntax_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<h4 class="section" id="Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
+20
-82
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax">
|
||||
<article data-uid="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_LogicSyntaxs_VolatileVariableReadingSyntax" data-uid="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax" class="text-break">
|
||||
<h1 id="Hi_NcParsers_EvaluationSyntaxs_VolatileVariableReadingSyntax" data-uid="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax" class="text-break">
|
||||
Class VolatileVariableReadingSyntax
|
||||
</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>.<a class="xref" href="Hi.NcParsers.LogicSyntaxs.html">LogicSyntaxs</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcParsers.html">NcParsers</a>.<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.html">EvaluationSyntaxs</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -111,7 +111,7 @@ abandons the SyntaxPiece JSON dataflow and starts fresh. Program-end
|
||||
<p>
|
||||
Only literal numeric RHS values are consumed by this syntax
|
||||
(<code>#124 = 15.</code> ✓; <code>#100 = #1 + 5</code> ✗). Non-literal RHS entries
|
||||
are left untouched in <code>Parsing.Assignments</code>; <a class="xref" href="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax</a>
|
||||
are left untouched in <code>Parsing.Assignments</code>; <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax</a>
|
||||
resolves them and writes the result into the same per-block dictionary.
|
||||
The two syntaxes are decoupled — the evaluator's lookup tracebacks via
|
||||
<code>SyntaxPiece</code> linkage so it does not depend on having run before
|
||||
@@ -205,9 +205,9 @@ or after this syntax.
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_VolatileVariableReadingSyntax__ctor_" data-uid="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax.#ctor*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_VolatileVariableReadingSyntax__ctor_" data-uid="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_VolatileVariableReadingSyntax__ctor" data-uid="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax.#ctor">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_VolatileVariableReadingSyntax__ctor" data-uid="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.#ctor">
|
||||
VolatileVariableReadingSyntax()
|
||||
|
||||
</h3>
|
||||
@@ -232,14 +232,14 @@ or after this syntax.
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_VolatileVariableReadingSyntax__ctor_" data-uid="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax.#ctor*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_VolatileVariableReadingSyntax__ctor_" data-uid="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_VolatileVariableReadingSyntax__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax.#ctor(System.Xml.Linq.XElement)">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_VolatileVariableReadingSyntax__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.#ctor(System.Xml.Linq.XElement)">
|
||||
VolatileVariableReadingSyntax(XElement)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Loads from an XML element produced by <a class="xref" href="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax.html#Hi_NcParsers_LogicSyntaxs_VolatileVariableReadingSyntax_MakeXmlSource_System_String_System_String_System_Boolean_">MakeXmlSource(string, string, bool)</a>. No state to deserialise.</p>
|
||||
<div class="markdown level1 summary"><p>Loads from an XML element produced by <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.html#Hi_NcParsers_EvaluationSyntaxs_VolatileVariableReadingSyntax_MakeXmlSource_System_String_System_String_System_Boolean_">MakeXmlSource(string, string, bool)</a>. No state to deserialise.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -269,69 +269,7 @@ or after this syntax.
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_VolatileVariableReadingSyntax_VarsSection" data-uid="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax.VarsSection">
|
||||
VarsSection
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Top-level JSON section that hosts per-block variable dictionaries.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const string VarsSection = "Vars"</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_LogicSyntaxs_VolatileVariableReadingSyntax_VolatileKey" data-uid="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax.VolatileKey">
|
||||
VolatileKey
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Sub-key under <a class="xref" href="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax.html#Hi_NcParsers_LogicSyntaxs_VolatileVariableReadingSyntax_VarsSection">VarsSection</a> for the non-retained common dictionary.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const string VolatileKey = "Volatile"</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_LogicSyntaxs_VolatileVariableReadingSyntax_VolatileMax" data-uid="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax.VolatileMax">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_VolatileVariableReadingSyntax_VolatileMax" data-uid="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.VolatileMax">
|
||||
VolatileMax
|
||||
|
||||
</h3>
|
||||
@@ -362,7 +300,7 @@ or after this syntax.
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_VolatileVariableReadingSyntax_VolatileMin" data-uid="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax.VolatileMin">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_VolatileVariableReadingSyntax_VolatileMin" data-uid="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.VolatileMin">
|
||||
VolatileMin
|
||||
|
||||
</h3>
|
||||
@@ -396,9 +334,9 @@ or after this syntax.
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_VolatileVariableReadingSyntax_Name_" data-uid="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax.Name*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_VolatileVariableReadingSyntax_Name_" data-uid="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.Name*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_VolatileVariableReadingSyntax_Name" data-uid="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax.Name">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_VolatileVariableReadingSyntax_Name" data-uid="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.Name">
|
||||
Name
|
||||
|
||||
</h3>
|
||||
@@ -428,9 +366,9 @@ or after this syntax.
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_VolatileVariableReadingSyntax_XName_" data-uid="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax.XName*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_VolatileVariableReadingSyntax_XName_" data-uid="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.XName*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_VolatileVariableReadingSyntax_XName" data-uid="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax.XName">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_VolatileVariableReadingSyntax_XName" data-uid="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
@@ -464,9 +402,9 @@ or after this syntax.
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_VolatileVariableReadingSyntax_Build_" data-uid="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax.Build*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_VolatileVariableReadingSyntax_Build_" data-uid="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.Build*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_VolatileVariableReadingSyntax_Build_Hi_Common_Collections_LazyLinkedListNode_Hi_NcParsers_Syntaxs_SyntaxPiece__System_Collections_Generic_List_Hi_NcParsers_Dependencys_INcDependency__Hi_NcParsers_NcDiagnosticProgress_" data-uid="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax.Build(Hi.Common.Collections.LazyLinkedListNode{Hi.NcParsers.Syntaxs.SyntaxPiece},System.Collections.Generic.List{Hi.NcParsers.Dependencys.INcDependency},Hi.NcParsers.NcDiagnosticProgress)">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_VolatileVariableReadingSyntax_Build_Hi_Common_Collections_LazyLinkedListNode_Hi_NcParsers_Syntaxs_SyntaxPiece__System_Collections_Generic_List_Hi_NcParsers_Dependencys_INcDependency__Hi_NcParsers_NcDiagnosticProgress_" data-uid="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.Build(Hi.Common.Collections.LazyLinkedListNode{Hi.NcParsers.Syntaxs.SyntaxPiece},System.Collections.Generic.List{Hi.NcParsers.Dependencys.INcDependency},Hi.NcParsers.NcDiagnosticProgress)">
|
||||
Build(LazyLinkedListNode<SyntaxPiece>, List<INcDependency>, NcDiagnosticProgress)
|
||||
|
||||
</h3>
|
||||
@@ -501,9 +439,9 @@ or after this syntax.
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_LogicSyntaxs_VolatileVariableReadingSyntax_MakeXmlSource_" data-uid="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax.MakeXmlSource*"></a>
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_VolatileVariableReadingSyntax_MakeXmlSource_" data-uid="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_LogicSyntaxs_VolatileVariableReadingSyntax_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_VolatileVariableReadingSyntax_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
@@ -543,7 +481,7 @@ This method may also generate additional resources such as related files.</p>
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_NcParsers_LogicSyntaxs_VolatileVariableReadingSyntax_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<h4 class="section" id="Hi_NcParsers_EvaluationSyntaxs_VolatileVariableReadingSyntax_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
@@ -0,0 +1,369 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Namespace Hi.NcParsers.EvaluationSyntaxs | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Namespace Hi.NcParsers.EvaluationSyntaxs | 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.EvaluationSyntaxs">
|
||||
|
||||
<h1 id="Hi_NcParsers_EvaluationSyntaxs" data-uid="Hi.NcParsers.EvaluationSyntaxs" class="text-break">Namespace Hi.NcParsers.EvaluationSyntaxs</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.EvaluationSyntaxs.FanucSystemControlVariableSyntax.html">FanucSystemControlVariableSyntax</a></dt>
|
||||
<dd><p>Consumes Fanuc-style system-control variable assignments
|
||||
(<code>#3000-#3999</code>) — alarm trigger (<code>#3000</code>), millisecond and
|
||||
hour clocks (<code>#3001</code> / <code>#3002</code>), single-block / feed-hold
|
||||
bypass flags (<code>#3003</code> / <code>#3004</code>), pause-with-message
|
||||
(<code>#3006</code>), mirror-image flags (<code>#3007</code>), date / time
|
||||
(<code>#3011</code> / <code>#3012</code>), tool-life data (<code>#3030</code> /
|
||||
<code>#3032</code>), etc.</p>
|
||||
<p>
|
||||
Every id in this range is a controller-side state variable — its
|
||||
authoritative value lives on the real hardware (RTC, alarm bus,
|
||||
override switches, …) and an NC write at most triggers a side effect
|
||||
(clock reset, alarm raise, message-pause prompt). Offline simulation
|
||||
has none of that machinery, so this syntax does <b>not</b> emulate the
|
||||
effect. Instead it:
|
||||
</p>
|
||||
<ol><li>records the literal write on the block JSON under
|
||||
<code>Vars.SystemControl</code> (round-trip and cache-dump visibility);</li><li>emits a <code>FanucSystemControl--Unsupported</code>
|
||||
<a class="xref" href="Hi.NcParsers.NcDiagnosticProgress.html#Hi_NcParsers_NcDiagnosticProgress_UnsupportedMessage_Hi_NcParsers_Sentence_System_String_System_String_System_Object_">UnsupportedMessage(Sentence, string, string, object)</a>
|
||||
so the user knows the assignment was recognised but its controller-side
|
||||
effect is not simulated. Message-severity (not Warning) because these
|
||||
writes are safe no-ops offline — every consumed assignment would emit
|
||||
a Warning per block, which would be noisy without signalling anything
|
||||
the user must act on;</li><li>removes the entry from <code>Parsing.Assignments</code> so it does not
|
||||
re-surface as a generic <code>Parsing--Unconsumed</code> diagnostic.</li></ol>
|
||||
<p>
|
||||
The dictionary carries forward block-by-block (same dict-merge pattern
|
||||
as <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.html">VolatileVariableReadingSyntax</a>) so a downstream consumer
|
||||
can read the most recent recorded value via <code>SyntaxPiece</code> linkage.
|
||||
</p>
|
||||
<p>
|
||||
Only literal numeric RHS values are consumed; non-literal RHS
|
||||
(e.g. <code>#3002 = #500</code>) is left in <code>Parsing.Assignments</code> for
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax</a> to resolve, mirroring the
|
||||
retained / volatile reading syntaxes.
|
||||
</p>
|
||||
<p>
|
||||
Fanuc-family only — Siemens uses named system variables
|
||||
(<code>$AC_TIME</code>, <code>$A_DAY</code>, …) and Heidenhain uses
|
||||
<code>FN18: SYSREAD</code>; neither flows through <code>Parsing.Assignments.#nnn</code>.
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.RetainedCommonVariableReadingSyntax.html">RetainedCommonVariableReadingSyntax</a></dt>
|
||||
<dd><p>Obtains values for Fanuc-style retained common variables (<code>#500-#999</code>)
|
||||
by consuming literal numeric assignments from <code>Parsing.Assignments.#nnn</code>
|
||||
and writing them straight to a registered
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.html">RetainedCommonVariableTable</a>.</p>
|
||||
<p>
|
||||
No SyntaxPiece JSON mirror is created — the table is the single source of
|
||||
truth for retained values, and <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax</a> reads
|
||||
from the table directly. The hincproj round-trip preserves writes across
|
||||
project sessions.
|
||||
</p>
|
||||
<p>
|
||||
Only literal numeric RHS values are consumed by this syntax
|
||||
(<code>#500 = 1.234</code> ✓; <code>#600 = #500 + 1</code> ✗). Non-literal RHS entries
|
||||
are left untouched in <code>Parsing.Assignments</code>; <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax</a>
|
||||
resolves them and writes the result through the same table. The two
|
||||
syntaxes are decoupled.
|
||||
</p>
|
||||
<p>
|
||||
If no <a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.html">RetainedCommonVariableTable</a> is registered on the
|
||||
runner's <code>NcDependencyList</code>, this syntax is a no-op.
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.html">SubProgramCallSyntax</a></dt>
|
||||
<dd><p>Inlines a Fanuc-style subprogram into the source layer when an M98 or
|
||||
M198 host block is reached. <code>M98 P_ L_</code> reads the matching
|
||||
<code>O<P></code> file from <a class="xref" href="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.html#Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_InternalFolder">InternalFolder</a>;
|
||||
<code>M198 P_</code> reads from <a class="xref" href="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.html#Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_ExternalFolder">ExternalFolder</a>
|
||||
(Fanuc external-storage call — same mechanism as M98, different lookup
|
||||
root). The file is segmented through the host runner's segmenter
|
||||
(<a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.SegmenterDependency.html">SegmenterDependency</a>) and the resulting
|
||||
<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a>s are prepended into <code>layers[0]</code> via
|
||||
<a class="xref" href="Hi.Common.Collections.LazyLinkedList-1.html#Hi_Common_Collections_LazyLinkedList_1_PrependSource_System_Collections_Generic_IEnumerable__0__">PrependSource(IEnumerable<T>)</a>; the rest of the
|
||||
pipeline picks them up through ordinary <code>walkNode.Next</code>
|
||||
traversal as if they had always been part of the host file.</p>
|
||||
<p>
|
||||
Pipeline placement: first child of the Fanuc <code>Evaluation</code>
|
||||
<a class="xref" href="Hi.NcParsers.Syntaxs.BundleSyntax.html">BundleSyntax</a>. By the time this runs,
|
||||
<a class="xref" href="Hi.NcParsers.Syntaxs.FanucSyntaxUtil.html#Hi_NcParsers_Syntaxs_FanucSyntaxUtil_M98Syntax">M98Syntax</a> /
|
||||
<a class="xref" href="Hi.NcParsers.Syntaxs.FanucSyntaxUtil.html#Hi_NcParsers_Syntaxs_FanucSyntaxUtil_M198Syntax">M198Syntax</a>
|
||||
(each a <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.ParameterizedFlagSyntax.html">ParameterizedFlagSyntax</a>) have written a
|
||||
<code>Parsing.M98</code> / <code>Parsing.M198</code> sub-object carrying the
|
||||
captured <code>P</code> / <code>L</code> parameters. Note: those sub-objects
|
||||
are this syntax's only trigger — <code>"M98"</code> / <code>"M198"</code>
|
||||
never reach <code>Parsing.Flags</code>, because the parameterized
|
||||
match has already consumed the text by the time
|
||||
<a class="xref" href="Hi.NcParsers.ParsingSyntaxs.NumberedFlagSyntax.html">NumberedFlagSyntax</a> runs.
|
||||
</p>
|
||||
<p>
|
||||
Filename lookup uses a fallback chain:
|
||||
<code>O{P:D4}.NC</code>, <code>O{P}.NC</code>, <code>O{P:D4}</code>, <code>O{P}</code>,
|
||||
<code>{P:D4}.NC</code>, <code>{P}.NC</code> — first match wins. Case-insensitive
|
||||
match is delegated to the host filesystem (Windows is, Linux is not).
|
||||
</p>
|
||||
<p>
|
||||
L > 1 inlines the same subprogram <code>L</code> times in series. Each
|
||||
repetition is a fresh segmentation pass so each block gets its own
|
||||
<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a> with an independent JSON object — the
|
||||
downstream pipeline mutates JSON in place and would clobber sibling
|
||||
repetitions if instances were shared.
|
||||
</p>
|
||||
<p>
|
||||
Not yet supported: <code>M99 P{seq}</code> early return inside a
|
||||
subprogram, partial-program calls (<code>M98 P{seq}{prog}</code> split
|
||||
encoding), and arg binding (G65 macro is a separate syntax).
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.SubProgramReturnSyntax.html">SubProgramReturnSyntax</a></dt>
|
||||
<dd><p>Consumes Fanuc-style <code>M99</code> subprogram-return blocks.</p>
|
||||
<p>
|
||||
In the inline model used by <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.html">SubProgramCallSyntax</a>, a
|
||||
plain <code>M99</code> at the end of a subprogram is implicit: the
|
||||
inlined blocks are followed in <code>layers[0]</code> by the caller's
|
||||
next block, so the natural pipeline traversal already does the
|
||||
"return". This syntax therefore only consumes the M99 flag (so
|
||||
<a class="xref" href="Hi.NcParsers.InspectionSyntaxs.UnconsumedCheckSyntax.html">UnconsumedCheckSyntax</a> doesn't warn)
|
||||
and records a <a class="xref" href="Hi.NcParsers.Keywords.SubProgramReturn.html">SubProgramReturn</a> section for cache-dump
|
||||
visibility.
|
||||
</p>
|
||||
<p>
|
||||
<code>M99 P{seq}</code> (return to caller's <code>N{seq}</code> sequence
|
||||
number) is captured in <a class="xref" href="Hi.NcParsers.Keywords.SubProgramReturn.html#Hi_NcParsers_Keywords_SubProgramReturn_P">P</a> but not yet
|
||||
honoured — the subprogram tail still proceeds straight into the
|
||||
caller's next block. Implementing the jump requires a forward scan
|
||||
of the post-host caller blocks for a matching <code>N{seq}</code> head
|
||||
index, then dropping the intervening blocks; deferred until the
|
||||
caller-side walk semantics are designed.
|
||||
</p>
|
||||
<p>
|
||||
Pipeline placement: anywhere after Parsing has populated
|
||||
<code>Parsing.M99</code>. Conventionally placed alongside
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.html">SubProgramCallSyntax</a> at the head of the Evaluation
|
||||
bundle so call/return live next to each other.
|
||||
</p>
|
||||
<p>
|
||||
Detection is on the <code>Parsing.M99</code> sub-object written by
|
||||
<a class="xref" href="Hi.NcParsers.Syntaxs.FanucSyntaxUtil.html#Hi_NcParsers_Syntaxs_FanucSyntaxUtil_M99Syntax">M99Syntax</a>
|
||||
(a <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.ParameterizedFlagSyntax.html">ParameterizedFlagSyntax</a>) — the keyword
|
||||
<code>"M99"</code> never reaches <code>Parsing.Flags</code> because the
|
||||
parameterized match has already consumed the text by the time
|
||||
<a class="xref" href="Hi.NcParsers.ParsingSyntaxs.NumberedFlagSyntax.html">NumberedFlagSyntax</a> runs.
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax</a></dt>
|
||||
<dd><p>Pure expression normalizer for Custom Macro B syntax. Walks the
|
||||
parser-stage residue on a single block and inlines numeric values
|
||||
wherever a Fanuc-style variable reference or bracket expression
|
||||
appears — but does <b>not</b> write to any specific store. Routing
|
||||
“where the resolved literal lands” stays in the brand-specific
|
||||
reader syntaxes (<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.html">VolatileVariableReadingSyntax</a>,
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.html">RetainedCommonVariableTable</a>'s reader,
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.FanucSystemControlVariableSyntax.html">FanucSystemControlVariableSyntax</a>, …) which run
|
||||
<i>after</i> this syntax on the same block.</p>
|
||||
<p>
|
||||
Two passes per block:
|
||||
</p>
|
||||
<ol><li>
|
||||
<b>Assignments normalize</b> — <code>Parsing.Assignments.#nnn</code> entries
|
||||
whose RHS is non-literal (e.g. <code>"#500+1"</code>, <code>"SQRT[#100]"</code>)
|
||||
are evaluated via the <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax.ChainLookup</a> and the RHS string is
|
||||
replaced with the resolved literal (round-trip-safe
|
||||
<code>"R"</code>-format). The entry stays in <code>Parsing.Assignments</code> so
|
||||
downstream reader syntaxes consume it as a pure-literal assignment.
|
||||
Iteration follows source order (Parsing.Assignments insertion order).
|
||||
</li><li>
|
||||
<b>Parsing tree substitution</b> — every string-typed value reachable
|
||||
from <code>Parsing.<tag></code> (axis tags, canned-cycle sub-objects)
|
||||
is parsed; on a successful evaluation the string is replaced with a
|
||||
numeric <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.json.nodes.jsonvalue">JsonValue</a>. Failures silently leave the original
|
||||
string and rely on downstream
|
||||
<a class="xref" href="Hi.NcParsers.SoftNcUtil.html#Hi_NcParsers_SoftNcUtil_GetParsedDouble_System_Text_Json_Nodes_JsonObject_System_String_Hi_NcParsers_Sentence_Hi_NcParsers_NcDiagnosticProgress_">GetParsedDouble(JsonObject, string, Sentence, NcDiagnosticProgress)</a> at consumer sites to surface
|
||||
<code>VariableExpression--Unevaluated</code> only if the tag is actually read.
|
||||
</li></ol>
|
||||
<p>
|
||||
Lookup chain (first non-null wins, configured per brand preset via
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html#Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax_RuntimeVariableLookups">RuntimeVariableLookups</a> + <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a>
|
||||
instances on <code>NcDependencyList</code>):
|
||||
</p>
|
||||
<ol><li><b>Current block's own resolved assignments</b> — built-in to
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax.ChainLookup</a>; covers same-block forward references in
|
||||
source order (an earlier <code>#nnn=literal</code> is visible to a later
|
||||
RHS that mentions <code>#nnn</code>).</li><li>Each <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IRuntimeVariableLookup.html">IRuntimeVariableLookup</a> in
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html#Hi_NcParsers_EvaluationSyntaxs_VariableEvaluatorSyntax_RuntimeVariableLookups">RuntimeVariableLookups</a>, in list order. Typical contents
|
||||
for a Fanuc-family preset:
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.LocalVariableLookup.html">LocalVariableLookup</a> (<code>#1-#33</code>),
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.VolatileVariableLookup.html">VolatileVariableLookup</a> (<code>#100-#499</code>),
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.FanucPositionVariableLookup.html">FanucPositionVariableLookup</a>
|
||||
(<code>#5001-#5043</code>).</li><li>Each <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a> on the runner's
|
||||
<code>NcDependencyList</code>, in registration order
|
||||
(<a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.html">RetainedCommonVariableTable</a>,
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.FanucParameterTable.html">FanucParameterTable</a>,
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.FanucToolOffsetVariableLookup.html">FanucToolOffsetVariableLookup</a>).</li></ol>
|
||||
<p>
|
||||
Each lookup self-gates its id range; the evaluator stays brand- and
|
||||
range-agnostic. Adding a new variable surface is additive: register
|
||||
an <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a> on a dependency or push an
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IRuntimeVariableLookup.html">IRuntimeVariableLookup</a> onto the per-preset list.
|
||||
</p>
|
||||
<p>
|
||||
<b>Same-block forward reference</b> — when an Assignment RHS
|
||||
references a <code>#nnn</code> that is <i>also</i> being assigned later in
|
||||
the same block (i.e. listed in <code>Parsing.Assignments</code> after the
|
||||
RHS being evaluated), the <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax.ChainLookup</a> cannot pick up
|
||||
the not-yet-resolved value and falls back to traceback /
|
||||
dependency-table reads — effectively the pre-block value. A
|
||||
<code>VariableEvaluator--SameBlockForwardReference</code> warning is
|
||||
emitted per such RHS so the user is told the source-order semantics
|
||||
were not honoured. Practical impact is near-zero for typical
|
||||
CAM-emitted NC (one assignment per line).
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.html">VolatileVariableReadingSyntax</a></dt>
|
||||
<dd><p>Obtains values for Fanuc-style non-retained common variables
|
||||
(<code>#100-#499</code>). Reads literal numeric assignments from
|
||||
<code>Parsing.Assignments.#nnn</code>, dict-merges them with the previous block's
|
||||
volatile state, and writes the resulting per-block dictionary into
|
||||
<code>Vars.Volatile</code>.</p>
|
||||
<p>
|
||||
Lifetime is bounded by <code>MachiningSession</code>: within one session the
|
||||
dictionary carries forward block-by-block via this syntax; session restart
|
||||
abandons the SyntaxPiece JSON dataflow and starts fresh. Program-end
|
||||
(M02/M30) clearing is handled by <a class="xref" href="Hi.NcParsers.LogicSyntaxs.ProgramEndCleanSyntax.html">ProgramEndCleanSyntax</a>.
|
||||
</p>
|
||||
<p>
|
||||
Only literal numeric RHS values are consumed by this syntax
|
||||
(<code>#124 = 15.</code> ✓; <code>#100 = #1 + 5</code> ✗). Non-literal RHS entries
|
||||
are left untouched in <code>Parsing.Assignments</code>; <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax</a>
|
||||
resolves them and writes the result into the same per-block dictionary.
|
||||
The two syntaxes are decoupled — the evaluator's lookup tracebacks via
|
||||
<code>SyntaxPiece</code> linkage so it does not depend on having run before
|
||||
or after this syntax.
|
||||
</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>
|
||||
@@ -0,0 +1,345 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class FanucProgramNumber | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class FanucProgramNumber | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Fanuc-family program identifier header that follows a line — e.g. O1234 or &lt;O1234&gt;. records the surface form so a parsed block can be emitted back to the original notation.">
|
||||
<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.Keywords.FanucProgramNumber">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_Keywords_FanucProgramNumber" data-uid="Hi.NcParsers.Keywords.FanucProgramNumber" class="text-break">
|
||||
Class FanucProgramNumber
|
||||
</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>.<a class="xref" href="Hi.NcParsers.Keywords.html">Keywords</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Fanuc-family program identifier header that follows a
|
||||
<a class="xref" href="Hi.NcParsers.Keywords.TapeBoundary.html">TapeBoundary</a> line — e.g. <code>O1234</code> or
|
||||
<code><O1234></code>. <a class="xref" href="Hi.NcParsers.Keywords.FanucProgramNumber.html#Hi_NcParsers_Keywords_FanucProgramNumber_Wrapper">Wrapper</a> records the surface form
|
||||
so a parsed block can be emitted back to the original notation.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class FanucProgramNumber</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">FanucProgramNumber</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>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="fields">Fields
|
||||
</h2>
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_Keywords_FanucProgramNumber_WrapperAngle" data-uid="Hi.NcParsers.Keywords.FanucProgramNumber.WrapperAngle">
|
||||
WrapperAngle
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p><a class="xref" href="Hi.NcParsers.Keywords.FanucProgramNumber.html#Hi_NcParsers_Keywords_FanucProgramNumber_Wrapper">Wrapper</a> value for the angle-bracketed form: <code><O1234></code>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const string WrapperAngle = "Angle"</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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_NcParsers_Keywords_FanucProgramNumber_WrapperAngle_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>Fanuc 30i / 31i / 32i extended program-name notation. Some CAM
|
||||
post-processors emit this at the head of subprogram files.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_NcParsers_Keywords_FanucProgramNumber_WrapperNone" data-uid="Hi.NcParsers.Keywords.FanucProgramNumber.WrapperNone">
|
||||
WrapperNone
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p><a class="xref" href="Hi.NcParsers.Keywords.FanucProgramNumber.html#Hi_NcParsers_Keywords_FanucProgramNumber_Wrapper">Wrapper</a> value for the bare form: <code>O1234</code>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const string WrapperNone = "None"</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_Keywords_FanucProgramNumber_Number_" data-uid="Hi.NcParsers.Keywords.FanucProgramNumber.Number*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Keywords_FanucProgramNumber_Number" data-uid="Hi.NcParsers.Keywords.FanucProgramNumber.Number">
|
||||
Number
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>The numeric portion of the program identifier, as written (no leading zero normalization).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Number { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</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_Keywords_FanucProgramNumber_Wrapper_" data-uid="Hi.NcParsers.Keywords.FanucProgramNumber.Wrapper*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Keywords_FanucProgramNumber_Wrapper" data-uid="Hi.NcParsers.Keywords.FanucProgramNumber.Wrapper">
|
||||
Wrapper
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Surface form of the wrapping symbols around the <code>O</code> token —
|
||||
one of <a class="xref" href="Hi.NcParsers.Keywords.FanucProgramNumber.html#Hi_NcParsers_Keywords_FanucProgramNumber_WrapperNone">WrapperNone</a> or <a class="xref" href="Hi.NcParsers.Keywords.FanucProgramNumber.html#Hi_NcParsers_Keywords_FanucProgramNumber_WrapperAngle">WrapperAngle</a>.
|
||||
New values may be added as additional notations are observed; consumers
|
||||
should treat unknown values as round-trip-only.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Wrapper { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></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>
|
||||
@@ -0,0 +1,337 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class SubProgramCall | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class SubProgramCall | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Subprogram call record left on the M98 / M198 host block by after the subprogram file has been inlined into the source layer. The call itself emits no motion act; this section is bookkeeping so cache dumps and diagnostic readers can see &quot;this block triggered an inline of file File&quot;.">
|
||||
<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.Keywords.SubProgramCall">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_Keywords_SubProgramCall" data-uid="Hi.NcParsers.Keywords.SubProgramCall" class="text-break">
|
||||
Class SubProgramCall
|
||||
</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>.<a class="xref" href="Hi.NcParsers.Keywords.html">Keywords</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Subprogram call record left on the M98 / M198 host block by
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.html">SubProgramCallSyntax</a> after the subprogram
|
||||
file has been inlined into the source layer. The call itself emits no
|
||||
motion act; this section is bookkeeping so cache dumps and diagnostic
|
||||
readers can see "this block triggered an inline of file <code>File</code>".</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class SubProgramCall</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">SubProgramCall</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>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Keywords_SubProgramCall_File_" data-uid="Hi.NcParsers.Keywords.SubProgramCall.File*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Keywords_SubProgramCall_File" data-uid="Hi.NcParsers.Keywords.SubProgramCall.File">
|
||||
File
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Resolved file path that supplied the inlined blocks. Useful for diagnostics when a fallback filename pattern matched.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string File { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</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_Keywords_SubProgramCall_L_" data-uid="Hi.NcParsers.Keywords.SubProgramCall.L*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Keywords_SubProgramCall_L" data-uid="Hi.NcParsers.Keywords.SubProgramCall.L">
|
||||
L
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Repeat count from the <code>L</code> parameter; defaults to 1 when absent.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int L { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Keywords_SubProgramCall_P_" data-uid="Hi.NcParsers.Keywords.SubProgramCall.P*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Keywords_SubProgramCall_P" data-uid="Hi.NcParsers.Keywords.SubProgramCall.P">
|
||||
P
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Subprogram number from the <code>P</code> parameter (e.g., 1234 for <code>O1234</code>).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int P { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Keywords_SubProgramCall_Term_" data-uid="Hi.NcParsers.Keywords.SubProgramCall.Term*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Keywords_SubProgramCall_Term" data-uid="Hi.NcParsers.Keywords.SubProgramCall.Term">
|
||||
Term
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Triggering keyword: <code>“M98”</code> (internal) or <code>“M198”</code> (external storage).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Term { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></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>
|
||||
@@ -0,0 +1,277 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class SubProgramReturn | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class SubProgramReturn | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Subprogram return record left on the M99 host block by . Return blocks produce no motion acts; this section makes the consumed M99 visible in cache dumps and reserves a slot for future M99 P{seq} (return-to-sequence-number) support.">
|
||||
<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.Keywords.SubProgramReturn">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_Keywords_SubProgramReturn" data-uid="Hi.NcParsers.Keywords.SubProgramReturn" class="text-break">
|
||||
Class SubProgramReturn
|
||||
</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>.<a class="xref" href="Hi.NcParsers.Keywords.html">Keywords</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Subprogram return record left on the M99 host block by
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.SubProgramReturnSyntax.html">SubProgramReturnSyntax</a>. Return blocks
|
||||
produce no motion acts; this section makes the consumed M99 visible
|
||||
in cache dumps and reserves a slot for future <code>M99 P{seq}</code>
|
||||
(return-to-sequence-number) support.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class SubProgramReturn</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">SubProgramReturn</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>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Keywords_SubProgramReturn_P_" data-uid="Hi.NcParsers.Keywords.SubProgramReturn.P*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Keywords_SubProgramReturn_P" data-uid="Hi.NcParsers.Keywords.SubProgramReturn.P">
|
||||
P
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Optional caller sequence number from the <code>P</code> parameter
|
||||
(<code>M99 P{seq}</code>). Null on a plain <code>M99</code>. Currently
|
||||
recorded but not yet honoured — the subprogram's tail
|
||||
continues straight into the caller's next block, regardless of
|
||||
<a class="xref" href="Hi.NcParsers.Keywords.SubProgramReturn.html#Hi_NcParsers_Keywords_SubProgramReturn_P">P</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int? P { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Keywords_SubProgramReturn_Term_" data-uid="Hi.NcParsers.Keywords.SubProgramReturn.Term*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Keywords_SubProgramReturn_Term" data-uid="Hi.NcParsers.Keywords.SubProgramReturn.Term">
|
||||
Term
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Triggering keyword (always <code>“M99”</code> for now).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Term { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></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>
|
||||
+16
-46
@@ -2,11 +2,11 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class ProgramBoundary | HiAPI-C# 2025 </title>
|
||||
<title>Class TapeBoundary | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class ProgramBoundary | HiAPI-C# 2025 ">
|
||||
<meta name="title" content="Class TapeBoundary | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Program start/end delimiter line (e.g., % in Fanuc/Mazak/Syntec, %_N_xxx_MPF in Siemens). Not a comment — the controller uses it as a tape/file boundary marker.">
|
||||
<meta name="description" content="Tape leader / trailer line — the literal % that historically marked the start and end of a punched paper-tape program. ISO-style controllers (Fanuc, Mazak, Syntec, Siemens) all preserve it as a file-level boundary marker. Distinct from a comment: the controller uses it as a tape/file delimiter, not as embedded operator text.">
|
||||
<link rel="icon" href="../img/HiAPI.favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
@@ -84,12 +84,12 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.NcParsers.Keywords.ProgramBoundary">
|
||||
<article data-uid="Hi.NcParsers.Keywords.TapeBoundary">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_Keywords_ProgramBoundary" data-uid="Hi.NcParsers.Keywords.ProgramBoundary" class="text-break">
|
||||
Class ProgramBoundary
|
||||
<h1 id="Hi_NcParsers_Keywords_TapeBoundary" data-uid="Hi.NcParsers.Keywords.TapeBoundary" class="text-break">
|
||||
Class TapeBoundary
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
@@ -97,14 +97,16 @@ Class ProgramBoundary
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Program start/end delimiter line (e.g., <code>%</code> in Fanuc/Mazak/Syntec,
|
||||
<code>%_N_xxx_MPF</code> in Siemens).
|
||||
Not a comment — the controller uses it as a tape/file boundary marker.</p>
|
||||
<div class="markdown summary"><p>Tape leader / trailer line — the literal <code>%</code> that historically
|
||||
marked the start and end of a punched paper-tape program. ISO-style
|
||||
controllers (Fanuc, Mazak, Syntec, Siemens) all preserve it as a
|
||||
file-level boundary marker. Distinct from a comment: the controller
|
||||
uses it as a tape/file delimiter, not as embedded operator text.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ProgramBoundary</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class TapeBoundary</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -114,7 +116,7 @@ Not a comment — the controller uses it as a tape/file boundary marker.</p>
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">ProgramBoundary</span></div>
|
||||
<div><span class="xref">TapeBoundary</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -180,46 +182,14 @@ Not a comment — the controller uses it as a tape/file boundary marker.</p>
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Keywords_ProgramBoundary_Symbol_" data-uid="Hi.NcParsers.Keywords.ProgramBoundary.Symbol*"></a>
|
||||
<a id="Hi_NcParsers_Keywords_TapeBoundary_Text_" data-uid="Hi.NcParsers.Keywords.TapeBoundary.Text*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Keywords_ProgramBoundary_Symbol" data-uid="Hi.NcParsers.Keywords.ProgramBoundary.Symbol">
|
||||
Symbol
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Delimiter symbol (e.g., "%").</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Symbol { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</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_Keywords_ProgramBoundary_Text_" data-uid="Hi.NcParsers.Keywords.ProgramBoundary.Text*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Keywords_ProgramBoundary_Text" data-uid="Hi.NcParsers.Keywords.ProgramBoundary.Text">
|
||||
<h3 id="Hi_NcParsers_Keywords_TapeBoundary_Text" data-uid="Hi.NcParsers.Keywords.TapeBoundary.Text">
|
||||
Text
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Content after the symbol, typically a program number or empty.</p>
|
||||
<div class="markdown level1 summary"><p>Free-form content after the <code>%</code> on the same line, typically empty.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -0,0 +1,320 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class Vars | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class Vars | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="JSON section schema for per-block variable storage. Each sub-property names a sub-section that holds a { &ldquo;#nnn&rdquo;: value } dictionary keyed by Fanuc-style variable id. The sub-sections partition the variable space by lifetime: — #1-#33, scope: macro call frame (pushed/popped by G65 / G66 / M99). — #100-#499, non-retained common; carries block-to-block, cleared by ProgramEndCleanSyntax on M02 / M30. — #3000-#3999, controller-side system variables; offline-only round-trip record (real controller effects such as clock reset / alarm trigger / message pause are not simulated). The property types are rather than strongly-typed dictionaries because each sub-section's keys are dynamic Fanuc variable ids (#100, #5001, …) discovered at parse time, not a fixed schema. This class exists solely to give the section name and sub-keys stable nameof() targets — instances are never constructed at runtime.">
|
||||
<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.Keywords.Vars">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_Keywords_Vars" data-uid="Hi.NcParsers.Keywords.Vars" class="text-break">
|
||||
Class Vars
|
||||
</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>.<a class="xref" href="Hi.NcParsers.Keywords.html">Keywords</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>JSON section schema for per-block variable storage. Each sub-property
|
||||
names a sub-section that holds a <code>{ “#nnn”: value }</code> dictionary
|
||||
keyed by Fanuc-style variable id.</p>
|
||||
<p>
|
||||
The sub-sections partition the variable space by lifetime:
|
||||
</p>
|
||||
<ul><li><a class="xref" href="Hi.NcParsers.Keywords.Vars.html#Hi_NcParsers_Keywords_Vars_Local">Local</a> — <code>#1-#33</code>, scope: macro call frame
|
||||
(pushed/popped by G65 / G66 / M99).</li><li><a class="xref" href="Hi.NcParsers.Keywords.Vars.html#Hi_NcParsers_Keywords_Vars_Volatile">Volatile</a> — <code>#100-#499</code>, non-retained common;
|
||||
carries block-to-block, cleared by <code>ProgramEndCleanSyntax</code> on M02 / M30.</li><li><a class="xref" href="Hi.NcParsers.Keywords.Vars.html#Hi_NcParsers_Keywords_Vars_SystemControl">SystemControl</a> — <code>#3000-#3999</code>, controller-side
|
||||
system variables; offline-only round-trip record (real controller
|
||||
effects such as clock reset / alarm trigger / message pause are not
|
||||
simulated).</li></ul>
|
||||
<p>
|
||||
The property types are <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.json.nodes.jsonobject">JsonObject</a> rather than strongly-typed
|
||||
dictionaries because each sub-section's keys are dynamic Fanuc variable
|
||||
ids (<code>#100</code>, <code>#5001</code>, …) discovered at parse time, not a fixed
|
||||
schema. This class exists solely to give the section name and sub-keys
|
||||
stable <code>nameof()</code> targets — instances are never constructed at
|
||||
runtime.
|
||||
</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class Vars</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">Vars</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>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Keywords_Vars_Local_" data-uid="Hi.NcParsers.Keywords.Vars.Local*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Keywords_Vars_Local" data-uid="Hi.NcParsers.Keywords.Vars.Local">
|
||||
Local
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Macro-local sub-section (<code>#1-#33</code>).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public JsonObject Local { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.json.nodes.jsonobject">JsonObject</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Keywords_Vars_SystemControl_" data-uid="Hi.NcParsers.Keywords.Vars.SystemControl*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Keywords_Vars_SystemControl" data-uid="Hi.NcParsers.Keywords.Vars.SystemControl">
|
||||
SystemControl
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>System-control sub-section (<code>#3000-#3999</code>).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public JsonObject SystemControl { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.json.nodes.jsonobject">JsonObject</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Keywords_Vars_Volatile_" data-uid="Hi.NcParsers.Keywords.Vars.Volatile*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Keywords_Vars_Volatile" data-uid="Hi.NcParsers.Keywords.Vars.Volatile">
|
||||
Volatile
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Non-retained common sub-section (<code>#100-#499</code>).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public JsonObject Volatile { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.json.nodes.jsonobject">JsonObject</a></dt>
|
||||
<dd></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>
|
||||
@@ -169,6 +169,14 @@ Heidenhain: CYCL DEF 247 (Datum Preset) / CYCL DEF 7 (Datum Shift).
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.Keywords.FanucPathSmoothing.html">FanucPathSmoothing</a></dt>
|
||||
<dd><p>Section data holder for <a class="xref" href="Hi.NcParsers.Keywords.IFanucPathSmoothingDef.html">IFanucPathSmoothingDef</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.Keywords.FanucProgramNumber.html">FanucProgramNumber</a></dt>
|
||||
<dd><p>Fanuc-family program identifier header that follows a
|
||||
<a class="xref" href="Hi.NcParsers.Keywords.TapeBoundary.html">TapeBoundary</a> line — e.g. <code>O1234</code> or
|
||||
<code><O1234></code>. <a class="xref" href="Hi.NcParsers.Keywords.FanucProgramNumber.html#Hi_NcParsers_Keywords_FanucProgramNumber_Wrapper">Wrapper</a> records the surface form
|
||||
so a parsed block can be emitted back to the original notation.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
@@ -232,13 +240,6 @@ do not share this key, because their data shapes are richer.
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.Keywords.Positioning.html">Positioning</a></dt>
|
||||
<dd><p>Section key holder + concrete implementation for <a class="xref" href="Hi.NcParsers.Keywords.IPositioningDef.html">IPositioningDef</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.Keywords.ProgramBoundary.html">ProgramBoundary</a></dt>
|
||||
<dd><p>Program start/end delimiter line (e.g., <code>%</code> in Fanuc/Mazak/Syntec,
|
||||
<code>%_N_xxx_MPF</code> in Siemens).
|
||||
Not a comment — the controller uses it as a tape/file boundary marker.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
@@ -269,6 +270,33 @@ Not a comment — the controller uses it as a tape/file boundary marker.</p>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.Keywords.SpindleSpeed.html">SpindleSpeed</a></dt>
|
||||
<dd><p>Section key holder + concrete implementation for <a class="xref" href="Hi.NcParsers.Keywords.ISpindleSpeedDef.html">ISpindleSpeedDef</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.Keywords.SubProgramCall.html">SubProgramCall</a></dt>
|
||||
<dd><p>Subprogram call record left on the M98 / M198 host block by
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.html">SubProgramCallSyntax</a> after the subprogram
|
||||
file has been inlined into the source layer. The call itself emits no
|
||||
motion act; this section is bookkeeping so cache dumps and diagnostic
|
||||
readers can see "this block triggered an inline of file <code>File</code>".</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.Keywords.SubProgramReturn.html">SubProgramReturn</a></dt>
|
||||
<dd><p>Subprogram return record left on the M99 host block by
|
||||
<a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.SubProgramReturnSyntax.html">SubProgramReturnSyntax</a>. Return blocks
|
||||
produce no motion acts; this section makes the consumed M99 visible
|
||||
in cache dumps and reserves a slot for future <code>M99 P{seq}</code>
|
||||
(return-to-sequence-number) support.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.Keywords.TapeBoundary.html">TapeBoundary</a></dt>
|
||||
<dd><p>Tape leader / trailer line — the literal <code>%</code> that historically
|
||||
marked the start and end of a punched paper-tape program. ISO-style
|
||||
controllers (Fanuc, Mazak, Syntec, Siemens) all preserve it as a
|
||||
file-level boundary marker. Distinct from a comment: the controller
|
||||
uses it as a tape/file delimiter, not as embedded operator text.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
@@ -284,6 +312,30 @@ Not a comment — the controller uses it as a tape/file boundary marker.</p>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.Keywords.Unit.html">Unit</a></dt>
|
||||
<dd><p>Section key holder + concrete implementation for <a class="xref" href="Hi.NcParsers.Keywords.IUnitDef.html">IUnitDef</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.Keywords.Vars.html">Vars</a></dt>
|
||||
<dd><p>JSON section schema for per-block variable storage. Each sub-property
|
||||
names a sub-section that holds a <code>{ “#nnn”: value }</code> dictionary
|
||||
keyed by Fanuc-style variable id.</p>
|
||||
<p>
|
||||
The sub-sections partition the variable space by lifetime:
|
||||
</p>
|
||||
<ul><li><a class="xref" href="Hi.NcParsers.Keywords.Vars.html#Hi_NcParsers_Keywords_Vars_Local">Local</a> — <code>#1-#33</code>, scope: macro call frame
|
||||
(pushed/popped by G65 / G66 / M99).</li><li><a class="xref" href="Hi.NcParsers.Keywords.Vars.html#Hi_NcParsers_Keywords_Vars_Volatile">Volatile</a> — <code>#100-#499</code>, non-retained common;
|
||||
carries block-to-block, cleared by <code>ProgramEndCleanSyntax</code> on M02 / M30.</li><li><a class="xref" href="Hi.NcParsers.Keywords.Vars.html#Hi_NcParsers_Keywords_Vars_SystemControl">SystemControl</a> — <code>#3000-#3999</code>, controller-side
|
||||
system variables; offline-only round-trip record (real controller
|
||||
effects such as clock reset / alarm trigger / message pause are not
|
||||
simulated).</li></ul>
|
||||
<p>
|
||||
The property types are <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.json.nodes.jsonobject">JsonObject</a> rather than strongly-typed
|
||||
dictionaries because each sub-section's keys are dynamic Fanuc variable
|
||||
ids (<code>#100</code>, <code>#5001</code>, …) discovered at parse time, not a fixed
|
||||
schema. This class exists solely to give the section name and sub-keys
|
||||
stable <code>nameof()</code> targets — instances are never constructed at
|
||||
runtime.
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<h3 id="interfaces">
|
||||
|
||||
@@ -104,13 +104,13 @@ triggered program end (M02 / M30, identified by the
|
||||
Real Fanuc clears non-retained common variables (#100-#499) on program
|
||||
end + reset; this syntax models that behaviour at the simulator level.
|
||||
The clear happens on the same block that carried M02/M30 — the next
|
||||
block's <a class="xref" href="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax.html">VolatileVariableReadingSyntax</a> carry then sees an
|
||||
block's <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.html">VolatileVariableReadingSyntax</a> carry then sees an
|
||||
empty dictionary on the predecessor and starts fresh.
|
||||
</p>
|
||||
<p>
|
||||
Pipeline placement: must run after both <a class="xref" href="Hi.NcParsers.LogicSyntaxs.ProgramEndSyntax.html">ProgramEndSyntax</a>
|
||||
(which writes the <a class="xref" href="Hi.NcParsers.Keywords.ProgramEnd.html">ProgramEnd</a> section this syntax checks)
|
||||
and <a class="xref" href="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax.html">VolatileVariableReadingSyntax</a> (so the carry has
|
||||
and <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.html">VolatileVariableReadingSyntax</a> (so the carry has
|
||||
already happened on this block; this syntax overwrites the result).
|
||||
</p>
|
||||
<p>
|
||||
|
||||
@@ -648,13 +648,13 @@ triggered program end (M02 / M30, identified by the
|
||||
Real Fanuc clears non-retained common variables (#100-#499) on program
|
||||
end + reset; this syntax models that behaviour at the simulator level.
|
||||
The clear happens on the same block that carried M02/M30 — the next
|
||||
block's <a class="xref" href="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax.html">VolatileVariableReadingSyntax</a> carry then sees an
|
||||
block's <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.html">VolatileVariableReadingSyntax</a> carry then sees an
|
||||
empty dictionary on the predecessor and starts fresh.
|
||||
</p>
|
||||
<p>
|
||||
Pipeline placement: must run after both <a class="xref" href="Hi.NcParsers.LogicSyntaxs.ProgramEndSyntax.html">ProgramEndSyntax</a>
|
||||
(which writes the <a class="xref" href="Hi.NcParsers.Keywords.ProgramEnd.html">ProgramEnd</a> section this syntax checks)
|
||||
and <a class="xref" href="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax.html">VolatileVariableReadingSyntax</a> (so the carry has
|
||||
and <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.html">VolatileVariableReadingSyntax</a> (so the carry has
|
||||
already happened on this block; this syntax overwrites the result).
|
||||
</p>
|
||||
<p>
|
||||
@@ -790,31 +790,6 @@ Overwrites root <a class="xref" href="Hi.NcParsers.Keywords.IMachineCoordinateSt
|
||||
and <a class="xref" href="Hi.NcParsers.Keywords.IProgramXyzDef.html#Hi_NcParsers_Keywords_IProgramXyzDef_ProgramXyz">ProgramXyz</a> with reference position
|
||||
for subsequent block lookback.
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.RetainedCommonVariableReadingSyntax.html">RetainedCommonVariableReadingSyntax</a></dt>
|
||||
<dd><p>Obtains values for Fanuc-style retained common variables (<code>#500-#999</code>)
|
||||
by consuming literal numeric assignments from <code>Parsing.Assignments.#nnn</code>
|
||||
and writing them straight to a registered
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.html">RetainedCommonVariableTable</a>.</p>
|
||||
<p>
|
||||
No SyntaxPiece JSON mirror is created — the table is the single source of
|
||||
truth for retained values, and <a class="xref" href="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax</a> reads
|
||||
from the table directly. The hincproj round-trip preserves writes across
|
||||
project sessions.
|
||||
</p>
|
||||
<p>
|
||||
Only literal numeric RHS values are consumed by this syntax
|
||||
(<code>#500 = 1.234</code> ✓; <code>#600 = #500 + 1</code> ✗). Non-literal RHS entries
|
||||
are left untouched in <code>Parsing.Assignments</code>; <a class="xref" href="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax</a>
|
||||
resolves them and writes the result through the same table. The two
|
||||
syntaxes are decoupled.
|
||||
</p>
|
||||
<p>
|
||||
If no <a class="xref" href="Hi.NcParsers.Dependencys.Fanuc.RetainedCommonVariableTable.html">RetainedCommonVariableTable</a> is registered on the
|
||||
runner's <code>NcDependencyList</code>, this syntax is a no-op.
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
@@ -901,70 +876,6 @@ are forced to pre-convert the NC program to metric.
|
||||
<a class="xref" href="Hi.NcParsers.Keywords.Generic.IsoKeywords.html#Hi_NcParsers_Keywords_Generic_IsoKeywords_G21">G21</a> is accepted as a no-op confirmation of
|
||||
the default.
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax</a></dt>
|
||||
<dd><p>Resolves Custom Macro B variable references and bracket expressions on
|
||||
a single block by walking the parser-stage residue and replacing each
|
||||
reference with its evaluated numeric value.</p>
|
||||
<p>
|
||||
Two passes per block:
|
||||
</p>
|
||||
<ol><li>
|
||||
<code>Parsing.Assignments.#nnn</code> entries with a non-literal RHS are
|
||||
evaluated in iteration order. Successful results are written to
|
||||
<code>Vars.Volatile</code> for <code>#100-#499</code> or to the registered
|
||||
<code>RetainedCommonVariableTable</code> for <code>#500-#999</code>, and the
|
||||
entry is removed. Iteration order matters: an earlier RHS may set a
|
||||
variable that a later RHS reads. Failures (vacant operand, unsupported
|
||||
function, parse error) emit a <code>VariableExpression--Unevaluated</code>
|
||||
error and leave the entry in place; out-of-range ids are likewise left
|
||||
in place.
|
||||
</li><li>
|
||||
Every string-typed value reachable from <code>Parsing.<tag></code>
|
||||
(axis tags, canned-cycle sub-objects like <code>Parsing.G81</code>,
|
||||
<code>Parsing.G54.1</code>, etc.) is parsed; on a successful evaluation the
|
||||
string is replaced with a numeric <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.json.nodes.jsonvalue">JsonValue</a>. Failures
|
||||
silently leave the original string and rely on downstream
|
||||
<a class="xref" href="Hi.NcParsers.SoftNcUtil.html#Hi_NcParsers_SoftNcUtil_GetParsedDouble_System_Text_Json_Nodes_JsonObject_System_String_Hi_NcParsers_Sentence_Hi_NcParsers_NcDiagnosticProgress_">GetParsedDouble(JsonObject, string, Sentence, NcDiagnosticProgress)</a> at consumer sites to surface
|
||||
<code>VariableExpression--Unevaluated</code> only if the tag is actually read.
|
||||
</li></ol>
|
||||
<p>
|
||||
Lookup chain (first non-null wins):
|
||||
</p>
|
||||
<ol><li>Block-local <code>Vars.Local</code> with <a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html#Hi_Common_Collections_LazyLinkedListNode_1_Previous">Previous</a> traceback (<code>#1-#33</code>).</li><li>Block-local <code>Vars.Volatile</code> with traceback (<code>#100-#499</code>).</li><li>Each <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a> in the runner's <code>NcDependencyList</code>, in registration order (e.g. <code>RetainedCommonVariableTable</code>, <code>FanucParameterTable</code>, <code>FanucToolOffsetTable</code>).</li><li>Each <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IRuntimeVariableLookup.html">IRuntimeVariableLookup</a> in <a class="xref" href="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.html#Hi_NcParsers_LogicSyntaxs_VariableEvaluatorSyntax_RuntimeVariableLookups">RuntimeVariableLookups</a>, in list order (e.g. <code>FanucPositionVariableLookup</code>).</li></ol>
|
||||
<p>
|
||||
Each lookup is responsible for its own id-range gating — id ranges are
|
||||
not hard-coded inside this syntax. Adding a new variable surface
|
||||
(Heidenhain Q parameters, Siemens GUDs, modal G/F/T reads) is additive:
|
||||
register an <a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup.html">IVariableLookup</a> on a dependency or push an
|
||||
<a class="xref" href="Hi.NcParsers.LogicSyntaxs.Evaluation.IRuntimeVariableLookup.html">IRuntimeVariableLookup</a> onto the per-preset list.
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax.html">VolatileVariableReadingSyntax</a></dt>
|
||||
<dd><p>Obtains values for Fanuc-style non-retained common variables
|
||||
(<code>#100-#499</code>). Reads literal numeric assignments from
|
||||
<code>Parsing.Assignments.#nnn</code>, dict-merges them with the previous block's
|
||||
volatile state, and writes the resulting per-block dictionary into
|
||||
<code>Vars.Volatile</code>.</p>
|
||||
<p>
|
||||
Lifetime is bounded by <code>MachiningSession</code>: within one session the
|
||||
dictionary carries forward block-by-block via this syntax; session restart
|
||||
abandons the SyntaxPiece JSON dataflow and starts fresh. Program-end
|
||||
(M02/M30) clearing is handled by <a class="xref" href="Hi.NcParsers.LogicSyntaxs.ProgramEndCleanSyntax.html">ProgramEndCleanSyntax</a>.
|
||||
</p>
|
||||
<p>
|
||||
Only literal numeric RHS values are consumed by this syntax
|
||||
(<code>#124 = 15.</code> ✓; <code>#100 = #1 + 5</code> ✗). Non-literal RHS entries
|
||||
are left untouched in <code>Parsing.Assignments</code>; <a class="xref" href="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.html">VariableEvaluatorSyntax</a>
|
||||
resolves them and writes the result into the same per-block dictionary.
|
||||
The two syntaxes are decoupled — the evaluator's lookup tracebacks via
|
||||
<code>SyntaxPiece</code> linkage so it does not depend on having run before
|
||||
or after this syntax.
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -695,6 +695,80 @@ reported <a class="xref" href="Hi.NcParsers.NcDiagnostic.html">NcDiagnostic</a>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_NcDiagnosticProgress_UnsupportedMessage_" data-uid="Hi.NcParsers.NcDiagnosticProgress.UnsupportedMessage*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_NcDiagnosticProgress_UnsupportedMessage_Hi_NcParsers_Sentence_System_String_System_String_System_Object_" data-uid="Hi.NcParsers.NcDiagnosticProgress.UnsupportedMessage(Hi.NcParsers.Sentence,System.String,System.String,System.Object)">
|
||||
UnsupportedMessage(Sentence, string, string, object)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Emits <a class="xref" href="Hi.NcParsers.NcDiagnosticCategory.html#Hi_NcParsers_NcDiagnosticCategory_Unsupported">Unsupported</a> + <a class="xref" href="Hi.NcParsers.NcDiagnosticSeverity.html#Hi_NcParsers_NcDiagnosticSeverity_Message">Message</a> located at <code class="paramref">sentence</code>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void UnsupportedMessage(Sentence sentence, string id, string text, object detail = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>sentence</code> <a class="xref" href="Hi.NcParsers.Sentence.html">Sentence</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>id</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>text</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>detail</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_NcDiagnosticProgress_UnsupportedMessage_" data-uid="Hi.NcParsers.NcDiagnosticProgress.UnsupportedMessage*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_NcDiagnosticProgress_UnsupportedMessage_System_String_System_String_System_Object_" data-uid="Hi.NcParsers.NcDiagnosticProgress.UnsupportedMessage(System.String,System.String,System.Object)">
|
||||
UnsupportedMessage(string, string, object)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Emits <a class="xref" href="Hi.NcParsers.NcDiagnosticCategory.html#Hi_NcParsers_NcDiagnosticCategory_Unsupported">Unsupported</a> + <a class="xref" href="Hi.NcParsers.NcDiagnosticSeverity.html#Hi_NcParsers_NcDiagnosticSeverity_Message">Message</a> (recognized, intentionally not simulated, considered safe / no-op offline).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void UnsupportedMessage(string id, string text, object detail = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>id</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>text</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>detail</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_NcDiagnosticProgress_UnsupportedWarning_" data-uid="Hi.NcParsers.NcDiagnosticProgress.UnsupportedWarning*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_NcDiagnosticProgress_UnsupportedWarning_Hi_NcParsers_Sentence_System_String_System_String_System_Object_" data-uid="Hi.NcParsers.NcDiagnosticProgress.UnsupportedWarning(Hi.NcParsers.Sentence,System.String,System.String,System.Object)">
|
||||
|
||||
+32
-28
@@ -2,11 +2,11 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class ProgramBoundarySyntax | HiAPI-C# 2025 </title>
|
||||
<title>Class FanucProgramNumberSyntax | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class ProgramBoundarySyntax | HiAPI-C# 2025 ">
|
||||
<meta name="title" content="Class FanucProgramNumberSyntax | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Detects program boundary markers: leading % tape header or O program number after a prior boundary, and records them under on the block JSON.">
|
||||
<meta name="description" content="Detects a Fanuc-family program identifier header — O1234 or &lt;O1234&gt; — that follows a line, and records it under on the block JSON. The wrapping form (bare vs angle-bracketed) is preserved in so the block can be emitted back to its original notation.">
|
||||
<link rel="icon" href="../img/HiAPI.favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
@@ -84,12 +84,12 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.NcParsers.ParsingSyntaxs.ProgramBoundarySyntax">
|
||||
<article data-uid="Hi.NcParsers.ParsingSyntaxs.FanucProgramNumberSyntax">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_ParsingSyntaxs_ProgramBoundarySyntax" data-uid="Hi.NcParsers.ParsingSyntaxs.ProgramBoundarySyntax" class="text-break">
|
||||
Class ProgramBoundarySyntax
|
||||
<h1 id="Hi_NcParsers_ParsingSyntaxs_FanucProgramNumberSyntax" data-uid="Hi.NcParsers.ParsingSyntaxs.FanucProgramNumberSyntax" class="text-break">
|
||||
Class FanucProgramNumberSyntax
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
@@ -97,13 +97,17 @@ Class ProgramBoundarySyntax
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Detects program boundary markers: leading <code>%</code> tape header or <code>O</code> program number after a prior boundary,
|
||||
and records them under <a class="xref" href="Hi.NcParsers.Keywords.ProgramBoundary.html">ProgramBoundary</a> on the block JSON.</p>
|
||||
<div class="markdown summary"><p>Detects a Fanuc-family program identifier header — <code>O1234</code> or
|
||||
<code><O1234></code> — that follows a <a class="xref" href="Hi.NcParsers.Keywords.TapeBoundary.html">TapeBoundary</a>
|
||||
line, and records it under <a class="xref" href="Hi.NcParsers.Keywords.FanucProgramNumber.html">FanucProgramNumber</a> on the
|
||||
block JSON. The wrapping form (bare vs angle-bracketed) is preserved
|
||||
in <a class="xref" href="Hi.NcParsers.Keywords.FanucProgramNumber.html#Hi_NcParsers_Keywords_FanucProgramNumber_Wrapper">Wrapper</a> so the block can be emitted
|
||||
back to its original notation.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ProgramBoundarySyntax : ISituNcSyntax, INcSyntax, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class FanucProgramNumberSyntax : ISituNcSyntax, INcSyntax, IMakeXmlSource</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -113,7 +117,7 @@ and records them under <a class="xref" href="Hi.NcParsers.Keywords.ProgramBounda
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">ProgramBoundarySyntax</span></div>
|
||||
<div><span class="xref">FanucProgramNumberSyntax</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -187,10 +191,10 @@ and records them under <a class="xref" href="Hi.NcParsers.Keywords.ProgramBounda
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_ParsingSyntaxs_ProgramBoundarySyntax__ctor_" data-uid="Hi.NcParsers.ParsingSyntaxs.ProgramBoundarySyntax.#ctor*"></a>
|
||||
<a id="Hi_NcParsers_ParsingSyntaxs_FanucProgramNumberSyntax__ctor_" data-uid="Hi.NcParsers.ParsingSyntaxs.FanucProgramNumberSyntax.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_ParsingSyntaxs_ProgramBoundarySyntax__ctor" data-uid="Hi.NcParsers.ParsingSyntaxs.ProgramBoundarySyntax.#ctor">
|
||||
ProgramBoundarySyntax()
|
||||
<h3 id="Hi_NcParsers_ParsingSyntaxs_FanucProgramNumberSyntax__ctor" data-uid="Hi.NcParsers.ParsingSyntaxs.FanucProgramNumberSyntax.#ctor">
|
||||
FanucProgramNumberSyntax()
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -199,7 +203,7 @@ and records them under <a class="xref" href="Hi.NcParsers.Keywords.ProgramBounda
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ProgramBoundarySyntax()</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public FanucProgramNumberSyntax()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -214,10 +218,10 @@ and records them under <a class="xref" href="Hi.NcParsers.Keywords.ProgramBounda
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_ParsingSyntaxs_ProgramBoundarySyntax__ctor_" data-uid="Hi.NcParsers.ParsingSyntaxs.ProgramBoundarySyntax.#ctor*"></a>
|
||||
<a id="Hi_NcParsers_ParsingSyntaxs_FanucProgramNumberSyntax__ctor_" data-uid="Hi.NcParsers.ParsingSyntaxs.FanucProgramNumberSyntax.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_ParsingSyntaxs_ProgramBoundarySyntax__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.ParsingSyntaxs.ProgramBoundarySyntax.#ctor(System.Xml.Linq.XElement)">
|
||||
ProgramBoundarySyntax(XElement)
|
||||
<h3 id="Hi_NcParsers_ParsingSyntaxs_FanucProgramNumberSyntax__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.ParsingSyntaxs.FanucProgramNumberSyntax.#ctor(System.Xml.Linq.XElement)">
|
||||
FanucProgramNumberSyntax(XElement)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -226,13 +230,13 @@ and records them under <a class="xref" href="Hi.NcParsers.Keywords.ProgramBounda
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ProgramBoundarySyntax(XElement src)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public FanucProgramNumberSyntax(XElement src)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
|
||||
<dd><p>Root element named <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.ProgramBoundarySyntax.html#Hi_NcParsers_ParsingSyntaxs_ProgramBoundarySyntax_XName">XName</a>.</p>
|
||||
<dd><p>Root element named <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.FanucProgramNumberSyntax.html#Hi_NcParsers_ParsingSyntaxs_FanucProgramNumberSyntax_XName">XName</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -251,9 +255,9 @@ and records them under <a class="xref" href="Hi.NcParsers.Keywords.ProgramBounda
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_ParsingSyntaxs_ProgramBoundarySyntax_Name_" data-uid="Hi.NcParsers.ParsingSyntaxs.ProgramBoundarySyntax.Name*"></a>
|
||||
<a id="Hi_NcParsers_ParsingSyntaxs_FanucProgramNumberSyntax_Name_" data-uid="Hi.NcParsers.ParsingSyntaxs.FanucProgramNumberSyntax.Name*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_ParsingSyntaxs_ProgramBoundarySyntax_Name" data-uid="Hi.NcParsers.ParsingSyntaxs.ProgramBoundarySyntax.Name">
|
||||
<h3 id="Hi_NcParsers_ParsingSyntaxs_FanucProgramNumberSyntax_Name" data-uid="Hi.NcParsers.ParsingSyntaxs.FanucProgramNumberSyntax.Name">
|
||||
Name
|
||||
|
||||
</h3>
|
||||
@@ -283,9 +287,9 @@ and records them under <a class="xref" href="Hi.NcParsers.Keywords.ProgramBounda
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_ParsingSyntaxs_ProgramBoundarySyntax_XName_" data-uid="Hi.NcParsers.ParsingSyntaxs.ProgramBoundarySyntax.XName*"></a>
|
||||
<a id="Hi_NcParsers_ParsingSyntaxs_FanucProgramNumberSyntax_XName_" data-uid="Hi.NcParsers.ParsingSyntaxs.FanucProgramNumberSyntax.XName*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_ParsingSyntaxs_ProgramBoundarySyntax_XName" data-uid="Hi.NcParsers.ParsingSyntaxs.ProgramBoundarySyntax.XName">
|
||||
<h3 id="Hi_NcParsers_ParsingSyntaxs_FanucProgramNumberSyntax_XName" data-uid="Hi.NcParsers.ParsingSyntaxs.FanucProgramNumberSyntax.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
@@ -319,9 +323,9 @@ and records them under <a class="xref" href="Hi.NcParsers.Keywords.ProgramBounda
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_ParsingSyntaxs_ProgramBoundarySyntax_Build_" data-uid="Hi.NcParsers.ParsingSyntaxs.ProgramBoundarySyntax.Build*"></a>
|
||||
<a id="Hi_NcParsers_ParsingSyntaxs_FanucProgramNumberSyntax_Build_" data-uid="Hi.NcParsers.ParsingSyntaxs.FanucProgramNumberSyntax.Build*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_ParsingSyntaxs_ProgramBoundarySyntax_Build_Hi_Common_Collections_LazyLinkedListNode_Hi_NcParsers_Syntaxs_SyntaxPiece__System_Collections_Generic_List_Hi_NcParsers_Dependencys_INcDependency__Hi_NcParsers_NcDiagnosticProgress_" data-uid="Hi.NcParsers.ParsingSyntaxs.ProgramBoundarySyntax.Build(Hi.Common.Collections.LazyLinkedListNode{Hi.NcParsers.Syntaxs.SyntaxPiece},System.Collections.Generic.List{Hi.NcParsers.Dependencys.INcDependency},Hi.NcParsers.NcDiagnosticProgress)">
|
||||
<h3 id="Hi_NcParsers_ParsingSyntaxs_FanucProgramNumberSyntax_Build_Hi_Common_Collections_LazyLinkedListNode_Hi_NcParsers_Syntaxs_SyntaxPiece__System_Collections_Generic_List_Hi_NcParsers_Dependencys_INcDependency__Hi_NcParsers_NcDiagnosticProgress_" data-uid="Hi.NcParsers.ParsingSyntaxs.FanucProgramNumberSyntax.Build(Hi.Common.Collections.LazyLinkedListNode{Hi.NcParsers.Syntaxs.SyntaxPiece},System.Collections.Generic.List{Hi.NcParsers.Dependencys.INcDependency},Hi.NcParsers.NcDiagnosticProgress)">
|
||||
Build(LazyLinkedListNode<SyntaxPiece>, List<INcDependency>, NcDiagnosticProgress)
|
||||
|
||||
</h3>
|
||||
@@ -356,9 +360,9 @@ and records them under <a class="xref" href="Hi.NcParsers.Keywords.ProgramBounda
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_ParsingSyntaxs_ProgramBoundarySyntax_MakeXmlSource_" data-uid="Hi.NcParsers.ParsingSyntaxs.ProgramBoundarySyntax.MakeXmlSource*"></a>
|
||||
<a id="Hi_NcParsers_ParsingSyntaxs_FanucProgramNumberSyntax_MakeXmlSource_" data-uid="Hi.NcParsers.ParsingSyntaxs.FanucProgramNumberSyntax.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_ParsingSyntaxs_ProgramBoundarySyntax_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.ParsingSyntaxs.ProgramBoundarySyntax.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
<h3 id="Hi_NcParsers_ParsingSyntaxs_FanucProgramNumberSyntax_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.ParsingSyntaxs.FanucProgramNumberSyntax.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
@@ -398,7 +402,7 @@ This method may also generate additional resources such as related files.</p>
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_NcParsers_ParsingSyntaxs_ProgramBoundarySyntax_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<h4 class="section" id="Hi_NcParsers_ParsingSyntaxs_FanucProgramNumberSyntax_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
@@ -0,0 +1,478 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class TapeBoundarySyntax | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class TapeBoundarySyntax | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Detects the % tape leader / trailer at the start of a block and records it under on the block JSON. Universal across ISO controllers (Fanuc, Mazak, Syntec, Siemens) — a brand's program-identifier header (e.g. Fanuc O1234) is a separate concern handled by its own brand-specific syntax.">
|
||||
<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.ParsingSyntaxs.TapeBoundarySyntax">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_NcParsers_ParsingSyntaxs_TapeBoundarySyntax" data-uid="Hi.NcParsers.ParsingSyntaxs.TapeBoundarySyntax" class="text-break">
|
||||
Class TapeBoundarySyntax
|
||||
</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>.<a class="xref" href="Hi.NcParsers.ParsingSyntaxs.html">ParsingSyntaxs</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Detects the <code>%</code> tape leader / trailer at the start of a block
|
||||
and records it under <a class="xref" href="Hi.NcParsers.Keywords.TapeBoundary.html">TapeBoundary</a> on the block JSON.
|
||||
Universal across ISO controllers (Fanuc, Mazak, Syntec, Siemens) —
|
||||
a brand's program-identifier header (e.g. Fanuc <code>O1234</code>) is a
|
||||
separate concern handled by its own brand-specific syntax.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class TapeBoundarySyntax : ISituNcSyntax, INcSyntax, IMakeXmlSource</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">TapeBoundarySyntax</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.NcParsers.Syntaxs.ISituNcSyntax.html">ISituNcSyntax</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.Syntaxs.INcSyntax.html">INcSyntax</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></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>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_ParsingSyntaxs_TapeBoundarySyntax__ctor_" data-uid="Hi.NcParsers.ParsingSyntaxs.TapeBoundarySyntax.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_ParsingSyntaxs_TapeBoundarySyntax__ctor" data-uid="Hi.NcParsers.ParsingSyntaxs.TapeBoundarySyntax.#ctor">
|
||||
TapeBoundarySyntax()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Parameterless instance for bundle composition (no XML state).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public TapeBoundarySyntax()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_ParsingSyntaxs_TapeBoundarySyntax__ctor_" data-uid="Hi.NcParsers.ParsingSyntaxs.TapeBoundarySyntax.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_ParsingSyntaxs_TapeBoundarySyntax__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.ParsingSyntaxs.TapeBoundarySyntax.#ctor(System.Xml.Linq.XElement)">
|
||||
TapeBoundarySyntax(XElement)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>XML ctor (no child elements; reserved for forward compatibility).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public TapeBoundarySyntax(XElement src)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
|
||||
<dd><p>Root element named <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.TapeBoundarySyntax.html#Hi_NcParsers_ParsingSyntaxs_TapeBoundarySyntax_XName">XName</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_ParsingSyntaxs_TapeBoundarySyntax_Name_" data-uid="Hi.NcParsers.ParsingSyntaxs.TapeBoundarySyntax.Name*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_ParsingSyntaxs_TapeBoundarySyntax_Name" data-uid="Hi.NcParsers.ParsingSyntaxs.TapeBoundarySyntax.Name">
|
||||
Name
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Syntax kind name (typically the concrete type name).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Name { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_ParsingSyntaxs_TapeBoundarySyntax_XName_" data-uid="Hi.NcParsers.ParsingSyntaxs.TapeBoundarySyntax.XName*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_ParsingSyntaxs_TapeBoundarySyntax_XName" data-uid="Hi.NcParsers.ParsingSyntaxs.TapeBoundarySyntax.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>XML element name for <a class="xref" href="Hi.Common.XmlUtils.XFactory.html#Hi_Common_XmlUtils_XFactory_Regs">Regs</a> registration.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string XName { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_ParsingSyntaxs_TapeBoundarySyntax_Build_" data-uid="Hi.NcParsers.ParsingSyntaxs.TapeBoundarySyntax.Build*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_ParsingSyntaxs_TapeBoundarySyntax_Build_Hi_Common_Collections_LazyLinkedListNode_Hi_NcParsers_Syntaxs_SyntaxPiece__System_Collections_Generic_List_Hi_NcParsers_Dependencys_INcDependency__Hi_NcParsers_NcDiagnosticProgress_" data-uid="Hi.NcParsers.ParsingSyntaxs.TapeBoundarySyntax.Build(Hi.Common.Collections.LazyLinkedListNode{Hi.NcParsers.Syntaxs.SyntaxPiece},System.Collections.Generic.List{Hi.NcParsers.Dependencys.INcDependency},Hi.NcParsers.NcDiagnosticProgress)">
|
||||
Build(LazyLinkedListNode<SyntaxPiece>, List<INcDependency>, NcDiagnosticProgress)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Build syntax arrangement into the
|
||||
<code class="paramref">syntaxPieceNode</code> in-place.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void Build(LazyLinkedListNode<SyntaxPiece> syntaxPieceNode, List<INcDependency> ncDependencyList, NcDiagnosticProgress ncDiagnosticProgress)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>syntaxPieceNode</code> <a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html">LazyLinkedListNode</a><<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>ncDependencyList</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a><<a class="xref" href="Hi.NcParsers.Dependencys.INcDependency.html">INcDependency</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>ncDiagnosticProgress</code> <a class="xref" href="Hi.NcParsers.NcDiagnosticProgress.html">NcDiagnosticProgress</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_ParsingSyntaxs_TapeBoundarySyntax_IsPreviousNodeTapeBoundary_" data-uid="Hi.NcParsers.ParsingSyntaxs.TapeBoundarySyntax.IsPreviousNodeTapeBoundary*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_ParsingSyntaxs_TapeBoundarySyntax_IsPreviousNodeTapeBoundary_Hi_Common_Collections_LazyLinkedListNode_Hi_NcParsers_Syntaxs_SyntaxPiece__" data-uid="Hi.NcParsers.ParsingSyntaxs.TapeBoundarySyntax.IsPreviousNodeTapeBoundary(Hi.Common.Collections.LazyLinkedListNode{Hi.NcParsers.Syntaxs.SyntaxPiece})">
|
||||
IsPreviousNodeTapeBoundary(LazyLinkedListNode<SyntaxPiece>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Returns true if the previous block carries a <a class="xref" href="Hi.NcParsers.Keywords.TapeBoundary.html">TapeBoundary</a>
|
||||
section, or if there is no previous block at all (start-of-stream is
|
||||
itself a tape boundary). Brand-specific program-identifier syntaxes use
|
||||
this to decide whether the current block can host a program-number
|
||||
header.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static bool IsPreviousNodeTapeBoundary(LazyLinkedListNode<SyntaxPiece> node)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>node</code> <a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html">LazyLinkedListNode</a><<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_ParsingSyntaxs_TapeBoundarySyntax_MakeXmlSource_" data-uid="Hi.NcParsers.ParsingSyntaxs.TapeBoundarySyntax.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_ParsingSyntaxs_TapeBoundarySyntax_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.ParsingSyntaxs.TapeBoundarySyntax.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Creates an XML representation of the object.
|
||||
This method may also generate additional resources such as related files.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The base directory for resolving relative paths</p>
|
||||
</dd>
|
||||
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The relative file path for the XML source</p>
|
||||
</dd>
|
||||
<dt><code>exhibitionOnly</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p>if true, the extended file creation is suppressed.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
|
||||
<dd><p>An XML element representing the object's state</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_NcParsers_ParsingSyntaxs_TapeBoundarySyntax_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
@@ -121,6 +121,16 @@ regardless of the skip switch.</li></ul>
|
||||
<a class="xref" href="Hi.NcParsers.ParsingSyntaxs.CsScriptSyntax.html#Hi_NcParsers_ParsingSyntaxs_CsScriptSyntax_PreMarker">PreMarker</a> marks a script that runs before the NC block;
|
||||
<a class="xref" href="Hi.NcParsers.ParsingSyntaxs.CsScriptSyntax.html#Hi_NcParsers_ParsingSyntaxs_CsScriptSyntax_PostMarker">PostMarker</a> marks a script that runs after.
|
||||
The symbols are configurable and serialized to XML.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.ParsingSyntaxs.FanucProgramNumberSyntax.html">FanucProgramNumberSyntax</a></dt>
|
||||
<dd><p>Detects a Fanuc-family program identifier header — <code>O1234</code> or
|
||||
<code><O1234></code> — that follows a <a class="xref" href="Hi.NcParsers.Keywords.TapeBoundary.html">TapeBoundary</a>
|
||||
line, and records it under <a class="xref" href="Hi.NcParsers.Keywords.FanucProgramNumber.html">FanucProgramNumber</a> on the
|
||||
block JSON. The wrapping form (bare vs angle-bracketed) is preserved
|
||||
in <a class="xref" href="Hi.NcParsers.Keywords.FanucProgramNumber.html#Hi_NcParsers_Keywords_FanucProgramNumber_Wrapper">Wrapper</a> so the block can be emitted
|
||||
back to its original notation.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
@@ -174,12 +184,6 @@ codes are kept as-is.
|
||||
This is essentially a combination of main flag matching (like <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.NumberedFlagSyntax.html">NumberedFlagSyntax</a>)
|
||||
plus scoped <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.TagValueSyntax.html">TagValueSyntax</a> for the parameters after the main flag.
|
||||
Note that the <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.ParameterizedFlagSyntax.html">ParameterizedFlagSyntax</a> often should be applied before <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.NumberedFlagSyntax.html">NumberedFlagSyntax</a> since <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.NumberedFlagSyntax.html">NumberedFlagSyntax</a> may eat the text that <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.ParameterizedFlagSyntax.html">ParameterizedFlagSyntax</a> should handle.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.ParsingSyntaxs.ProgramBoundarySyntax.html">ProgramBoundarySyntax</a></dt>
|
||||
<dd><p>Detects program boundary markers: leading <code>%</code> tape header or <code>O</code> program number after a prior boundary,
|
||||
and records them under <a class="xref" href="Hi.NcParsers.Keywords.ProgramBoundary.html">ProgramBoundary</a> on the block JSON.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
@@ -208,6 +212,15 @@ this class handles explicit assignment statements.</p>
|
||||
ex.
|
||||
Heidenhain: L X Q2 Y33.4 FQ1
|
||||
ISO: X100.3Y3.3</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.NcParsers.ParsingSyntaxs.TapeBoundarySyntax.html">TapeBoundarySyntax</a></dt>
|
||||
<dd><p>Detects the <code>%</code> tape leader / trailer at the start of a block
|
||||
and records it under <a class="xref" href="Hi.NcParsers.Keywords.TapeBoundary.html">TapeBoundary</a> on the block JSON.
|
||||
Universal across ISO controllers (Fanuc, Mazak, Syntec, Siemens) —
|
||||
a brand's program-identifier header (e.g. Fanuc <code>O1234</code>) is a
|
||||
separate concern handled by its own brand-specific syntax.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -313,10 +313,11 @@ authored values (the latter have no
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Default-configured <a class="xref" href="Hi.NcParsers.PostLogicSyntaxs.ModalCarrySyntax.html">ModalCarrySyntax</a> with the standard
|
||||
modal sections (<code>TiltTransform</code>, <code>PathSmoothing</code>,
|
||||
<code>IsoLocalCoordinateOffset</code>, <code>CannedCycle</code>, <code>MotionState</code>,
|
||||
<code>MachineCoordinateState</code>) tracked.</p>
|
||||
<div class="markdown level1 summary"><p>Full-set carrier (<a class="xref" href="Hi.NcParsers.PostLogicSyntaxs.ModalCarrySyntax.html#Hi_NcParsers_PostLogicSyntaxs_ModalCarrySyntax_Logic">Logic</a> ∪ <a class="xref" href="Hi.NcParsers.PostLogicSyntaxs.ModalCarrySyntax.html#Hi_NcParsers_PostLogicSyntaxs_ModalCarrySyntax_PostLogic">PostLogic</a>) —
|
||||
retained for the legacy backstop in
|
||||
<a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a> that appends a single ModalCarry to
|
||||
pre-3.1.168 project syntax lists. New brand syntax kits should
|
||||
split into <a class="xref" href="Hi.NcParsers.PostLogicSyntaxs.ModalCarrySyntax.html#Hi_NcParsers_PostLogicSyntaxs_ModalCarrySyntax_Logic">Logic</a> + <a class="xref" href="Hi.NcParsers.PostLogicSyntaxs.ModalCarrySyntax.html#Hi_NcParsers_PostLogicSyntaxs_ModalCarrySyntax_PostLogic">PostLogic</a> instead.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -341,6 +342,45 @@ modal sections (<code>TiltTransform</code>, <code>PathSmoothing</code>,
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_PostLogicSyntaxs_ModalCarrySyntax_Logic_" data-uid="Hi.NcParsers.PostLogicSyntaxs.ModalCarrySyntax.Logic*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_PostLogicSyntaxs_ModalCarrySyntax_Logic" data-uid="Hi.NcParsers.PostLogicSyntaxs.ModalCarrySyntax.Logic">
|
||||
Logic
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Logic-stage carrier — modal sections that are written in the Logic
|
||||
bundle and never mutated by PostLogic. Carrying these at the end of
|
||||
each block's Logic bundle keeps single-step
|
||||
<code>node.Previous</code> modal lookups from Logic syntaxes correct, even
|
||||
when a PostLogic syntax (e.g.
|
||||
<a class="xref" href="Hi.NcParsers.PostLogicSyntaxs.RadiusCompensationSyntax.html">RadiusCompensationSyntax</a>) does <code>node.Next</code>
|
||||
look-forward and drags subsequent blocks' Logic builds forward
|
||||
before the intermediate block's PostLogic ModalCarry has run.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static ModalCarrySyntax Logic { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.NcParsers.PostLogicSyntaxs.ModalCarrySyntax.html">ModalCarrySyntax</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_PostLogicSyntaxs_ModalCarrySyntax_Name_" data-uid="Hi.NcParsers.PostLogicSyntaxs.ModalCarrySyntax.Name*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_PostLogicSyntaxs_ModalCarrySyntax_Name" data-uid="Hi.NcParsers.PostLogicSyntaxs.ModalCarrySyntax.Name">
|
||||
@@ -373,6 +413,43 @@ modal sections (<code>TiltTransform</code>, <code>PathSmoothing</code>,
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_PostLogicSyntaxs_ModalCarrySyntax_PostLogic_" data-uid="Hi.NcParsers.PostLogicSyntaxs.ModalCarrySyntax.PostLogic*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_PostLogicSyntaxs_ModalCarrySyntax_PostLogic" data-uid="Hi.NcParsers.PostLogicSyntaxs.ModalCarrySyntax.PostLogic">
|
||||
PostLogic
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>PostLogic-stage carrier — modal sections that may still be mutated
|
||||
by PostLogic syntaxes after Logic completes. Today only
|
||||
<code>MachineCoordinateState</code> qualifies (overwritten by
|
||||
<a class="xref" href="Hi.NcParsers.PostLogicSyntaxs.RadiusCompensationSyntax.html">RadiusCompensationSyntax</a> with the radius-compensated
|
||||
position). Carrying these at the end of PostLogic ensures the
|
||||
modal value reflects the final, post-compensation state.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static ModalCarrySyntax PostLogic { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.NcParsers.PostLogicSyntaxs.ModalCarrySyntax.html">ModalCarrySyntax</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_PostLogicSyntaxs_ModalCarrySyntax_TrackedKeys_" data-uid="Hi.NcParsers.PostLogicSyntaxs.ModalCarrySyntax.TrackedKeys*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_PostLogicSyntaxs_ModalCarrySyntax_TrackedKeys" data-uid="Hi.NcParsers.PostLogicSyntaxs.ModalCarrySyntax.TrackedKeys">
|
||||
|
||||
@@ -641,10 +641,10 @@ present on the chain into the <a class="xref" href="Hi.NcParsers.Dependencys.IMa
|
||||
<a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_NcDependencyList">NcDependencyList</a> (linear or rotary, derived from
|
||||
whether the chain's transformer implements
|
||||
<a class="xref" href="Hi.Mech.Topo.IDynamicRotation.html">IDynamicRotation</a>). When the chain carries any rotary
|
||||
axis, a <a class="xref" href="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.html">NcKinematicsDependency</a> is appended so that
|
||||
axis, a <a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.html">NcKinematicsDependency</a> is appended so that
|
||||
downstream syntaxes / semantics (e.g. <code>G53.1</code>, <code>G68.2</code>,
|
||||
<a class="xref" href="Hi.NcParsers.Semantics.McLinearMotionSemantic.html">McLinearMotionSemantic</a>) can resolve
|
||||
orientation; its <a class="xref" href="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.html#Hi_NcParsers_Dependencys_Generic_NcKinematicsDependency_KinematicsProvider">KinematicsProvider</a>
|
||||
orientation; its <a class="xref" href="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.html#Hi_NcParsers_Dependencys_SystemWired_NcKinematicsDependency_KinematicsProvider">KinematicsProvider</a>
|
||||
is intentionally left null — the owning project service wires it up
|
||||
after the solver instance is available (see
|
||||
<code>LocalProjectService.BuildCoordinateConverter</code>).</p>
|
||||
|
||||
@@ -403,6 +403,42 @@ until cancelled by G67.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Syntaxs_FanucSyntaxUtil_M198Syntax_" data-uid="Hi.NcParsers.Syntaxs.FanucSyntaxUtil.M198Syntax*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Syntaxs_FanucSyntaxUtil_M198Syntax" data-uid="Hi.NcParsers.Syntaxs.FanucSyntaxUtil.M198Syntax">
|
||||
M198Syntax
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>M198: Fanuc subprogram call from external storage (memory card,
|
||||
USB, DNC drive). Same parameter shape as <a class="xref" href="Hi.NcParsers.Syntaxs.FanucSyntaxUtil.html#Hi_NcParsers_Syntaxs_FanucSyntaxUtil_M98Syntax">M98Syntax</a>;
|
||||
only the lookup root differs (see
|
||||
<a class="xref" href="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.html#Hi_NcParsers_Dependencys_Generic_SubProgramFolderConfig_ExternalFolder">ExternalFolder</a>).
|
||||
M198 P{program} [L{repeat}]</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static ParameterizedFlagSyntax M198Syntax { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.NcParsers.ParsingSyntaxs.ParameterizedFlagSyntax.html">ParameterizedFlagSyntax</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Syntaxs_FanucSyntaxUtil_M98Syntax_" data-uid="Hi.NcParsers.Syntaxs.FanucSyntaxUtil.M98Syntax*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Syntaxs_FanucSyntaxUtil_M98Syntax" data-uid="Hi.NcParsers.Syntaxs.FanucSyntaxUtil.M98Syntax">
|
||||
|
||||
@@ -298,6 +298,45 @@ to store typed values at parse time.
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_Syntaxs_SyntaxPiece_SentenceIndex_" data-uid="Hi.NcParsers.Syntaxs.SyntaxPiece.SentenceIndex*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_Syntaxs_SyntaxPiece_SentenceIndex" data-uid="Hi.NcParsers.Syntaxs.SyntaxPiece.SentenceIndex">
|
||||
SentenceIndex
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>0-based ordinal in NC execution order. Stamped at piece construction
|
||||
time by <a class="xref" href="Hi.NcParsers.Segmenters.ISegmenter.html">GetSyntaxPieces(ISegmenter, LazyLinkedList<IndexedFileLine>, int, NcDiagnosticProgress, CancellationToken)</a> from the destination
|
||||
<code>layers[0]</code>'s running count, so subprogram pieces inlined by
|
||||
<code>SubProgramCallSyntax</code> get sequential indices that interleave
|
||||
correctly between host blocks. Useful as a cross-process alignment
|
||||
key (messages, ClStripPos, MachiningStep) — unlike
|
||||
<code>FileLineUtil.MixedIndex()</code>, it reflects execution order rather
|
||||
than (FileIndex, LineIndex) source order.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int SentenceIndex { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
+36
-36
@@ -6,7 +6,7 @@
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class EnablingWrapper | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Wrapper for shell commands that provides enable/disable functionality.">
|
||||
<meta name="description" content="Wrapper for session commands that provides enable/disable functionality.">
|
||||
<link rel="icon" href="../img/HiAPI.favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
@@ -84,25 +84,25 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ShellCommands.EnablingWrapper">
|
||||
<article data-uid="Hi.SessionCommands.EnablingWrapper">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_ShellCommands_EnablingWrapper" data-uid="Hi.ShellCommands.EnablingWrapper" class="text-break">
|
||||
<h1 id="Hi_SessionCommands_EnablingWrapper" data-uid="Hi.SessionCommands.EnablingWrapper" class="text-break">
|
||||
Class EnablingWrapper
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.ShellCommands.html">ShellCommands</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.SessionCommands.html">SessionCommands</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Wrapper for shell commands that provides enable/disable functionality.</p>
|
||||
<div class="markdown summary"><p>Wrapper for session commands that provides enable/disable functionality.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class EnablingWrapper : IShellCommand, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class EnablingWrapper : ISessionCommand, IMakeXmlSource</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -119,7 +119,7 @@ Class EnablingWrapper
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.ShellCommands.IShellCommand.html">IShellCommand</a></div>
|
||||
<div><a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -185,9 +185,9 @@ Class EnablingWrapper
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_EnablingWrapper__ctor_" data-uid="Hi.ShellCommands.EnablingWrapper.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_EnablingWrapper__ctor_" data-uid="Hi.SessionCommands.EnablingWrapper.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_EnablingWrapper__ctor" data-uid="Hi.ShellCommands.EnablingWrapper.#ctor">
|
||||
<h3 id="Hi_SessionCommands_EnablingWrapper__ctor" data-uid="Hi.SessionCommands.EnablingWrapper.#ctor">
|
||||
EnablingWrapper()
|
||||
|
||||
</h3>
|
||||
@@ -212,24 +212,24 @@ Class EnablingWrapper
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_EnablingWrapper__ctor_" data-uid="Hi.ShellCommands.EnablingWrapper.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_EnablingWrapper__ctor_" data-uid="Hi.SessionCommands.EnablingWrapper.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_EnablingWrapper__ctor_Hi_ShellCommands_IShellCommand_" data-uid="Hi.ShellCommands.EnablingWrapper.#ctor(Hi.ShellCommands.IShellCommand)">
|
||||
EnablingWrapper(IShellCommand)
|
||||
<h3 id="Hi_SessionCommands_EnablingWrapper__ctor_Hi_SessionCommands_ISessionCommand_" data-uid="Hi.SessionCommands.EnablingWrapper.#ctor(Hi.SessionCommands.ISessionCommand)">
|
||||
EnablingWrapper(ISessionCommand)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.ShellCommands.EnablingWrapper.html">EnablingWrapper</a> class with the specified command.</p>
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.SessionCommands.EnablingWrapper.html">EnablingWrapper</a> class with the specified command.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public EnablingWrapper(IShellCommand command)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public EnablingWrapper(ISessionCommand command)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>command</code> <a class="xref" href="Hi.ShellCommands.IShellCommand.html">IShellCommand</a></dt>
|
||||
<dt><code>command</code> <a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a></dt>
|
||||
<dd><p>The command to wrap.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -245,9 +245,9 @@ Class EnablingWrapper
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_EnablingWrapper__ctor_" data-uid="Hi.ShellCommands.EnablingWrapper.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_EnablingWrapper__ctor_" data-uid="Hi.SessionCommands.EnablingWrapper.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_EnablingWrapper__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_System_Object__System_Object___" data-uid="Hi.ShellCommands.EnablingWrapper.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{System.Object},System.Object[])">
|
||||
<h3 id="Hi_SessionCommands_EnablingWrapper__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_System_Object__System_Object___" data-uid="Hi.SessionCommands.EnablingWrapper.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{System.Object},System.Object[])">
|
||||
EnablingWrapper(XElement, string, string, IProgress<object>, object[])
|
||||
|
||||
</h3>
|
||||
@@ -294,19 +294,19 @@ Class EnablingWrapper
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_EnablingWrapper_Command_" data-uid="Hi.ShellCommands.EnablingWrapper.Command*"></a>
|
||||
<a id="Hi_SessionCommands_EnablingWrapper_Command_" data-uid="Hi.SessionCommands.EnablingWrapper.Command*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_EnablingWrapper_Command" data-uid="Hi.ShellCommands.EnablingWrapper.Command">
|
||||
<h3 id="Hi_SessionCommands_EnablingWrapper_Command" data-uid="Hi.SessionCommands.EnablingWrapper.Command">
|
||||
Command
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets or sets the wrapped shell command.</p>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the wrapped session command.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IShellCommand Command { get; set; }</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public ISessionCommand Command { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -315,7 +315,7 @@ Class EnablingWrapper
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.ShellCommands.IShellCommand.html">IShellCommand</a></dt>
|
||||
<dt><a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
@@ -326,9 +326,9 @@ Class EnablingWrapper
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_EnablingWrapper_IsEnabled_" data-uid="Hi.ShellCommands.EnablingWrapper.IsEnabled*"></a>
|
||||
<a id="Hi_SessionCommands_EnablingWrapper_IsEnabled_" data-uid="Hi.SessionCommands.EnablingWrapper.IsEnabled*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_EnablingWrapper_IsEnabled" data-uid="Hi.ShellCommands.EnablingWrapper.IsEnabled">
|
||||
<h3 id="Hi_SessionCommands_EnablingWrapper_IsEnabled" data-uid="Hi.SessionCommands.EnablingWrapper.IsEnabled">
|
||||
IsEnabled
|
||||
|
||||
</h3>
|
||||
@@ -358,9 +358,9 @@ Class EnablingWrapper
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_EnablingWrapper_XName_" data-uid="Hi.ShellCommands.EnablingWrapper.XName*"></a>
|
||||
<a id="Hi_SessionCommands_EnablingWrapper_XName_" data-uid="Hi.SessionCommands.EnablingWrapper.XName*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_EnablingWrapper_XName" data-uid="Hi.ShellCommands.EnablingWrapper.XName">
|
||||
<h3 id="Hi_SessionCommands_EnablingWrapper_XName" data-uid="Hi.SessionCommands.EnablingWrapper.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
@@ -394,9 +394,9 @@ Class EnablingWrapper
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_EnablingWrapper_MakeXmlSource_" data-uid="Hi.ShellCommands.EnablingWrapper.MakeXmlSource*"></a>
|
||||
<a id="Hi_SessionCommands_EnablingWrapper_MakeXmlSource_" data-uid="Hi.SessionCommands.EnablingWrapper.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_EnablingWrapper_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.ShellCommands.EnablingWrapper.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
<h3 id="Hi_SessionCommands_EnablingWrapper_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.SessionCommands.EnablingWrapper.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
@@ -436,7 +436,7 @@ This method may also generate additional resources such as related files.</p>
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_ShellCommands_EnablingWrapper_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<h4 class="section" id="Hi_SessionCommands_EnablingWrapper_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
@@ -445,25 +445,25 @@ Since the folder can be moving with the configuration file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_EnablingWrapper_Run_" data-uid="Hi.ShellCommands.EnablingWrapper.Run*"></a>
|
||||
<a id="Hi_SessionCommands_EnablingWrapper_Run_" data-uid="Hi.SessionCommands.EnablingWrapper.Run*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_EnablingWrapper_Run_Hi_MachiningProcs_RuntimeApi_" data-uid="Hi.ShellCommands.EnablingWrapper.Run(Hi.MachiningProcs.RuntimeApi)">
|
||||
Run(RuntimeApi)
|
||||
<h3 id="Hi_SessionCommands_EnablingWrapper_Run_Hi_MachiningProcs_SessionShell_" data-uid="Hi.SessionCommands.EnablingWrapper.Run(Hi.MachiningProcs.SessionShell)">
|
||||
Run(SessionShell)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Runs the command using the provided script API.</p>
|
||||
<div class="markdown level1 summary"><p>Runs the command, delegating execution to the provided session shell.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(RuntimeApi scriptApi)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(SessionShell sessionShell)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
|
||||
<dd><p>Script API for executing milling commands.</p>
|
||||
<dt><code>sessionShell</code> <a class="xref" href="Hi.MachiningProcs.SessionShell.html">SessionShell</a></dt>
|
||||
<dd><p>Session shell that exposes the machining facade to commands.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+24
-24
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ShellCommands.GeomDiffCommand">
|
||||
<article data-uid="Hi.SessionCommands.GeomDiffCommand">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_ShellCommands_GeomDiffCommand" data-uid="Hi.ShellCommands.GeomDiffCommand" class="text-break">
|
||||
<h1 id="Hi_SessionCommands_GeomDiffCommand" data-uid="Hi.SessionCommands.GeomDiffCommand" class="text-break">
|
||||
Class GeomDiffCommand
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.ShellCommands.html">ShellCommands</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.SessionCommands.html">SessionCommands</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -102,7 +102,7 @@ Class GeomDiffCommand
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class GeomDiffCommand : IShellCommand, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class GeomDiffCommand : ISessionCommand, IMakeXmlSource</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -119,7 +119,7 @@ Class GeomDiffCommand
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.ShellCommands.IShellCommand.html">IShellCommand</a></div>
|
||||
<div><a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -185,9 +185,9 @@ Class GeomDiffCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_GeomDiffCommand__ctor_" data-uid="Hi.ShellCommands.GeomDiffCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_GeomDiffCommand__ctor_" data-uid="Hi.SessionCommands.GeomDiffCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_GeomDiffCommand__ctor" data-uid="Hi.ShellCommands.GeomDiffCommand.#ctor">
|
||||
<h3 id="Hi_SessionCommands_GeomDiffCommand__ctor" data-uid="Hi.SessionCommands.GeomDiffCommand.#ctor">
|
||||
GeomDiffCommand()
|
||||
|
||||
</h3>
|
||||
@@ -212,9 +212,9 @@ Class GeomDiffCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_GeomDiffCommand__ctor_" data-uid="Hi.ShellCommands.GeomDiffCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_GeomDiffCommand__ctor_" data-uid="Hi.SessionCommands.GeomDiffCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_GeomDiffCommand__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.ShellCommands.GeomDiffCommand.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
<h3 id="Hi_SessionCommands_GeomDiffCommand__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.SessionCommands.GeomDiffCommand.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
GeomDiffCommand(XElement, string)
|
||||
|
||||
</h3>
|
||||
@@ -253,7 +253,7 @@ Class GeomDiffCommand
|
||||
|
||||
|
||||
|
||||
<h3 id="Hi_ShellCommands_GeomDiffCommand_ConstDisplayName" data-uid="Hi.ShellCommands.GeomDiffCommand.ConstDisplayName">
|
||||
<h3 id="Hi_SessionCommands_GeomDiffCommand_ConstDisplayName" data-uid="Hi.SessionCommands.GeomDiffCommand.ConstDisplayName">
|
||||
ConstDisplayName
|
||||
|
||||
</h3>
|
||||
@@ -287,9 +287,9 @@ Class GeomDiffCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_GeomDiffCommand_DetectRadius_mm_" data-uid="Hi.ShellCommands.GeomDiffCommand.DetectRadius_mm*"></a>
|
||||
<a id="Hi_SessionCommands_GeomDiffCommand_DetectRadius_mm_" data-uid="Hi.SessionCommands.GeomDiffCommand.DetectRadius_mm*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_GeomDiffCommand_DetectRadius_mm" data-uid="Hi.ShellCommands.GeomDiffCommand.DetectRadius_mm">
|
||||
<h3 id="Hi_SessionCommands_GeomDiffCommand_DetectRadius_mm" data-uid="Hi.SessionCommands.GeomDiffCommand.DetectRadius_mm">
|
||||
DetectRadius_mm
|
||||
|
||||
</h3>
|
||||
@@ -319,9 +319,9 @@ Class GeomDiffCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_GeomDiffCommand_XName_" data-uid="Hi.ShellCommands.GeomDiffCommand.XName*"></a>
|
||||
<a id="Hi_SessionCommands_GeomDiffCommand_XName_" data-uid="Hi.SessionCommands.GeomDiffCommand.XName*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_GeomDiffCommand_XName" data-uid="Hi.ShellCommands.GeomDiffCommand.XName">
|
||||
<h3 id="Hi_SessionCommands_GeomDiffCommand_XName" data-uid="Hi.SessionCommands.GeomDiffCommand.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
@@ -355,9 +355,9 @@ Class GeomDiffCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_GeomDiffCommand_MakeXmlSource_" data-uid="Hi.ShellCommands.GeomDiffCommand.MakeXmlSource*"></a>
|
||||
<a id="Hi_SessionCommands_GeomDiffCommand_MakeXmlSource_" data-uid="Hi.SessionCommands.GeomDiffCommand.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_GeomDiffCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.ShellCommands.GeomDiffCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
<h3 id="Hi_SessionCommands_GeomDiffCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.SessionCommands.GeomDiffCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
@@ -397,7 +397,7 @@ This method may also generate additional resources such as related files.</p>
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_ShellCommands_GeomDiffCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<h4 class="section" id="Hi_SessionCommands_GeomDiffCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
@@ -406,25 +406,25 @@ Since the folder can be moving with the configuration file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_GeomDiffCommand_Run_" data-uid="Hi.ShellCommands.GeomDiffCommand.Run*"></a>
|
||||
<a id="Hi_SessionCommands_GeomDiffCommand_Run_" data-uid="Hi.SessionCommands.GeomDiffCommand.Run*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_GeomDiffCommand_Run_Hi_MachiningProcs_RuntimeApi_" data-uid="Hi.ShellCommands.GeomDiffCommand.Run(Hi.MachiningProcs.RuntimeApi)">
|
||||
Run(RuntimeApi)
|
||||
<h3 id="Hi_SessionCommands_GeomDiffCommand_Run_Hi_MachiningProcs_SessionShell_" data-uid="Hi.SessionCommands.GeomDiffCommand.Run(Hi.MachiningProcs.SessionShell)">
|
||||
Run(SessionShell)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Runs the command using the provided script API.</p>
|
||||
<div class="markdown level1 summary"><p>Runs the command, delegating execution to the provided session shell.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(RuntimeApi scriptApi)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(SessionShell sessionShell)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
|
||||
<dd><p>Script API for executing milling commands.</p>
|
||||
<dt><code>sessionShell</code> <a class="xref" href="Hi.MachiningProcs.SessionShell.html">SessionShell</a></dt>
|
||||
<dd><p>Session shell that exposes the machining facade to commands.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+16
-16
@@ -2,11 +2,11 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Interface IShellCommand | HiAPI-C# 2025 </title>
|
||||
<title>Interface ISessionCommand | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Interface IShellCommand | HiAPI-C# 2025 ">
|
||||
<meta name="title" content="Interface ISessionCommand | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Interface for commands that can be executed in a milling course.">
|
||||
<meta name="description" content="Interface for commands that can be executed in a machining session.">
|
||||
<link rel="icon" href="../img/HiAPI.favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
@@ -84,25 +84,25 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ShellCommands.IShellCommand">
|
||||
<article data-uid="Hi.SessionCommands.ISessionCommand">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_ShellCommands_IShellCommand" data-uid="Hi.ShellCommands.IShellCommand" class="text-break">
|
||||
Interface IShellCommand
|
||||
<h1 id="Hi_SessionCommands_ISessionCommand" data-uid="Hi.SessionCommands.ISessionCommand" class="text-break">
|
||||
Interface ISessionCommand
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.ShellCommands.html">ShellCommands</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.SessionCommands.html">SessionCommands</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Interface for commands that can be executed in a milling course.</p>
|
||||
<div class="markdown summary"><p>Interface for commands that can be executed in a machining session.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public interface IShellCommand : IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public interface ISessionCommand : IMakeXmlSource</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -153,25 +153,25 @@ Interface IShellCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_IShellCommand_Run_" data-uid="Hi.ShellCommands.IShellCommand.Run*"></a>
|
||||
<a id="Hi_SessionCommands_ISessionCommand_Run_" data-uid="Hi.SessionCommands.ISessionCommand.Run*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_IShellCommand_Run_Hi_MachiningProcs_RuntimeApi_" data-uid="Hi.ShellCommands.IShellCommand.Run(Hi.MachiningProcs.RuntimeApi)">
|
||||
Run(RuntimeApi)
|
||||
<h3 id="Hi_SessionCommands_ISessionCommand_Run_Hi_MachiningProcs_SessionShell_" data-uid="Hi.SessionCommands.ISessionCommand.Run(Hi.MachiningProcs.SessionShell)">
|
||||
Run(SessionShell)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Runs the command using the provided script API.</p>
|
||||
<div class="markdown level1 summary"><p>Runs the command, delegating execution to the provided session shell.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">IEnumerable<Action> Run(RuntimeApi scriptApi)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">IEnumerable<Action> Run(SessionShell sessionShell)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
|
||||
<dd><p>Script API for executing milling commands.</p>
|
||||
<dt><code>sessionShell</code> <a class="xref" href="Hi.MachiningProcs.SessionShell.html">SessionShell</a></dt>
|
||||
<dd><p>Session shell that exposes the machining facade to commands.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+8
-8
@@ -84,25 +84,25 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ShellCommands.ITitleCommand">
|
||||
<article data-uid="Hi.SessionCommands.ITitleCommand">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_ShellCommands_ITitleCommand" data-uid="Hi.ShellCommands.ITitleCommand" class="text-break">
|
||||
<h1 id="Hi_SessionCommands_ITitleCommand" data-uid="Hi.SessionCommands.ITitleCommand" class="text-break">
|
||||
Interface ITitleCommand
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.ShellCommands.html">ShellCommands</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.SessionCommands.html">SessionCommands</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p><a class="xref" href="Hi.ShellCommands.IShellCommand.html">IShellCommand</a> with title.</p>
|
||||
<div class="markdown summary"><p><a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a> with title.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public interface ITitleCommand : IShellCommand, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public interface ITitleCommand : ISessionCommand, IMakeXmlSource</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -115,7 +115,7 @@ Interface ITitleCommand
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="Hi.ShellCommands.IShellCommand.html#Hi_ShellCommands_IShellCommand_Run_Hi_MachiningProcs_RuntimeApi_">IShellCommand.Run(RuntimeApi)</a>
|
||||
<a class="xref" href="Hi.SessionCommands.ISessionCommand.html#Hi_SessionCommands_ISessionCommand_Run_Hi_MachiningProcs_SessionShell_">ISessionCommand.Run(SessionShell)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html#Hi_Common_XmlUtils_IMakeXmlSource_MakeXmlSource_System_String_System_String_System_Boolean_">IMakeXmlSource.MakeXmlSource(string, string, bool)</a>
|
||||
@@ -156,9 +156,9 @@ Interface ITitleCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_ITitleCommand_GetCommandTitle_" data-uid="Hi.ShellCommands.ITitleCommand.GetCommandTitle*"></a>
|
||||
<a id="Hi_SessionCommands_ITitleCommand_GetCommandTitle_" data-uid="Hi.SessionCommands.ITitleCommand.GetCommandTitle*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_ITitleCommand_GetCommandTitle" data-uid="Hi.ShellCommands.ITitleCommand.GetCommandTitle">
|
||||
<h3 id="Hi_SessionCommands_ITitleCommand_GetCommandTitle" data-uid="Hi.SessionCommands.ITitleCommand.GetCommandTitle">
|
||||
GetCommandTitle()
|
||||
|
||||
</h3>
|
||||
+3
-3
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ShellCommands.Lang">
|
||||
<article data-uid="Hi.SessionCommands.Lang">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_ShellCommands_Lang" data-uid="Hi.ShellCommands.Lang" class="text-break">
|
||||
<h1 id="Hi_SessionCommands_Lang" data-uid="Hi.SessionCommands.Lang" class="text-break">
|
||||
Class Lang
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.ShellCommands.html">ShellCommands</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.SessionCommands.html">SessionCommands</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
+27
-27
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ShellCommands.ListCommand">
|
||||
<article data-uid="Hi.SessionCommands.ListCommand">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_ShellCommands_ListCommand" data-uid="Hi.ShellCommands.ListCommand" class="text-break">
|
||||
<h1 id="Hi_SessionCommands_ListCommand" data-uid="Hi.SessionCommands.ListCommand" class="text-break">
|
||||
Class ListCommand
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.ShellCommands.html">ShellCommands</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.SessionCommands.html">SessionCommands</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -102,7 +102,7 @@ Class ListCommand
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ListCommand : ITitleCommand, IShellCommand, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class ListCommand : ITitleCommand, ISessionCommand, IMakeXmlSource</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -119,8 +119,8 @@ Class ListCommand
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.ShellCommands.ITitleCommand.html">ITitleCommand</a></div>
|
||||
<div><a class="xref" href="Hi.ShellCommands.IShellCommand.html">IShellCommand</a></div>
|
||||
<div><a class="xref" href="Hi.SessionCommands.ITitleCommand.html">ITitleCommand</a></div>
|
||||
<div><a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -186,9 +186,9 @@ Class ListCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_ListCommand__ctor_" data-uid="Hi.ShellCommands.ListCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_ListCommand__ctor_" data-uid="Hi.SessionCommands.ListCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_ListCommand__ctor" data-uid="Hi.ShellCommands.ListCommand.#ctor">
|
||||
<h3 id="Hi_SessionCommands_ListCommand__ctor" data-uid="Hi.SessionCommands.ListCommand.#ctor">
|
||||
ListCommand()
|
||||
|
||||
</h3>
|
||||
@@ -213,9 +213,9 @@ Class ListCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_ListCommand__ctor_" data-uid="Hi.ShellCommands.ListCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_ListCommand__ctor_" data-uid="Hi.SessionCommands.ListCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_ListCommand__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_System_Object__System_Object___" data-uid="Hi.ShellCommands.ListCommand.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{System.Object},System.Object[])">
|
||||
<h3 id="Hi_SessionCommands_ListCommand__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_System_Object__System_Object___" data-uid="Hi.SessionCommands.ListCommand.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{System.Object},System.Object[])">
|
||||
ListCommand(XElement, string, string, IProgress<object>, object[])
|
||||
|
||||
</h3>
|
||||
@@ -262,9 +262,9 @@ Class ListCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_ListCommand_CommandEntryList_" data-uid="Hi.ShellCommands.ListCommand.CommandEntryList*"></a>
|
||||
<a id="Hi_SessionCommands_ListCommand_CommandEntryList_" data-uid="Hi.SessionCommands.ListCommand.CommandEntryList*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_ListCommand_CommandEntryList" data-uid="Hi.ShellCommands.ListCommand.CommandEntryList">
|
||||
<h3 id="Hi_SessionCommands_ListCommand_CommandEntryList" data-uid="Hi.SessionCommands.ListCommand.CommandEntryList">
|
||||
CommandEntryList
|
||||
|
||||
</h3>
|
||||
@@ -284,7 +284,7 @@ The item in list is null capable.</p>
|
||||
|
||||
<h4 class="section">Property Value</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.ShellCommands.EnablingWrapper.html">EnablingWrapper</a>></dt>
|
||||
<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></dd>
|
||||
</dl>
|
||||
|
||||
@@ -295,9 +295,9 @@ The item in list is null capable.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_ListCommand_XName_" data-uid="Hi.ShellCommands.ListCommand.XName*"></a>
|
||||
<a id="Hi_SessionCommands_ListCommand_XName_" data-uid="Hi.SessionCommands.ListCommand.XName*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_ListCommand_XName" data-uid="Hi.ShellCommands.ListCommand.XName">
|
||||
<h3 id="Hi_SessionCommands_ListCommand_XName" data-uid="Hi.SessionCommands.ListCommand.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
@@ -331,9 +331,9 @@ The item in list is null capable.</p>
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_ListCommand_GetCommandTitle_" data-uid="Hi.ShellCommands.ListCommand.GetCommandTitle*"></a>
|
||||
<a id="Hi_SessionCommands_ListCommand_GetCommandTitle_" data-uid="Hi.SessionCommands.ListCommand.GetCommandTitle*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_ListCommand_GetCommandTitle" data-uid="Hi.ShellCommands.ListCommand.GetCommandTitle">
|
||||
<h3 id="Hi_SessionCommands_ListCommand_GetCommandTitle" data-uid="Hi.SessionCommands.ListCommand.GetCommandTitle">
|
||||
GetCommandTitle()
|
||||
|
||||
</h3>
|
||||
@@ -364,9 +364,9 @@ The item in list is null capable.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_ListCommand_MakeXmlSource_" data-uid="Hi.ShellCommands.ListCommand.MakeXmlSource*"></a>
|
||||
<a id="Hi_SessionCommands_ListCommand_MakeXmlSource_" data-uid="Hi.SessionCommands.ListCommand.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_ListCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.ShellCommands.ListCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
<h3 id="Hi_SessionCommands_ListCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.SessionCommands.ListCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
@@ -406,7 +406,7 @@ This method may also generate additional resources such as related files.</p>
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_ShellCommands_ListCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<h4 class="section" id="Hi_SessionCommands_ListCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
@@ -415,25 +415,25 @@ Since the folder can be moving with the configuration file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_ListCommand_Run_" data-uid="Hi.ShellCommands.ListCommand.Run*"></a>
|
||||
<a id="Hi_SessionCommands_ListCommand_Run_" data-uid="Hi.SessionCommands.ListCommand.Run*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_ListCommand_Run_Hi_MachiningProcs_RuntimeApi_" data-uid="Hi.ShellCommands.ListCommand.Run(Hi.MachiningProcs.RuntimeApi)">
|
||||
Run(RuntimeApi)
|
||||
<h3 id="Hi_SessionCommands_ListCommand_Run_Hi_MachiningProcs_SessionShell_" data-uid="Hi.SessionCommands.ListCommand.Run(Hi.MachiningProcs.SessionShell)">
|
||||
Run(SessionShell)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Runs the command using the provided script API.</p>
|
||||
<div class="markdown level1 summary"><p>Runs the command, delegating execution to the provided session shell.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(RuntimeApi scriptApi)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(SessionShell sessionShell)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
|
||||
<dd><p>Script API for executing milling commands.</p>
|
||||
<dt><code>sessionShell</code> <a class="xref" href="Hi.MachiningProcs.SessionShell.html">SessionShell</a></dt>
|
||||
<dd><p>Session shell that exposes the machining facade to commands.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+23
-23
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ShellCommands.MachiningMotionResolutionCommand">
|
||||
<article data-uid="Hi.SessionCommands.MachiningMotionResolutionCommand">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_ShellCommands_MachiningMotionResolutionCommand" data-uid="Hi.ShellCommands.MachiningMotionResolutionCommand" class="text-break">
|
||||
<h1 id="Hi_SessionCommands_MachiningMotionResolutionCommand" data-uid="Hi.SessionCommands.MachiningMotionResolutionCommand" class="text-break">
|
||||
Class MachiningMotionResolutionCommand
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.ShellCommands.html">ShellCommands</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.SessionCommands.html">SessionCommands</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -102,7 +102,7 @@ Class MachiningMotionResolutionCommand
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class MachiningMotionResolutionCommand : IShellCommand, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class MachiningMotionResolutionCommand : ISessionCommand, IMakeXmlSource</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -119,7 +119,7 @@ Class MachiningMotionResolutionCommand
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.ShellCommands.IShellCommand.html">IShellCommand</a></div>
|
||||
<div><a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -185,9 +185,9 @@ Class MachiningMotionResolutionCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_MachiningMotionResolutionCommand__ctor_" data-uid="Hi.ShellCommands.MachiningMotionResolutionCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_MachiningMotionResolutionCommand__ctor_" data-uid="Hi.SessionCommands.MachiningMotionResolutionCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_MachiningMotionResolutionCommand__ctor" data-uid="Hi.ShellCommands.MachiningMotionResolutionCommand.#ctor">
|
||||
<h3 id="Hi_SessionCommands_MachiningMotionResolutionCommand__ctor" data-uid="Hi.SessionCommands.MachiningMotionResolutionCommand.#ctor">
|
||||
MachiningMotionResolutionCommand()
|
||||
|
||||
</h3>
|
||||
@@ -212,9 +212,9 @@ Class MachiningMotionResolutionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_MachiningMotionResolutionCommand__ctor_" data-uid="Hi.ShellCommands.MachiningMotionResolutionCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_MachiningMotionResolutionCommand__ctor_" data-uid="Hi.SessionCommands.MachiningMotionResolutionCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_MachiningMotionResolutionCommand__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_System_Object__" data-uid="Hi.ShellCommands.MachiningMotionResolutionCommand.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{System.Object})">
|
||||
<h3 id="Hi_SessionCommands_MachiningMotionResolutionCommand__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_System_Object__" data-uid="Hi.SessionCommands.MachiningMotionResolutionCommand.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{System.Object})">
|
||||
MachiningMotionResolutionCommand(XElement, string, string, IProgress<object>)
|
||||
|
||||
</h3>
|
||||
@@ -258,9 +258,9 @@ Class MachiningMotionResolutionCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_MachiningMotionResolutionCommand_MachiningMotionResolution_" data-uid="Hi.ShellCommands.MachiningMotionResolutionCommand.MachiningMotionResolution*"></a>
|
||||
<a id="Hi_SessionCommands_MachiningMotionResolutionCommand_MachiningMotionResolution_" data-uid="Hi.SessionCommands.MachiningMotionResolutionCommand.MachiningMotionResolution*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_MachiningMotionResolutionCommand_MachiningMotionResolution" data-uid="Hi.ShellCommands.MachiningMotionResolutionCommand.MachiningMotionResolution">
|
||||
<h3 id="Hi_SessionCommands_MachiningMotionResolutionCommand_MachiningMotionResolution" data-uid="Hi.SessionCommands.MachiningMotionResolutionCommand.MachiningMotionResolution">
|
||||
MachiningMotionResolution
|
||||
|
||||
</h3>
|
||||
@@ -290,9 +290,9 @@ Class MachiningMotionResolutionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_MachiningMotionResolutionCommand_XName_" data-uid="Hi.ShellCommands.MachiningMotionResolutionCommand.XName*"></a>
|
||||
<a id="Hi_SessionCommands_MachiningMotionResolutionCommand_XName_" data-uid="Hi.SessionCommands.MachiningMotionResolutionCommand.XName*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_MachiningMotionResolutionCommand_XName" data-uid="Hi.ShellCommands.MachiningMotionResolutionCommand.XName">
|
||||
<h3 id="Hi_SessionCommands_MachiningMotionResolutionCommand_XName" data-uid="Hi.SessionCommands.MachiningMotionResolutionCommand.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
@@ -326,9 +326,9 @@ Class MachiningMotionResolutionCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_MachiningMotionResolutionCommand_MakeXmlSource_" data-uid="Hi.ShellCommands.MachiningMotionResolutionCommand.MakeXmlSource*"></a>
|
||||
<a id="Hi_SessionCommands_MachiningMotionResolutionCommand_MakeXmlSource_" data-uid="Hi.SessionCommands.MachiningMotionResolutionCommand.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_MachiningMotionResolutionCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.ShellCommands.MachiningMotionResolutionCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
<h3 id="Hi_SessionCommands_MachiningMotionResolutionCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.SessionCommands.MachiningMotionResolutionCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
@@ -368,7 +368,7 @@ This method may also generate additional resources such as related files.</p>
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_ShellCommands_MachiningMotionResolutionCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<h4 class="section" id="Hi_SessionCommands_MachiningMotionResolutionCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
@@ -377,25 +377,25 @@ Since the folder can be moving with the configuration file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_MachiningMotionResolutionCommand_Run_" data-uid="Hi.ShellCommands.MachiningMotionResolutionCommand.Run*"></a>
|
||||
<a id="Hi_SessionCommands_MachiningMotionResolutionCommand_Run_" data-uid="Hi.SessionCommands.MachiningMotionResolutionCommand.Run*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_MachiningMotionResolutionCommand_Run_Hi_MachiningProcs_RuntimeApi_" data-uid="Hi.ShellCommands.MachiningMotionResolutionCommand.Run(Hi.MachiningProcs.RuntimeApi)">
|
||||
Run(RuntimeApi)
|
||||
<h3 id="Hi_SessionCommands_MachiningMotionResolutionCommand_Run_Hi_MachiningProcs_SessionShell_" data-uid="Hi.SessionCommands.MachiningMotionResolutionCommand.Run(Hi.MachiningProcs.SessionShell)">
|
||||
Run(SessionShell)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Runs the command using the provided script API.</p>
|
||||
<div class="markdown level1 summary"><p>Runs the command, delegating execution to the provided session shell.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(RuntimeApi scriptApi)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(SessionShell sessionShell)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
|
||||
<dd><p>Script API for executing milling commands.</p>
|
||||
<dt><code>sessionShell</code> <a class="xref" href="Hi.MachiningProcs.SessionShell.html">SessionShell</a></dt>
|
||||
<dd><p>Session shell that exposes the machining facade to commands.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+31
-31
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ShellCommands.NcCodeCommand">
|
||||
<article data-uid="Hi.SessionCommands.NcCodeCommand">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_ShellCommands_NcCodeCommand" data-uid="Hi.ShellCommands.NcCodeCommand" class="text-break">
|
||||
<h1 id="Hi_SessionCommands_NcCodeCommand" data-uid="Hi.SessionCommands.NcCodeCommand" class="text-break">
|
||||
Class NcCodeCommand
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.ShellCommands.html">ShellCommands</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.SessionCommands.html">SessionCommands</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -102,7 +102,7 @@ Class NcCodeCommand
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class NcCodeCommand : ITitleCommand, IShellCommand, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class NcCodeCommand : ITitleCommand, ISessionCommand, IMakeXmlSource</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -119,8 +119,8 @@ Class NcCodeCommand
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.ShellCommands.ITitleCommand.html">ITitleCommand</a></div>
|
||||
<div><a class="xref" href="Hi.ShellCommands.IShellCommand.html">IShellCommand</a></div>
|
||||
<div><a class="xref" href="Hi.SessionCommands.ITitleCommand.html">ITitleCommand</a></div>
|
||||
<div><a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -186,9 +186,9 @@ Class NcCodeCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcCodeCommand__ctor_" data-uid="Hi.ShellCommands.NcCodeCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_NcCodeCommand__ctor_" data-uid="Hi.SessionCommands.NcCodeCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcCodeCommand__ctor" data-uid="Hi.ShellCommands.NcCodeCommand.#ctor">
|
||||
<h3 id="Hi_SessionCommands_NcCodeCommand__ctor" data-uid="Hi.SessionCommands.NcCodeCommand.#ctor">
|
||||
NcCodeCommand()
|
||||
|
||||
</h3>
|
||||
@@ -213,14 +213,14 @@ Class NcCodeCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcCodeCommand__ctor_" data-uid="Hi.ShellCommands.NcCodeCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_NcCodeCommand__ctor_" data-uid="Hi.SessionCommands.NcCodeCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcCodeCommand__ctor_System_String_" data-uid="Hi.ShellCommands.NcCodeCommand.#ctor(System.String)">
|
||||
<h3 id="Hi_SessionCommands_NcCodeCommand__ctor_System_String_" data-uid="Hi.SessionCommands.NcCodeCommand.#ctor(System.String)">
|
||||
NcCodeCommand(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.ShellCommands.NcCodeCommand.html">NcCodeCommand</a> class with the specified NC text.</p>
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.SessionCommands.NcCodeCommand.html">NcCodeCommand</a> class with the specified NC text.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -246,9 +246,9 @@ Class NcCodeCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcCodeCommand__ctor_" data-uid="Hi.ShellCommands.NcCodeCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_NcCodeCommand__ctor_" data-uid="Hi.SessionCommands.NcCodeCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcCodeCommand__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.ShellCommands.NcCodeCommand.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
<h3 id="Hi_SessionCommands_NcCodeCommand__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.SessionCommands.NcCodeCommand.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
NcCodeCommand(XElement, string)
|
||||
|
||||
</h3>
|
||||
@@ -286,9 +286,9 @@ Class NcCodeCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcCodeCommand_NcText_" data-uid="Hi.ShellCommands.NcCodeCommand.NcText*"></a>
|
||||
<a id="Hi_SessionCommands_NcCodeCommand_NcText_" data-uid="Hi.SessionCommands.NcCodeCommand.NcText*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcCodeCommand_NcText" data-uid="Hi.ShellCommands.NcCodeCommand.NcText">
|
||||
<h3 id="Hi_SessionCommands_NcCodeCommand_NcText" data-uid="Hi.SessionCommands.NcCodeCommand.NcText">
|
||||
NcText
|
||||
|
||||
</h3>
|
||||
@@ -318,9 +318,9 @@ Class NcCodeCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcCodeCommand_Title_" data-uid="Hi.ShellCommands.NcCodeCommand.Title*"></a>
|
||||
<a id="Hi_SessionCommands_NcCodeCommand_Title_" data-uid="Hi.SessionCommands.NcCodeCommand.Title*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcCodeCommand_Title" data-uid="Hi.ShellCommands.NcCodeCommand.Title">
|
||||
<h3 id="Hi_SessionCommands_NcCodeCommand_Title" data-uid="Hi.SessionCommands.NcCodeCommand.Title">
|
||||
Title
|
||||
|
||||
</h3>
|
||||
@@ -351,9 +351,9 @@ Alternative file name for the NC code file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcCodeCommand_XName_" data-uid="Hi.ShellCommands.NcCodeCommand.XName*"></a>
|
||||
<a id="Hi_SessionCommands_NcCodeCommand_XName_" data-uid="Hi.SessionCommands.NcCodeCommand.XName*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcCodeCommand_XName" data-uid="Hi.ShellCommands.NcCodeCommand.XName">
|
||||
<h3 id="Hi_SessionCommands_NcCodeCommand_XName" data-uid="Hi.SessionCommands.NcCodeCommand.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
@@ -387,9 +387,9 @@ Alternative file name for the NC code file.</p>
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcCodeCommand_GetCommandTitle_" data-uid="Hi.ShellCommands.NcCodeCommand.GetCommandTitle*"></a>
|
||||
<a id="Hi_SessionCommands_NcCodeCommand_GetCommandTitle_" data-uid="Hi.SessionCommands.NcCodeCommand.GetCommandTitle*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcCodeCommand_GetCommandTitle" data-uid="Hi.ShellCommands.NcCodeCommand.GetCommandTitle">
|
||||
<h3 id="Hi_SessionCommands_NcCodeCommand_GetCommandTitle" data-uid="Hi.SessionCommands.NcCodeCommand.GetCommandTitle">
|
||||
GetCommandTitle()
|
||||
|
||||
</h3>
|
||||
@@ -420,9 +420,9 @@ Alternative file name for the NC code file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcCodeCommand_MakeXmlSource_" data-uid="Hi.ShellCommands.NcCodeCommand.MakeXmlSource*"></a>
|
||||
<a id="Hi_SessionCommands_NcCodeCommand_MakeXmlSource_" data-uid="Hi.SessionCommands.NcCodeCommand.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcCodeCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.ShellCommands.NcCodeCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
<h3 id="Hi_SessionCommands_NcCodeCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.SessionCommands.NcCodeCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
@@ -462,7 +462,7 @@ This method may also generate additional resources such as related files.</p>
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_ShellCommands_NcCodeCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<h4 class="section" id="Hi_SessionCommands_NcCodeCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
@@ -471,25 +471,25 @@ Since the folder can be moving with the configuration file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcCodeCommand_Run_" data-uid="Hi.ShellCommands.NcCodeCommand.Run*"></a>
|
||||
<a id="Hi_SessionCommands_NcCodeCommand_Run_" data-uid="Hi.SessionCommands.NcCodeCommand.Run*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcCodeCommand_Run_Hi_MachiningProcs_RuntimeApi_" data-uid="Hi.ShellCommands.NcCodeCommand.Run(Hi.MachiningProcs.RuntimeApi)">
|
||||
Run(RuntimeApi)
|
||||
<h3 id="Hi_SessionCommands_NcCodeCommand_Run_Hi_MachiningProcs_SessionShell_" data-uid="Hi.SessionCommands.NcCodeCommand.Run(Hi.MachiningProcs.SessionShell)">
|
||||
Run(SessionShell)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Runs the command using the provided script API.</p>
|
||||
<div class="markdown level1 summary"><p>Runs the command, delegating execution to the provided session shell.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(RuntimeApi scriptApi)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(SessionShell sessionShell)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
|
||||
<dd><p>Script API for executing milling commands.</p>
|
||||
<dt><code>sessionShell</code> <a class="xref" href="Hi.MachiningProcs.SessionShell.html">SessionShell</a></dt>
|
||||
<dd><p>Session shell that exposes the machining facade to commands.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+29
-29
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ShellCommands.NcFileCommand">
|
||||
<article data-uid="Hi.SessionCommands.NcFileCommand">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_ShellCommands_NcFileCommand" data-uid="Hi.ShellCommands.NcFileCommand" class="text-break">
|
||||
<h1 id="Hi_SessionCommands_NcFileCommand" data-uid="Hi.SessionCommands.NcFileCommand" class="text-break">
|
||||
Class NcFileCommand
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.ShellCommands.html">ShellCommands</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.SessionCommands.html">SessionCommands</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -102,7 +102,7 @@ Class NcFileCommand
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class NcFileCommand : ITitleCommand, IShellCommand, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class NcFileCommand : ITitleCommand, ISessionCommand, IMakeXmlSource</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -119,8 +119,8 @@ Class NcFileCommand
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.ShellCommands.ITitleCommand.html">ITitleCommand</a></div>
|
||||
<div><a class="xref" href="Hi.ShellCommands.IShellCommand.html">IShellCommand</a></div>
|
||||
<div><a class="xref" href="Hi.SessionCommands.ITitleCommand.html">ITitleCommand</a></div>
|
||||
<div><a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -186,9 +186,9 @@ Class NcFileCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcFileCommand__ctor_" data-uid="Hi.ShellCommands.NcFileCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_NcFileCommand__ctor_" data-uid="Hi.SessionCommands.NcFileCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcFileCommand__ctor" data-uid="Hi.ShellCommands.NcFileCommand.#ctor">
|
||||
<h3 id="Hi_SessionCommands_NcFileCommand__ctor" data-uid="Hi.SessionCommands.NcFileCommand.#ctor">
|
||||
NcFileCommand()
|
||||
|
||||
</h3>
|
||||
@@ -213,14 +213,14 @@ Class NcFileCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcFileCommand__ctor_" data-uid="Hi.ShellCommands.NcFileCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_NcFileCommand__ctor_" data-uid="Hi.SessionCommands.NcFileCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcFileCommand__ctor_System_String_" data-uid="Hi.ShellCommands.NcFileCommand.#ctor(System.String)">
|
||||
<h3 id="Hi_SessionCommands_NcFileCommand__ctor_System_String_" data-uid="Hi.SessionCommands.NcFileCommand.#ctor(System.String)">
|
||||
NcFileCommand(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.ShellCommands.NcFileCommand.html">NcFileCommand</a> class with the specified NC file path.</p>
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.SessionCommands.NcFileCommand.html">NcFileCommand</a> class with the specified NC file path.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -246,9 +246,9 @@ Class NcFileCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcFileCommand__ctor_" data-uid="Hi.ShellCommands.NcFileCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_NcFileCommand__ctor_" data-uid="Hi.SessionCommands.NcFileCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcFileCommand__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.ShellCommands.NcFileCommand.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
<h3 id="Hi_SessionCommands_NcFileCommand__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.SessionCommands.NcFileCommand.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
NcFileCommand(XElement, string)
|
||||
|
||||
</h3>
|
||||
@@ -286,9 +286,9 @@ Class NcFileCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcFileCommand_NcFile_" data-uid="Hi.ShellCommands.NcFileCommand.NcFile*"></a>
|
||||
<a id="Hi_SessionCommands_NcFileCommand_NcFile_" data-uid="Hi.SessionCommands.NcFileCommand.NcFile*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcFileCommand_NcFile" data-uid="Hi.ShellCommands.NcFileCommand.NcFile">
|
||||
<h3 id="Hi_SessionCommands_NcFileCommand_NcFile" data-uid="Hi.SessionCommands.NcFileCommand.NcFile">
|
||||
NcFile
|
||||
|
||||
</h3>
|
||||
@@ -318,9 +318,9 @@ Class NcFileCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcFileCommand_XName_" data-uid="Hi.ShellCommands.NcFileCommand.XName*"></a>
|
||||
<a id="Hi_SessionCommands_NcFileCommand_XName_" data-uid="Hi.SessionCommands.NcFileCommand.XName*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcFileCommand_XName" data-uid="Hi.ShellCommands.NcFileCommand.XName">
|
||||
<h3 id="Hi_SessionCommands_NcFileCommand_XName" data-uid="Hi.SessionCommands.NcFileCommand.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
@@ -354,9 +354,9 @@ Class NcFileCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcFileCommand_GetCommandTitle_" data-uid="Hi.ShellCommands.NcFileCommand.GetCommandTitle*"></a>
|
||||
<a id="Hi_SessionCommands_NcFileCommand_GetCommandTitle_" data-uid="Hi.SessionCommands.NcFileCommand.GetCommandTitle*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcFileCommand_GetCommandTitle" data-uid="Hi.ShellCommands.NcFileCommand.GetCommandTitle">
|
||||
<h3 id="Hi_SessionCommands_NcFileCommand_GetCommandTitle" data-uid="Hi.SessionCommands.NcFileCommand.GetCommandTitle">
|
||||
GetCommandTitle()
|
||||
|
||||
</h3>
|
||||
@@ -387,9 +387,9 @@ Class NcFileCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcFileCommand_MakeXmlSource_" data-uid="Hi.ShellCommands.NcFileCommand.MakeXmlSource*"></a>
|
||||
<a id="Hi_SessionCommands_NcFileCommand_MakeXmlSource_" data-uid="Hi.SessionCommands.NcFileCommand.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcFileCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.ShellCommands.NcFileCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
<h3 id="Hi_SessionCommands_NcFileCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.SessionCommands.NcFileCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
@@ -429,7 +429,7 @@ This method may also generate additional resources such as related files.</p>
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_ShellCommands_NcFileCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<h4 class="section" id="Hi_SessionCommands_NcFileCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
@@ -438,25 +438,25 @@ Since the folder can be moving with the configuration file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcFileCommand_Run_" data-uid="Hi.ShellCommands.NcFileCommand.Run*"></a>
|
||||
<a id="Hi_SessionCommands_NcFileCommand_Run_" data-uid="Hi.SessionCommands.NcFileCommand.Run*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcFileCommand_Run_Hi_MachiningProcs_RuntimeApi_" data-uid="Hi.ShellCommands.NcFileCommand.Run(Hi.MachiningProcs.RuntimeApi)">
|
||||
Run(RuntimeApi)
|
||||
<h3 id="Hi_SessionCommands_NcFileCommand_Run_Hi_MachiningProcs_SessionShell_" data-uid="Hi.SessionCommands.NcFileCommand.Run(Hi.MachiningProcs.SessionShell)">
|
||||
Run(SessionShell)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Runs the command using the provided script API.</p>
|
||||
<div class="markdown level1 summary"><p>Runs the command, delegating execution to the provided session shell.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(RuntimeApi scriptApi)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(SessionShell sessionShell)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
|
||||
<dd><p>Script API for executing milling commands.</p>
|
||||
<dt><code>sessionShell</code> <a class="xref" href="Hi.MachiningProcs.SessionShell.html">SessionShell</a></dt>
|
||||
<dd><p>Session shell that exposes the machining facade to commands.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+23
-23
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ShellCommands.NcFileListCommand">
|
||||
<article data-uid="Hi.SessionCommands.NcFileListCommand">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_ShellCommands_NcFileListCommand" data-uid="Hi.ShellCommands.NcFileListCommand" class="text-break">
|
||||
<h1 id="Hi_SessionCommands_NcFileListCommand" data-uid="Hi.SessionCommands.NcFileListCommand" class="text-break">
|
||||
Class NcFileListCommand
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.ShellCommands.html">ShellCommands</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.SessionCommands.html">SessionCommands</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -102,7 +102,7 @@ Class NcFileListCommand
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class NcFileListCommand : IShellCommand, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class NcFileListCommand : ISessionCommand, IMakeXmlSource</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -119,7 +119,7 @@ Class NcFileListCommand
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.ShellCommands.IShellCommand.html">IShellCommand</a></div>
|
||||
<div><a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -185,9 +185,9 @@ Class NcFileListCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcFileListCommand__ctor_" data-uid="Hi.ShellCommands.NcFileListCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_NcFileListCommand__ctor_" data-uid="Hi.SessionCommands.NcFileListCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcFileListCommand__ctor" data-uid="Hi.ShellCommands.NcFileListCommand.#ctor">
|
||||
<h3 id="Hi_SessionCommands_NcFileListCommand__ctor" data-uid="Hi.SessionCommands.NcFileListCommand.#ctor">
|
||||
NcFileListCommand()
|
||||
|
||||
</h3>
|
||||
@@ -212,9 +212,9 @@ Class NcFileListCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcFileListCommand__ctor_" data-uid="Hi.ShellCommands.NcFileListCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_NcFileListCommand__ctor_" data-uid="Hi.SessionCommands.NcFileListCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcFileListCommand__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.ShellCommands.NcFileListCommand.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
<h3 id="Hi_SessionCommands_NcFileListCommand__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.SessionCommands.NcFileListCommand.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
NcFileListCommand(XElement, string)
|
||||
|
||||
</h3>
|
||||
@@ -252,9 +252,9 @@ Class NcFileListCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcFileListCommand_NcFileList_" data-uid="Hi.ShellCommands.NcFileListCommand.NcFileList*"></a>
|
||||
<a id="Hi_SessionCommands_NcFileListCommand_NcFileList_" data-uid="Hi.SessionCommands.NcFileListCommand.NcFileList*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcFileListCommand_NcFileList" data-uid="Hi.ShellCommands.NcFileListCommand.NcFileList">
|
||||
<h3 id="Hi_SessionCommands_NcFileListCommand_NcFileList" data-uid="Hi.SessionCommands.NcFileListCommand.NcFileList">
|
||||
NcFileList
|
||||
|
||||
</h3>
|
||||
@@ -284,9 +284,9 @@ Class NcFileListCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcFileListCommand_XName_" data-uid="Hi.ShellCommands.NcFileListCommand.XName*"></a>
|
||||
<a id="Hi_SessionCommands_NcFileListCommand_XName_" data-uid="Hi.SessionCommands.NcFileListCommand.XName*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcFileListCommand_XName" data-uid="Hi.ShellCommands.NcFileListCommand.XName">
|
||||
<h3 id="Hi_SessionCommands_NcFileListCommand_XName" data-uid="Hi.SessionCommands.NcFileListCommand.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
@@ -320,9 +320,9 @@ Class NcFileListCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcFileListCommand_MakeXmlSource_" data-uid="Hi.ShellCommands.NcFileListCommand.MakeXmlSource*"></a>
|
||||
<a id="Hi_SessionCommands_NcFileListCommand_MakeXmlSource_" data-uid="Hi.SessionCommands.NcFileListCommand.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcFileListCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.ShellCommands.NcFileListCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
<h3 id="Hi_SessionCommands_NcFileListCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.SessionCommands.NcFileListCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
@@ -362,7 +362,7 @@ This method may also generate additional resources such as related files.</p>
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_ShellCommands_NcFileListCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<h4 class="section" id="Hi_SessionCommands_NcFileListCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
@@ -371,25 +371,25 @@ Since the folder can be moving with the configuration file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcFileListCommand_Run_" data-uid="Hi.ShellCommands.NcFileListCommand.Run*"></a>
|
||||
<a id="Hi_SessionCommands_NcFileListCommand_Run_" data-uid="Hi.SessionCommands.NcFileListCommand.Run*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcFileListCommand_Run_Hi_MachiningProcs_RuntimeApi_" data-uid="Hi.ShellCommands.NcFileListCommand.Run(Hi.MachiningProcs.RuntimeApi)">
|
||||
Run(RuntimeApi)
|
||||
<h3 id="Hi_SessionCommands_NcFileListCommand_Run_Hi_MachiningProcs_SessionShell_" data-uid="Hi.SessionCommands.NcFileListCommand.Run(Hi.MachiningProcs.SessionShell)">
|
||||
Run(SessionShell)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Runs the command using the provided script API.</p>
|
||||
<div class="markdown level1 summary"><p>Runs the command, delegating execution to the provided session shell.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(RuntimeApi scriptApi)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(SessionShell sessionShell)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
|
||||
<dd><p>Script API for executing milling commands.</p>
|
||||
<dt><code>sessionShell</code> <a class="xref" href="Hi.MachiningProcs.SessionShell.html">SessionShell</a></dt>
|
||||
<dd><p>Session shell that exposes the machining facade to commands.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+26
-26
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ShellCommands.NcOptOptionCommand">
|
||||
<article data-uid="Hi.SessionCommands.NcOptOptionCommand">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_ShellCommands_NcOptOptionCommand" data-uid="Hi.ShellCommands.NcOptOptionCommand" class="text-break">
|
||||
<h1 id="Hi_SessionCommands_NcOptOptionCommand" data-uid="Hi.SessionCommands.NcOptOptionCommand" class="text-break">
|
||||
Class NcOptOptionCommand
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.ShellCommands.html">ShellCommands</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.SessionCommands.html">SessionCommands</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -102,7 +102,7 @@ Class NcOptOptionCommand
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class NcOptOptionCommand : ITitleCommand, IShellCommand, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class NcOptOptionCommand : ITitleCommand, ISessionCommand, IMakeXmlSource</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -119,8 +119,8 @@ Class NcOptOptionCommand
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.ShellCommands.ITitleCommand.html">ITitleCommand</a></div>
|
||||
<div><a class="xref" href="Hi.ShellCommands.IShellCommand.html">IShellCommand</a></div>
|
||||
<div><a class="xref" href="Hi.SessionCommands.ITitleCommand.html">ITitleCommand</a></div>
|
||||
<div><a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -186,9 +186,9 @@ Class NcOptOptionCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcOptOptionCommand__ctor_" data-uid="Hi.ShellCommands.NcOptOptionCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_NcOptOptionCommand__ctor_" data-uid="Hi.SessionCommands.NcOptOptionCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcOptOptionCommand__ctor" data-uid="Hi.ShellCommands.NcOptOptionCommand.#ctor">
|
||||
<h3 id="Hi_SessionCommands_NcOptOptionCommand__ctor" data-uid="Hi.SessionCommands.NcOptOptionCommand.#ctor">
|
||||
NcOptOptionCommand()
|
||||
|
||||
</h3>
|
||||
@@ -213,9 +213,9 @@ Class NcOptOptionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcOptOptionCommand__ctor_" data-uid="Hi.ShellCommands.NcOptOptionCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_NcOptOptionCommand__ctor_" data-uid="Hi.SessionCommands.NcOptOptionCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcOptOptionCommand__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_System_Object__System_Object___" data-uid="Hi.ShellCommands.NcOptOptionCommand.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{System.Object},System.Object[])">
|
||||
<h3 id="Hi_SessionCommands_NcOptOptionCommand__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_System_Object__System_Object___" data-uid="Hi.SessionCommands.NcOptOptionCommand.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{System.Object},System.Object[])">
|
||||
NcOptOptionCommand(XElement, string, string, IProgress<object>, object[])
|
||||
|
||||
</h3>
|
||||
@@ -262,9 +262,9 @@ Class NcOptOptionCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcOptOptionCommand_NcOptOption_" data-uid="Hi.ShellCommands.NcOptOptionCommand.NcOptOption*"></a>
|
||||
<a id="Hi_SessionCommands_NcOptOptionCommand_NcOptOption_" data-uid="Hi.SessionCommands.NcOptOptionCommand.NcOptOption*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcOptOptionCommand_NcOptOption" data-uid="Hi.ShellCommands.NcOptOptionCommand.NcOptOption">
|
||||
<h3 id="Hi_SessionCommands_NcOptOptionCommand_NcOptOption" data-uid="Hi.SessionCommands.NcOptOptionCommand.NcOptOption">
|
||||
NcOptOption
|
||||
|
||||
</h3>
|
||||
@@ -294,9 +294,9 @@ Class NcOptOptionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcOptOptionCommand_XName_" data-uid="Hi.ShellCommands.NcOptOptionCommand.XName*"></a>
|
||||
<a id="Hi_SessionCommands_NcOptOptionCommand_XName_" data-uid="Hi.SessionCommands.NcOptOptionCommand.XName*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcOptOptionCommand_XName" data-uid="Hi.ShellCommands.NcOptOptionCommand.XName">
|
||||
<h3 id="Hi_SessionCommands_NcOptOptionCommand_XName" data-uid="Hi.SessionCommands.NcOptOptionCommand.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
@@ -330,9 +330,9 @@ Class NcOptOptionCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcOptOptionCommand_GetCommandTitle_" data-uid="Hi.ShellCommands.NcOptOptionCommand.GetCommandTitle*"></a>
|
||||
<a id="Hi_SessionCommands_NcOptOptionCommand_GetCommandTitle_" data-uid="Hi.SessionCommands.NcOptOptionCommand.GetCommandTitle*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcOptOptionCommand_GetCommandTitle" data-uid="Hi.ShellCommands.NcOptOptionCommand.GetCommandTitle">
|
||||
<h3 id="Hi_SessionCommands_NcOptOptionCommand_GetCommandTitle" data-uid="Hi.SessionCommands.NcOptOptionCommand.GetCommandTitle">
|
||||
GetCommandTitle()
|
||||
|
||||
</h3>
|
||||
@@ -363,9 +363,9 @@ Class NcOptOptionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcOptOptionCommand_MakeXmlSource_" data-uid="Hi.ShellCommands.NcOptOptionCommand.MakeXmlSource*"></a>
|
||||
<a id="Hi_SessionCommands_NcOptOptionCommand_MakeXmlSource_" data-uid="Hi.SessionCommands.NcOptOptionCommand.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcOptOptionCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.ShellCommands.NcOptOptionCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
<h3 id="Hi_SessionCommands_NcOptOptionCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.SessionCommands.NcOptOptionCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
@@ -405,7 +405,7 @@ This method may also generate additional resources such as related files.</p>
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_ShellCommands_NcOptOptionCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<h4 class="section" id="Hi_SessionCommands_NcOptOptionCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
@@ -414,25 +414,25 @@ Since the folder can be moving with the configuration file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_NcOptOptionCommand_Run_" data-uid="Hi.ShellCommands.NcOptOptionCommand.Run*"></a>
|
||||
<a id="Hi_SessionCommands_NcOptOptionCommand_Run_" data-uid="Hi.SessionCommands.NcOptOptionCommand.Run*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_NcOptOptionCommand_Run_Hi_MachiningProcs_RuntimeApi_" data-uid="Hi.ShellCommands.NcOptOptionCommand.Run(Hi.MachiningProcs.RuntimeApi)">
|
||||
Run(RuntimeApi)
|
||||
<h3 id="Hi_SessionCommands_NcOptOptionCommand_Run_Hi_MachiningProcs_SessionShell_" data-uid="Hi.SessionCommands.NcOptOptionCommand.Run(Hi.MachiningProcs.SessionShell)">
|
||||
Run(SessionShell)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Runs the command using the provided script API.</p>
|
||||
<div class="markdown level1 summary"><p>Runs the command, delegating execution to the provided session shell.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(RuntimeApi scriptApi)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(SessionShell sessionShell)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
|
||||
<dd><p>Script API for executing milling commands.</p>
|
||||
<dt><code>sessionShell</code> <a class="xref" href="Hi.MachiningProcs.SessionShell.html">SessionShell</a></dt>
|
||||
<dd><p>Session shell that exposes the machining facade to commands.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+24
-24
@@ -84,25 +84,25 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ShellCommands.OptimizeToFilesCommand">
|
||||
<article data-uid="Hi.SessionCommands.OptimizeToFilesCommand">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_ShellCommands_OptimizeToFilesCommand" data-uid="Hi.ShellCommands.OptimizeToFilesCommand" class="text-break">
|
||||
<h1 id="Hi_SessionCommands_OptimizeToFilesCommand" data-uid="Hi.SessionCommands.OptimizeToFilesCommand" class="text-break">
|
||||
Class OptimizeToFilesCommand
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.ShellCommands.html">ShellCommands</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.SessionCommands.html">SessionCommands</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Command to call <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_OptimizeToFiles_System_String_">OptimizeToFiles(string)</a>.</p>
|
||||
<div class="markdown summary"><p>Command to call <a class="xref" href="Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_OptimizeToFiles_System_String_">OptimizeToFiles(string)</a>.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class OptimizeToFilesCommand : IShellCommand, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class OptimizeToFilesCommand : ISessionCommand, IMakeXmlSource</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -119,7 +119,7 @@ Class OptimizeToFilesCommand
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.ShellCommands.IShellCommand.html">IShellCommand</a></div>
|
||||
<div><a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -185,9 +185,9 @@ Class OptimizeToFilesCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_OptimizeToFilesCommand__ctor_" data-uid="Hi.ShellCommands.OptimizeToFilesCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_OptimizeToFilesCommand__ctor_" data-uid="Hi.SessionCommands.OptimizeToFilesCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_OptimizeToFilesCommand__ctor" data-uid="Hi.ShellCommands.OptimizeToFilesCommand.#ctor">
|
||||
<h3 id="Hi_SessionCommands_OptimizeToFilesCommand__ctor" data-uid="Hi.SessionCommands.OptimizeToFilesCommand.#ctor">
|
||||
OptimizeToFilesCommand()
|
||||
|
||||
</h3>
|
||||
@@ -212,9 +212,9 @@ Class OptimizeToFilesCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_OptimizeToFilesCommand__ctor_" data-uid="Hi.ShellCommands.OptimizeToFilesCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_OptimizeToFilesCommand__ctor_" data-uid="Hi.SessionCommands.OptimizeToFilesCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_OptimizeToFilesCommand__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.ShellCommands.OptimizeToFilesCommand.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
<h3 id="Hi_SessionCommands_OptimizeToFilesCommand__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.SessionCommands.OptimizeToFilesCommand.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
OptimizeToFilesCommand(XElement, string)
|
||||
|
||||
</h3>
|
||||
@@ -252,9 +252,9 @@ Class OptimizeToFilesCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_OptimizeToFilesCommand_RelFileTemplate_" data-uid="Hi.ShellCommands.OptimizeToFilesCommand.RelFileTemplate*"></a>
|
||||
<a id="Hi_SessionCommands_OptimizeToFilesCommand_RelFileTemplate_" data-uid="Hi.SessionCommands.OptimizeToFilesCommand.RelFileTemplate*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_OptimizeToFilesCommand_RelFileTemplate" data-uid="Hi.ShellCommands.OptimizeToFilesCommand.RelFileTemplate">
|
||||
<h3 id="Hi_SessionCommands_OptimizeToFilesCommand_RelFileTemplate" data-uid="Hi.SessionCommands.OptimizeToFilesCommand.RelFileTemplate">
|
||||
RelFileTemplate
|
||||
|
||||
</h3>
|
||||
@@ -284,9 +284,9 @@ Class OptimizeToFilesCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_OptimizeToFilesCommand_XName_" data-uid="Hi.ShellCommands.OptimizeToFilesCommand.XName*"></a>
|
||||
<a id="Hi_SessionCommands_OptimizeToFilesCommand_XName_" data-uid="Hi.SessionCommands.OptimizeToFilesCommand.XName*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_OptimizeToFilesCommand_XName" data-uid="Hi.ShellCommands.OptimizeToFilesCommand.XName">
|
||||
<h3 id="Hi_SessionCommands_OptimizeToFilesCommand_XName" data-uid="Hi.SessionCommands.OptimizeToFilesCommand.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
@@ -320,9 +320,9 @@ Class OptimizeToFilesCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_OptimizeToFilesCommand_MakeXmlSource_" data-uid="Hi.ShellCommands.OptimizeToFilesCommand.MakeXmlSource*"></a>
|
||||
<a id="Hi_SessionCommands_OptimizeToFilesCommand_MakeXmlSource_" data-uid="Hi.SessionCommands.OptimizeToFilesCommand.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_OptimizeToFilesCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.ShellCommands.OptimizeToFilesCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
<h3 id="Hi_SessionCommands_OptimizeToFilesCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.SessionCommands.OptimizeToFilesCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
@@ -362,7 +362,7 @@ This method may also generate additional resources such as related files.</p>
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_ShellCommands_OptimizeToFilesCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<h4 class="section" id="Hi_SessionCommands_OptimizeToFilesCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
@@ -371,25 +371,25 @@ Since the folder can be moving with the configuration file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_OptimizeToFilesCommand_Run_" data-uid="Hi.ShellCommands.OptimizeToFilesCommand.Run*"></a>
|
||||
<a id="Hi_SessionCommands_OptimizeToFilesCommand_Run_" data-uid="Hi.SessionCommands.OptimizeToFilesCommand.Run*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_OptimizeToFilesCommand_Run_Hi_MachiningProcs_RuntimeApi_" data-uid="Hi.ShellCommands.OptimizeToFilesCommand.Run(Hi.MachiningProcs.RuntimeApi)">
|
||||
Run(RuntimeApi)
|
||||
<h3 id="Hi_SessionCommands_OptimizeToFilesCommand_Run_Hi_MachiningProcs_SessionShell_" data-uid="Hi.SessionCommands.OptimizeToFilesCommand.Run(Hi.MachiningProcs.SessionShell)">
|
||||
Run(SessionShell)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Runs the command using the provided script API.</p>
|
||||
<div class="markdown level1 summary"><p>Runs the command, delegating execution to the provided session shell.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(RuntimeApi scriptApi)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(SessionShell sessionShell)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
|
||||
<dd><p>Script API for executing milling commands.</p>
|
||||
<dt><code>sessionShell</code> <a class="xref" href="Hi.MachiningProcs.SessionShell.html">SessionShell</a></dt>
|
||||
<dd><p>Session shell that exposes the machining facade to commands.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+46
-46
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ShellCommands.PostExecutionCommand">
|
||||
<article data-uid="Hi.SessionCommands.PostExecutionCommand">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_ShellCommands_PostExecutionCommand" data-uid="Hi.ShellCommands.PostExecutionCommand" class="text-break">
|
||||
<h1 id="Hi_SessionCommands_PostExecutionCommand" data-uid="Hi.SessionCommands.PostExecutionCommand" class="text-break">
|
||||
Class PostExecutionCommand
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.ShellCommands.html">ShellCommands</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.SessionCommands.html">SessionCommands</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -102,7 +102,7 @@ Class PostExecutionCommand
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class PostExecutionCommand : ITitleCommand, IShellCommand, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class PostExecutionCommand : ITitleCommand, ISessionCommand, IMakeXmlSource</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -119,8 +119,8 @@ Class PostExecutionCommand
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.ShellCommands.ITitleCommand.html">ITitleCommand</a></div>
|
||||
<div><a class="xref" href="Hi.ShellCommands.IShellCommand.html">IShellCommand</a></div>
|
||||
<div><a class="xref" href="Hi.SessionCommands.ITitleCommand.html">ITitleCommand</a></div>
|
||||
<div><a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -186,9 +186,9 @@ Class PostExecutionCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PostExecutionCommand__ctor_" data-uid="Hi.ShellCommands.PostExecutionCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_PostExecutionCommand__ctor_" data-uid="Hi.SessionCommands.PostExecutionCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PostExecutionCommand__ctor" data-uid="Hi.ShellCommands.PostExecutionCommand.#ctor">
|
||||
<h3 id="Hi_SessionCommands_PostExecutionCommand__ctor" data-uid="Hi.SessionCommands.PostExecutionCommand.#ctor">
|
||||
PostExecutionCommand()
|
||||
|
||||
</h3>
|
||||
@@ -213,9 +213,9 @@ Class PostExecutionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PostExecutionCommand__ctor_" data-uid="Hi.ShellCommands.PostExecutionCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_PostExecutionCommand__ctor_" data-uid="Hi.SessionCommands.PostExecutionCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PostExecutionCommand__ctor_System_Xml_Linq_XElement_System_String_System_String_System_Object___" data-uid="Hi.ShellCommands.PostExecutionCommand.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.Object[])">
|
||||
<h3 id="Hi_SessionCommands_PostExecutionCommand__ctor_System_Xml_Linq_XElement_System_String_System_String_System_Object___" data-uid="Hi.SessionCommands.PostExecutionCommand.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.Object[])">
|
||||
PostExecutionCommand(XElement, string, string, params object[])
|
||||
|
||||
</h3>
|
||||
@@ -259,9 +259,9 @@ Class PostExecutionCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PostExecutionCommand_EnableGeomDiff_" data-uid="Hi.ShellCommands.PostExecutionCommand.EnableGeomDiff*"></a>
|
||||
<a id="Hi_SessionCommands_PostExecutionCommand_EnableGeomDiff_" data-uid="Hi.SessionCommands.PostExecutionCommand.EnableGeomDiff*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PostExecutionCommand_EnableGeomDiff" data-uid="Hi.ShellCommands.PostExecutionCommand.EnableGeomDiff">
|
||||
<h3 id="Hi_SessionCommands_PostExecutionCommand_EnableGeomDiff" data-uid="Hi.SessionCommands.PostExecutionCommand.EnableGeomDiff">
|
||||
EnableGeomDiff
|
||||
|
||||
</h3>
|
||||
@@ -291,9 +291,9 @@ Class PostExecutionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PostExecutionCommand_EnableOptimizeToFiles_" data-uid="Hi.ShellCommands.PostExecutionCommand.EnableOptimizeToFiles*"></a>
|
||||
<a id="Hi_SessionCommands_PostExecutionCommand_EnableOptimizeToFiles_" data-uid="Hi.SessionCommands.PostExecutionCommand.EnableOptimizeToFiles*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PostExecutionCommand_EnableOptimizeToFiles" data-uid="Hi.ShellCommands.PostExecutionCommand.EnableOptimizeToFiles">
|
||||
<h3 id="Hi_SessionCommands_PostExecutionCommand_EnableOptimizeToFiles" data-uid="Hi.SessionCommands.PostExecutionCommand.EnableOptimizeToFiles">
|
||||
EnableOptimizeToFiles
|
||||
|
||||
</h3>
|
||||
@@ -323,9 +323,9 @@ Class PostExecutionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PostExecutionCommand_EnableWriteRuntimeGeom_" data-uid="Hi.ShellCommands.PostExecutionCommand.EnableWriteRuntimeGeom*"></a>
|
||||
<a id="Hi_SessionCommands_PostExecutionCommand_EnableWriteRuntimeGeom_" data-uid="Hi.SessionCommands.PostExecutionCommand.EnableWriteRuntimeGeom*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PostExecutionCommand_EnableWriteRuntimeGeom" data-uid="Hi.ShellCommands.PostExecutionCommand.EnableWriteRuntimeGeom">
|
||||
<h3 id="Hi_SessionCommands_PostExecutionCommand_EnableWriteRuntimeGeom" data-uid="Hi.SessionCommands.PostExecutionCommand.EnableWriteRuntimeGeom">
|
||||
EnableWriteRuntimeGeom
|
||||
|
||||
</h3>
|
||||
@@ -355,9 +355,9 @@ Class PostExecutionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PostExecutionCommand_EnableWriteShotFiles_" data-uid="Hi.ShellCommands.PostExecutionCommand.EnableWriteShotFiles*"></a>
|
||||
<a id="Hi_SessionCommands_PostExecutionCommand_EnableWriteShotFiles_" data-uid="Hi.SessionCommands.PostExecutionCommand.EnableWriteShotFiles*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PostExecutionCommand_EnableWriteShotFiles" data-uid="Hi.ShellCommands.PostExecutionCommand.EnableWriteShotFiles">
|
||||
<h3 id="Hi_SessionCommands_PostExecutionCommand_EnableWriteShotFiles" data-uid="Hi.SessionCommands.PostExecutionCommand.EnableWriteShotFiles">
|
||||
EnableWriteShotFiles
|
||||
|
||||
</h3>
|
||||
@@ -387,9 +387,9 @@ Class PostExecutionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PostExecutionCommand_EnableWriteStepFiles_" data-uid="Hi.ShellCommands.PostExecutionCommand.EnableWriteStepFiles*"></a>
|
||||
<a id="Hi_SessionCommands_PostExecutionCommand_EnableWriteStepFiles_" data-uid="Hi.SessionCommands.PostExecutionCommand.EnableWriteStepFiles*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PostExecutionCommand_EnableWriteStepFiles" data-uid="Hi.ShellCommands.PostExecutionCommand.EnableWriteStepFiles">
|
||||
<h3 id="Hi_SessionCommands_PostExecutionCommand_EnableWriteStepFiles" data-uid="Hi.SessionCommands.PostExecutionCommand.EnableWriteStepFiles">
|
||||
EnableWriteStepFiles
|
||||
|
||||
</h3>
|
||||
@@ -419,9 +419,9 @@ Class PostExecutionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PostExecutionCommand_GeomDiffDetectRadius_mm_" data-uid="Hi.ShellCommands.PostExecutionCommand.GeomDiffDetectRadius_mm*"></a>
|
||||
<a id="Hi_SessionCommands_PostExecutionCommand_GeomDiffDetectRadius_mm_" data-uid="Hi.SessionCommands.PostExecutionCommand.GeomDiffDetectRadius_mm*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PostExecutionCommand_GeomDiffDetectRadius_mm" data-uid="Hi.ShellCommands.PostExecutionCommand.GeomDiffDetectRadius_mm">
|
||||
<h3 id="Hi_SessionCommands_PostExecutionCommand_GeomDiffDetectRadius_mm" data-uid="Hi.SessionCommands.PostExecutionCommand.GeomDiffDetectRadius_mm">
|
||||
GeomDiffDetectRadius_mm
|
||||
|
||||
</h3>
|
||||
@@ -451,9 +451,9 @@ Class PostExecutionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PostExecutionCommand_OptimizationFileTemplate_" data-uid="Hi.ShellCommands.PostExecutionCommand.OptimizationFileTemplate*"></a>
|
||||
<a id="Hi_SessionCommands_PostExecutionCommand_OptimizationFileTemplate_" data-uid="Hi.SessionCommands.PostExecutionCommand.OptimizationFileTemplate*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PostExecutionCommand_OptimizationFileTemplate" data-uid="Hi.ShellCommands.PostExecutionCommand.OptimizationFileTemplate">
|
||||
<h3 id="Hi_SessionCommands_PostExecutionCommand_OptimizationFileTemplate" data-uid="Hi.SessionCommands.PostExecutionCommand.OptimizationFileTemplate">
|
||||
OptimizationFileTemplate
|
||||
|
||||
</h3>
|
||||
@@ -483,9 +483,9 @@ Class PostExecutionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PostExecutionCommand_RuntimeGeomFilePath_" data-uid="Hi.ShellCommands.PostExecutionCommand.RuntimeGeomFilePath*"></a>
|
||||
<a id="Hi_SessionCommands_PostExecutionCommand_RuntimeGeomFilePath_" data-uid="Hi.SessionCommands.PostExecutionCommand.RuntimeGeomFilePath*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PostExecutionCommand_RuntimeGeomFilePath" data-uid="Hi.ShellCommands.PostExecutionCommand.RuntimeGeomFilePath">
|
||||
<h3 id="Hi_SessionCommands_PostExecutionCommand_RuntimeGeomFilePath" data-uid="Hi.SessionCommands.PostExecutionCommand.RuntimeGeomFilePath">
|
||||
RuntimeGeomFilePath
|
||||
|
||||
</h3>
|
||||
@@ -515,9 +515,9 @@ Class PostExecutionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PostExecutionCommand_ShotFileTemplate_" data-uid="Hi.ShellCommands.PostExecutionCommand.ShotFileTemplate*"></a>
|
||||
<a id="Hi_SessionCommands_PostExecutionCommand_ShotFileTemplate_" data-uid="Hi.SessionCommands.PostExecutionCommand.ShotFileTemplate*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PostExecutionCommand_ShotFileTemplate" data-uid="Hi.ShellCommands.PostExecutionCommand.ShotFileTemplate">
|
||||
<h3 id="Hi_SessionCommands_PostExecutionCommand_ShotFileTemplate" data-uid="Hi.SessionCommands.PostExecutionCommand.ShotFileTemplate">
|
||||
ShotFileTemplate
|
||||
|
||||
</h3>
|
||||
@@ -547,9 +547,9 @@ Class PostExecutionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PostExecutionCommand_ShotFileTimeResolution_ms_" data-uid="Hi.ShellCommands.PostExecutionCommand.ShotFileTimeResolution_ms*"></a>
|
||||
<a id="Hi_SessionCommands_PostExecutionCommand_ShotFileTimeResolution_ms_" data-uid="Hi.SessionCommands.PostExecutionCommand.ShotFileTimeResolution_ms*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PostExecutionCommand_ShotFileTimeResolution_ms" data-uid="Hi.ShellCommands.PostExecutionCommand.ShotFileTimeResolution_ms">
|
||||
<h3 id="Hi_SessionCommands_PostExecutionCommand_ShotFileTimeResolution_ms" data-uid="Hi.SessionCommands.PostExecutionCommand.ShotFileTimeResolution_ms">
|
||||
ShotFileTimeResolution_ms
|
||||
|
||||
</h3>
|
||||
@@ -579,9 +579,9 @@ Class PostExecutionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PostExecutionCommand_StepFileTemplate_" data-uid="Hi.ShellCommands.PostExecutionCommand.StepFileTemplate*"></a>
|
||||
<a id="Hi_SessionCommands_PostExecutionCommand_StepFileTemplate_" data-uid="Hi.SessionCommands.PostExecutionCommand.StepFileTemplate*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PostExecutionCommand_StepFileTemplate" data-uid="Hi.ShellCommands.PostExecutionCommand.StepFileTemplate">
|
||||
<h3 id="Hi_SessionCommands_PostExecutionCommand_StepFileTemplate" data-uid="Hi.SessionCommands.PostExecutionCommand.StepFileTemplate">
|
||||
StepFileTemplate
|
||||
|
||||
</h3>
|
||||
@@ -611,9 +611,9 @@ Class PostExecutionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PostExecutionCommand_XName_" data-uid="Hi.ShellCommands.PostExecutionCommand.XName*"></a>
|
||||
<a id="Hi_SessionCommands_PostExecutionCommand_XName_" data-uid="Hi.SessionCommands.PostExecutionCommand.XName*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PostExecutionCommand_XName" data-uid="Hi.ShellCommands.PostExecutionCommand.XName">
|
||||
<h3 id="Hi_SessionCommands_PostExecutionCommand_XName" data-uid="Hi.SessionCommands.PostExecutionCommand.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
@@ -647,9 +647,9 @@ Class PostExecutionCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PostExecutionCommand_GetCommandTitle_" data-uid="Hi.ShellCommands.PostExecutionCommand.GetCommandTitle*"></a>
|
||||
<a id="Hi_SessionCommands_PostExecutionCommand_GetCommandTitle_" data-uid="Hi.SessionCommands.PostExecutionCommand.GetCommandTitle*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PostExecutionCommand_GetCommandTitle" data-uid="Hi.ShellCommands.PostExecutionCommand.GetCommandTitle">
|
||||
<h3 id="Hi_SessionCommands_PostExecutionCommand_GetCommandTitle" data-uid="Hi.SessionCommands.PostExecutionCommand.GetCommandTitle">
|
||||
GetCommandTitle()
|
||||
|
||||
</h3>
|
||||
@@ -680,9 +680,9 @@ Class PostExecutionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PostExecutionCommand_MakeXmlSource_" data-uid="Hi.ShellCommands.PostExecutionCommand.MakeXmlSource*"></a>
|
||||
<a id="Hi_SessionCommands_PostExecutionCommand_MakeXmlSource_" data-uid="Hi.SessionCommands.PostExecutionCommand.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PostExecutionCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.ShellCommands.PostExecutionCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
<h3 id="Hi_SessionCommands_PostExecutionCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.SessionCommands.PostExecutionCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
@@ -722,7 +722,7 @@ This method may also generate additional resources such as related files.</p>
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_ShellCommands_PostExecutionCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<h4 class="section" id="Hi_SessionCommands_PostExecutionCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
@@ -731,25 +731,25 @@ Since the folder can be moving with the configuration file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PostExecutionCommand_Run_" data-uid="Hi.ShellCommands.PostExecutionCommand.Run*"></a>
|
||||
<a id="Hi_SessionCommands_PostExecutionCommand_Run_" data-uid="Hi.SessionCommands.PostExecutionCommand.Run*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PostExecutionCommand_Run_Hi_MachiningProcs_RuntimeApi_" data-uid="Hi.ShellCommands.PostExecutionCommand.Run(Hi.MachiningProcs.RuntimeApi)">
|
||||
Run(RuntimeApi)
|
||||
<h3 id="Hi_SessionCommands_PostExecutionCommand_Run_Hi_MachiningProcs_SessionShell_" data-uid="Hi.SessionCommands.PostExecutionCommand.Run(Hi.MachiningProcs.SessionShell)">
|
||||
Run(SessionShell)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Runs the command using the provided script API.</p>
|
||||
<div class="markdown level1 summary"><p>Runs the command, delegating execution to the provided session shell.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(RuntimeApi scriptApi)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(SessionShell sessionShell)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
|
||||
<dd><p>Script API for executing milling commands.</p>
|
||||
<dt><code>sessionShell</code> <a class="xref" href="Hi.MachiningProcs.SessionShell.html">SessionShell</a></dt>
|
||||
<dd><p>Session shell that exposes the machining facade to commands.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+38
-38
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ShellCommands.PreSettingCommand">
|
||||
<article data-uid="Hi.SessionCommands.PreSettingCommand">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_ShellCommands_PreSettingCommand" data-uid="Hi.ShellCommands.PreSettingCommand" class="text-break">
|
||||
<h1 id="Hi_SessionCommands_PreSettingCommand" data-uid="Hi.SessionCommands.PreSettingCommand" class="text-break">
|
||||
Class PreSettingCommand
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.ShellCommands.html">ShellCommands</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.SessionCommands.html">SessionCommands</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -102,7 +102,7 @@ Class PreSettingCommand
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class PreSettingCommand : ITitleCommand, IShellCommand, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class PreSettingCommand : ITitleCommand, ISessionCommand, IMakeXmlSource</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -119,8 +119,8 @@ Class PreSettingCommand
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.ShellCommands.ITitleCommand.html">ITitleCommand</a></div>
|
||||
<div><a class="xref" href="Hi.ShellCommands.IShellCommand.html">IShellCommand</a></div>
|
||||
<div><a class="xref" href="Hi.SessionCommands.ITitleCommand.html">ITitleCommand</a></div>
|
||||
<div><a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -186,9 +186,9 @@ Class PreSettingCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PreSettingCommand__ctor_" data-uid="Hi.ShellCommands.PreSettingCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_PreSettingCommand__ctor_" data-uid="Hi.SessionCommands.PreSettingCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PreSettingCommand__ctor" data-uid="Hi.ShellCommands.PreSettingCommand.#ctor">
|
||||
<h3 id="Hi_SessionCommands_PreSettingCommand__ctor" data-uid="Hi.SessionCommands.PreSettingCommand.#ctor">
|
||||
PreSettingCommand()
|
||||
|
||||
</h3>
|
||||
@@ -213,9 +213,9 @@ Class PreSettingCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PreSettingCommand__ctor_" data-uid="Hi.ShellCommands.PreSettingCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_PreSettingCommand__ctor_" data-uid="Hi.SessionCommands.PreSettingCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PreSettingCommand__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_System_Object__System_Object___" data-uid="Hi.ShellCommands.PreSettingCommand.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{System.Object},System.Object[])">
|
||||
<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>
|
||||
@@ -262,9 +262,9 @@ Class PreSettingCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PreSettingCommand_EnableCollisionDetection_" data-uid="Hi.ShellCommands.PreSettingCommand.EnableCollisionDetection*"></a>
|
||||
<a id="Hi_SessionCommands_PreSettingCommand_EnableCollisionDetection_" data-uid="Hi.SessionCommands.PreSettingCommand.EnableCollisionDetection*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PreSettingCommand_EnableCollisionDetection" data-uid="Hi.ShellCommands.PreSettingCommand.EnableCollisionDetection">
|
||||
<h3 id="Hi_SessionCommands_PreSettingCommand_EnableCollisionDetection" data-uid="Hi.SessionCommands.PreSettingCommand.EnableCollisionDetection">
|
||||
EnableCollisionDetection
|
||||
|
||||
</h3>
|
||||
@@ -294,9 +294,9 @@ Class PreSettingCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PreSettingCommand_EnablePauseOnFailure_" data-uid="Hi.ShellCommands.PreSettingCommand.EnablePauseOnFailure*"></a>
|
||||
<a id="Hi_SessionCommands_PreSettingCommand_EnablePauseOnFailure_" data-uid="Hi.SessionCommands.PreSettingCommand.EnablePauseOnFailure*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PreSettingCommand_EnablePauseOnFailure" data-uid="Hi.ShellCommands.PreSettingCommand.EnablePauseOnFailure">
|
||||
<h3 id="Hi_SessionCommands_PreSettingCommand_EnablePauseOnFailure" data-uid="Hi.SessionCommands.PreSettingCommand.EnablePauseOnFailure">
|
||||
EnablePauseOnFailure
|
||||
|
||||
</h3>
|
||||
@@ -326,9 +326,9 @@ Class PreSettingCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PreSettingCommand_EnablePhysics_" data-uid="Hi.ShellCommands.PreSettingCommand.EnablePhysics*"></a>
|
||||
<a id="Hi_SessionCommands_PreSettingCommand_EnablePhysics_" data-uid="Hi.SessionCommands.PreSettingCommand.EnablePhysics*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PreSettingCommand_EnablePhysics" data-uid="Hi.ShellCommands.PreSettingCommand.EnablePhysics">
|
||||
<h3 id="Hi_SessionCommands_PreSettingCommand_EnablePhysics" data-uid="Hi.SessionCommands.PreSettingCommand.EnablePhysics">
|
||||
EnablePhysics
|
||||
|
||||
</h3>
|
||||
@@ -358,9 +358,9 @@ Class PreSettingCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PreSettingCommand_EnableReadRuntimeGeom_" data-uid="Hi.ShellCommands.PreSettingCommand.EnableReadRuntimeGeom*"></a>
|
||||
<a id="Hi_SessionCommands_PreSettingCommand_EnableReadRuntimeGeom_" data-uid="Hi.SessionCommands.PreSettingCommand.EnableReadRuntimeGeom*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PreSettingCommand_EnableReadRuntimeGeom" data-uid="Hi.ShellCommands.PreSettingCommand.EnableReadRuntimeGeom">
|
||||
<h3 id="Hi_SessionCommands_PreSettingCommand_EnableReadRuntimeGeom" data-uid="Hi.SessionCommands.PreSettingCommand.EnableReadRuntimeGeom">
|
||||
EnableReadRuntimeGeom
|
||||
|
||||
</h3>
|
||||
@@ -390,9 +390,9 @@ Class PreSettingCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PreSettingCommand_MachiningMotionResolution_" data-uid="Hi.ShellCommands.PreSettingCommand.MachiningMotionResolution*"></a>
|
||||
<a id="Hi_SessionCommands_PreSettingCommand_MachiningMotionResolution_" data-uid="Hi.SessionCommands.PreSettingCommand.MachiningMotionResolution*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PreSettingCommand_MachiningMotionResolution" data-uid="Hi.ShellCommands.PreSettingCommand.MachiningMotionResolution">
|
||||
<h3 id="Hi_SessionCommands_PreSettingCommand_MachiningMotionResolution" data-uid="Hi.SessionCommands.PreSettingCommand.MachiningMotionResolution">
|
||||
MachiningMotionResolution
|
||||
|
||||
</h3>
|
||||
@@ -422,9 +422,9 @@ Class PreSettingCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PreSettingCommand_MachiningResolution_mm_" data-uid="Hi.ShellCommands.PreSettingCommand.MachiningResolution_mm*"></a>
|
||||
<a id="Hi_SessionCommands_PreSettingCommand_MachiningResolution_mm_" data-uid="Hi.SessionCommands.PreSettingCommand.MachiningResolution_mm*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PreSettingCommand_MachiningResolution_mm" data-uid="Hi.ShellCommands.PreSettingCommand.MachiningResolution_mm">
|
||||
<h3 id="Hi_SessionCommands_PreSettingCommand_MachiningResolution_mm" data-uid="Hi.SessionCommands.PreSettingCommand.MachiningResolution_mm">
|
||||
MachiningResolution_mm
|
||||
|
||||
</h3>
|
||||
@@ -454,9 +454,9 @@ Class PreSettingCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PreSettingCommand_RuntimeGeomFile_" data-uid="Hi.ShellCommands.PreSettingCommand.RuntimeGeomFile*"></a>
|
||||
<a id="Hi_SessionCommands_PreSettingCommand_RuntimeGeomFile_" data-uid="Hi.SessionCommands.PreSettingCommand.RuntimeGeomFile*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PreSettingCommand_RuntimeGeomFile" data-uid="Hi.ShellCommands.PreSettingCommand.RuntimeGeomFile">
|
||||
<h3 id="Hi_SessionCommands_PreSettingCommand_RuntimeGeomFile" data-uid="Hi.SessionCommands.PreSettingCommand.RuntimeGeomFile">
|
||||
RuntimeGeomFile
|
||||
|
||||
</h3>
|
||||
@@ -486,9 +486,9 @@ Class PreSettingCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PreSettingCommand_XName_" data-uid="Hi.ShellCommands.PreSettingCommand.XName*"></a>
|
||||
<a id="Hi_SessionCommands_PreSettingCommand_XName_" data-uid="Hi.SessionCommands.PreSettingCommand.XName*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PreSettingCommand_XName" data-uid="Hi.ShellCommands.PreSettingCommand.XName">
|
||||
<h3 id="Hi_SessionCommands_PreSettingCommand_XName" data-uid="Hi.SessionCommands.PreSettingCommand.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
@@ -522,9 +522,9 @@ Class PreSettingCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PreSettingCommand_GetCommandTitle_" data-uid="Hi.ShellCommands.PreSettingCommand.GetCommandTitle*"></a>
|
||||
<a id="Hi_SessionCommands_PreSettingCommand_GetCommandTitle_" data-uid="Hi.SessionCommands.PreSettingCommand.GetCommandTitle*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PreSettingCommand_GetCommandTitle" data-uid="Hi.ShellCommands.PreSettingCommand.GetCommandTitle">
|
||||
<h3 id="Hi_SessionCommands_PreSettingCommand_GetCommandTitle" data-uid="Hi.SessionCommands.PreSettingCommand.GetCommandTitle">
|
||||
GetCommandTitle()
|
||||
|
||||
</h3>
|
||||
@@ -555,9 +555,9 @@ Class PreSettingCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PreSettingCommand_MakeXmlSource_" data-uid="Hi.ShellCommands.PreSettingCommand.MakeXmlSource*"></a>
|
||||
<a id="Hi_SessionCommands_PreSettingCommand_MakeXmlSource_" data-uid="Hi.SessionCommands.PreSettingCommand.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PreSettingCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.ShellCommands.PreSettingCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
<h3 id="Hi_SessionCommands_PreSettingCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.SessionCommands.PreSettingCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
@@ -597,7 +597,7 @@ This method may also generate additional resources such as related files.</p>
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_ShellCommands_PreSettingCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<h4 class="section" id="Hi_SessionCommands_PreSettingCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
@@ -606,25 +606,25 @@ Since the folder can be moving with the configuration file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_PreSettingCommand_Run_" data-uid="Hi.ShellCommands.PreSettingCommand.Run*"></a>
|
||||
<a id="Hi_SessionCommands_PreSettingCommand_Run_" data-uid="Hi.SessionCommands.PreSettingCommand.Run*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_PreSettingCommand_Run_Hi_MachiningProcs_RuntimeApi_" data-uid="Hi.ShellCommands.PreSettingCommand.Run(Hi.MachiningProcs.RuntimeApi)">
|
||||
Run(RuntimeApi)
|
||||
<h3 id="Hi_SessionCommands_PreSettingCommand_Run_Hi_MachiningProcs_SessionShell_" data-uid="Hi.SessionCommands.PreSettingCommand.Run(Hi.MachiningProcs.SessionShell)">
|
||||
Run(SessionShell)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Runs the command using the provided script API.</p>
|
||||
<div class="markdown level1 summary"><p>Runs the command, delegating execution to the provided session shell.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(RuntimeApi scriptApi)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(SessionShell sessionShell)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
|
||||
<dd><p>Script API for executing milling commands.</p>
|
||||
<dt><code>sessionShell</code> <a class="xref" href="Hi.MachiningProcs.SessionShell.html">SessionShell</a></dt>
|
||||
<dd><p>Session shell that exposes the machining facade to commands.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+8
-8
@@ -84,21 +84,21 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ShellCommands.RecordRuntimeGeomActionEnum">
|
||||
<article data-uid="Hi.SessionCommands.RecordRuntimeGeomActionEnum">
|
||||
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_ShellCommands_RecordRuntimeGeomActionEnum" data-uid="Hi.ShellCommands.RecordRuntimeGeomActionEnum" class="text-break">
|
||||
<h1 id="Hi_SessionCommands_RecordRuntimeGeomActionEnum" data-uid="Hi.SessionCommands.RecordRuntimeGeomActionEnum" class="text-break">
|
||||
Enum RecordRuntimeGeomActionEnum
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.ShellCommands.html">ShellCommands</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.SessionCommands.html">SessionCommands</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Action of the <a class="xref" href="Hi.ShellCommands.RecordRuntimeGeomCommand.html">RecordRuntimeGeomCommand</a>.</p>
|
||||
<div class="markdown summary"><p>Action of the <a class="xref" href="Hi.SessionCommands.RecordRuntimeGeomCommand.html">RecordRuntimeGeomCommand</a>.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
@@ -145,20 +145,20 @@ Enum RecordRuntimeGeomActionEnum
|
||||
<h2 id="fields">Fields
|
||||
</h2>
|
||||
<dl class="parameters">
|
||||
<dt id="Hi_ShellCommands_RecordRuntimeGeomActionEnum_NoAction"><code>NoAction = 0</code></dt>
|
||||
<dt id="Hi_SessionCommands_RecordRuntimeGeomActionEnum_NoAction"><code>NoAction = 0</code></dt>
|
||||
|
||||
<dd><p>No action.</p>
|
||||
</dd>
|
||||
<dt id="Hi_ShellCommands_RecordRuntimeGeomActionEnum_Read"><code>Read = 1</code></dt>
|
||||
<dt id="Hi_SessionCommands_RecordRuntimeGeomActionEnum_Read"><code>Read = 1</code></dt>
|
||||
|
||||
<dd><p>Read runtime geometry from file.</p>
|
||||
</dd>
|
||||
<dt id="Hi_ShellCommands_RecordRuntimeGeomActionEnum_ReadOnFirstOrWrite"><code>ReadOnFirstOrWrite = 3</code></dt>
|
||||
<dt id="Hi_SessionCommands_RecordRuntimeGeomActionEnum_ReadOnFirstOrWrite"><code>ReadOnFirstOrWrite = 3</code></dt>
|
||||
|
||||
<dd><p>If file existed and no motion has ran before, read the runtime geometry;
|
||||
otherwise, write the current geometry into file.</p>
|
||||
</dd>
|
||||
<dt id="Hi_ShellCommands_RecordRuntimeGeomActionEnum_Write"><code>Write = 2</code></dt>
|
||||
<dt id="Hi_SessionCommands_RecordRuntimeGeomActionEnum_Write"><code>Write = 2</code></dt>
|
||||
|
||||
<dd><p>Write runtime geometry to file.</p>
|
||||
</dd>
|
||||
+26
-26
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ShellCommands.RecordRuntimeGeomCommand">
|
||||
<article data-uid="Hi.SessionCommands.RecordRuntimeGeomCommand">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_ShellCommands_RecordRuntimeGeomCommand" data-uid="Hi.ShellCommands.RecordRuntimeGeomCommand" class="text-break">
|
||||
<h1 id="Hi_SessionCommands_RecordRuntimeGeomCommand" data-uid="Hi.SessionCommands.RecordRuntimeGeomCommand" class="text-break">
|
||||
Class RecordRuntimeGeomCommand
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.ShellCommands.html">ShellCommands</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.SessionCommands.html">SessionCommands</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -102,7 +102,7 @@ Class RecordRuntimeGeomCommand
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class RecordRuntimeGeomCommand : IShellCommand, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class RecordRuntimeGeomCommand : ISessionCommand, IMakeXmlSource</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -119,7 +119,7 @@ Class RecordRuntimeGeomCommand
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.ShellCommands.IShellCommand.html">IShellCommand</a></div>
|
||||
<div><a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -185,9 +185,9 @@ Class RecordRuntimeGeomCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_RecordRuntimeGeomCommand__ctor_" data-uid="Hi.ShellCommands.RecordRuntimeGeomCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_RecordRuntimeGeomCommand__ctor_" data-uid="Hi.SessionCommands.RecordRuntimeGeomCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_RecordRuntimeGeomCommand__ctor" data-uid="Hi.ShellCommands.RecordRuntimeGeomCommand.#ctor">
|
||||
<h3 id="Hi_SessionCommands_RecordRuntimeGeomCommand__ctor" data-uid="Hi.SessionCommands.RecordRuntimeGeomCommand.#ctor">
|
||||
RecordRuntimeGeomCommand()
|
||||
|
||||
</h3>
|
||||
@@ -212,9 +212,9 @@ Class RecordRuntimeGeomCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_RecordRuntimeGeomCommand__ctor_" data-uid="Hi.ShellCommands.RecordRuntimeGeomCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_RecordRuntimeGeomCommand__ctor_" data-uid="Hi.SessionCommands.RecordRuntimeGeomCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_RecordRuntimeGeomCommand__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.ShellCommands.RecordRuntimeGeomCommand.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
<h3 id="Hi_SessionCommands_RecordRuntimeGeomCommand__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.SessionCommands.RecordRuntimeGeomCommand.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
RecordRuntimeGeomCommand(XElement, string)
|
||||
|
||||
</h3>
|
||||
@@ -252,9 +252,9 @@ Class RecordRuntimeGeomCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_RecordRuntimeGeomCommand_MainActionEnum_" data-uid="Hi.ShellCommands.RecordRuntimeGeomCommand.MainActionEnum*"></a>
|
||||
<a id="Hi_SessionCommands_RecordRuntimeGeomCommand_MainActionEnum_" data-uid="Hi.SessionCommands.RecordRuntimeGeomCommand.MainActionEnum*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_RecordRuntimeGeomCommand_MainActionEnum" data-uid="Hi.ShellCommands.RecordRuntimeGeomCommand.MainActionEnum">
|
||||
<h3 id="Hi_SessionCommands_RecordRuntimeGeomCommand_MainActionEnum" data-uid="Hi.SessionCommands.RecordRuntimeGeomCommand.MainActionEnum">
|
||||
MainActionEnum
|
||||
|
||||
</h3>
|
||||
@@ -273,7 +273,7 @@ Class RecordRuntimeGeomCommand
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.ShellCommands.RecordRuntimeGeomActionEnum.html">RecordRuntimeGeomActionEnum</a></dt>
|
||||
<dt><a class="xref" href="Hi.SessionCommands.RecordRuntimeGeomActionEnum.html">RecordRuntimeGeomActionEnum</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
@@ -284,9 +284,9 @@ Class RecordRuntimeGeomCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_RecordRuntimeGeomCommand_RelFile_" data-uid="Hi.ShellCommands.RecordRuntimeGeomCommand.RelFile*"></a>
|
||||
<a id="Hi_SessionCommands_RecordRuntimeGeomCommand_RelFile_" data-uid="Hi.SessionCommands.RecordRuntimeGeomCommand.RelFile*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_RecordRuntimeGeomCommand_RelFile" data-uid="Hi.ShellCommands.RecordRuntimeGeomCommand.RelFile">
|
||||
<h3 id="Hi_SessionCommands_RecordRuntimeGeomCommand_RelFile" data-uid="Hi.SessionCommands.RecordRuntimeGeomCommand.RelFile">
|
||||
RelFile
|
||||
|
||||
</h3>
|
||||
@@ -316,9 +316,9 @@ Class RecordRuntimeGeomCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_RecordRuntimeGeomCommand_XName_" data-uid="Hi.ShellCommands.RecordRuntimeGeomCommand.XName*"></a>
|
||||
<a id="Hi_SessionCommands_RecordRuntimeGeomCommand_XName_" data-uid="Hi.SessionCommands.RecordRuntimeGeomCommand.XName*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_RecordRuntimeGeomCommand_XName" data-uid="Hi.ShellCommands.RecordRuntimeGeomCommand.XName">
|
||||
<h3 id="Hi_SessionCommands_RecordRuntimeGeomCommand_XName" data-uid="Hi.SessionCommands.RecordRuntimeGeomCommand.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
@@ -352,9 +352,9 @@ Class RecordRuntimeGeomCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_RecordRuntimeGeomCommand_MakeXmlSource_" data-uid="Hi.ShellCommands.RecordRuntimeGeomCommand.MakeXmlSource*"></a>
|
||||
<a id="Hi_SessionCommands_RecordRuntimeGeomCommand_MakeXmlSource_" data-uid="Hi.SessionCommands.RecordRuntimeGeomCommand.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_RecordRuntimeGeomCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.ShellCommands.RecordRuntimeGeomCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
<h3 id="Hi_SessionCommands_RecordRuntimeGeomCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.SessionCommands.RecordRuntimeGeomCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
@@ -394,7 +394,7 @@ This method may also generate additional resources such as related files.</p>
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_ShellCommands_RecordRuntimeGeomCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<h4 class="section" id="Hi_SessionCommands_RecordRuntimeGeomCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
@@ -403,25 +403,25 @@ Since the folder can be moving with the configuration file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_RecordRuntimeGeomCommand_Run_" data-uid="Hi.ShellCommands.RecordRuntimeGeomCommand.Run*"></a>
|
||||
<a id="Hi_SessionCommands_RecordRuntimeGeomCommand_Run_" data-uid="Hi.SessionCommands.RecordRuntimeGeomCommand.Run*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_RecordRuntimeGeomCommand_Run_Hi_MachiningProcs_RuntimeApi_" data-uid="Hi.ShellCommands.RecordRuntimeGeomCommand.Run(Hi.MachiningProcs.RuntimeApi)">
|
||||
Run(RuntimeApi)
|
||||
<h3 id="Hi_SessionCommands_RecordRuntimeGeomCommand_Run_Hi_MachiningProcs_SessionShell_" data-uid="Hi.SessionCommands.RecordRuntimeGeomCommand.Run(Hi.MachiningProcs.SessionShell)">
|
||||
Run(SessionShell)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Runs the command using the provided script API.</p>
|
||||
<div class="markdown level1 summary"><p>Runs the command, delegating execution to the provided session shell.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(RuntimeApi scriptApi)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(SessionShell sessionShell)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
|
||||
<dd><p>Script API for executing milling commands.</p>
|
||||
<dt><code>sessionShell</code> <a class="xref" href="Hi.MachiningProcs.SessionShell.html">SessionShell</a></dt>
|
||||
<dd><p>Session shell that exposes the machining facade to commands.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+49
-49
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ShellCommands.ScriptCommand">
|
||||
<article data-uid="Hi.SessionCommands.ScriptCommand">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_ShellCommands_ScriptCommand" data-uid="Hi.ShellCommands.ScriptCommand" class="text-break">
|
||||
<h1 id="Hi_SessionCommands_ScriptCommand" data-uid="Hi.SessionCommands.ScriptCommand" class="text-break">
|
||||
Class ScriptCommand
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.ShellCommands.html">ShellCommands</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.SessionCommands.html">SessionCommands</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -102,7 +102,7 @@ Class ScriptCommand
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ScriptCommand : ITitleCommand, IShellCommand, IMakeXmlSource, IGetSelectionName</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class ScriptCommand : ITitleCommand, ISessionCommand, IMakeXmlSource, IGetSelectionName</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -119,8 +119,8 @@ Class ScriptCommand
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.ShellCommands.ITitleCommand.html">ITitleCommand</a></div>
|
||||
<div><a class="xref" href="Hi.ShellCommands.IShellCommand.html">IShellCommand</a></div>
|
||||
<div><a class="xref" href="Hi.SessionCommands.ITitleCommand.html">ITitleCommand</a></div>
|
||||
<div><a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
||||
<div><a class="xref" href="Hi.Common.IGetSelectionName.html">IGetSelectionName</a></div>
|
||||
</dd>
|
||||
@@ -187,9 +187,9 @@ Class ScriptCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_ScriptCommand__ctor_" data-uid="Hi.ShellCommands.ScriptCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_ScriptCommand__ctor_" data-uid="Hi.SessionCommands.ScriptCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_ScriptCommand__ctor" data-uid="Hi.ShellCommands.ScriptCommand.#ctor">
|
||||
<h3 id="Hi_SessionCommands_ScriptCommand__ctor" data-uid="Hi.SessionCommands.ScriptCommand.#ctor">
|
||||
ScriptCommand()
|
||||
|
||||
</h3>
|
||||
@@ -214,9 +214,9 @@ Class ScriptCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_ScriptCommand__ctor_" data-uid="Hi.ShellCommands.ScriptCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_ScriptCommand__ctor_" data-uid="Hi.SessionCommands.ScriptCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_ScriptCommand__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.ShellCommands.ScriptCommand.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
<h3 id="Hi_SessionCommands_ScriptCommand__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.SessionCommands.ScriptCommand.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
ScriptCommand(XElement, string)
|
||||
|
||||
</h3>
|
||||
@@ -254,9 +254,9 @@ Class ScriptCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_ScriptCommand_ExecutionTemplate_" data-uid="Hi.ShellCommands.ScriptCommand.ExecutionTemplate*"></a>
|
||||
<a id="Hi_SessionCommands_ScriptCommand_ExecutionTemplate_" data-uid="Hi.SessionCommands.ScriptCommand.ExecutionTemplate*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_ScriptCommand_ExecutionTemplate" data-uid="Hi.ShellCommands.ScriptCommand.ExecutionTemplate">
|
||||
<h3 id="Hi_SessionCommands_ScriptCommand_ExecutionTemplate" data-uid="Hi.SessionCommands.ScriptCommand.ExecutionTemplate">
|
||||
ExecutionTemplate
|
||||
|
||||
</h3>
|
||||
@@ -275,7 +275,7 @@ Class ScriptCommand
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.ShellCommands.ScriptCommand.html">ScriptCommand</a></dt>
|
||||
<dt><a class="xref" href="Hi.SessionCommands.ScriptCommand.html">ScriptCommand</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
@@ -286,9 +286,9 @@ Class ScriptCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_ScriptCommand_OptimizationConfigurationTemplate_" data-uid="Hi.ShellCommands.ScriptCommand.OptimizationConfigurationTemplate*"></a>
|
||||
<a id="Hi_SessionCommands_ScriptCommand_OptimizationConfigurationTemplate_" data-uid="Hi.SessionCommands.ScriptCommand.OptimizationConfigurationTemplate*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_ScriptCommand_OptimizationConfigurationTemplate" data-uid="Hi.ShellCommands.ScriptCommand.OptimizationConfigurationTemplate">
|
||||
<h3 id="Hi_SessionCommands_ScriptCommand_OptimizationConfigurationTemplate" data-uid="Hi.SessionCommands.ScriptCommand.OptimizationConfigurationTemplate">
|
||||
OptimizationConfigurationTemplate
|
||||
|
||||
</h3>
|
||||
@@ -307,7 +307,7 @@ Class ScriptCommand
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.ShellCommands.ScriptCommand.html">ScriptCommand</a></dt>
|
||||
<dt><a class="xref" href="Hi.SessionCommands.ScriptCommand.html">ScriptCommand</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
@@ -318,9 +318,9 @@ Class ScriptCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_ScriptCommand_PreSettingTemplate_" data-uid="Hi.ShellCommands.ScriptCommand.PreSettingTemplate*"></a>
|
||||
<a id="Hi_SessionCommands_ScriptCommand_PreSettingTemplate_" data-uid="Hi.SessionCommands.ScriptCommand.PreSettingTemplate*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_ScriptCommand_PreSettingTemplate" data-uid="Hi.ShellCommands.ScriptCommand.PreSettingTemplate">
|
||||
<h3 id="Hi_SessionCommands_ScriptCommand_PreSettingTemplate" data-uid="Hi.SessionCommands.ScriptCommand.PreSettingTemplate">
|
||||
PreSettingTemplate
|
||||
|
||||
</h3>
|
||||
@@ -339,7 +339,7 @@ Class ScriptCommand
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.ShellCommands.ScriptCommand.html">ScriptCommand</a></dt>
|
||||
<dt><a class="xref" href="Hi.SessionCommands.ScriptCommand.html">ScriptCommand</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
@@ -350,9 +350,9 @@ Class ScriptCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_ScriptCommand_ScriptText_" data-uid="Hi.ShellCommands.ScriptCommand.ScriptText*"></a>
|
||||
<a id="Hi_SessionCommands_ScriptCommand_ScriptText_" data-uid="Hi.SessionCommands.ScriptCommand.ScriptText*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_ScriptCommand_ScriptText" data-uid="Hi.ShellCommands.ScriptCommand.ScriptText">
|
||||
<h3 id="Hi_SessionCommands_ScriptCommand_ScriptText" data-uid="Hi.SessionCommands.ScriptCommand.ScriptText">
|
||||
ScriptText
|
||||
|
||||
</h3>
|
||||
@@ -382,9 +382,9 @@ Class ScriptCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_ScriptCommand_ScriptTitle_" data-uid="Hi.ShellCommands.ScriptCommand.ScriptTitle*"></a>
|
||||
<a id="Hi_SessionCommands_ScriptCommand_ScriptTitle_" data-uid="Hi.SessionCommands.ScriptCommand.ScriptTitle*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_ScriptCommand_ScriptTitle" data-uid="Hi.ShellCommands.ScriptCommand.ScriptTitle">
|
||||
<h3 id="Hi_SessionCommands_ScriptCommand_ScriptTitle" data-uid="Hi.SessionCommands.ScriptCommand.ScriptTitle">
|
||||
ScriptTitle
|
||||
|
||||
</h3>
|
||||
@@ -414,9 +414,9 @@ Class ScriptCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_ScriptCommand_XName_" data-uid="Hi.ShellCommands.ScriptCommand.XName*"></a>
|
||||
<a id="Hi_SessionCommands_ScriptCommand_XName_" data-uid="Hi.SessionCommands.ScriptCommand.XName*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_ScriptCommand_XName" data-uid="Hi.ShellCommands.ScriptCommand.XName">
|
||||
<h3 id="Hi_SessionCommands_ScriptCommand_XName" data-uid="Hi.SessionCommands.ScriptCommand.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
@@ -450,9 +450,9 @@ Class ScriptCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_ScriptCommand_GenTemplateCommand_" data-uid="Hi.ShellCommands.ScriptCommand.GenTemplateCommand*"></a>
|
||||
<a id="Hi_SessionCommands_ScriptCommand_GenTemplateCommand_" data-uid="Hi.SessionCommands.ScriptCommand.GenTemplateCommand*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_ScriptCommand_GenTemplateCommand" data-uid="Hi.ShellCommands.ScriptCommand.GenTemplateCommand">
|
||||
<h3 id="Hi_SessionCommands_ScriptCommand_GenTemplateCommand" data-uid="Hi.SessionCommands.ScriptCommand.GenTemplateCommand">
|
||||
GenTemplateCommand()
|
||||
|
||||
</h3>
|
||||
@@ -468,7 +468,7 @@ Class ScriptCommand
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.ShellCommands.ScriptCommand.html">ScriptCommand</a></dt>
|
||||
<dt><a class="xref" href="Hi.SessionCommands.ScriptCommand.html">ScriptCommand</a></dt>
|
||||
<dd><p>A new ScriptCommand with template values</p>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -483,9 +483,9 @@ Class ScriptCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_ScriptCommand_GetCommandTitle_" data-uid="Hi.ShellCommands.ScriptCommand.GetCommandTitle*"></a>
|
||||
<a id="Hi_SessionCommands_ScriptCommand_GetCommandTitle_" data-uid="Hi.SessionCommands.ScriptCommand.GetCommandTitle*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_ScriptCommand_GetCommandTitle" data-uid="Hi.ShellCommands.ScriptCommand.GetCommandTitle">
|
||||
<h3 id="Hi_SessionCommands_ScriptCommand_GetCommandTitle" data-uid="Hi.SessionCommands.ScriptCommand.GetCommandTitle">
|
||||
GetCommandTitle()
|
||||
|
||||
</h3>
|
||||
@@ -516,9 +516,9 @@ Class ScriptCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_ScriptCommand_GetSelectionName_" data-uid="Hi.ShellCommands.ScriptCommand.GetSelectionName*"></a>
|
||||
<a id="Hi_SessionCommands_ScriptCommand_GetSelectionName_" data-uid="Hi.SessionCommands.ScriptCommand.GetSelectionName*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_ScriptCommand_GetSelectionName" data-uid="Hi.ShellCommands.ScriptCommand.GetSelectionName">
|
||||
<h3 id="Hi_SessionCommands_ScriptCommand_GetSelectionName" data-uid="Hi.SessionCommands.ScriptCommand.GetSelectionName">
|
||||
GetSelectionName()
|
||||
|
||||
</h3>
|
||||
@@ -549,9 +549,9 @@ Class ScriptCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_ScriptCommand_MakeXmlSource_" data-uid="Hi.ShellCommands.ScriptCommand.MakeXmlSource*"></a>
|
||||
<a id="Hi_SessionCommands_ScriptCommand_MakeXmlSource_" data-uid="Hi.SessionCommands.ScriptCommand.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_ScriptCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.ShellCommands.ScriptCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
<h3 id="Hi_SessionCommands_ScriptCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.SessionCommands.ScriptCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
@@ -591,7 +591,7 @@ This method may also generate additional resources such as related files.</p>
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_ShellCommands_ScriptCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<h4 class="section" id="Hi_SessionCommands_ScriptCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
@@ -600,25 +600,25 @@ Since the folder can be moving with the configuration file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_ScriptCommand_Run_" data-uid="Hi.ShellCommands.ScriptCommand.Run*"></a>
|
||||
<a id="Hi_SessionCommands_ScriptCommand_Run_" data-uid="Hi.SessionCommands.ScriptCommand.Run*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_ScriptCommand_Run_Hi_MachiningProcs_RuntimeApi_" data-uid="Hi.ShellCommands.ScriptCommand.Run(Hi.MachiningProcs.RuntimeApi)">
|
||||
Run(RuntimeApi)
|
||||
<h3 id="Hi_SessionCommands_ScriptCommand_Run_Hi_MachiningProcs_SessionShell_" data-uid="Hi.SessionCommands.ScriptCommand.Run(Hi.MachiningProcs.SessionShell)">
|
||||
Run(SessionShell)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Runs the command using the provided script API.</p>
|
||||
<div class="markdown level1 summary"><p>Runs the command, delegating execution to the provided session shell.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(RuntimeApi scriptApi)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(SessionShell sessionShell)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
|
||||
<dd><p>Script API for executing milling commands.</p>
|
||||
<dt><code>sessionShell</code> <a class="xref" href="Hi.MachiningProcs.SessionShell.html">SessionShell</a></dt>
|
||||
<dd><p>Session shell that exposes the machining facade to commands.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -639,25 +639,25 @@ Since the folder can be moving with the configuration file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_ScriptCommand_Run_" data-uid="Hi.ShellCommands.ScriptCommand.Run*"></a>
|
||||
<a id="Hi_SessionCommands_ScriptCommand_Run_" data-uid="Hi.SessionCommands.ScriptCommand.Run*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_ScriptCommand_Run_Hi_MachiningProcs_RuntimeApi_System_String_" data-uid="Hi.ShellCommands.ScriptCommand.Run(Hi.MachiningProcs.RuntimeApi,System.String)">
|
||||
Run(RuntimeApi, string)
|
||||
<h3 id="Hi_SessionCommands_ScriptCommand_Run_Hi_MachiningProcs_SessionShell_System_String_" data-uid="Hi.SessionCommands.ScriptCommand.Run(Hi.MachiningProcs.SessionShell,System.String)">
|
||||
Run(SessionShell, string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Runs a specified script with the given script API.</p>
|
||||
<div class="markdown level1 summary"><p>Runs a specified script with the given session shell.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(RuntimeApi scriptApi, string scriptText)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(SessionShell sessionShell, string scriptText)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
|
||||
<dd><p>The milling course script API</p>
|
||||
<dt><code>sessionShell</code> <a class="xref" href="Hi.MachiningProcs.SessionShell.html">SessionShell</a></dt>
|
||||
<dd><p>The session shell that scripts delegate to.</p>
|
||||
</dd>
|
||||
<dt><code>scriptText</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The script text to run</p>
|
||||
+61
-61
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ShellCommands.SimpleSessionCommand">
|
||||
<article data-uid="Hi.SessionCommands.SimpleSessionCommand">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_ShellCommands_SimpleSessionCommand" data-uid="Hi.ShellCommands.SimpleSessionCommand" class="text-break">
|
||||
<h1 id="Hi_SessionCommands_SimpleSessionCommand" data-uid="Hi.SessionCommands.SimpleSessionCommand" class="text-break">
|
||||
Class SimpleSessionCommand
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.ShellCommands.html">ShellCommands</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.SessionCommands.html">SessionCommands</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -102,7 +102,7 @@ Class SimpleSessionCommand
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class SimpleSessionCommand : IShellCommand, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class SimpleSessionCommand : ISessionCommand, IMakeXmlSource</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -119,7 +119,7 @@ Class SimpleSessionCommand
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.ShellCommands.IShellCommand.html">IShellCommand</a></div>
|
||||
<div><a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -185,9 +185,9 @@ Class SimpleSessionCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_SimpleSessionCommand__ctor_" data-uid="Hi.ShellCommands.SimpleSessionCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_SimpleSessionCommand__ctor_" data-uid="Hi.SessionCommands.SimpleSessionCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_SimpleSessionCommand__ctor" data-uid="Hi.ShellCommands.SimpleSessionCommand.#ctor">
|
||||
<h3 id="Hi_SessionCommands_SimpleSessionCommand__ctor" data-uid="Hi.SessionCommands.SimpleSessionCommand.#ctor">
|
||||
SimpleSessionCommand()
|
||||
|
||||
</h3>
|
||||
@@ -212,9 +212,9 @@ Class SimpleSessionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_SimpleSessionCommand__ctor_" data-uid="Hi.ShellCommands.SimpleSessionCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_SimpleSessionCommand__ctor_" data-uid="Hi.SessionCommands.SimpleSessionCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_SimpleSessionCommand__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_System_Object__System_Object___" data-uid="Hi.ShellCommands.SimpleSessionCommand.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{System.Object},System.Object[])">
|
||||
<h3 id="Hi_SessionCommands_SimpleSessionCommand__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_System_Object__System_Object___" data-uid="Hi.SessionCommands.SimpleSessionCommand.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{System.Object},System.Object[])">
|
||||
SimpleSessionCommand(XElement, string, string, IProgress<object>, object[])
|
||||
|
||||
</h3>
|
||||
@@ -261,9 +261,9 @@ Class SimpleSessionCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_SimpleSessionCommand_EnableCollisionDetection_" data-uid="Hi.ShellCommands.SimpleSessionCommand.EnableCollisionDetection*"></a>
|
||||
<a id="Hi_SessionCommands_SimpleSessionCommand_EnableCollisionDetection_" data-uid="Hi.SessionCommands.SimpleSessionCommand.EnableCollisionDetection*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_SimpleSessionCommand_EnableCollisionDetection" data-uid="Hi.ShellCommands.SimpleSessionCommand.EnableCollisionDetection">
|
||||
<h3 id="Hi_SessionCommands_SimpleSessionCommand_EnableCollisionDetection" data-uid="Hi.SessionCommands.SimpleSessionCommand.EnableCollisionDetection">
|
||||
EnableCollisionDetection
|
||||
|
||||
</h3>
|
||||
@@ -293,9 +293,9 @@ Class SimpleSessionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_SimpleSessionCommand_EnableGeomDiff_" data-uid="Hi.ShellCommands.SimpleSessionCommand.EnableGeomDiff*"></a>
|
||||
<a id="Hi_SessionCommands_SimpleSessionCommand_EnableGeomDiff_" data-uid="Hi.SessionCommands.SimpleSessionCommand.EnableGeomDiff*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_SimpleSessionCommand_EnableGeomDiff" data-uid="Hi.ShellCommands.SimpleSessionCommand.EnableGeomDiff">
|
||||
<h3 id="Hi_SessionCommands_SimpleSessionCommand_EnableGeomDiff" data-uid="Hi.SessionCommands.SimpleSessionCommand.EnableGeomDiff">
|
||||
EnableGeomDiff
|
||||
|
||||
</h3>
|
||||
@@ -325,9 +325,9 @@ Class SimpleSessionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_SimpleSessionCommand_EnableOptimizeToFiles_" data-uid="Hi.ShellCommands.SimpleSessionCommand.EnableOptimizeToFiles*"></a>
|
||||
<a id="Hi_SessionCommands_SimpleSessionCommand_EnableOptimizeToFiles_" data-uid="Hi.SessionCommands.SimpleSessionCommand.EnableOptimizeToFiles*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_SimpleSessionCommand_EnableOptimizeToFiles" data-uid="Hi.ShellCommands.SimpleSessionCommand.EnableOptimizeToFiles">
|
||||
<h3 id="Hi_SessionCommands_SimpleSessionCommand_EnableOptimizeToFiles" data-uid="Hi.SessionCommands.SimpleSessionCommand.EnableOptimizeToFiles">
|
||||
EnableOptimizeToFiles
|
||||
|
||||
</h3>
|
||||
@@ -357,9 +357,9 @@ Class SimpleSessionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_SimpleSessionCommand_EnablePauseOnFailure_" data-uid="Hi.ShellCommands.SimpleSessionCommand.EnablePauseOnFailure*"></a>
|
||||
<a id="Hi_SessionCommands_SimpleSessionCommand_EnablePauseOnFailure_" data-uid="Hi.SessionCommands.SimpleSessionCommand.EnablePauseOnFailure*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_SimpleSessionCommand_EnablePauseOnFailure" data-uid="Hi.ShellCommands.SimpleSessionCommand.EnablePauseOnFailure">
|
||||
<h3 id="Hi_SessionCommands_SimpleSessionCommand_EnablePauseOnFailure" data-uid="Hi.SessionCommands.SimpleSessionCommand.EnablePauseOnFailure">
|
||||
EnablePauseOnFailure
|
||||
|
||||
</h3>
|
||||
@@ -389,9 +389,9 @@ Class SimpleSessionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_SimpleSessionCommand_EnableReadRuntimeGeom_" data-uid="Hi.ShellCommands.SimpleSessionCommand.EnableReadRuntimeGeom*"></a>
|
||||
<a id="Hi_SessionCommands_SimpleSessionCommand_EnableReadRuntimeGeom_" data-uid="Hi.SessionCommands.SimpleSessionCommand.EnableReadRuntimeGeom*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_SimpleSessionCommand_EnableReadRuntimeGeom" data-uid="Hi.ShellCommands.SimpleSessionCommand.EnableReadRuntimeGeom">
|
||||
<h3 id="Hi_SessionCommands_SimpleSessionCommand_EnableReadRuntimeGeom" data-uid="Hi.SessionCommands.SimpleSessionCommand.EnableReadRuntimeGeom">
|
||||
EnableReadRuntimeGeom
|
||||
|
||||
</h3>
|
||||
@@ -421,9 +421,9 @@ Class SimpleSessionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_SimpleSessionCommand_EnableWriteRuntimeGeom_" data-uid="Hi.ShellCommands.SimpleSessionCommand.EnableWriteRuntimeGeom*"></a>
|
||||
<a id="Hi_SessionCommands_SimpleSessionCommand_EnableWriteRuntimeGeom_" data-uid="Hi.SessionCommands.SimpleSessionCommand.EnableWriteRuntimeGeom*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_SimpleSessionCommand_EnableWriteRuntimeGeom" data-uid="Hi.ShellCommands.SimpleSessionCommand.EnableWriteRuntimeGeom">
|
||||
<h3 id="Hi_SessionCommands_SimpleSessionCommand_EnableWriteRuntimeGeom" data-uid="Hi.SessionCommands.SimpleSessionCommand.EnableWriteRuntimeGeom">
|
||||
EnableWriteRuntimeGeom
|
||||
|
||||
</h3>
|
||||
@@ -453,9 +453,9 @@ Class SimpleSessionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_SimpleSessionCommand_EnableWriteShotFiles_" data-uid="Hi.ShellCommands.SimpleSessionCommand.EnableWriteShotFiles*"></a>
|
||||
<a id="Hi_SessionCommands_SimpleSessionCommand_EnableWriteShotFiles_" data-uid="Hi.SessionCommands.SimpleSessionCommand.EnableWriteShotFiles*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_SimpleSessionCommand_EnableWriteShotFiles" data-uid="Hi.ShellCommands.SimpleSessionCommand.EnableWriteShotFiles">
|
||||
<h3 id="Hi_SessionCommands_SimpleSessionCommand_EnableWriteShotFiles" data-uid="Hi.SessionCommands.SimpleSessionCommand.EnableWriteShotFiles">
|
||||
EnableWriteShotFiles
|
||||
|
||||
</h3>
|
||||
@@ -485,9 +485,9 @@ Class SimpleSessionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_SimpleSessionCommand_EnableWriteStepFiles_" data-uid="Hi.ShellCommands.SimpleSessionCommand.EnableWriteStepFiles*"></a>
|
||||
<a id="Hi_SessionCommands_SimpleSessionCommand_EnableWriteStepFiles_" data-uid="Hi.SessionCommands.SimpleSessionCommand.EnableWriteStepFiles*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_SimpleSessionCommand_EnableWriteStepFiles" data-uid="Hi.ShellCommands.SimpleSessionCommand.EnableWriteStepFiles">
|
||||
<h3 id="Hi_SessionCommands_SimpleSessionCommand_EnableWriteStepFiles" data-uid="Hi.SessionCommands.SimpleSessionCommand.EnableWriteStepFiles">
|
||||
EnableWriteStepFiles
|
||||
|
||||
</h3>
|
||||
@@ -517,9 +517,9 @@ Class SimpleSessionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_SimpleSessionCommand_GeomDiffDetectRadius_mm_" data-uid="Hi.ShellCommands.SimpleSessionCommand.GeomDiffDetectRadius_mm*"></a>
|
||||
<a id="Hi_SessionCommands_SimpleSessionCommand_GeomDiffDetectRadius_mm_" data-uid="Hi.SessionCommands.SimpleSessionCommand.GeomDiffDetectRadius_mm*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_SimpleSessionCommand_GeomDiffDetectRadius_mm" data-uid="Hi.ShellCommands.SimpleSessionCommand.GeomDiffDetectRadius_mm">
|
||||
<h3 id="Hi_SessionCommands_SimpleSessionCommand_GeomDiffDetectRadius_mm" data-uid="Hi.SessionCommands.SimpleSessionCommand.GeomDiffDetectRadius_mm">
|
||||
GeomDiffDetectRadius_mm
|
||||
|
||||
</h3>
|
||||
@@ -549,9 +549,9 @@ Class SimpleSessionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_SimpleSessionCommand_MachiningMotionResolution_" data-uid="Hi.ShellCommands.SimpleSessionCommand.MachiningMotionResolution*"></a>
|
||||
<a id="Hi_SessionCommands_SimpleSessionCommand_MachiningMotionResolution_" data-uid="Hi.SessionCommands.SimpleSessionCommand.MachiningMotionResolution*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_SimpleSessionCommand_MachiningMotionResolution" data-uid="Hi.ShellCommands.SimpleSessionCommand.MachiningMotionResolution">
|
||||
<h3 id="Hi_SessionCommands_SimpleSessionCommand_MachiningMotionResolution" data-uid="Hi.SessionCommands.SimpleSessionCommand.MachiningMotionResolution">
|
||||
MachiningMotionResolution
|
||||
|
||||
</h3>
|
||||
@@ -581,9 +581,9 @@ Class SimpleSessionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_SimpleSessionCommand_MachiningResolution_mm_" data-uid="Hi.ShellCommands.SimpleSessionCommand.MachiningResolution_mm*"></a>
|
||||
<a id="Hi_SessionCommands_SimpleSessionCommand_MachiningResolution_mm_" data-uid="Hi.SessionCommands.SimpleSessionCommand.MachiningResolution_mm*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_SimpleSessionCommand_MachiningResolution_mm" data-uid="Hi.ShellCommands.SimpleSessionCommand.MachiningResolution_mm">
|
||||
<h3 id="Hi_SessionCommands_SimpleSessionCommand_MachiningResolution_mm" data-uid="Hi.SessionCommands.SimpleSessionCommand.MachiningResolution_mm">
|
||||
MachiningResolution_mm
|
||||
|
||||
</h3>
|
||||
@@ -613,15 +613,15 @@ Class SimpleSessionCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_SimpleSessionCommand_NcCommandList_" data-uid="Hi.ShellCommands.SimpleSessionCommand.NcCommandList*"></a>
|
||||
<a id="Hi_SessionCommands_SimpleSessionCommand_NcCommandList_" data-uid="Hi.SessionCommands.SimpleSessionCommand.NcCommandList*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_SimpleSessionCommand_NcCommandList" data-uid="Hi.ShellCommands.SimpleSessionCommand.NcCommandList">
|
||||
<h3 id="Hi_SessionCommands_SimpleSessionCommand_NcCommandList" data-uid="Hi.SessionCommands.SimpleSessionCommand.NcCommandList">
|
||||
NcCommandList
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Middle command list. Mainly for NC commands.
|
||||
Because of the design idea is for simplicity, only expect the wrapper content to be <a class="xref" href="Hi.ShellCommands.NcFileCommand.html">NcFileCommand</a> or <a class="xref" href="Hi.ShellCommands.NcCodeCommand.html">NcCodeCommand</a> or <a class="xref" href="Hi.ShellCommands.ScriptCommand.html">ScriptCommand</a>.</p>
|
||||
Because of the design idea is for simplicity, only expect the wrapper content to be <a class="xref" href="Hi.SessionCommands.NcFileCommand.html">NcFileCommand</a> or <a class="xref" href="Hi.SessionCommands.NcCodeCommand.html">NcCodeCommand</a> or <a class="xref" href="Hi.SessionCommands.ScriptCommand.html">ScriptCommand</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -635,7 +635,7 @@ Because of the design idea is for simplicity, only expect the wrapper content to
|
||||
|
||||
<h4 class="section">Property Value</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.ShellCommands.EnablingWrapper.html">EnablingWrapper</a>></dt>
|
||||
<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></dd>
|
||||
</dl>
|
||||
|
||||
@@ -646,9 +646,9 @@ Because of the design idea is for simplicity, only expect the wrapper content to
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_SimpleSessionCommand_NcOptOption_" data-uid="Hi.ShellCommands.SimpleSessionCommand.NcOptOption*"></a>
|
||||
<a id="Hi_SessionCommands_SimpleSessionCommand_NcOptOption_" data-uid="Hi.SessionCommands.SimpleSessionCommand.NcOptOption*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_SimpleSessionCommand_NcOptOption" data-uid="Hi.ShellCommands.SimpleSessionCommand.NcOptOption">
|
||||
<h3 id="Hi_SessionCommands_SimpleSessionCommand_NcOptOption" data-uid="Hi.SessionCommands.SimpleSessionCommand.NcOptOption">
|
||||
NcOptOption
|
||||
|
||||
</h3>
|
||||
@@ -678,9 +678,9 @@ Because of the design idea is for simplicity, only expect the wrapper content to
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_SimpleSessionCommand_OptimizationFileTemplate_" data-uid="Hi.ShellCommands.SimpleSessionCommand.OptimizationFileTemplate*"></a>
|
||||
<a id="Hi_SessionCommands_SimpleSessionCommand_OptimizationFileTemplate_" data-uid="Hi.SessionCommands.SimpleSessionCommand.OptimizationFileTemplate*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_SimpleSessionCommand_OptimizationFileTemplate" data-uid="Hi.ShellCommands.SimpleSessionCommand.OptimizationFileTemplate">
|
||||
<h3 id="Hi_SessionCommands_SimpleSessionCommand_OptimizationFileTemplate" data-uid="Hi.SessionCommands.SimpleSessionCommand.OptimizationFileTemplate">
|
||||
OptimizationFileTemplate
|
||||
|
||||
</h3>
|
||||
@@ -710,9 +710,9 @@ Because of the design idea is for simplicity, only expect the wrapper content to
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_SimpleSessionCommand_RuntimeGeomFile_" data-uid="Hi.ShellCommands.SimpleSessionCommand.RuntimeGeomFile*"></a>
|
||||
<a id="Hi_SessionCommands_SimpleSessionCommand_RuntimeGeomFile_" data-uid="Hi.SessionCommands.SimpleSessionCommand.RuntimeGeomFile*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_SimpleSessionCommand_RuntimeGeomFile" data-uid="Hi.ShellCommands.SimpleSessionCommand.RuntimeGeomFile">
|
||||
<h3 id="Hi_SessionCommands_SimpleSessionCommand_RuntimeGeomFile" data-uid="Hi.SessionCommands.SimpleSessionCommand.RuntimeGeomFile">
|
||||
RuntimeGeomFile
|
||||
|
||||
</h3>
|
||||
@@ -742,9 +742,9 @@ Because of the design idea is for simplicity, only expect the wrapper content to
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_SimpleSessionCommand_RuntimeGeomFileTemplate_" data-uid="Hi.ShellCommands.SimpleSessionCommand.RuntimeGeomFileTemplate*"></a>
|
||||
<a id="Hi_SessionCommands_SimpleSessionCommand_RuntimeGeomFileTemplate_" data-uid="Hi.SessionCommands.SimpleSessionCommand.RuntimeGeomFileTemplate*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_SimpleSessionCommand_RuntimeGeomFileTemplate" data-uid="Hi.ShellCommands.SimpleSessionCommand.RuntimeGeomFileTemplate">
|
||||
<h3 id="Hi_SessionCommands_SimpleSessionCommand_RuntimeGeomFileTemplate" data-uid="Hi.SessionCommands.SimpleSessionCommand.RuntimeGeomFileTemplate">
|
||||
RuntimeGeomFileTemplate
|
||||
|
||||
</h3>
|
||||
@@ -774,9 +774,9 @@ Because of the design idea is for simplicity, only expect the wrapper content to
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_SimpleSessionCommand_ShotFileTemplate_" data-uid="Hi.ShellCommands.SimpleSessionCommand.ShotFileTemplate*"></a>
|
||||
<a id="Hi_SessionCommands_SimpleSessionCommand_ShotFileTemplate_" data-uid="Hi.SessionCommands.SimpleSessionCommand.ShotFileTemplate*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_SimpleSessionCommand_ShotFileTemplate" data-uid="Hi.ShellCommands.SimpleSessionCommand.ShotFileTemplate">
|
||||
<h3 id="Hi_SessionCommands_SimpleSessionCommand_ShotFileTemplate" data-uid="Hi.SessionCommands.SimpleSessionCommand.ShotFileTemplate">
|
||||
ShotFileTemplate
|
||||
|
||||
</h3>
|
||||
@@ -806,9 +806,9 @@ Because of the design idea is for simplicity, only expect the wrapper content to
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_SimpleSessionCommand_ShotFileTimeResolution_ms_" data-uid="Hi.ShellCommands.SimpleSessionCommand.ShotFileTimeResolution_ms*"></a>
|
||||
<a id="Hi_SessionCommands_SimpleSessionCommand_ShotFileTimeResolution_ms_" data-uid="Hi.SessionCommands.SimpleSessionCommand.ShotFileTimeResolution_ms*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_SimpleSessionCommand_ShotFileTimeResolution_ms" data-uid="Hi.ShellCommands.SimpleSessionCommand.ShotFileTimeResolution_ms">
|
||||
<h3 id="Hi_SessionCommands_SimpleSessionCommand_ShotFileTimeResolution_ms" data-uid="Hi.SessionCommands.SimpleSessionCommand.ShotFileTimeResolution_ms">
|
||||
ShotFileTimeResolution_ms
|
||||
|
||||
</h3>
|
||||
@@ -838,9 +838,9 @@ Because of the design idea is for simplicity, only expect the wrapper content to
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_SimpleSessionCommand_StepFileTemplate_" data-uid="Hi.ShellCommands.SimpleSessionCommand.StepFileTemplate*"></a>
|
||||
<a id="Hi_SessionCommands_SimpleSessionCommand_StepFileTemplate_" data-uid="Hi.SessionCommands.SimpleSessionCommand.StepFileTemplate*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_SimpleSessionCommand_StepFileTemplate" data-uid="Hi.ShellCommands.SimpleSessionCommand.StepFileTemplate">
|
||||
<h3 id="Hi_SessionCommands_SimpleSessionCommand_StepFileTemplate" data-uid="Hi.SessionCommands.SimpleSessionCommand.StepFileTemplate">
|
||||
StepFileTemplate
|
||||
|
||||
</h3>
|
||||
@@ -870,9 +870,9 @@ Because of the design idea is for simplicity, only expect the wrapper content to
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_SimpleSessionCommand_XName_" data-uid="Hi.ShellCommands.SimpleSessionCommand.XName*"></a>
|
||||
<a id="Hi_SessionCommands_SimpleSessionCommand_XName_" data-uid="Hi.SessionCommands.SimpleSessionCommand.XName*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_SimpleSessionCommand_XName" data-uid="Hi.ShellCommands.SimpleSessionCommand.XName">
|
||||
<h3 id="Hi_SessionCommands_SimpleSessionCommand_XName" data-uid="Hi.SessionCommands.SimpleSessionCommand.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
@@ -906,9 +906,9 @@ Because of the design idea is for simplicity, only expect the wrapper content to
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_SimpleSessionCommand_MakeXmlSource_" data-uid="Hi.ShellCommands.SimpleSessionCommand.MakeXmlSource*"></a>
|
||||
<a id="Hi_SessionCommands_SimpleSessionCommand_MakeXmlSource_" data-uid="Hi.SessionCommands.SimpleSessionCommand.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_SimpleSessionCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.ShellCommands.SimpleSessionCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
<h3 id="Hi_SessionCommands_SimpleSessionCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.SessionCommands.SimpleSessionCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
@@ -948,7 +948,7 @@ This method may also generate additional resources such as related files.</p>
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_ShellCommands_SimpleSessionCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<h4 class="section" id="Hi_SessionCommands_SimpleSessionCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
@@ -957,25 +957,25 @@ Since the folder can be moving with the configuration file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_SimpleSessionCommand_Run_" data-uid="Hi.ShellCommands.SimpleSessionCommand.Run*"></a>
|
||||
<a id="Hi_SessionCommands_SimpleSessionCommand_Run_" data-uid="Hi.SessionCommands.SimpleSessionCommand.Run*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_SimpleSessionCommand_Run_Hi_MachiningProcs_RuntimeApi_" data-uid="Hi.ShellCommands.SimpleSessionCommand.Run(Hi.MachiningProcs.RuntimeApi)">
|
||||
Run(RuntimeApi)
|
||||
<h3 id="Hi_SessionCommands_SimpleSessionCommand_Run_Hi_MachiningProcs_SessionShell_" data-uid="Hi.SessionCommands.SimpleSessionCommand.Run(Hi.MachiningProcs.SessionShell)">
|
||||
Run(SessionShell)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Runs the command using the provided script API.</p>
|
||||
<div class="markdown level1 summary"><p>Runs the command, delegating execution to the provided session shell.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(RuntimeApi scriptApi)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(SessionShell sessionShell)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
|
||||
<dd><p>Script API for executing milling commands.</p>
|
||||
<dt><code>sessionShell</code> <a class="xref" href="Hi.MachiningProcs.SessionShell.html">SessionShell</a></dt>
|
||||
<dd><p>Session shell that exposes the machining facade to commands.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+25
-25
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ShellCommands.WriteRuntimeGeomToStlCommand">
|
||||
<article data-uid="Hi.SessionCommands.WriteRuntimeGeomToStlCommand">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_ShellCommands_WriteRuntimeGeomToStlCommand" data-uid="Hi.ShellCommands.WriteRuntimeGeomToStlCommand" class="text-break">
|
||||
<h1 id="Hi_SessionCommands_WriteRuntimeGeomToStlCommand" data-uid="Hi.SessionCommands.WriteRuntimeGeomToStlCommand" class="text-break">
|
||||
Class WriteRuntimeGeomToStlCommand
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.ShellCommands.html">ShellCommands</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.SessionCommands.html">SessionCommands</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -102,7 +102,7 @@ Class WriteRuntimeGeomToStlCommand
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class WriteRuntimeGeomToStlCommand : IShellCommand, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class WriteRuntimeGeomToStlCommand : ISessionCommand, IMakeXmlSource</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -119,7 +119,7 @@ Class WriteRuntimeGeomToStlCommand
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.ShellCommands.IShellCommand.html">IShellCommand</a></div>
|
||||
<div><a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -185,9 +185,9 @@ Class WriteRuntimeGeomToStlCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_WriteRuntimeGeomToStlCommand__ctor_" data-uid="Hi.ShellCommands.WriteRuntimeGeomToStlCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_WriteRuntimeGeomToStlCommand__ctor_" data-uid="Hi.SessionCommands.WriteRuntimeGeomToStlCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_WriteRuntimeGeomToStlCommand__ctor" data-uid="Hi.ShellCommands.WriteRuntimeGeomToStlCommand.#ctor">
|
||||
<h3 id="Hi_SessionCommands_WriteRuntimeGeomToStlCommand__ctor" data-uid="Hi.SessionCommands.WriteRuntimeGeomToStlCommand.#ctor">
|
||||
WriteRuntimeGeomToStlCommand()
|
||||
|
||||
</h3>
|
||||
@@ -212,9 +212,9 @@ Class WriteRuntimeGeomToStlCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_WriteRuntimeGeomToStlCommand__ctor_" data-uid="Hi.ShellCommands.WriteRuntimeGeomToStlCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_WriteRuntimeGeomToStlCommand__ctor_" data-uid="Hi.SessionCommands.WriteRuntimeGeomToStlCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_WriteRuntimeGeomToStlCommand__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.ShellCommands.WriteRuntimeGeomToStlCommand.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
<h3 id="Hi_SessionCommands_WriteRuntimeGeomToStlCommand__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.SessionCommands.WriteRuntimeGeomToStlCommand.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
WriteRuntimeGeomToStlCommand(XElement, string)
|
||||
|
||||
</h3>
|
||||
@@ -252,9 +252,9 @@ Class WriteRuntimeGeomToStlCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_WriteRuntimeGeomToStlCommand_RelFile_" data-uid="Hi.ShellCommands.WriteRuntimeGeomToStlCommand.RelFile*"></a>
|
||||
<a id="Hi_SessionCommands_WriteRuntimeGeomToStlCommand_RelFile_" data-uid="Hi.SessionCommands.WriteRuntimeGeomToStlCommand.RelFile*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_WriteRuntimeGeomToStlCommand_RelFile" data-uid="Hi.ShellCommands.WriteRuntimeGeomToStlCommand.RelFile">
|
||||
<h3 id="Hi_SessionCommands_WriteRuntimeGeomToStlCommand_RelFile" data-uid="Hi.SessionCommands.WriteRuntimeGeomToStlCommand.RelFile">
|
||||
RelFile
|
||||
|
||||
</h3>
|
||||
@@ -284,9 +284,9 @@ Class WriteRuntimeGeomToStlCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_WriteRuntimeGeomToStlCommand_Resolution_mm_" data-uid="Hi.ShellCommands.WriteRuntimeGeomToStlCommand.Resolution_mm*"></a>
|
||||
<a id="Hi_SessionCommands_WriteRuntimeGeomToStlCommand_Resolution_mm_" data-uid="Hi.SessionCommands.WriteRuntimeGeomToStlCommand.Resolution_mm*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_WriteRuntimeGeomToStlCommand_Resolution_mm" data-uid="Hi.ShellCommands.WriteRuntimeGeomToStlCommand.Resolution_mm">
|
||||
<h3 id="Hi_SessionCommands_WriteRuntimeGeomToStlCommand_Resolution_mm" data-uid="Hi.SessionCommands.WriteRuntimeGeomToStlCommand.Resolution_mm">
|
||||
Resolution_mm
|
||||
|
||||
</h3>
|
||||
@@ -316,9 +316,9 @@ Class WriteRuntimeGeomToStlCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_WriteRuntimeGeomToStlCommand_XName_" data-uid="Hi.ShellCommands.WriteRuntimeGeomToStlCommand.XName*"></a>
|
||||
<a id="Hi_SessionCommands_WriteRuntimeGeomToStlCommand_XName_" data-uid="Hi.SessionCommands.WriteRuntimeGeomToStlCommand.XName*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_WriteRuntimeGeomToStlCommand_XName" data-uid="Hi.ShellCommands.WriteRuntimeGeomToStlCommand.XName">
|
||||
<h3 id="Hi_SessionCommands_WriteRuntimeGeomToStlCommand_XName" data-uid="Hi.SessionCommands.WriteRuntimeGeomToStlCommand.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
@@ -352,9 +352,9 @@ Class WriteRuntimeGeomToStlCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_WriteRuntimeGeomToStlCommand_MakeXmlSource_" data-uid="Hi.ShellCommands.WriteRuntimeGeomToStlCommand.MakeXmlSource*"></a>
|
||||
<a id="Hi_SessionCommands_WriteRuntimeGeomToStlCommand_MakeXmlSource_" data-uid="Hi.SessionCommands.WriteRuntimeGeomToStlCommand.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_WriteRuntimeGeomToStlCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.ShellCommands.WriteRuntimeGeomToStlCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
<h3 id="Hi_SessionCommands_WriteRuntimeGeomToStlCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.SessionCommands.WriteRuntimeGeomToStlCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
@@ -394,7 +394,7 @@ This method may also generate additional resources such as related files.</p>
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_ShellCommands_WriteRuntimeGeomToStlCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<h4 class="section" id="Hi_SessionCommands_WriteRuntimeGeomToStlCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
@@ -403,25 +403,25 @@ Since the folder can be moving with the configuration file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_WriteRuntimeGeomToStlCommand_Run_" data-uid="Hi.ShellCommands.WriteRuntimeGeomToStlCommand.Run*"></a>
|
||||
<a id="Hi_SessionCommands_WriteRuntimeGeomToStlCommand_Run_" data-uid="Hi.SessionCommands.WriteRuntimeGeomToStlCommand.Run*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_WriteRuntimeGeomToStlCommand_Run_Hi_MachiningProcs_RuntimeApi_" data-uid="Hi.ShellCommands.WriteRuntimeGeomToStlCommand.Run(Hi.MachiningProcs.RuntimeApi)">
|
||||
Run(RuntimeApi)
|
||||
<h3 id="Hi_SessionCommands_WriteRuntimeGeomToStlCommand_Run_Hi_MachiningProcs_SessionShell_" data-uid="Hi.SessionCommands.WriteRuntimeGeomToStlCommand.Run(Hi.MachiningProcs.SessionShell)">
|
||||
Run(SessionShell)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Runs the command using the provided script API.</p>
|
||||
<div class="markdown level1 summary"><p>Runs the command, delegating execution to the provided session shell.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(RuntimeApi scriptApi)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(SessionShell sessionShell)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
|
||||
<dd><p>Script API for executing milling commands.</p>
|
||||
<dt><code>sessionShell</code> <a class="xref" href="Hi.MachiningProcs.SessionShell.html">SessionShell</a></dt>
|
||||
<dd><p>Session shell that exposes the machining facade to commands.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+26
-26
@@ -84,25 +84,25 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ShellCommands.WriteShotFilesCommand">
|
||||
<article data-uid="Hi.SessionCommands.WriteShotFilesCommand">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_ShellCommands_WriteShotFilesCommand" data-uid="Hi.ShellCommands.WriteShotFilesCommand" class="text-break">
|
||||
<h1 id="Hi_SessionCommands_WriteShotFilesCommand" data-uid="Hi.SessionCommands.WriteShotFilesCommand" class="text-break">
|
||||
Class WriteShotFilesCommand
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.ShellCommands.html">ShellCommands</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.SessionCommands.html">SessionCommands</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Command to call <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_WriteShotFiles_System_String_System_Double_">WriteShotFiles(string, double)</a>.</p>
|
||||
<div class="markdown summary"><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>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class WriteShotFilesCommand : IShellCommand, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class WriteShotFilesCommand : ISessionCommand, IMakeXmlSource</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -119,7 +119,7 @@ Class WriteShotFilesCommand
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.ShellCommands.IShellCommand.html">IShellCommand</a></div>
|
||||
<div><a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -185,9 +185,9 @@ Class WriteShotFilesCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_WriteShotFilesCommand__ctor_" data-uid="Hi.ShellCommands.WriteShotFilesCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_WriteShotFilesCommand__ctor_" data-uid="Hi.SessionCommands.WriteShotFilesCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_WriteShotFilesCommand__ctor" data-uid="Hi.ShellCommands.WriteShotFilesCommand.#ctor">
|
||||
<h3 id="Hi_SessionCommands_WriteShotFilesCommand__ctor" data-uid="Hi.SessionCommands.WriteShotFilesCommand.#ctor">
|
||||
WriteShotFilesCommand()
|
||||
|
||||
</h3>
|
||||
@@ -212,9 +212,9 @@ Class WriteShotFilesCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_WriteShotFilesCommand__ctor_" data-uid="Hi.ShellCommands.WriteShotFilesCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_WriteShotFilesCommand__ctor_" data-uid="Hi.SessionCommands.WriteShotFilesCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_WriteShotFilesCommand__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.ShellCommands.WriteShotFilesCommand.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
<h3 id="Hi_SessionCommands_WriteShotFilesCommand__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.SessionCommands.WriteShotFilesCommand.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
WriteShotFilesCommand(XElement, string)
|
||||
|
||||
</h3>
|
||||
@@ -252,9 +252,9 @@ Class WriteShotFilesCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_WriteShotFilesCommand_RelFileTemplate_" data-uid="Hi.ShellCommands.WriteShotFilesCommand.RelFileTemplate*"></a>
|
||||
<a id="Hi_SessionCommands_WriteShotFilesCommand_RelFileTemplate_" data-uid="Hi.SessionCommands.WriteShotFilesCommand.RelFileTemplate*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_WriteShotFilesCommand_RelFileTemplate" data-uid="Hi.ShellCommands.WriteShotFilesCommand.RelFileTemplate">
|
||||
<h3 id="Hi_SessionCommands_WriteShotFilesCommand_RelFileTemplate" data-uid="Hi.SessionCommands.WriteShotFilesCommand.RelFileTemplate">
|
||||
RelFileTemplate
|
||||
|
||||
</h3>
|
||||
@@ -284,9 +284,9 @@ Class WriteShotFilesCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_WriteShotFilesCommand_TimeResolution_ms_" data-uid="Hi.ShellCommands.WriteShotFilesCommand.TimeResolution_ms*"></a>
|
||||
<a id="Hi_SessionCommands_WriteShotFilesCommand_TimeResolution_ms_" data-uid="Hi.SessionCommands.WriteShotFilesCommand.TimeResolution_ms*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_WriteShotFilesCommand_TimeResolution_ms" data-uid="Hi.ShellCommands.WriteShotFilesCommand.TimeResolution_ms">
|
||||
<h3 id="Hi_SessionCommands_WriteShotFilesCommand_TimeResolution_ms" data-uid="Hi.SessionCommands.WriteShotFilesCommand.TimeResolution_ms">
|
||||
TimeResolution_ms
|
||||
|
||||
</h3>
|
||||
@@ -316,9 +316,9 @@ Class WriteShotFilesCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_WriteShotFilesCommand_XName_" data-uid="Hi.ShellCommands.WriteShotFilesCommand.XName*"></a>
|
||||
<a id="Hi_SessionCommands_WriteShotFilesCommand_XName_" data-uid="Hi.SessionCommands.WriteShotFilesCommand.XName*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_WriteShotFilesCommand_XName" data-uid="Hi.ShellCommands.WriteShotFilesCommand.XName">
|
||||
<h3 id="Hi_SessionCommands_WriteShotFilesCommand_XName" data-uid="Hi.SessionCommands.WriteShotFilesCommand.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
@@ -352,9 +352,9 @@ Class WriteShotFilesCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_WriteShotFilesCommand_MakeXmlSource_" data-uid="Hi.ShellCommands.WriteShotFilesCommand.MakeXmlSource*"></a>
|
||||
<a id="Hi_SessionCommands_WriteShotFilesCommand_MakeXmlSource_" data-uid="Hi.SessionCommands.WriteShotFilesCommand.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_WriteShotFilesCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.ShellCommands.WriteShotFilesCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
<h3 id="Hi_SessionCommands_WriteShotFilesCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.SessionCommands.WriteShotFilesCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
@@ -394,7 +394,7 @@ This method may also generate additional resources such as related files.</p>
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_ShellCommands_WriteShotFilesCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<h4 class="section" id="Hi_SessionCommands_WriteShotFilesCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
@@ -403,25 +403,25 @@ Since the folder can be moving with the configuration file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_WriteShotFilesCommand_Run_" data-uid="Hi.ShellCommands.WriteShotFilesCommand.Run*"></a>
|
||||
<a id="Hi_SessionCommands_WriteShotFilesCommand_Run_" data-uid="Hi.SessionCommands.WriteShotFilesCommand.Run*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_WriteShotFilesCommand_Run_Hi_MachiningProcs_RuntimeApi_" data-uid="Hi.ShellCommands.WriteShotFilesCommand.Run(Hi.MachiningProcs.RuntimeApi)">
|
||||
Run(RuntimeApi)
|
||||
<h3 id="Hi_SessionCommands_WriteShotFilesCommand_Run_Hi_MachiningProcs_SessionShell_" data-uid="Hi.SessionCommands.WriteShotFilesCommand.Run(Hi.MachiningProcs.SessionShell)">
|
||||
Run(SessionShell)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Runs the command using the provided script API.</p>
|
||||
<div class="markdown level1 summary"><p>Runs the command, delegating execution to the provided session shell.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(RuntimeApi scriptApi)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(SessionShell sessionShell)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
|
||||
<dd><p>Script API for executing milling commands.</p>
|
||||
<dt><code>sessionShell</code> <a class="xref" href="Hi.MachiningProcs.SessionShell.html">SessionShell</a></dt>
|
||||
<dd><p>Session shell that exposes the machining facade to commands.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+24
-24
@@ -84,25 +84,25 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ShellCommands.WriteStepFilesCommand">
|
||||
<article data-uid="Hi.SessionCommands.WriteStepFilesCommand">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_ShellCommands_WriteStepFilesCommand" data-uid="Hi.ShellCommands.WriteStepFilesCommand" class="text-break">
|
||||
<h1 id="Hi_SessionCommands_WriteStepFilesCommand" data-uid="Hi.SessionCommands.WriteStepFilesCommand" class="text-break">
|
||||
Class WriteStepFilesCommand
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.ShellCommands.html">ShellCommands</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.SessionCommands.html">SessionCommands</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Command to call <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_WriteStepFiles_System_String_">WriteStepFiles(string)</a>.</p>
|
||||
<div class="markdown summary"><p>Command to call <a class="xref" href="Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_WriteStepFiles_System_String_">WriteStepFiles(string)</a>.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class WriteStepFilesCommand : IShellCommand, IMakeXmlSource</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class WriteStepFilesCommand : ISessionCommand, IMakeXmlSource</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -119,7 +119,7 @@ Class WriteStepFilesCommand
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.ShellCommands.IShellCommand.html">IShellCommand</a></div>
|
||||
<div><a class="xref" href="Hi.SessionCommands.ISessionCommand.html">ISessionCommand</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -185,9 +185,9 @@ Class WriteStepFilesCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_WriteStepFilesCommand__ctor_" data-uid="Hi.ShellCommands.WriteStepFilesCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_WriteStepFilesCommand__ctor_" data-uid="Hi.SessionCommands.WriteStepFilesCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_WriteStepFilesCommand__ctor" data-uid="Hi.ShellCommands.WriteStepFilesCommand.#ctor">
|
||||
<h3 id="Hi_SessionCommands_WriteStepFilesCommand__ctor" data-uid="Hi.SessionCommands.WriteStepFilesCommand.#ctor">
|
||||
WriteStepFilesCommand()
|
||||
|
||||
</h3>
|
||||
@@ -212,9 +212,9 @@ Class WriteStepFilesCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_WriteStepFilesCommand__ctor_" data-uid="Hi.ShellCommands.WriteStepFilesCommand.#ctor*"></a>
|
||||
<a id="Hi_SessionCommands_WriteStepFilesCommand__ctor_" data-uid="Hi.SessionCommands.WriteStepFilesCommand.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_WriteStepFilesCommand__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.ShellCommands.WriteStepFilesCommand.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
<h3 id="Hi_SessionCommands_WriteStepFilesCommand__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.SessionCommands.WriteStepFilesCommand.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
WriteStepFilesCommand(XElement, string)
|
||||
|
||||
</h3>
|
||||
@@ -252,9 +252,9 @@ Class WriteStepFilesCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_WriteStepFilesCommand_RelFileTemplate_" data-uid="Hi.ShellCommands.WriteStepFilesCommand.RelFileTemplate*"></a>
|
||||
<a id="Hi_SessionCommands_WriteStepFilesCommand_RelFileTemplate_" data-uid="Hi.SessionCommands.WriteStepFilesCommand.RelFileTemplate*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_WriteStepFilesCommand_RelFileTemplate" data-uid="Hi.ShellCommands.WriteStepFilesCommand.RelFileTemplate">
|
||||
<h3 id="Hi_SessionCommands_WriteStepFilesCommand_RelFileTemplate" data-uid="Hi.SessionCommands.WriteStepFilesCommand.RelFileTemplate">
|
||||
RelFileTemplate
|
||||
|
||||
</h3>
|
||||
@@ -284,9 +284,9 @@ Class WriteStepFilesCommand
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_WriteStepFilesCommand_XName_" data-uid="Hi.ShellCommands.WriteStepFilesCommand.XName*"></a>
|
||||
<a id="Hi_SessionCommands_WriteStepFilesCommand_XName_" data-uid="Hi.SessionCommands.WriteStepFilesCommand.XName*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_WriteStepFilesCommand_XName" data-uid="Hi.ShellCommands.WriteStepFilesCommand.XName">
|
||||
<h3 id="Hi_SessionCommands_WriteStepFilesCommand_XName" data-uid="Hi.SessionCommands.WriteStepFilesCommand.XName">
|
||||
XName
|
||||
|
||||
</h3>
|
||||
@@ -320,9 +320,9 @@ Class WriteStepFilesCommand
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_WriteStepFilesCommand_MakeXmlSource_" data-uid="Hi.ShellCommands.WriteStepFilesCommand.MakeXmlSource*"></a>
|
||||
<a id="Hi_SessionCommands_WriteStepFilesCommand_MakeXmlSource_" data-uid="Hi.SessionCommands.WriteStepFilesCommand.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_WriteStepFilesCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.ShellCommands.WriteStepFilesCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
<h3 id="Hi_SessionCommands_WriteStepFilesCommand_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.SessionCommands.WriteStepFilesCommand.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
@@ -362,7 +362,7 @@ This method may also generate additional resources such as related files.</p>
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_ShellCommands_WriteStepFilesCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<h4 class="section" id="Hi_SessionCommands_WriteStepFilesCommand_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
|
||||
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
|
||||
Since the folder can be moving with the configuration file.</p>
|
||||
@@ -371,25 +371,25 @@ Since the folder can be moving with the configuration file.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ShellCommands_WriteStepFilesCommand_Run_" data-uid="Hi.ShellCommands.WriteStepFilesCommand.Run*"></a>
|
||||
<a id="Hi_SessionCommands_WriteStepFilesCommand_Run_" data-uid="Hi.SessionCommands.WriteStepFilesCommand.Run*"></a>
|
||||
|
||||
<h3 id="Hi_ShellCommands_WriteStepFilesCommand_Run_Hi_MachiningProcs_RuntimeApi_" data-uid="Hi.ShellCommands.WriteStepFilesCommand.Run(Hi.MachiningProcs.RuntimeApi)">
|
||||
Run(RuntimeApi)
|
||||
<h3 id="Hi_SessionCommands_WriteStepFilesCommand_Run_Hi_MachiningProcs_SessionShell_" data-uid="Hi.SessionCommands.WriteStepFilesCommand.Run(Hi.MachiningProcs.SessionShell)">
|
||||
Run(SessionShell)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Runs the command using the provided script API.</p>
|
||||
<div class="markdown level1 summary"><p>Runs the command, delegating execution to the provided session shell.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(RuntimeApi scriptApi)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Action> Run(SessionShell sessionShell)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
|
||||
<dd><p>Script API for executing milling commands.</p>
|
||||
<dt><code>sessionShell</code> <a class="xref" href="Hi.MachiningProcs.SessionShell.html">SessionShell</a></dt>
|
||||
<dd><p>Session shell that exposes the machining facade to commands.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+32
-32
@@ -2,9 +2,9 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Namespace Hi.ShellCommands | HiAPI-C# 2025 </title>
|
||||
<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.ShellCommands | HiAPI-C# 2025 ">
|
||||
<meta name="title" content="Namespace Hi.SessionCommands | HiAPI-C# 2025 ">
|
||||
|
||||
|
||||
<link rel="icon" href="../img/HiAPI.favicon.ico">
|
||||
@@ -84,9 +84,9 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ShellCommands">
|
||||
<article data-uid="Hi.SessionCommands">
|
||||
|
||||
<h1 id="Hi_ShellCommands" data-uid="Hi.ShellCommands" class="text-break">Namespace Hi.ShellCommands</h1>
|
||||
<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>
|
||||
@@ -95,114 +95,114 @@
|
||||
Classes
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.ShellCommands.EnablingWrapper.html">EnablingWrapper</a></dt>
|
||||
<dd><p>Wrapper for shell commands that provides enable/disable functionality.</p>
|
||||
<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.ShellCommands.GeomDiffCommand.html">GeomDiffCommand</a></dt>
|
||||
<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.ShellCommands.Lang.html">Lang</a></dt>
|
||||
<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.ShellCommands.ListCommand.html">ListCommand</a></dt>
|
||||
<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.ShellCommands.MachiningMotionResolutionCommand.html">MachiningMotionResolutionCommand</a></dt>
|
||||
<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.ShellCommands.NcCodeCommand.html">NcCodeCommand</a></dt>
|
||||
<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.ShellCommands.NcFileCommand.html">NcFileCommand</a></dt>
|
||||
<dt><a class="xref" href="Hi.SessionCommands.NcFileCommand.html">NcFileCommand</a></dt>
|
||||
<dd><p>Command for executing NC code from a file.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.ShellCommands.NcFileListCommand.html">NcFileListCommand</a></dt>
|
||||
<dt><a class="xref" href="Hi.SessionCommands.NcFileListCommand.html">NcFileListCommand</a></dt>
|
||||
<dd><p>Command for executing multiple NC files sequentially.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.ShellCommands.NcOptOptionCommand.html">NcOptOptionCommand</a></dt>
|
||||
<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.ShellCommands.OptimizeToFilesCommand.html">OptimizeToFilesCommand</a></dt>
|
||||
<dd><p>Command to call <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_OptimizeToFiles_System_String_">OptimizeToFiles(string)</a>.</p>
|
||||
<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.ShellCommands.PostExecutionCommand.html">PostExecutionCommand</a></dt>
|
||||
<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.ShellCommands.PreSettingCommand.html">PreSettingCommand</a></dt>
|
||||
<dt><a class="xref" href="Hi.SessionCommands.PreSettingCommand.html">PreSettingCommand</a></dt>
|
||||
<dd><p>Command for pre-settings before NC command running.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.ShellCommands.RecordRuntimeGeomCommand.html">RecordRuntimeGeomCommand</a></dt>
|
||||
<dt><a class="xref" href="Hi.SessionCommands.RecordRuntimeGeomCommand.html">RecordRuntimeGeomCommand</a></dt>
|
||||
<dd><p>Command for recording runtime geometry to/from file.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.ShellCommands.ScriptCommand.html">ScriptCommand</a></dt>
|
||||
<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.ShellCommands.SimpleSessionCommand.html">SimpleSessionCommand</a></dt>
|
||||
<dt><a class="xref" href="Hi.SessionCommands.SimpleSessionCommand.html">SimpleSessionCommand</a></dt>
|
||||
<dd><p>Simple session command for executing machining operations.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.ShellCommands.WriteRuntimeGeomToStlCommand.html">WriteRuntimeGeomToStlCommand</a></dt>
|
||||
<dt><a class="xref" href="Hi.SessionCommands.WriteRuntimeGeomToStlCommand.html">WriteRuntimeGeomToStlCommand</a></dt>
|
||||
<dd><p>Command to call <span class="xref">Hi.MillingProcs.MachiningProjectCsScriptApi.WriteRuntimeGeomToStl</span>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.ShellCommands.WriteShotFilesCommand.html">WriteShotFilesCommand</a></dt>
|
||||
<dd><p>Command to call <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_WriteShotFiles_System_String_System_Double_">WriteShotFiles(string, double)</a>.</p>
|
||||
<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.ShellCommands.WriteStepFilesCommand.html">WriteStepFilesCommand</a></dt>
|
||||
<dd><p>Command to call <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_WriteStepFiles_System_String_">WriteStepFiles(string)</a>.</p>
|
||||
<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.ShellCommands.IShellCommand.html">IShellCommand</a></dt>
|
||||
<dd><p>Interface for commands that can be executed in a milling course.</p>
|
||||
<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.ShellCommands.ITitleCommand.html">ITitleCommand</a></dt>
|
||||
<dd><p><a class="xref" href="Hi.ShellCommands.IShellCommand.html">IShellCommand</a> with title.</p>
|
||||
<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.ShellCommands.RecordRuntimeGeomActionEnum.html">RecordRuntimeGeomActionEnum</a></dt>
|
||||
<dd><p>Action of the <a class="xref" href="Hi.ShellCommands.RecordRuntimeGeomCommand.html">RecordRuntimeGeomCommand</a>.</p>
|
||||
<dt><a class="xref" href="Hi.SessionCommands.RecordRuntimeGeomActionEnum.html">RecordRuntimeGeomActionEnum</a></dt>
|
||||
<dd><p>Action of the <a class="xref" href="Hi.SessionCommands.RecordRuntimeGeomCommand.html">RecordRuntimeGeomCommand</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+9
-41
@@ -2,9 +2,9 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Interface ICsScriptApi | HiAPI-C# 2025 </title>
|
||||
<title>Interface ISessionShell | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Interface ICsScriptApi | HiAPI-C# 2025 ">
|
||||
<meta name="title" content="Interface ISessionShell | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Interface for C# scripting API functionality.">
|
||||
<link rel="icon" href="../img/HiAPI.favicon.ico">
|
||||
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ScriptApiUtils.ICsScriptApi">
|
||||
<article data-uid="Hi.SessionShellUtils.ISessionShell">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_ScriptApiUtils_ICsScriptApi" data-uid="Hi.ScriptApiUtils.ICsScriptApi" class="text-break">
|
||||
Interface ICsScriptApi
|
||||
<h1 id="Hi_SessionShellUtils_ISessionShell" data-uid="Hi.SessionShellUtils.ISessionShell" class="text-break">
|
||||
Interface ISessionShell
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.ScriptApiUtils.html">ScriptApiUtils</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.SessionShellUtils.html">SessionShellUtils</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -102,7 +102,7 @@ Interface ICsScriptApi
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public interface ICsScriptApi</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public interface ISessionShell</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -146,41 +146,9 @@ Interface ICsScriptApi
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ScriptApiUtils_ICsScriptApi_Global_" data-uid="Hi.ScriptApiUtils.ICsScriptApi.Global*"></a>
|
||||
<a id="Hi_SessionShellUtils_ISessionShell_ScriptOptions_" data-uid="Hi.SessionShellUtils.ISessionShell.ScriptOptions*"></a>
|
||||
|
||||
<h3 id="Hi_ScriptApiUtils_ICsScriptApi_Global" data-uid="Hi.ScriptApiUtils.ICsScriptApi.Global">
|
||||
Global
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Global variables.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">Dictionary<object, object> Global { 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.dictionary-2">Dictionary</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ScriptApiUtils_ICsScriptApi_ScriptOptions_" data-uid="Hi.ScriptApiUtils.ICsScriptApi.ScriptOptions*"></a>
|
||||
|
||||
<h3 id="Hi_ScriptApiUtils_ICsScriptApi_ScriptOptions" data-uid="Hi.ScriptApiUtils.ICsScriptApi.ScriptOptions">
|
||||
<h3 id="Hi_SessionShellUtils_ISessionShell_ScriptOptions" data-uid="Hi.SessionShellUtils.ISessionShell.ScriptOptions">
|
||||
ScriptOptions
|
||||
|
||||
</h3>
|
||||
+19
-19
@@ -84,16 +84,16 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ScriptApiUtils.JsAceAttribute">
|
||||
<article data-uid="Hi.SessionShellUtils.JsAceAttribute">
|
||||
|
||||
|
||||
|
||||
<h1 id="Hi_ScriptApiUtils_JsAceAttribute" data-uid="Hi.ScriptApiUtils.JsAceAttribute" class="text-break">
|
||||
<h1 id="Hi_SessionShellUtils_JsAceAttribute" data-uid="Hi.SessionShellUtils.JsAceAttribute" class="text-break">
|
||||
Class JsAceAttribute
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.ScriptApiUtils.html">ScriptApiUtils</a></dd></dl>
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.SessionShellUtils.html">SessionShellUtils</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
@@ -278,11 +278,11 @@ Class JsAceAttribute
|
||||
|
||||
|
||||
|
||||
<h2 id="Hi_ScriptApiUtils_JsAceAttribute_remarks">Remarks</h2>
|
||||
<h2 id="Hi_SessionShellUtils_JsAceAttribute_remarks">Remarks</h2>
|
||||
<div class="markdown level0 remarks"><p>
|
||||
<b>Do not add new usages.</b> Retained only so the legacy HiNcRcl (Blazor)
|
||||
Ace editor completion pipeline keeps working until that app is retired:
|
||||
<code>RuntimeApi.JsAceCompletionProfileJsonArray</code> scans <code>[JsAce]</code>
|
||||
<code>SessionShell.JsAceCompletionProfileJsonArray</code> scans <code>[JsAce]</code>
|
||||
members by reflection and <code>CommonRcl.AceEditor</code> feeds the resulting
|
||||
JSON into Ace's completer list.
|
||||
</p>
|
||||
@@ -296,11 +296,11 @@ attribute metadata is needed.
|
||||
<p>
|
||||
Deprecation lifecycle:
|
||||
<ol><li><b>Now</b> — discouraged for new code (this remark);
|
||||
existing call sites in HiNcRcl / <code>RuntimeApi</code> /
|
||||
existing call sites in HiNcRcl / <code>SessionShell</code> /
|
||||
<code>MachiningStep</code> keep building without warnings.</li><li><b>When HiNcRcl retires</b> — this attribute will be
|
||||
marked <code>[Obsolete]</code>, surfacing a compiler warning on every
|
||||
remaining call site so they can be cleaned up.</li><li><b>After all call sites are gone</b> — this file
|
||||
(and <code>RuntimeApi.JsAceCompletionProfileJsonArray</code>) will be
|
||||
(and <code>SessionShell.JsAceCompletionProfileJsonArray</code>) will be
|
||||
deleted entirely.</li></ol>
|
||||
|
||||
</div>
|
||||
@@ -310,9 +310,9 @@ Deprecation lifecycle:
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ScriptApiUtils_JsAceAttribute__ctor_" data-uid="Hi.ScriptApiUtils.JsAceAttribute.#ctor*"></a>
|
||||
<a id="Hi_SessionShellUtils_JsAceAttribute__ctor_" data-uid="Hi.SessionShellUtils.JsAceAttribute.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ScriptApiUtils_JsAceAttribute__ctor" data-uid="Hi.ScriptApiUtils.JsAceAttribute.#ctor">
|
||||
<h3 id="Hi_SessionShellUtils_JsAceAttribute__ctor" data-uid="Hi.SessionShellUtils.JsAceAttribute.#ctor">
|
||||
JsAceAttribute()
|
||||
|
||||
</h3>
|
||||
@@ -337,9 +337,9 @@ Deprecation lifecycle:
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ScriptApiUtils_JsAceAttribute__ctor_" data-uid="Hi.ScriptApiUtils.JsAceAttribute.#ctor*"></a>
|
||||
<a id="Hi_SessionShellUtils_JsAceAttribute__ctor_" data-uid="Hi.SessionShellUtils.JsAceAttribute.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ScriptApiUtils_JsAceAttribute__ctor_System_String_" data-uid="Hi.ScriptApiUtils.JsAceAttribute.#ctor(System.String)">
|
||||
<h3 id="Hi_SessionShellUtils_JsAceAttribute__ctor_System_String_" data-uid="Hi.SessionShellUtils.JsAceAttribute.#ctor(System.String)">
|
||||
JsAceAttribute(string)
|
||||
|
||||
</h3>
|
||||
@@ -370,9 +370,9 @@ Deprecation lifecycle:
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ScriptApiUtils_JsAceAttribute__ctor_" data-uid="Hi.ScriptApiUtils.JsAceAttribute.#ctor*"></a>
|
||||
<a id="Hi_SessionShellUtils_JsAceAttribute__ctor_" data-uid="Hi.SessionShellUtils.JsAceAttribute.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_ScriptApiUtils_JsAceAttribute__ctor_System_String_System_String_" data-uid="Hi.ScriptApiUtils.JsAceAttribute.#ctor(System.String,System.String)">
|
||||
<h3 id="Hi_SessionShellUtils_JsAceAttribute__ctor_System_String_System_String_" data-uid="Hi.SessionShellUtils.JsAceAttribute.#ctor(System.String,System.String)">
|
||||
JsAceAttribute(string, string)
|
||||
|
||||
</h3>
|
||||
@@ -410,9 +410,9 @@ Deprecation lifecycle:
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_ScriptApiUtils_JsAceAttribute_ClassExt_" data-uid="Hi.ScriptApiUtils.JsAceAttribute.ClassExt*"></a>
|
||||
<a id="Hi_SessionShellUtils_JsAceAttribute_ClassExt_" data-uid="Hi.SessionShellUtils.JsAceAttribute.ClassExt*"></a>
|
||||
|
||||
<h3 id="Hi_ScriptApiUtils_JsAceAttribute_ClassExt" data-uid="Hi.ScriptApiUtils.JsAceAttribute.ClassExt">
|
||||
<h3 id="Hi_SessionShellUtils_JsAceAttribute_ClassExt" data-uid="Hi.SessionShellUtils.JsAceAttribute.ClassExt">
|
||||
ClassExt
|
||||
|
||||
</h3>
|
||||
@@ -442,9 +442,9 @@ Deprecation lifecycle:
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ScriptApiUtils_JsAceAttribute_DocContentHtml_" data-uid="Hi.ScriptApiUtils.JsAceAttribute.DocContentHtml*"></a>
|
||||
<a id="Hi_SessionShellUtils_JsAceAttribute_DocContentHtml_" data-uid="Hi.SessionShellUtils.JsAceAttribute.DocContentHtml*"></a>
|
||||
|
||||
<h3 id="Hi_ScriptApiUtils_JsAceAttribute_DocContentHtml" data-uid="Hi.ScriptApiUtils.JsAceAttribute.DocContentHtml">
|
||||
<h3 id="Hi_SessionShellUtils_JsAceAttribute_DocContentHtml" data-uid="Hi.SessionShellUtils.JsAceAttribute.DocContentHtml">
|
||||
DocContentHtml
|
||||
|
||||
</h3>
|
||||
@@ -474,9 +474,9 @@ Deprecation lifecycle:
|
||||
|
||||
|
||||
|
||||
<a id="Hi_ScriptApiUtils_JsAceAttribute_Snippet_" data-uid="Hi.ScriptApiUtils.JsAceAttribute.Snippet*"></a>
|
||||
<a id="Hi_SessionShellUtils_JsAceAttribute_Snippet_" data-uid="Hi.SessionShellUtils.JsAceAttribute.Snippet*"></a>
|
||||
|
||||
<h3 id="Hi_ScriptApiUtils_JsAceAttribute_Snippet" data-uid="Hi.ScriptApiUtils.JsAceAttribute.Snippet">
|
||||
<h3 id="Hi_SessionShellUtils_JsAceAttribute_Snippet" data-uid="Hi.SessionShellUtils.JsAceAttribute.Snippet">
|
||||
Snippet
|
||||
|
||||
</h3>
|
||||
+6
-6
@@ -2,9 +2,9 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Namespace Hi.ScriptApiUtils | HiAPI-C# 2025 </title>
|
||||
<title>Namespace Hi.SessionShellUtils | HiAPI-C# 2025 </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Namespace Hi.ScriptApiUtils | HiAPI-C# 2025 ">
|
||||
<meta name="title" content="Namespace Hi.SessionShellUtils | HiAPI-C# 2025 ">
|
||||
|
||||
|
||||
<link rel="icon" href="../img/HiAPI.favicon.ico">
|
||||
@@ -84,9 +84,9 @@
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Hi.ScriptApiUtils">
|
||||
<article data-uid="Hi.SessionShellUtils">
|
||||
|
||||
<h1 id="Hi_ScriptApiUtils" data-uid="Hi.ScriptApiUtils" class="text-break">Namespace Hi.ScriptApiUtils</h1>
|
||||
<h1 id="Hi_SessionShellUtils" data-uid="Hi.SessionShellUtils" class="text-break">Namespace Hi.SessionShellUtils</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="markdown level0 remarks"></div>
|
||||
@@ -95,7 +95,7 @@
|
||||
Classes
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.ScriptApiUtils.JsAceAttribute.html">JsAceAttribute</a></dt>
|
||||
<dt><a class="xref" href="Hi.SessionShellUtils.JsAceAttribute.html">JsAceAttribute</a></dt>
|
||||
<dd><p>Attribute for JavaScript Ace editor integration.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -103,7 +103,7 @@ Classes
|
||||
Interfaces
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.ScriptApiUtils.ICsScriptApi.html">ICsScriptApi</a></dt>
|
||||
<dt><a class="xref" href="Hi.SessionShellUtils.ISessionShell.html">ISessionShell</a></dt>
|
||||
<dd><p>Interface for C# scripting API functionality.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -1402,12 +1402,6 @@
|
||||
<li>
|
||||
<a href="Hi.MachiningProcs.RenderingFlag.html" name="" title="RenderingFlag">RenderingFlag</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.MachiningProcs.RuntimeApi.html" name="" title="RuntimeApi">RuntimeApi</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.MachiningProcs.RuntimeController.html" name="" title="RuntimeController">RuntimeController</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.MachiningProcs.SessionMessage.html" name="" title="SessionMessage">SessionMessage</a>
|
||||
</li>
|
||||
@@ -1420,6 +1414,12 @@
|
||||
<li>
|
||||
<a href="Hi.MachiningProcs.SessionProgress.FilterFlag.html" name="" title="SessionProgress.FilterFlag">SessionProgress.FilterFlag</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.MachiningProcs.SessionShell.html" name="" title="SessionShell">SessionShell</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.MachiningProcs.SessionShellController.html" name="" title="SessionShellController">SessionShellController</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.MachiningProcs.SetupController.html" name="" title="SetupController">SetupController</a>
|
||||
</li>
|
||||
@@ -1437,7 +1437,7 @@
|
||||
<a href="Hi.MachiningSteps.IFlagText.html" name="" title="IFlagText">IFlagText</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.MachiningSteps.IMachiningStepHost.html" name="" title="IMachiningStepHost">IMachiningStepHost</a>
|
||||
<a href="Hi.MachiningSteps.IMachiningService.html" name="" title="IMachiningService">IMachiningService</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.MachiningSteps.MachineMotionStep.html" name="" title="MachineMotionStep">MachineMotionStep</a>
|
||||
@@ -2496,7 +2496,7 @@
|
||||
<a href="Hi.NcParsers.Dependencys.Generic.IsoCoordinateTable.html" name="" title="IsoCoordinateTable">IsoCoordinateTable</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.Dependencys.Generic.NcKinematicsDependency.html" name="" title="NcKinematicsDependency">NcKinematicsDependency</a>
|
||||
<a href="Hi.NcParsers.Dependencys.Generic.SubProgramFolderConfig.html" name="" title="SubProgramFolderConfig">SubProgramFolderConfig</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.Dependencys.Generic.ToolOffsetRow.html" name="" title="ToolOffsetRow">ToolOffsetRow</a>
|
||||
@@ -2545,6 +2545,108 @@
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<span class="expand-stub"></span>
|
||||
<a href="Hi.NcParsers.Dependencys.SystemWired.html" name="" title="Hi.NcParsers.Dependencys.SystemWired">Hi.NcParsers.Dependencys.SystemWired</a>
|
||||
|
||||
<ul class="nav level2">
|
||||
<li>
|
||||
<a href="Hi.NcParsers.Dependencys.SystemWired.FileIndexCounterDependency.html" name="" title="FileIndexCounterDependency">FileIndexCounterDependency</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.Dependencys.SystemWired.NcKinematicsDependency.html" name="" title="NcKinematicsDependency">NcKinematicsDependency</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.Dependencys.SystemWired.ProjectFolderDependency.html" name="" title="ProjectFolderDependency">ProjectFolderDependency</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.Dependencys.SystemWired.SegmenterDependency.html" name="" title="SegmenterDependency">SegmenterDependency</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.Dependencys.SystemWired.SyntaxPieceLayerDependency.html" name="" title="SyntaxPieceLayerDependency">SyntaxPieceLayerDependency</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<span class="expand-stub"></span>
|
||||
<a href="Hi.NcParsers.EvaluationSyntaxs.html" name="" title="Hi.NcParsers.EvaluationSyntaxs">Hi.NcParsers.EvaluationSyntaxs</a>
|
||||
|
||||
<ul class="nav level2">
|
||||
<li>
|
||||
<a href="Hi.NcParsers.EvaluationSyntaxs.FanucSystemControlVariableSyntax.html" name="" title="FanucSystemControlVariableSyntax">FanucSystemControlVariableSyntax</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.EvaluationSyntaxs.RetainedCommonVariableReadingSyntax.html" name="" title="RetainedCommonVariableReadingSyntax">RetainedCommonVariableReadingSyntax</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.EvaluationSyntaxs.SubProgramCallSyntax.html" name="" title="SubProgramCallSyntax">SubProgramCallSyntax</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.EvaluationSyntaxs.SubProgramReturnSyntax.html" name="" title="SubProgramReturnSyntax">SubProgramReturnSyntax</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.EvaluationSyntaxs.VariableEvaluatorSyntax.html" name="" title="VariableEvaluatorSyntax">VariableEvaluatorSyntax</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.html" name="" title="VolatileVariableReadingSyntax">VolatileVariableReadingSyntax</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<span class="expand-stub"></span>
|
||||
<a href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.html" name="" title="Hi.NcParsers.EvaluationSyntaxs.Evaluation">Hi.NcParsers.EvaluationSyntaxs.Evaluation</a>
|
||||
|
||||
<ul class="nav level2">
|
||||
<li>
|
||||
<a href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.EvalResult.html" name="" title="EvalResult">EvalResult</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IRuntimeVariableLookup.html" name="" title="IRuntimeVariableLookup">IRuntimeVariableLookup</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IVariableLookup.html" name="" title="IVariableLookup">IVariableLookup</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.LocalVariableLookup.html" name="" title="LocalVariableLookup">LocalVariableLookup</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcBinaryExpr.html" name="" title="NcBinaryExpr">NcBinaryExpr</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcBinaryOp.html" name="" title="NcBinaryOp">NcBinaryOp</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpr.html" name="" title="NcExpr">NcExpr</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionEvaluator.html" name="" title="NcExpressionEvaluator">NcExpressionEvaluator</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcExpressionParser.html" name="" title="NcExpressionParser">NcExpressionParser</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcFunctionExpr.html" name="" title="NcFunctionExpr">NcFunctionExpr</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcIndirectVariableExpr.html" name="" title="NcIndirectVariableExpr">NcIndirectVariableExpr</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcLiteralExpr.html" name="" title="NcLiteralExpr">NcLiteralExpr</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcUnaryExpr.html" name="" title="NcUnaryExpr">NcUnaryExpr</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcUnaryOp.html" name="" title="NcUnaryOp">NcUnaryOp</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.NcVariableExpr.html" name="" title="NcVariableExpr">NcVariableExpr</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.VolatileVariableLookup.html" name="" title="VolatileVariableLookup">VolatileVariableLookup</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<span class="expand-stub"></span>
|
||||
<a href="Hi.NcParsers.Initializers.html" name="" title="Hi.NcParsers.Initializers">Hi.NcParsers.Initializers</a>
|
||||
@@ -2612,6 +2714,9 @@
|
||||
<li>
|
||||
<a href="Hi.NcParsers.Keywords.FanucPathSmoothing.html" name="" title="FanucPathSmoothing">FanucPathSmoothing</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.Keywords.FanucProgramNumber.html" name="" title="FanucProgramNumber">FanucProgramNumber</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.Keywords.Feedrate.html" name="" title="Feedrate">Feedrate</a>
|
||||
</li>
|
||||
@@ -2720,9 +2825,6 @@
|
||||
<li>
|
||||
<a href="Hi.NcParsers.Keywords.Positioning.html" name="" title="Positioning">Positioning</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.Keywords.ProgramBoundary.html" name="" title="ProgramBoundary">ProgramBoundary</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.Keywords.ProgramEnd.html" name="" title="ProgramEnd">ProgramEnd</a>
|
||||
</li>
|
||||
@@ -2741,6 +2843,15 @@
|
||||
<li>
|
||||
<a href="Hi.NcParsers.Keywords.SpindleSpeed.html" name="" title="SpindleSpeed">SpindleSpeed</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.Keywords.SubProgramCall.html" name="" title="SubProgramCall">SubProgramCall</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.Keywords.SubProgramReturn.html" name="" title="SubProgramReturn">SubProgramReturn</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.Keywords.TapeBoundary.html" name="" title="TapeBoundary">TapeBoundary</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.Keywords.TiltTransform.html" name="" title="TiltTransform">TiltTransform</a>
|
||||
</li>
|
||||
@@ -2750,6 +2861,9 @@
|
||||
<li>
|
||||
<a href="Hi.NcParsers.Keywords.Unit.html" name="" title="Unit">Unit</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.Keywords.Vars.html" name="" title="Vars">Vars</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
@@ -2902,9 +3016,6 @@
|
||||
<li>
|
||||
<a href="Hi.NcParsers.LogicSyntaxs.ReferenceReturnSyntax.html" name="" title="ReferenceReturnSyntax">ReferenceReturnSyntax</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.LogicSyntaxs.RetainedCommonVariableReadingSyntax.html" name="" title="RetainedCommonVariableReadingSyntax">RetainedCommonVariableReadingSyntax</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.LogicSyntaxs.RotaryAxisUtil.html" name="" title="RotaryAxisUtil">RotaryAxisUtil</a>
|
||||
</li>
|
||||
@@ -2926,61 +3037,6 @@
|
||||
<li>
|
||||
<a href="Hi.NcParsers.LogicSyntaxs.UnitModeSyntax.html" name="" title="UnitModeSyntax">UnitModeSyntax</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.LogicSyntaxs.VariableEvaluatorSyntax.html" name="" title="VariableEvaluatorSyntax">VariableEvaluatorSyntax</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.LogicSyntaxs.VolatileVariableReadingSyntax.html" name="" title="VolatileVariableReadingSyntax">VolatileVariableReadingSyntax</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<span class="expand-stub"></span>
|
||||
<a href="Hi.NcParsers.LogicSyntaxs.Evaluation.html" name="" title="Hi.NcParsers.LogicSyntaxs.Evaluation">Hi.NcParsers.LogicSyntaxs.Evaluation</a>
|
||||
|
||||
<ul class="nav level2">
|
||||
<li>
|
||||
<a href="Hi.NcParsers.LogicSyntaxs.Evaluation.EvalResult.html" name="" title="EvalResult">EvalResult</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.LogicSyntaxs.Evaluation.IRuntimeVariableLookup.html" name="" title="IRuntimeVariableLookup">IRuntimeVariableLookup</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.LogicSyntaxs.Evaluation.IVariableLookup.html" name="" title="IVariableLookup">IVariableLookup</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcBinaryExpr.html" name="" title="NcBinaryExpr">NcBinaryExpr</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcBinaryOp.html" name="" title="NcBinaryOp">NcBinaryOp</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpr.html" name="" title="NcExpr">NcExpr</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionEvaluator.html" name="" title="NcExpressionEvaluator">NcExpressionEvaluator</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcExpressionParser.html" name="" title="NcExpressionParser">NcExpressionParser</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcFunctionExpr.html" name="" title="NcFunctionExpr">NcFunctionExpr</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcIndirectVariableExpr.html" name="" title="NcIndirectVariableExpr">NcIndirectVariableExpr</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcLiteralExpr.html" name="" title="NcLiteralExpr">NcLiteralExpr</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcUnaryExpr.html" name="" title="NcUnaryExpr">NcUnaryExpr</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcUnaryOp.html" name="" title="NcUnaryOp">NcUnaryOp</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.LogicSyntaxs.Evaluation.NcVariableExpr.html" name="" title="NcVariableExpr">NcVariableExpr</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
@@ -3014,6 +3070,9 @@
|
||||
<li>
|
||||
<a href="Hi.NcParsers.ParsingSyntaxs.CsScriptSyntax.html" name="" title="CsScriptSyntax">CsScriptSyntax</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.ParsingSyntaxs.FanucProgramNumberSyntax.html" name="" title="FanucProgramNumberSyntax">FanucProgramNumberSyntax</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.ParsingSyntaxs.FlagSyntax.html" name="" title="FlagSyntax">FlagSyntax</a>
|
||||
</li>
|
||||
@@ -3035,9 +3094,6 @@
|
||||
<li>
|
||||
<a href="Hi.NcParsers.ParsingSyntaxs.ParameterizedFlagSyntax.html" name="" title="ParameterizedFlagSyntax">ParameterizedFlagSyntax</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.ParsingSyntaxs.ProgramBoundarySyntax.html" name="" title="ProgramBoundarySyntax">ProgramBoundarySyntax</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.ParsingSyntaxs.ShrinkIfNoDecimalPointSyntax.html" name="" title="ShrinkIfNoDecimalPointSyntax">ShrinkIfNoDecimalPointSyntax</a>
|
||||
</li>
|
||||
@@ -3047,6 +3103,9 @@
|
||||
<li>
|
||||
<a href="Hi.NcParsers.ParsingSyntaxs.TagValueSyntax.html" name="" title="TagValueSyntax">TagValueSyntax</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.NcParsers.ParsingSyntaxs.TapeBoundarySyntax.html" name="" title="TapeBoundarySyntax">TapeBoundarySyntax</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
@@ -3852,84 +3911,84 @@
|
||||
</li>
|
||||
<li>
|
||||
<span class="expand-stub"></span>
|
||||
<a href="Hi.ScriptApiUtils.html" name="" title="Hi.ScriptApiUtils">Hi.ScriptApiUtils</a>
|
||||
<a href="Hi.SessionCommands.html" name="" title="Hi.SessionCommands">Hi.SessionCommands</a>
|
||||
|
||||
<ul class="nav level2">
|
||||
<li>
|
||||
<a href="Hi.ScriptApiUtils.ICsScriptApi.html" name="" title="ICsScriptApi">ICsScriptApi</a>
|
||||
<a href="Hi.SessionCommands.EnablingWrapper.html" name="" title="EnablingWrapper">EnablingWrapper</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.ScriptApiUtils.JsAceAttribute.html" name="" title="JsAceAttribute">JsAceAttribute</a>
|
||||
<a href="Hi.SessionCommands.GeomDiffCommand.html" name="" title="GeomDiffCommand">GeomDiffCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.SessionCommands.ISessionCommand.html" name="" title="ISessionCommand">ISessionCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.SessionCommands.ITitleCommand.html" name="" title="ITitleCommand">ITitleCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.SessionCommands.Lang.html" name="" title="Lang">Lang</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.SessionCommands.ListCommand.html" name="" title="ListCommand">ListCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.SessionCommands.MachiningMotionResolutionCommand.html" name="" title="MachiningMotionResolutionCommand">MachiningMotionResolutionCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.SessionCommands.NcCodeCommand.html" name="" title="NcCodeCommand">NcCodeCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.SessionCommands.NcFileCommand.html" name="" title="NcFileCommand">NcFileCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.SessionCommands.NcFileListCommand.html" name="" title="NcFileListCommand">NcFileListCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.SessionCommands.NcOptOptionCommand.html" name="" title="NcOptOptionCommand">NcOptOptionCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.SessionCommands.OptimizeToFilesCommand.html" name="" title="OptimizeToFilesCommand">OptimizeToFilesCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.SessionCommands.PostExecutionCommand.html" name="" title="PostExecutionCommand">PostExecutionCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.SessionCommands.PreSettingCommand.html" name="" title="PreSettingCommand">PreSettingCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.SessionCommands.RecordRuntimeGeomActionEnum.html" name="" title="RecordRuntimeGeomActionEnum">RecordRuntimeGeomActionEnum</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.SessionCommands.RecordRuntimeGeomCommand.html" name="" title="RecordRuntimeGeomCommand">RecordRuntimeGeomCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.SessionCommands.ScriptCommand.html" name="" title="ScriptCommand">ScriptCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.SessionCommands.SimpleSessionCommand.html" name="" title="SimpleSessionCommand">SimpleSessionCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.SessionCommands.WriteRuntimeGeomToStlCommand.html" name="" title="WriteRuntimeGeomToStlCommand">WriteRuntimeGeomToStlCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.SessionCommands.WriteShotFilesCommand.html" name="" title="WriteShotFilesCommand">WriteShotFilesCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.SessionCommands.WriteStepFilesCommand.html" name="" title="WriteStepFilesCommand">WriteStepFilesCommand</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<span class="expand-stub"></span>
|
||||
<a href="Hi.ShellCommands.html" name="" title="Hi.ShellCommands">Hi.ShellCommands</a>
|
||||
<a href="Hi.SessionShellUtils.html" name="" title="Hi.SessionShellUtils">Hi.SessionShellUtils</a>
|
||||
|
||||
<ul class="nav level2">
|
||||
<li>
|
||||
<a href="Hi.ShellCommands.EnablingWrapper.html" name="" title="EnablingWrapper">EnablingWrapper</a>
|
||||
<a href="Hi.SessionShellUtils.ISessionShell.html" name="" title="ISessionShell">ISessionShell</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.ShellCommands.GeomDiffCommand.html" name="" title="GeomDiffCommand">GeomDiffCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.ShellCommands.IShellCommand.html" name="" title="IShellCommand">IShellCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.ShellCommands.ITitleCommand.html" name="" title="ITitleCommand">ITitleCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.ShellCommands.Lang.html" name="" title="Lang">Lang</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.ShellCommands.ListCommand.html" name="" title="ListCommand">ListCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.ShellCommands.MachiningMotionResolutionCommand.html" name="" title="MachiningMotionResolutionCommand">MachiningMotionResolutionCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.ShellCommands.NcCodeCommand.html" name="" title="NcCodeCommand">NcCodeCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.ShellCommands.NcFileCommand.html" name="" title="NcFileCommand">NcFileCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.ShellCommands.NcFileListCommand.html" name="" title="NcFileListCommand">NcFileListCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.ShellCommands.NcOptOptionCommand.html" name="" title="NcOptOptionCommand">NcOptOptionCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.ShellCommands.OptimizeToFilesCommand.html" name="" title="OptimizeToFilesCommand">OptimizeToFilesCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.ShellCommands.PostExecutionCommand.html" name="" title="PostExecutionCommand">PostExecutionCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.ShellCommands.PreSettingCommand.html" name="" title="PreSettingCommand">PreSettingCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.ShellCommands.RecordRuntimeGeomActionEnum.html" name="" title="RecordRuntimeGeomActionEnum">RecordRuntimeGeomActionEnum</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.ShellCommands.RecordRuntimeGeomCommand.html" name="" title="RecordRuntimeGeomCommand">RecordRuntimeGeomCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.ShellCommands.ScriptCommand.html" name="" title="ScriptCommand">ScriptCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.ShellCommands.SimpleSessionCommand.html" name="" title="SimpleSessionCommand">SimpleSessionCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.ShellCommands.WriteRuntimeGeomToStlCommand.html" name="" title="WriteRuntimeGeomToStlCommand">WriteRuntimeGeomToStlCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.ShellCommands.WriteShotFilesCommand.html" name="" title="WriteShotFilesCommand">WriteShotFilesCommand</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Hi.ShellCommands.WriteStepFilesCommand.html" name="" title="WriteStepFilesCommand">WriteStepFilesCommand</a>
|
||||
<a href="Hi.SessionShellUtils.JsAceAttribute.html" name="" title="JsAceAttribute">JsAceAttribute</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user