369 lines
12 KiB
HTML
369 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Class TimeCounter | HiAPI-C# 2025 </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Class TimeCounter | HiAPI-C# 2025 ">
|
|
|
|
<meta name="description" content="A utility counts the average/total time consume between the areas. The count of time consume for the given key starts at the first time (and the odd time) calling ; stops and accumulates at the second time (and the even 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.Common.TimeCounter">
|
|
|
|
|
|
|
|
<h1 id="Hi_Common_TimeCounter" data-uid="Hi.Common.TimeCounter" class="text-break">
|
|
Class TimeCounter
|
|
</h1>
|
|
|
|
<div class="facts text-secondary">
|
|
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Common.html">Common</a></dd></dl>
|
|
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
|
|
</div>
|
|
|
|
<div class="markdown summary"><p>A utility counts the average/total time consume between the <a class="xref" href="Hi.Common.TimeCounter.html#Hi_Common_TimeCounter_Bound_System_Object_">Bound(object)</a> areas.
|
|
The count of time consume for the given key starts at the first time (and the odd time) calling <a class="xref" href="Hi.Common.TimeCounter.html#Hi_Common_TimeCounter_Bound_System_Object_">Bound(object)</a>;
|
|
stops and accumulates at the second time (and the even time).</p>
|
|
</div>
|
|
<div class="markdown conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static class TimeCounter</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">TimeCounter</span></div>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<dl class="typelist inheritedMembers">
|
|
<dt>Inherited Members</dt>
|
|
<dd>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="methods">Methods
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_Common_TimeCounter_Bound_" data-uid="Hi.Common.TimeCounter.Bound*"></a>
|
|
|
|
<h3 id="Hi_Common_TimeCounter_Bound_System_Object_" data-uid="Hi.Common.TimeCounter.Bound(System.Object)">
|
|
Bound(object)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Marks a boundary for time measurement for the specified key.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void Bound(object key)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>key</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
|
<dd><p>The key that identifies this particular measurement.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section" id="Hi_Common_TimeCounter_Bound_System_Object__remarks">Remarks</h4>
|
|
<div class="markdown level1 remarks"><p>This method alternates between starting and stopping time measurement:</p>
|
|
<ul>
|
|
<li>First call with a key: Starts the timer</li>
|
|
<li>Second call with the same key: Stops the timer and records the elapsed time</li>
|
|
<li>Third call: Starts the timer again</li>
|
|
<li>And so on…</li>
|
|
</ul>
|
|
<p>The elapsed time is accumulated and the count is incremented each time a measurement completes.</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Common_TimeCounter_Pass_" data-uid="Hi.Common.TimeCounter.Pass*"></a>
|
|
|
|
<h3 id="Hi_Common_TimeCounter_Pass_System_Object_" data-uid="Hi.Common.TimeCounter.Pass(System.Object)">
|
|
Pass(object)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Cancels an active time measurement for the specified key without recording the elapsed time.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void Pass(object key)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>key</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
|
<dd><p>The key that identifies the measurement to cancel.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section" id="Hi_Common_TimeCounter_Pass_System_Object__remarks">Remarks</h4>
|
|
<div class="markdown level1 remarks"><p>If timing has not been started for the specified key, this method has no effect.
|
|
This is useful for aborting a measurement without affecting statistics.</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Common_TimeCounter_Reset_" data-uid="Hi.Common.TimeCounter.Reset*"></a>
|
|
|
|
<h3 id="Hi_Common_TimeCounter_Reset" data-uid="Hi.Common.TimeCounter.Reset">
|
|
Reset()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Resets all time measurements by clearing all accumulated statistics and counters.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void Reset()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Common_TimeCounter_Show_" data-uid="Hi.Common.TimeCounter.Show*"></a>
|
|
|
|
<h3 id="Hi_Common_TimeCounter_Show" data-uid="Hi.Common.TimeCounter.Show">
|
|
Show()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Displays all accumulated time measurements to the console.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void Show()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section" id="Hi_Common_TimeCounter_Show_remarks">Remarks</h4>
|
|
<div class="markdown level1 remarks"><p>For each key, this method outputs:</p>
|
|
<ul>
|
|
<li>The count of measurements</li>
|
|
<li>The total accumulated time</li>
|
|
<li>The average time per measurement</li>
|
|
<li>The key identifier</li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Common_TimeCounter_ShowExt_" data-uid="Hi.Common.TimeCounter.ShowExt*"></a>
|
|
|
|
<h3 id="Hi_Common_TimeCounter_ShowExt_System_Int32_" data-uid="Hi.Common.TimeCounter.ShowExt(System.Int32)">
|
|
ShowExt(int)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Displays time measurements and resets counters periodically based on call frequency.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void ShowExt(int gap)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>gap</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
|
<dd><p>The number of calls to this method before showing results and resetting.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section" id="Hi_Common_TimeCounter_ShowExt_System_Int32__remarks">Remarks</h4>
|
|
<div class="markdown level1 remarks"><p>This method increments an internal counter with each call. When the counter reaches
|
|
the specified <code class="paramref">gap</code> value, it:</p>
|
|
<ol>
|
|
<li>Displays all measurements (calls <a class="xref" href="Hi.Common.TimeCounter.html#Hi_Common_TimeCounter_Show">Show()</a>)</li>
|
|
<li>Resets all counters (calls <a class="xref" href="Hi.Common.TimeCounter.html#Hi_Common_TimeCounter_Reset">Reset()</a>)</li>
|
|
<li>Resets the internal counter to zero</li>
|
|
</ol>
|
|
<p>This is useful for periodic reporting during long-running operations.</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
<div class="contribution d-print-none">
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="affix">
|
|
<nav id="affix"></nav>
|
|
</div>
|
|
</main>
|
|
|
|
<div class="container-xxl search-results" id="search-results"></div>
|
|
|
|
<footer class="border-top text-secondary">
|
|
<div class="container-xxl">
|
|
<div class="flex-fill">
|
|
<span> Copyright © 2025 <a href='https://superhightech.com.tw'>Tech Coordinate</a>. All rights reserved. <a href='https://superhightech.com.tw'>超級高科技股份有限公司</a> © 2025 版權所有 </span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</body>
|
|
</html>
|