tune
This commit is contained in:
@@ -6,7 +6,7 @@
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class FluteDependentRatioProfile | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Represents a flute number dependent ratio profile for a milling cutter. This profile determines the ratio between inner and outer radii based on the number of flutes. Internal Use Only">
|
||||
<meta name="description" content="Represents a flute number dependent ratio profile for a milling cutter. This profile determines the ratio between inner and outer radii based on the number of flutes.">
|
||||
<link rel="icon" href="../img/HiAPI.favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
@@ -98,13 +98,12 @@ Class FluteDependentRatioProfile
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Represents a flute number dependent ratio profile for a milling cutter.
|
||||
This profile determines the ratio between inner and outer radii based on the number of flutes.
|
||||
Internal Use Only</p>
|
||||
This profile determines the ratio between inner and outer radii based on the number of flutes.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class FluteDependentRatioProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetStl, IGetZrList, IDuplicate, IClearCache</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class FluteDependentRatioProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetZrList, IGenStl, IGetStl, IDuplicate, IClearCache, IFluteNumSourceProperty, IZrListSourceProperty</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -124,10 +123,13 @@ Internal Use Only</p>
|
||||
<div><a class="xref" href="Hi.Milling.Cutters.IShaperProfile.html">IShaperProfile</a></div>
|
||||
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
|
||||
<div><a class="xref" href="Hi.Common.IAbstractNote.html">IAbstractNote</a></div>
|
||||
<div><a class="xref" href="Hi.Geom.IGetStl.html">IGetStl</a></div>
|
||||
<div><a class="xref" href="Hi.Geom.IGetZrList.html">IGetZrList</a></div>
|
||||
<div><a class="xref" href="Hi.Geom.IGenStl.html">IGenStl</a></div>
|
||||
<div><a class="xref" href="Hi.Geom.IGetStl.html">IGetStl</a></div>
|
||||
<div><a class="xref" href="Hi.Common.IDuplicate.html">IDuplicate</a></div>
|
||||
<div><a class="xref" href="Hi.Common.IClearCache.html">IClearCache</a></div>
|
||||
<div><a class="xref" href="Hi.Milling.FluteContours.IFluteNumSourceProperty.html">IFluteNumSourceProperty</a></div>
|
||||
<div><a class="xref" href="Hi.Geom.IZrListSourceProperty.html">IZrListSourceProperty</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -200,26 +202,19 @@ Internal Use Only</p>
|
||||
|
||||
<a id="Hi_Milling_Cutters_FluteDependentRatioProfile__ctor_" data-uid="Hi.Milling.Cutters.FluteDependentRatioProfile.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Milling_Cutters_FluteDependentRatioProfile__ctor_Hi_Milling_Cutters_MillingCutter_" data-uid="Hi.Milling.Cutters.FluteDependentRatioProfile.#ctor(Hi.Milling.Cutters.MillingCutter)">
|
||||
FluteDependentRatioProfile(MillingCutter)
|
||||
<h3 id="Hi_Milling_Cutters_FluteDependentRatioProfile__ctor" data-uid="Hi.Milling.Cutters.FluteDependentRatioProfile.#ctor">
|
||||
FluteDependentRatioProfile()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the FluteDependentRatioProfile class.
|
||||
Internal Use Only</p>
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FluteDependentRatioProfile(MillingCutter millingCutter)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public FluteDependentRatioProfile()</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>millingCutter</code> <a class="xref" href="Hi.Milling.Cutters.MillingCutter.html">MillingCutter</a></dt>
|
||||
<dd><p>The associated milling cutter</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
@@ -234,8 +229,8 @@ Internal Use Only</p>
|
||||
|
||||
<a id="Hi_Milling_Cutters_FluteDependentRatioProfile__ctor_" data-uid="Hi.Milling.Cutters.FluteDependentRatioProfile.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Milling_Cutters_FluteDependentRatioProfile__ctor_System_Xml_Linq_XElement_System_String_Hi_Milling_Cutters_MillingCutter_" data-uid="Hi.Milling.Cutters.FluteDependentRatioProfile.#ctor(System.Xml.Linq.XElement,System.String,Hi.Milling.Cutters.MillingCutter)">
|
||||
FluteDependentRatioProfile(XElement, string, MillingCutter)
|
||||
<h3 id="Hi_Milling_Cutters_FluteDependentRatioProfile__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.Milling.Cutters.FluteDependentRatioProfile.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
FluteDependentRatioProfile(XElement, string)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -244,7 +239,7 @@ Internal Use Only</p>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FluteDependentRatioProfile(XElement element, string baseDirectory, MillingCutter host)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public FluteDependentRatioProfile(XElement element, string baseDirectory)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -254,9 +249,6 @@ Internal Use Only</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>host</code> <a class="xref" href="Hi.Milling.Cutters.MillingCutter.html">MillingCutter</a></dt>
|
||||
<dd><p>The host milling cutter.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -282,8 +274,7 @@ Internal Use Only</p>
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the abstract note describing the profile.
|
||||
Internal Use Only</p>
|
||||
<div class="markdown level1 summary"><p>Gets the abstract note describing the profile.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -308,20 +299,18 @@ Internal Use Only</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Milling_Cutters_FluteDependentRatioProfile_MillingCutter_" data-uid="Hi.Milling.Cutters.FluteDependentRatioProfile.MillingCutter*"></a>
|
||||
<a id="Hi_Milling_Cutters_FluteDependentRatioProfile_FluteNumSource_" data-uid="Hi.Milling.Cutters.FluteDependentRatioProfile.FluteNumSource*"></a>
|
||||
|
||||
<h3 id="Hi_Milling_Cutters_FluteDependentRatioProfile_MillingCutter" data-uid="Hi.Milling.Cutters.FluteDependentRatioProfile.MillingCutter">
|
||||
MillingCutter
|
||||
<h3 id="Hi_Milling_Cutters_FluteDependentRatioProfile_FluteNumSource" data-uid="Hi.Milling.Cutters.FluteDependentRatioProfile.FluteNumSource">
|
||||
FluteNumSource
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets or sets the associated milling cutter.
|
||||
Internal Use Only</p>
|
||||
</div>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MillingCutter MillingCutter { get; set; }</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public Func<int> FluteNumSource { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -330,7 +319,7 @@ Internal Use Only</p>
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.Milling.Cutters.MillingCutter.html">MillingCutter</a></dt>
|
||||
<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.int32">int</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
@@ -348,8 +337,7 @@ Internal Use Only</p>
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the radius ratio based on the current number of flutes.
|
||||
Internal Use Only</p>
|
||||
<div class="markdown level1 summary"><p>Gets the radius ratio based on the current number of flutes.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -406,6 +394,39 @@ Internal Use Only</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Milling_Cutters_FluteDependentRatioProfile_ZrListSource_" data-uid="Hi.Milling.Cutters.FluteDependentRatioProfile.ZrListSource*"></a>
|
||||
|
||||
<h3 id="Hi_Milling_Cutters_FluteDependentRatioProfile_ZrListSource" data-uid="Hi.Milling.Cutters.FluteDependentRatioProfile.ZrListSource">
|
||||
ZrListSource
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Get base geometry source.
|
||||
Runtime property.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Func<IGetZrList> ZrListSource { 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="Hi.Geom.IGetZrList.html">IGetZrList</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
@@ -476,6 +497,44 @@ Internal Use Only</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Milling_Cutters_FluteDependentRatioProfile_GenStl_" data-uid="Hi.Milling.Cutters.FluteDependentRatioProfile.GenStl*"></a>
|
||||
|
||||
<h3 id="Hi_Milling_Cutters_FluteDependentRatioProfile_GenStl_Hi_Geom_Resolution_IPolarResolution2d_" data-uid="Hi.Milling.Cutters.FluteDependentRatioProfile.GenStl(Hi.Geom.Resolution.IPolarResolution2d)">
|
||||
GenStl(IPolarResolution2d)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Generate a new Stl.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Stl GenStl(IPolarResolution2d resolution)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>resolution</code> <a class="xref" href="Hi.Geom.Resolution.IPolarResolution2d.html">IPolarResolution2d</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.Geom.Stl.html">Stl</a></dt>
|
||||
<dd><p>newly created Stl</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Milling_Cutters_FluteDependentRatioProfile_GetStl_" data-uid="Hi.Milling.Cutters.FluteDependentRatioProfile.GetStl*"></a>
|
||||
|
||||
<h3 id="Hi_Milling_Cutters_FluteDependentRatioProfile_GetStl" data-uid="Hi.Milling.Cutters.FluteDependentRatioProfile.GetStl">
|
||||
@@ -544,8 +603,8 @@ Internal Use Only</p>
|
||||
|
||||
<a id="Hi_Milling_Cutters_FluteDependentRatioProfile_MakeXmlSource_" data-uid="Hi.Milling.Cutters.FluteDependentRatioProfile.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_Milling_Cutters_FluteDependentRatioProfile_MakeXmlSource_System_String_System_String_" data-uid="Hi.Milling.Cutters.FluteDependentRatioProfile.MakeXmlSource(System.String,System.String)">
|
||||
MakeXmlSource(string, string)
|
||||
<h3 id="Hi_Milling_Cutters_FluteDependentRatioProfile_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.Milling.Cutters.FluteDependentRatioProfile.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -555,7 +614,7 @@ This method may also generate additional resources such as related files.</p>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -565,6 +624,9 @@ This method may also generate additional resources such as related files.</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>
|
||||
|
||||
@@ -581,6 +643,11 @@ This method may also generate additional resources such as related files.</p>
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_Milling_Cutters_FluteDependentRatioProfile_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>
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user