rename XFactory.Regs to XFactory.Generators.
This commit is contained in:
+167
-9
@@ -6,7 +6,7 @@
|
||||
<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).">
|
||||
<meta name="description" content="Reads Fanuc-style non-retained common variables (#100-#499) from Vars.Volatile. Self-gates the id range so the evaluator's chain can fall through to the next lookup for out-of-range keys. Single-step lookup: already dict-merges every block's Vars.Volatile into the next block, so the entry — if it exists — must be on the current block (when this lookup runs after the reader) or on the immediately previous block (when this lookup runs before the reader on the same block, which is the Fanuc preset's order — evaluator first, reader second). No arbitrary walk-back: such a walk would be defensive overkill given the reader's carry guarantee. Stateless and dependency-free — instances are interchangeable. Reads stay decoupled from the reader (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">
|
||||
@@ -98,22 +98,29 @@ Class VolatileVariableLookup
|
||||
</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
|
||||
from <code>Vars.Volatile</code>. 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).
|
||||
Single-step lookup: <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.VolatileVariableReadingSyntax.html">VolatileVariableReadingSyntax</a> already
|
||||
dict-merges every block's <code>Vars.Volatile</code> into the next block, so
|
||||
the entry — if it exists — must be on the current block (when this
|
||||
lookup runs after the reader) or on the immediately previous block
|
||||
(when this lookup runs before the reader on the same block, which is
|
||||
the Fanuc preset's order — evaluator first, reader second). No
|
||||
arbitrary walk-back: such a walk would be defensive overkill given
|
||||
the reader's carry guarantee.
|
||||
</p>
|
||||
<p>
|
||||
Stateless and dependency-free — instances are interchangeable. Reads
|
||||
stay decoupled from the reader (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>
|
||||
<pre><code class="lang-csharp hljs">public class VolatileVariableLookup : IRuntimeVariableLookup, IMakeXmlSource</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -131,6 +138,7 @@ decoupled (read side here; write side in the reader).
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.IRuntimeVariableLookup.html">IRuntimeVariableLookup</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -191,6 +199,105 @@ decoupled (read side here; write side in the reader).
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_VolatileVariableLookup__ctor_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.VolatileVariableLookup.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_VolatileVariableLookup__ctor" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.VolatileVariableLookup.#ctor">
|
||||
VolatileVariableLookup()
|
||||
|
||||
</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 VolatileVariableLookup()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_VolatileVariableLookup__ctor_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.VolatileVariableLookup.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_VolatileVariableLookup__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.VolatileVariableLookup.#ctor(System.Xml.Linq.XElement)">
|
||||
VolatileVariableLookup(XElement)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Loads from an XML element produced by <a class="xref" href="Hi.NcParsers.EvaluationSyntaxs.Evaluation.VolatileVariableLookup.html#Hi_NcParsers_EvaluationSyntaxs_Evaluation_VolatileVariableLookup_MakeXmlSource_System_String_System_String_System_Boolean_">MakeXmlSource(string, string, bool)</a>. Stateless — no fields to deserialise.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public VolatileVariableLookup(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="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_VolatileVariableLookup_XName_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.VolatileVariableLookup.XName*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_VolatileVariableLookup_XName" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.VolatileVariableLookup.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_Generators">Generators</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>
|
||||
|
||||
@@ -239,6 +346,57 @@ this lookup's range or the value is vacant.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_VolatileVariableLookup_MakeXmlSource_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.VolatileVariableLookup.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_EvaluationSyntaxs_Evaluation_VolatileVariableLookup_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.EvaluationSyntaxs.Evaluation.VolatileVariableLookup.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_Evaluation_VolatileVariableLookup_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>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user