Archived
942 lines
37 KiB
HTML
942 lines
37 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Class CodeXyzabcChain | HiAPI-C# 2025 </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Class CodeXyzabcChain | HiAPI-C# 2025 ">
|
|
|
|
<meta name="description" content="A authored through chain code — a bracket notation for the connectivity of the mechanism's branches. On purpose of easy XML hand management. The entity is the inherited ; is a delegated representation: reading derives the codes from the mechanism's topology, assigning reseeds the mechanism (transformers and solids of same-named components carry over). Notation: each segment declares branches left to right — [O][Y];[Y][X];[X][w] pairs, or the concatenated sugar [O][Y][X][w]. Words merge by name across segments; [] is an anonymous component (each occurrence is a fresh one). Reserved words: X,Y,Z translational axes, A,B,C rotational axes, w table buckle, t tool buckle; any other word is a plain component. Reserved words are matched exactly as written, so a word differing only in letter case is a plain component.">
|
|
<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.Numerical.Xyzabc.CodeXyzabcChain">
|
|
|
|
|
|
|
|
<h1 id="Hi_Numerical_Xyzabc_CodeXyzabcChain" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain" class="text-break">
|
|
Class CodeXyzabcChain
|
|
</h1>
|
|
|
|
<div class="facts text-secondary">
|
|
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Numerical.html">Numerical</a>.<a class="xref" href="Hi.Numerical.Xyzabc.html">Xyzabc</a></dd></dl>
|
|
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
|
</div>
|
|
|
|
<div class="markdown summary"><p>A <a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html">GeneralXyzabcChain</a> authored through chain code — a bracket
|
|
notation for the connectivity of the mechanism's branches.
|
|
On purpose of easy XML hand management.</p>
|
|
<p>The entity is the inherited
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_GeneralMechanism">GeneralMechanism</a>; <a class="xref" href="Hi.Numerical.Xyzabc.CodeXyzabcChain.html#Hi_Numerical_Xyzabc_CodeXyzabcChain_ChainCodes">ChainCodes</a>
|
|
is a delegated representation: reading derives the codes from the
|
|
mechanism's topology, assigning reseeds the mechanism (transformers and
|
|
solids of same-named components carry over).</p>
|
|
<p>Notation: each segment declares branches left to right —
|
|
<code>[O][Y];[Y][X];[X][w]</code> pairs, or the concatenated sugar
|
|
<code>[O][Y][X][w]</code>. Words merge by name across segments; <code>[]</code> is an
|
|
anonymous component (each occurrence is a fresh one). Reserved words:
|
|
<code>X</code>,<code>Y</code>,<code>Z</code> translational axes, <code>A</code>,<code>B</code>,<code>C</code>
|
|
rotational axes, <code>w</code> table buckle, <code>t</code> tool buckle; any other
|
|
word is a plain component. Reserved words are matched exactly as written,
|
|
so a word differing only in letter case is a plain component.</p>
|
|
</div>
|
|
<div class="markdown conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class CodeXyzabcChain : GeneralXyzabcChain, IXyzabcChain, IGetXyzabcChain, IMachiningChain, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d, 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><a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html">GeneralXyzabcChain</a></div>
|
|
<div><span class="xref">CodeXyzabcChain</span></div>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl class="typelist implements">
|
|
<dt>Implements</dt>
|
|
<dd>
|
|
<div><a class="xref" href="Hi.Numerical.Xyzabc.IXyzabcChain.html">IXyzabcChain</a></div>
|
|
<div><a class="xref" href="Hi.Numerical.Xyzabc.IGetXyzabcChain.html">IGetXyzabcChain</a></div>
|
|
<div><a class="xref" href="Hi.Mech.IMachiningChain.html">IMachiningChain</a></div>
|
|
<div><a class="xref" href="Hi.Mech.Topo.IGetAsmb.html">IGetAsmb</a></div>
|
|
<div><a class="xref" href="Hi.Mech.Topo.IGetAnchor.html">IGetAnchor</a></div>
|
|
<div><a class="xref" href="Hi.Mech.Topo.IGetTopoIndex.html">IGetTopoIndex</a></div>
|
|
<div><a class="xref" href="Hi.Mech.IGetAnchorToSolidDictionary.html">IGetAnchorToSolidDictionary</a></div>
|
|
<div><a class="xref" href="Hi.Mech.Topo.IGetAnchoredDisplayeeList.html">IGetAnchoredDisplayeeList</a></div>
|
|
<div><a class="xref" href="Hi.Geom.IExpandToBox3d.html">IExpandToBox3d</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="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_Asmb">GeneralXyzabcChain.Asmb</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_TransformerX">GeneralXyzabcChain.TransformerX</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_TransformerY">GeneralXyzabcChain.TransformerY</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_TransformerZ">GeneralXyzabcChain.TransformerZ</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_TransformerA">GeneralXyzabcChain.TransformerA</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_TransformerB">GeneralXyzabcChain.TransformerB</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_TransformerC">GeneralXyzabcChain.TransformerC</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_TableBuckleTransformer">GeneralXyzabcChain.TableBuckleTransformer</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_ToolBuckleTransformer">GeneralXyzabcChain.ToolBuckleTransformer</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_GeneralMechanismFile">GeneralXyzabcChain.GeneralMechanismFile</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_GeneralMechanism">GeneralXyzabcChain.GeneralMechanism</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_UpdateByMechanism">GeneralXyzabcChain.UpdateByMechanism()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_GetAsmb">GeneralXyzabcChain.GetAsmb()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_GetTableBuckle">GeneralXyzabcChain.GetTableBuckle()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_GetToolBuckle">GeneralXyzabcChain.GetToolBuckle()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_GetTransformerA">GeneralXyzabcChain.GetTransformerA()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_GetTransformerB">GeneralXyzabcChain.GetTransformerB()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_GetTransformerC">GeneralXyzabcChain.GetTransformerC()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_GetTransformerX">GeneralXyzabcChain.GetTransformerX()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_GetTransformerY">GeneralXyzabcChain.GetTransformerY()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_GetTransformerZ">GeneralXyzabcChain.GetTransformerZ()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_McCodes">GeneralXyzabcChain.McCodes</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_McTransformers">GeneralXyzabcChain.McTransformers</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_GetXyzabcChain">GeneralXyzabcChain.GetXyzabcChain()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_GetAnchor">GeneralXyzabcChain.GetAnchor()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_GetAnchorToSolidDictionary">GeneralXyzabcChain.GetAnchorToSolidDictionary()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_ExpandToBox3d_Hi_Geom_Box3d_">GeneralXyzabcChain.ExpandToBox3d(Box3d)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.GeneralXyzabcChain.html#Hi_Numerical_Xyzabc_GeneralXyzabcChain_GetAnchoredDisplayeeList">GeneralXyzabcChain.GetAnchoredDisplayeeList()</a>
|
|
</div>
|
|
<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.Mech.MachiningChainUtil.html#Hi_Mech_MachiningChainUtil_GetMcCodeTransformerDictionary_Hi_Mech_IMachiningChain_">MachiningChainUtil.GetMcCodeTransformerDictionary(IMachiningChain)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Mech.Topo.TopoUtil.html#Hi_Mech_Topo_TopoUtil_Display_Hi_Mech_Topo_IGetAnchor_Hi_Disp_Bind_System_Collections_Generic_Dictionary_Hi_Mech_Topo_Anchor_Hi_Geom_Mat4d__">TopoUtil.Display(IGetAnchor, Bind, Dictionary<Anchor, Mat4d>)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Mech.Topo.TopoUtil.html#Hi_Mech_Topo_TopoUtil_ExpandToBox3d_Hi_Mech_Topo_IGetAnchor_Hi_Geom_Box3d_System_Collections_Generic_Dictionary_Hi_Mech_Topo_Anchor_Hi_Geom_Mat4d__">TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary<Anchor, Mat4d>)</a>
|
|
</div>
|
|
<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.Numerical.Xyzabc.XyzabcUtil.html#Hi_Numerical_Xyzabc_XyzabcUtil_GenerateCollisionIndexPairs_Hi_Numerical_Xyzabc_IXyzabcChain_">XyzabcUtil.GenerateCollisionIndexPairs(IXyzabcChain)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.XyzabcUtil.html#Hi_Numerical_Xyzabc_XyzabcUtil_GetMc_Hi_Numerical_Xyzabc_IXyzabcChain_Hi_Geom_DVec3d__">XyzabcUtil.GetMc(IXyzabcChain, out DVec3d)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.XyzabcUtil.html#Hi_Numerical_Xyzabc_XyzabcUtil_GetMc_Hi_Numerical_Xyzabc_IXyzabcChain_System_Double__System_Double__System_Double__System_Double__System_Double__System_Double__">XyzabcUtil.GetMc(IXyzabcChain, out double, out double, out double, out double, out double, out double)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.XyzabcUtil.html#Hi_Numerical_Xyzabc_XyzabcUtil_GetMcAbc_rad_Hi_Numerical_Xyzabc_IXyzabcChain_Hi_Numerical_Xyzabc_Abc__">XyzabcUtil.GetMcAbc_rad(IXyzabcChain, out Abc)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.XyzabcUtil.html#Hi_Numerical_Xyzabc_XyzabcUtil_GetMcXyzabc_Hi_Numerical_Xyzabc_IXyzabcChain_">XyzabcUtil.GetMcXyzabc(IXyzabcChain)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.XyzabcUtil.html#Hi_Numerical_Xyzabc_XyzabcUtil_GetNp_Hi_Numerical_Xyzabc_IXyzabcChain_">XyzabcUtil.GetNp(IXyzabcChain)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.XyzabcUtil.html#Hi_Numerical_Xyzabc_XyzabcUtil_GetTransformationMat4d_Hi_Numerical_Xyzabc_IXyzabcChain_">XyzabcUtil.GetTransformationMat4d(IXyzabcChain)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.XyzabcUtil.html#Hi_Numerical_Xyzabc_XyzabcUtil_RequireEndAnchor_Hi_Numerical_Xyzabc_IXyzabcChain_Hi_Mech_Topo_IGetAnchor_System_String_System_String_">XyzabcUtil.RequireEndAnchor(IXyzabcChain, IGetAnchor, string, string)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.XyzabcUtil.html#Hi_Numerical_Xyzabc_XyzabcUtil_RequireEndAnchors_Hi_Numerical_Xyzabc_IXyzabcChain_">XyzabcUtil.RequireEndAnchors(IXyzabcChain)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.XyzabcUtil.html#Hi_Numerical_Xyzabc_XyzabcUtil_SetMc_Hi_Numerical_Xyzabc_IXyzabcChain_Hi_Geom_DVec3d_">XyzabcUtil.SetMc(IXyzabcChain, DVec3d)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.XyzabcUtil.html#Hi_Numerical_Xyzabc_XyzabcUtil_SetMc_Hi_Numerical_Xyzabc_IXyzabcChain_Hi_Geom_Vec3d_">XyzabcUtil.SetMc(IXyzabcChain, Vec3d)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.XyzabcUtil.html#Hi_Numerical_Xyzabc_XyzabcUtil_SetMc_Hi_Numerical_Xyzabc_IXyzabcChain_System_Double_System_Double_System_Double_">XyzabcUtil.SetMc(IXyzabcChain, double, double, double)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.XyzabcUtil.html#Hi_Numerical_Xyzabc_XyzabcUtil_SetMc_Hi_Numerical_Xyzabc_IXyzabcChain_System_Double_System_Double_System_Double_System_Double_System_Double_System_Double_">XyzabcUtil.SetMc(IXyzabcChain, double, double, double, double, double, double)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Numerical.Xyzabc.XyzabcUtil.html#Hi_Numerical_Xyzabc_XyzabcUtil_SetMcAbc_rad_Hi_Numerical_Xyzabc_IXyzabcChain_Hi_Geom_Vec3d_">XyzabcUtil.SetMcAbc_rad(IXyzabcChain, Vec3d)</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_Numerical_Xyzabc_CodeXyzabcChain__ctor_" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.#ctor*"></a>
|
|
|
|
<h3 id="Hi_Numerical_Xyzabc_CodeXyzabcChain__ctor_System_String_" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.#ctor(System.String)">
|
|
CodeXyzabcChain(string)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Initializes a new instance seeded from the given chain code.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public CodeXyzabcChain(string chainCode = "[O][Z][C][w];[O][Y][X][B][S][t]")</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>chainCode</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>Semicolon-separated branch segments; see the
|
|
class summary for the notation.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Numerical_Xyzabc_CodeXyzabcChain__ctor_" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.#ctor*"></a>
|
|
|
|
<h3 id="Hi_Numerical_Xyzabc_CodeXyzabcChain__ctor_System_String_System_Boolean_" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.#ctor(System.String,System.Boolean)">
|
|
CodeXyzabcChain(string, bool)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Legacy overload keeping the retired vertical/horizontal flag working.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">[Obsolete("IsVertical is a legacy orientation shim. Author the ground rotation in the GeneralMechanism instead.")]
|
|
public CodeXyzabcChain(string chainCode, bool isVertical)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>chainCode</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>Semicolon-separated branch segments.</p>
|
|
</dd>
|
|
<dt><code>isVertical</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
|
<dd><p>Legacy orientation flag; <code>false</code> lays the
|
|
machine down via a hidden root rotation.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Numerical_Xyzabc_CodeXyzabcChain__ctor_" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.#ctor*"></a>
|
|
|
|
<h3 id="Hi_Numerical_Xyzabc_CodeXyzabcChain__ctor_System_Xml_Linq_XElement_System_String_System_String_System_IProgress_Hi_Common_Messages_IMessage__" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.IProgress{Hi.Common.Messages.IMessage})">
|
|
CodeXyzabcChain(XElement, string, string, IProgress<IMessage>)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Numerical.Xyzabc.CodeXyzabcChain.html">CodeXyzabcChain</a> class from XML.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public CodeXyzabcChain(XElement src, string baseDirectory, string relFile, IProgress<IMessage> progress)</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>The XML source element.</p>
|
|
</dd>
|
|
<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.</p>
|
|
</dd>
|
|
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="Hi.Common.Messages.IMessage.html">IMessage</a>></dt>
|
|
<dd><p>The progress reporter.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="fields">Fields
|
|
</h2>
|
|
|
|
|
|
|
|
<h3 id="Hi_Numerical_Xyzabc_CodeXyzabcChain_DefaultChainCode" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.DefaultChainCode">
|
|
DefaultChainCode
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>The classic 5-axis table-tilting layout used when no chain code is given.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public const string DefaultChainCode = "[O][Z][C][w];[O][Y][X][B][S][t]"</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_Numerical_Xyzabc_CodeXyzabcChain_AnchorToSolid_" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.AnchorToSolid*"></a>
|
|
|
|
<h3 id="Hi_Numerical_Xyzabc_CodeXyzabcChain_AnchorToSolid" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.AnchorToSolid">
|
|
AnchorToSolid
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the dictionary mapping anchors to solids for display
|
|
purposes — the mechanism's dictionary. Assigning copies the entries
|
|
into it (the mechanism stays the owner).</p>
|
|
<p>The compact wire format keys solids by component name, so a
|
|
solid attached to an anonymous <code>[]</code> component is not persisted —
|
|
name the component if its solid must survive a save.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Dictionary<Anchor, Solid> AnchorToSolid { 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="Hi.Mech.Topo.Anchor.html">Anchor</a>, <a class="xref" href="Hi.NcMech.Solids.Solid.html">Solid</a>></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Numerical_Xyzabc_CodeXyzabcChain_ChainBegin_" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.ChainBegin*"></a>
|
|
|
|
<h3 id="Hi_Numerical_Xyzabc_CodeXyzabcChain_ChainBegin" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.ChainBegin">
|
|
ChainBegin
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the chain begin anchor (the table buckle).</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Anchor ChainBegin { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Mech.Topo.Anchor.html">Anchor</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Numerical_Xyzabc_CodeXyzabcChain_ChainCode_" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.ChainCode*"></a>
|
|
|
|
<h3 id="Hi_Numerical_Xyzabc_CodeXyzabcChain_ChainCode" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.ChainCode">
|
|
ChainCode
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>The semicolon-joined form of <a class="xref" href="Hi.Numerical.Xyzabc.CodeXyzabcChain.html#Hi_Numerical_Xyzabc_CodeXyzabcChain_ChainCodes">ChainCodes</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string ChainCode { 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_Numerical_Xyzabc_CodeXyzabcChain_ChainCodes_" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.ChainCodes*"></a>
|
|
|
|
<h3 id="Hi_Numerical_Xyzabc_CodeXyzabcChain_ChainCodes" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.ChainCodes">
|
|
ChainCodes
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>The chain code segments — a delegated representation of the mechanism's
|
|
connectivity. Reading derives them (table-buckle segment first, then the
|
|
tool-buckle one, then any others); assigning reseeds the mechanism,
|
|
carrying over the transformers and solids of same-named components.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IReadOnlyList<string> ChainCodes { 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.ireadonlylist-1">IReadOnlyList</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Numerical_Xyzabc_CodeXyzabcChain_ChainEnd_" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.ChainEnd*"></a>
|
|
|
|
<h3 id="Hi_Numerical_Xyzabc_CodeXyzabcChain_ChainEnd" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.ChainEnd">
|
|
ChainEnd
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the chain end anchor (the tool buckle).</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Anchor ChainEnd { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Mech.Topo.Anchor.html">Anchor</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Numerical_Xyzabc_CodeXyzabcChain_CodeToAnc_" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.CodeToAnc*"></a>
|
|
|
|
<h3 id="Hi_Numerical_Xyzabc_CodeXyzabcChain_CodeToAnc" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.CodeToAnc">
|
|
CodeToAnc
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the dictionary mapping component words to anchors — derived from
|
|
the mechanism; the legacy horizontal shim's hidden root is excluded.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Dictionary<string, Anchor> CodeToAnc { 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.string">string</a>, <a class="xref" href="Hi.Mech.Topo.Anchor.html">Anchor</a>></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Numerical_Xyzabc_CodeXyzabcChain_ComponentCodes_O2T_" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.ComponentCodes_O2T*"></a>
|
|
|
|
<h3 id="Hi_Numerical_Xyzabc_CodeXyzabcChain_ComponentCodes_O2T" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.ComponentCodes_O2T">
|
|
ComponentCodes_O2T
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the list of component words from the code view root to the tool buckle.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public List<string> ComponentCodes_O2T { 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="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Numerical_Xyzabc_CodeXyzabcChain_ComponentCodes_O2W_" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.ComponentCodes_O2W*"></a>
|
|
|
|
<h3 id="Hi_Numerical_Xyzabc_CodeXyzabcChain_ComponentCodes_O2W" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.ComponentCodes_O2W">
|
|
ComponentCodes_O2W
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the list of component words from the code view root to the table buckle.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public List<string> ComponentCodes_O2W { 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="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Numerical_Xyzabc_CodeXyzabcChain_RootAnchor_" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.RootAnchor*"></a>
|
|
|
|
<h3 id="Hi_Numerical_Xyzabc_CodeXyzabcChain_RootAnchor" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.RootAnchor">
|
|
RootAnchor
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the root anchor of the XYZABC chain.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Anchor RootAnchor { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Mech.Topo.Anchor.html">Anchor</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Numerical_Xyzabc_CodeXyzabcChain_XName_" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.XName*"></a>
|
|
|
|
<h3 id="Hi_Numerical_Xyzabc_CodeXyzabcChain_XName" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.XName">
|
|
XName
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the XML element name for serialization.</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_Numerical_Xyzabc_CodeXyzabcChain_MakeXmlSource_" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.MakeXmlSource*"></a>
|
|
|
|
<h3 id="Hi_Numerical_Xyzabc_CodeXyzabcChain_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.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 override 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_Numerical_Xyzabc_CodeXyzabcChain_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>
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Numerical_Xyzabc_CodeXyzabcChain_Reg_" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.Reg*"></a>
|
|
|
|
<h3 id="Hi_Numerical_Xyzabc_CodeXyzabcChain_Reg_Hi_Common_XmlUtils_XFactory_" data-uid="Hi.Numerical.Xyzabc.CodeXyzabcChain.Reg(Hi.Common.XmlUtils.XFactory)">
|
|
Reg(XFactory)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Registers this type's deserializer with the given <a class="xref" href="Hi.Common.XmlUtils.XFactory.html">XFactory</a>
|
|
and chains <code>Reg(factory)</code> on dependents. Idempotent.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void Reg(XFactory factory = null)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>factory</code> <a class="xref" href="Hi.Common.XmlUtils.XFactory.html">XFactory</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>
|