1163 lines
33 KiB
HTML
1163 lines
33 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Class ForceAccelShot | HiAPI-C# 2025 </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Class ForceAccelShot | HiAPI-C# 2025 ">
|
|
|
|
<meta name="description" content="Represents a data point containing force, acceleration, and moment measurements at a specific time.">
|
|
<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.Vibrations.ForceAccelShot">
|
|
|
|
|
|
|
|
<h1 id="Hi_Vibrations_ForceAccelShot" data-uid="Hi.Vibrations.ForceAccelShot" class="text-break">
|
|
Class ForceAccelShot
|
|
</h1>
|
|
|
|
<div class="facts text-secondary">
|
|
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Vibrations.html">Vibrations</a></dd></dl>
|
|
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
|
</div>
|
|
|
|
<div class="markdown summary"><p>Represents a data point containing force, acceleration, and moment measurements at a specific time.</p>
|
|
</div>
|
|
<div class="markdown conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class ForceAccelShot : IForceShot, IMomentShot, IAccelerationShot, ITimeShot, ITimeGetter</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">ForceAccelShot</span></div>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl class="typelist implements">
|
|
<dt>Implements</dt>
|
|
<dd>
|
|
<div><a class="xref" href="Hi.Mapping.IForceShot.html">IForceShot</a></div>
|
|
<div><a class="xref" href="Hi.Mapping.IMomentShot.html">IMomentShot</a></div>
|
|
<div><a class="xref" href="Hi.Mapping.IAccelerationShot.html">IAccelerationShot</a></div>
|
|
<div><a class="xref" href="Hi.Mapping.ITimeShot.html">ITimeShot</a></div>
|
|
<div><a class="xref" href="Hi.Physics.ITimeGetter.html">ITimeGetter</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>
|
|
</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_Vibrations_ForceAccelShot__ctor_" data-uid="Hi.Vibrations.ForceAccelShot.#ctor*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot__ctor" data-uid="Hi.Vibrations.ForceAccelShot.#ctor">
|
|
ForceAccelShot()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Vibrations.ForceAccelShot.html">ForceAccelShot</a> class.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ForceAccelShot()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Vibrations_ForceAccelShot__ctor_" data-uid="Hi.Vibrations.ForceAccelShot.#ctor*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot__ctor_System_TimeSpan_Hi_Geom_Vec3d_Hi_Geom_Vec3d_Hi_Geom_Vec3d_" data-uid="Hi.Vibrations.ForceAccelShot.#ctor(System.TimeSpan,Hi.Geom.Vec3d,Hi.Geom.Vec3d,Hi.Geom.Vec3d)">
|
|
ForceAccelShot(TimeSpan, Vec3d, Vec3d, Vec3d)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Vibrations.ForceAccelShot.html">ForceAccelShot</a> class with the specified values.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ForceAccelShot(TimeSpan time, Vec3d force_N, Vec3d acceleration_g, Vec3d moment_Nm)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>time</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.timespan">TimeSpan</a></dt>
|
|
<dd><p>The time point of the measurement.</p>
|
|
</dd>
|
|
<dt><code>force_N</code> <a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a></dt>
|
|
<dd><p>The force vector in Newtons.</p>
|
|
</dd>
|
|
<dt><code>acceleration_g</code> <a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a></dt>
|
|
<dd><p>The acceleration vector in g-force units.</p>
|
|
</dd>
|
|
<dt><code>moment_Nm</code> <a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a></dt>
|
|
<dd><p>The moment vector in Newton-meters.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="properties">Properties
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_Vibrations_ForceAccelShot_Acceleration_g_" data-uid="Hi.Vibrations.ForceAccelShot.Acceleration_g*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot_Acceleration_g" data-uid="Hi.Vibrations.ForceAccelShot.Acceleration_g">
|
|
Acceleration_g
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the acceleration vector in g-force units (g).
|
|
This property automatically converts between mm/s² and g, where 1g = 9.81 m/s².</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Vec3d Acceleration_g { get; set; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<h4 class="section" id="Hi_Vibrations_ForceAccelShot_Acceleration_g_remarks">Remarks</h4>
|
|
<div class="markdown level1 remarks"><p>Conversion factors:</p>
|
|
<ul>
|
|
<li>From m/s² to g: divide by 9.81</li>
|
|
<li>From g to m/s²: multiply by 9.81</li>
|
|
</ul>
|
|
<p>Common reference values:</p>
|
|
<ul>
|
|
<li>1g: Earth's gravitational acceleration</li>
|
|
<li>0g: Free fall</li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Vibrations_ForceAccelShot_Acceleration_mds2_" data-uid="Hi.Vibrations.ForceAccelShot.Acceleration_mds2*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot_Acceleration_mds2" data-uid="Hi.Vibrations.ForceAccelShot.Acceleration_mds2">
|
|
Acceleration_mds2
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the acceleration vector in meters per second squared (m/s²).
|
|
This property automatically converts between mm/s² and m/s².</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Vec3d Acceleration_mds2 { get; set; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<h4 class="section" id="Hi_Vibrations_ForceAccelShot_Acceleration_mds2_remarks">Remarks</h4>
|
|
<div class="markdown level1 remarks"><p>Conversion factors:</p>
|
|
<ul>
|
|
<li>From mm/s² to m/s²: divide by 1000</li>
|
|
<li>From m/s² to mm/s²: multiply by 1000</li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Vibrations_ForceAccelShot_Acceleration_mmds2_" data-uid="Hi.Vibrations.ForceAccelShot.Acceleration_mmds2*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot_Acceleration_mmds2" data-uid="Hi.Vibrations.ForceAccelShot.Acceleration_mmds2">
|
|
Acceleration_mmds2
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the acceleration vector in millimeters per second squared (mm/s²).
|
|
This is the base unit for acceleration storage in the system.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Vec3d Acceleration_mmds2 { get; set; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<h4 class="section" id="Hi_Vibrations_ForceAccelShot_Acceleration_mmds2_remarks">Remarks</h4>
|
|
<div class="markdown level1 remarks"><p>The acceleration vector components represent:</p>
|
|
<ul>
|
|
<li>X: Acceleration in the X direction (mm/s²)</li>
|
|
<li>Y: Acceleration in the Y direction (mm/s²)</li>
|
|
<li>Z: Acceleration in the Z direction (mm/s²)</li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Vibrations_ForceAccelShot_AxTag_" data-uid="Hi.Vibrations.ForceAccelShot.AxTag*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot_AxTag" data-uid="Hi.Vibrations.ForceAccelShot.AxTag">
|
|
AxTag
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the column name for X-axis acceleration data in CSV files.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static string AxTag { 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_Vibrations_ForceAccelShot_AyTag_" data-uid="Hi.Vibrations.ForceAccelShot.AyTag*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot_AyTag" data-uid="Hi.Vibrations.ForceAccelShot.AyTag">
|
|
AyTag
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the column name for Y-axis acceleration data in CSV files.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static string AyTag { 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_Vibrations_ForceAccelShot_AzTag_" data-uid="Hi.Vibrations.ForceAccelShot.AzTag*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot_AzTag" data-uid="Hi.Vibrations.ForceAccelShot.AzTag">
|
|
AzTag
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the column name for Z-axis acceleration data in CSV files.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static string AzTag { 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_Vibrations_ForceAccelShot_Force_N_" data-uid="Hi.Vibrations.ForceAccelShot.Force_N*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot_Force_N" data-uid="Hi.Vibrations.ForceAccelShot.Force_N">
|
|
Force_N
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the force vector applied to the workpiece, measured in Newtons (N).</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Vec3d Force_N { get; set; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<h4 class="section" id="Hi_Vibrations_ForceAccelShot_Force_N_remarks">Remarks</h4>
|
|
<div class="markdown level1 remarks"><p>The force vector components represent:</p>
|
|
<ul>
|
|
<li>X: Force in the X direction (N)</li>
|
|
<li>Y: Force in the Y direction (N)</li>
|
|
<li>Z: Force in the Z direction (N)</li>
|
|
</ul>
|
|
<p>Positive values typically indicate:</p>
|
|
<ul>
|
|
<li>Forces acting in the positive direction of each axis</li>
|
|
<li>Forces applied to the workpiece (rather than the tool)</li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Vibrations_ForceAccelShot_FxTags_" data-uid="Hi.Vibrations.ForceAccelShot.FxTags*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot_FxTags" data-uid="Hi.Vibrations.ForceAccelShot.FxTags">
|
|
FxTags
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the possible column names for X-axis force data in CSV files.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static string[] FxTags { 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_Vibrations_ForceAccelShot_FyTags_" data-uid="Hi.Vibrations.ForceAccelShot.FyTags*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot_FyTags" data-uid="Hi.Vibrations.ForceAccelShot.FyTags">
|
|
FyTags
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the possible column names for Y-axis force data in CSV files.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static string[] FyTags { 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_Vibrations_ForceAccelShot_FzTags_" data-uid="Hi.Vibrations.ForceAccelShot.FzTags*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot_FzTags" data-uid="Hi.Vibrations.ForceAccelShot.FzTags">
|
|
FzTags
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the possible column names for Z-axis force data in CSV files.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static string[] FzTags { 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_Vibrations_ForceAccelShot_Moment_Nm_" data-uid="Hi.Vibrations.ForceAccelShot.Moment_Nm*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot_Moment_Nm" data-uid="Hi.Vibrations.ForceAccelShot.Moment_Nm">
|
|
Moment_Nm
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the moment (torque) vector, measured in Newton-meters (N⋅m).</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Vec3d Moment_Nm { get; set; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<h4 class="section" id="Hi_Vibrations_ForceAccelShot_Moment_Nm_remarks">Remarks</h4>
|
|
<div class="markdown level1 remarks"><p>The moment vector components represent:</p>
|
|
<ul>
|
|
<li>X: Moment around the X axis (N⋅m)</li>
|
|
<li>Y: Moment around the Y axis (N⋅m)</li>
|
|
<li>Z: Moment around the Z axis (N⋅m)</li>
|
|
</ul>
|
|
<p>Positive values indicate:</p>
|
|
<ul>
|
|
<li>Clockwise moments when looking along the positive axis direction</li>
|
|
<li>Following the right-hand rule convention</li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Vibrations_ForceAccelShot_MxTags_" data-uid="Hi.Vibrations.ForceAccelShot.MxTags*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot_MxTags" data-uid="Hi.Vibrations.ForceAccelShot.MxTags">
|
|
MxTags
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the possible column names for X-axis moment data in CSV files.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static string[] MxTags { 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_Vibrations_ForceAccelShot_MyTags_" data-uid="Hi.Vibrations.ForceAccelShot.MyTags*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot_MyTags" data-uid="Hi.Vibrations.ForceAccelShot.MyTags">
|
|
MyTags
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the possible column names for Y-axis moment data in CSV files.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static string[] MyTags { 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_Vibrations_ForceAccelShot_MzTags_" data-uid="Hi.Vibrations.ForceAccelShot.MzTags*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot_MzTags" data-uid="Hi.Vibrations.ForceAccelShot.MzTags">
|
|
MzTags
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the possible column names for Z-axis moment data in CSV files.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static string[] MzTags { 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_Vibrations_ForceAccelShot_Time_" data-uid="Hi.Vibrations.ForceAccelShot.Time*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot_Time" data-uid="Hi.Vibrations.ForceAccelShot.Time">
|
|
Time
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the time value in seconds.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public TimeSpan Time { 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.timespan">TimeSpan</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Vibrations_ForceAccelShot_TimeTags_" data-uid="Hi.Vibrations.ForceAccelShot.TimeTags*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot_TimeTags" data-uid="Hi.Vibrations.ForceAccelShot.TimeTags">
|
|
TimeTags
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the possible column names for time data in CSV files.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static string[] TimeTags { 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_Vibrations_ForceAccelShot_GetAdd_" data-uid="Hi.Vibrations.ForceAccelShot.GetAdd*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot_GetAdd_Hi_Mapping_ITimeShot_" data-uid="Hi.Vibrations.ForceAccelShot.GetAdd(Hi.Mapping.ITimeShot)">
|
|
GetAdd(ITimeShot)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Adds another time shot to this one.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ITimeShot GetAdd(ITimeShot shot)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>shot</code> <a class="xref" href="Hi.Mapping.ITimeShot.html">ITimeShot</a></dt>
|
|
<dd><p>The time shot to add.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Mapping.ITimeShot.html">ITimeShot</a></dt>
|
|
<dd><p>A new time shot representing the sum of the two shots.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section" id="Hi_Vibrations_ForceAccelShot_GetAdd_Hi_Mapping_ITimeShot__remarks">Remarks</h4>
|
|
<div class="markdown level1 remarks"><p>The addition should:</p>
|
|
<ul>
|
|
<li>Combine vector components appropriately</li>
|
|
<li>Handle null or missing data gracefully</li>
|
|
<li>Preserve the time value according to implementation rules</li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Vibrations_ForceAccelShot_GetScaled_" data-uid="Hi.Vibrations.ForceAccelShot.GetScaled*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot_GetScaled_System_Double_" data-uid="Hi.Vibrations.ForceAccelShot.GetScaled(System.Double)">
|
|
GetScaled(double)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Scales the values in this time shot by the specified factor.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ITimeShot GetScaled(double scale)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>scale</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
|
<dd><p>The scaling factor to apply to all vector components.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Mapping.ITimeShot.html">ITimeShot</a></dt>
|
|
<dd><p>A new time shot with all values scaled by the given factor.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section" id="Hi_Vibrations_ForceAccelShot_GetScaled_System_Double__remarks">Remarks</h4>
|
|
<div class="markdown level1 remarks"><p>The scaling should:</p>
|
|
<ul>
|
|
<li>Apply to all vector components</li>
|
|
<li>Handle null or missing data gracefully</li>
|
|
<li>Scale the time value if appropriate for the implementation</li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Vibrations_ForceAccelShot_ReadRows_" data-uid="Hi.Vibrations.ForceAccelShot.ReadRows*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot_ReadRows_System_String_System_Action_System_Int32__System_Nullable_System_Threading_CancellationToken__" data-uid="Hi.Vibrations.ForceAccelShot.ReadRows(System.String,System.Action{System.Int32},System.Nullable{System.Threading.CancellationToken})">
|
|
ReadRows(string, Action<int>, CancellationToken?)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Reads force and acceleration data from a CSV file.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static List<ForceAccelShot> ReadRows(string file, Action<int> lineReaded = null, CancellationToken? cancellationToken = null)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>file</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>The path to the CSV file to read.</p>
|
|
</dd>
|
|
<dt><code>lineReaded</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>></dt>
|
|
<dd><p>Optional callback function to report progress.</p>
|
|
</dd>
|
|
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a>?</dt>
|
|
<dd><p>Optional cancellation token to cancel the operation.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a><<a class="xref" href="Hi.Vibrations.ForceAccelShot.html">ForceAccelShot</a>></dt>
|
|
<dd><p>A list of ForceAccelShot objects containing the data from the file.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Exceptions</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.io.invaliddataexception">InvalidDataException</a></dt>
|
|
<dd><p>Thrown when the file format is invalid.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<a id="Hi_Vibrations_ForceAccelShot_ToString_" data-uid="Hi.Vibrations.ForceAccelShot.ToString*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot_ToString" data-uid="Hi.Vibrations.ForceAccelShot.ToString">
|
|
ToString()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Returns a string that represents the current object.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
|
|
</div>
|
|
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>A string that represents the current object.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Vibrations_ForceAccelShot_ToString_" data-uid="Hi.Vibrations.ForceAccelShot.ToString*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot_ToString_System_String_" data-uid="Hi.Vibrations.ForceAccelShot.ToString(System.String)">
|
|
ToString(string)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Returns a string representation of the ForceAccelShot instance with the specified format.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string ToString(string format)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>format</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>The format string to use for numeric values.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>A string containing the formatted values.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="operators">Operators
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_Vibrations_ForceAccelShot_op_Addition_" data-uid="Hi.Vibrations.ForceAccelShot.op_Addition*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot_op_Addition_Hi_Vibrations_ForceAccelShot_Hi_Vibrations_ForceAccelShot_" data-uid="Hi.Vibrations.ForceAccelShot.op_Addition(Hi.Vibrations.ForceAccelShot,Hi.Vibrations.ForceAccelShot)">
|
|
operator +(ForceAccelShot, ForceAccelShot)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Adds two ForceAccelShot instances together.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ForceAccelShot operator +(ForceAccelShot a, ForceAccelShot b)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>a</code> <a class="xref" href="Hi.Vibrations.ForceAccelShot.html">ForceAccelShot</a></dt>
|
|
<dd><p>The first ForceAccelShot instance.</p>
|
|
</dd>
|
|
<dt><code>b</code> <a class="xref" href="Hi.Vibrations.ForceAccelShot.html">ForceAccelShot</a></dt>
|
|
<dd><p>The second ForceAccelShot instance.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Vibrations.ForceAccelShot.html">ForceAccelShot</a></dt>
|
|
<dd><p>A new ForceAccelShot instance containing the sum of the two inputs.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Vibrations_ForceAccelShot_op_Multiply_" data-uid="Hi.Vibrations.ForceAccelShot.op_Multiply*"></a>
|
|
|
|
<h3 id="Hi_Vibrations_ForceAccelShot_op_Multiply_Hi_Vibrations_ForceAccelShot_System_Double_" data-uid="Hi.Vibrations.ForceAccelShot.op_Multiply(Hi.Vibrations.ForceAccelShot,System.Double)">
|
|
operator *(ForceAccelShot, double)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Multiplies a ForceAccelShot instance by a scalar value.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ForceAccelShot operator *(ForceAccelShot a, double s)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>a</code> <a class="xref" href="Hi.Vibrations.ForceAccelShot.html">ForceAccelShot</a></dt>
|
|
<dd><p>The ForceAccelShot instance to multiply.</p>
|
|
</dd>
|
|
<dt><code>s</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
|
<dd><p>The scalar value to multiply by.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Vibrations.ForceAccelShot.html">ForceAccelShot</a></dt>
|
|
<dd><p>A new ForceAccelShot instance containing the scaled values.</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>
|