-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
27 changed files
with
3,245 additions
and
505 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,301 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8" /> | ||
| <title>cubos::core::tel::Metrics class | Cubos Docs</title> | ||
| <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" /> | ||
| <link rel="stylesheet" href="m-dark+documentation.compiled.css" /> | ||
| <link rel="icon" href="Favicon.png" type="image/png" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
| <meta name="theme-color" content="#22272e" /> | ||
| </head> | ||
| <body> | ||
| <header><nav id="navigation"> | ||
| <div class="m-container"> | ||
| <div class="m-row"> | ||
| <span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m"> | ||
| <a href="https://cubosengine.org"><img src="Favicon.png" alt="" />Cubos</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">Docs</a> | ||
| </span> | ||
| <div class="m-col-t-4 m-hide-m m-text-right m-nopadr"> | ||
| <a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16"> | ||
| <path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/> | ||
| </svg></a> | ||
| <a id="m-navbar-show" href="#navigation" title="Show navigation"></a> | ||
| <a id="m-navbar-hide" href="#" title="Hide navigation"></a> | ||
| </div> | ||
| <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m"> | ||
| <div class="m-row"> | ||
| <ol class="m-col-t-6 m-col-m-none"> | ||
| <li><a href="pages.html">Pages</a></li> | ||
| <li><a href="modules.html">Modules</a></li> | ||
| </ol> | ||
| <ol class="m-col-t-6 m-col-m-none" start="3"> | ||
| <li><a href="annotated.html">Classes</a></li> | ||
| <li><a href="files.html">Files</a></li> | ||
| <li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16"> | ||
| <use href="#m-doc-search-icon-path" /> | ||
| </svg></a></li> | ||
| </ol> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </nav></header> | ||
| <main><article> | ||
| <div class="m-container m-container-inflatable"> | ||
| <div class="m-row"> | ||
| <div class="m-col-l-10 m-push-l-1"> | ||
| <h1> | ||
| <span class="m-breadcrumb"><a href="namespacecubos.html">cubos</a>::<wbr/></span><span class="m-breadcrumb"><a href="namespacecubos_1_1core.html">core</a>::<wbr/></span><span class="m-breadcrumb"><a href="namespacecubos_1_1core_1_1tel.html">tel</a>::<wbr/></span>Metrics <span class="m-thin">class</span> | ||
| <div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="metrics_8hpp.html"><core/tel/metrics.hpp></a></div> | ||
| </h1> | ||
| <p>Singleton class that manages a collection of metrics.</p> | ||
| <nav class="m-block m-default"> | ||
| <h3>Contents</h3> | ||
| <ul> | ||
| <li> | ||
| Reference | ||
| <ul> | ||
| <li><a href="#pub-static-methods">Public static functions</a></li> | ||
| <li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </nav> | ||
| <section id="pub-static-methods"> | ||
| <h2><a href="#pub-static-methods">Public static functions</a></h2> | ||
| <dl class="m-doc"> | ||
| <dt> | ||
| <span class="m-doc-wrap-bumper">static void <a href="#ab96e51f639d0b4b559d8501b9fd791d3" class="m-doc">metric</a>(</span><span class="m-doc-wrap">const std::string& name, | ||
| double metric)</span> | ||
| </dt> | ||
| <dd>Add a metric in the pool.</dd> | ||
| <dt> | ||
| <span class="m-doc-wrap-bumper">static auto <a href="#a4bc3b5c4cf9c475b383d180ed58f3901" class="m-doc">size</a>(</span><span class="m-doc-wrap">) -> std::size_t</span> | ||
| </dt> | ||
| <dd>Size of the metric pool.</dd> | ||
| <dt> | ||
| <span class="m-doc-wrap-bumper">static auto <a href="#ade3b5eb2fb3e38f9cdf5612774731fa3" class="m-doc">sizeByName</a>(</span><span class="m-doc-wrap">const std::string& name) -> std::size_t</span> | ||
| </dt> | ||
| <dd>Size of metrics associated with a given name.</dd> | ||
| <dt id="a0c869d1c2f2873a48d4d0363953cbf54"> | ||
| <span class="m-doc-wrap-bumper">static void <a href="#a0c869d1c2f2873a48d4d0363953cbf54" class="m-doc-self">clear</a>(</span><span class="m-doc-wrap">)</span> | ||
| </dt> | ||
| <dd>Clears the metric pool.</dd> | ||
| <dt> | ||
| <span class="m-doc-wrap-bumper">static void <a href="#ab4f47922911239ea3a43f834368fe4c9" class="m-doc">setMaxEntries</a>(</span><span class="m-doc-wrap">std::size_t n)</span> | ||
| </dt> | ||
| <dd>Sets maximum metric entries.</dd> | ||
| <dt> | ||
| <span class="m-doc-wrap-bumper">static auto <a href="#a4bb2d1ced231806aff379eded950ec32" class="m-doc">readValue</a>(</span><span class="m-doc-wrap">const std::string& name, | ||
| double& value, | ||
| size_t& offset) -> bool</span> | ||
| </dt> | ||
| <dd>Read a metric value by its name.</dd> | ||
| <dt> | ||
| <span class="m-doc-wrap-bumper">static auto <a href="#aa43b84e245f1ae7911ea3669ceff0a76" class="m-doc">readName</a>(</span><span class="m-doc-wrap">std::string& name, | ||
| size_t& seenCount) -> bool</span> | ||
| </dt> | ||
| <dd>Search for a new unique metric name.</dd> | ||
| </dl> | ||
| </section> | ||
| <section id="typeless-methods"> | ||
| <h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2> | ||
| <dl class="m-doc"> | ||
| <dt id="a29876ef7ee85a04a731513842094eac7"> | ||
| <span class="m-doc-wrap-bumper"><a href="#a29876ef7ee85a04a731513842094eac7" class="m-doc-self">Metrics</a>(</span><span class="m-doc-wrap">) <span class="m-label m-flat m-danger">deleted</span></span> | ||
| </dt> | ||
| <dd>Deleted constructor.</dd> | ||
| </dl> | ||
| </section> | ||
| <section> | ||
| <h2>Function documentation</h2> | ||
| <section class="m-doc-details" id="ab96e51f639d0b4b559d8501b9fd791d3"><div> | ||
| <h3> | ||
| <span class="m-doc-wrap-bumper">static void cubos::<wbr />core::<wbr />tel::<wbr />Metrics::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ab96e51f639d0b4b559d8501b9fd791d3" class="m-doc-self">metric</a>(</span><span class="m-doc-wrap">const std::string& name, | ||
| double metric)</span></span> | ||
| </h3> | ||
| <p>Add a metric in the pool.</p> | ||
| <table class="m-table m-fullwidth m-flat"> | ||
| <thead> | ||
| <tr><th colspan="2">Parameters</th></tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td style="width: 1%">name</td> | ||
| <td></td> | ||
| </tr> | ||
| <tr> | ||
| <td>metric</td> | ||
| <td>The metric to add.</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </div></section> | ||
| <section class="m-doc-details" id="a4bc3b5c4cf9c475b383d180ed58f3901"><div> | ||
| <h3> | ||
| <span class="m-doc-wrap-bumper">static std::size_t cubos::<wbr />core::<wbr />tel::<wbr />Metrics::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a4bc3b5c4cf9c475b383d180ed58f3901" class="m-doc-self">size</a>(</span><span class="m-doc-wrap">)</span></span> | ||
| </h3> | ||
| <p>Size of the metric pool.</p> | ||
| <table class="m-table m-fullwidth m-flat"> | ||
| <tfoot> | ||
| <tr> | ||
| <th style="width: 1%">Returns</th> | ||
| <td><a href="classcubos_1_1core_1_1tel_1_1Metrics.html" class="m-doc">Metrics</a> count.</td> | ||
| </tr> | ||
| </tfoot> | ||
| </table> | ||
| </div></section> | ||
| <section class="m-doc-details" id="ade3b5eb2fb3e38f9cdf5612774731fa3"><div> | ||
| <h3> | ||
| <span class="m-doc-wrap-bumper">static std::size_t cubos::<wbr />core::<wbr />tel::<wbr />Metrics::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ade3b5eb2fb3e38f9cdf5612774731fa3" class="m-doc-self">sizeByName</a>(</span><span class="m-doc-wrap">const std::string& name)</span></span> | ||
| </h3> | ||
| <p>Size of metrics associated with a given name.</p> | ||
| <table class="m-table m-fullwidth m-flat"> | ||
| <thead> | ||
| <tr><th colspan="2">Parameters</th></tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td style="width: 1%">name</td> | ||
| <td>Metric name.</td> | ||
| </tr> | ||
| </tbody> | ||
| <tfoot> | ||
| <tr> | ||
| <th>Returns</th> | ||
| <td><a href="classcubos_1_1core_1_1tel_1_1Metrics.html" class="m-doc">Metrics</a> count.</td> | ||
| </tr> | ||
| </tfoot> | ||
| </table> | ||
| </div></section> | ||
| <section class="m-doc-details" id="ab4f47922911239ea3a43f834368fe4c9"><div> | ||
| <h3> | ||
| <span class="m-doc-wrap-bumper">static void cubos::<wbr />core::<wbr />tel::<wbr />Metrics::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ab4f47922911239ea3a43f834368fe4c9" class="m-doc-self">setMaxEntries</a>(</span><span class="m-doc-wrap">std::size_t n)</span></span> | ||
| </h3> | ||
| <p>Sets maximum metric entries.</p> | ||
| <table class="m-table m-fullwidth m-flat"> | ||
| <thead> | ||
| <tr><th colspan="2">Parameters</th></tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td style="width: 1%">n</td> | ||
| <td>The new maximum value.</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </div></section> | ||
| <section class="m-doc-details" id="a4bb2d1ced231806aff379eded950ec32"><div> | ||
| <h3> | ||
| <span class="m-doc-wrap-bumper">static bool cubos::<wbr />core::<wbr />tel::<wbr />Metrics::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a4bb2d1ced231806aff379eded950ec32" class="m-doc-self">readValue</a>(</span><span class="m-doc-wrap">const std::string& name, | ||
| double& value, | ||
| size_t& offset)</span></span> | ||
| </h3> | ||
| <p>Read a metric value by its name.</p> | ||
| <table class="m-table m-fullwidth m-flat"> | ||
| <thead> | ||
| <tr><th colspan="2">Parameters</th></tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td style="width: 1%">name</td> | ||
| <td>Metric name.</td> | ||
| </tr> | ||
| <tr> | ||
| <td>value <span class="m-label m-flat m-warning">out</span></td> | ||
| <td>Buffer to store metric value.</td> | ||
| </tr> | ||
| <tr> | ||
| <td>offset</td> | ||
| <td>Read count per metric.</td> | ||
| </tr> | ||
| </tbody> | ||
| <tfoot> | ||
| <tr> | ||
| <th>Returns</th> | ||
| <td>Whether the metric was found.</td> | ||
| </tr> | ||
| </tfoot> | ||
| </table> | ||
| </div></section> | ||
| <section class="m-doc-details" id="aa43b84e245f1ae7911ea3669ceff0a76"><div> | ||
| <h3> | ||
| <span class="m-doc-wrap-bumper">static bool cubos::<wbr />core::<wbr />tel::<wbr />Metrics::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aa43b84e245f1ae7911ea3669ceff0a76" class="m-doc-self">readName</a>(</span><span class="m-doc-wrap">std::string& name, | ||
| size_t& seenCount)</span></span> | ||
| </h3> | ||
| <p>Search for a new unique metric name.</p> | ||
| <table class="m-table m-fullwidth m-flat"> | ||
| <thead> | ||
| <tr><th colspan="2">Parameters</th></tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td style="width: 1%">name <span class="m-label m-flat m-warning">out</span></td> | ||
| <td>Buffer to store metric name.</td> | ||
| </tr> | ||
| <tr> | ||
| <td>seenCount</td> | ||
| <td>Seen metrics count.</td> | ||
| </tr> | ||
| </tbody> | ||
| <tfoot> | ||
| <tr> | ||
| <th>Returns</th> | ||
| <td>Whether a new metric was found.</td> | ||
| </tr> | ||
| </tfoot> | ||
| </table> | ||
| </div></section> | ||
| </section> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </article></main> | ||
| <div class="m-doc-search" id="search"> | ||
| <a href="#!" onclick="return hideSearch()"></a> | ||
| <div class="m-container"> | ||
| <div class="m-row"> | ||
| <div class="m-col-m-8 m-push-m-2"> | ||
| <div class="m-doc-search-header m-text m-small"> | ||
| <div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div> | ||
| <div id="search-symbolcount">…</div> | ||
| </div> | ||
| <div class="m-doc-search-content"> | ||
| <form> | ||
| <input type="search" name="q" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" /> | ||
| </form> | ||
| <noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript> | ||
| <div id="search-help" class="m-text m-dim m-text-center"> | ||
| <p class="m-noindent">Search for symbols, directories, files, pages or | ||
| modules. You can omit any prefix from the symbol or file path; adding a | ||
| <code>:</code> or <code>/</code> suffix lists all members of given symbol or | ||
| directory.</p> | ||
| <p class="m-noindent">Use <span class="m-label m-dim">↓</span> | ||
| / <span class="m-label m-dim">↑</span> to navigate through the list, | ||
| <span class="m-label m-dim">Enter</span> to go. | ||
| <span class="m-label m-dim">Tab</span> autocompletes common prefix, you can | ||
| copy a link to the result using <span class="m-label m-dim">⌘</span> | ||
| <span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span> | ||
| <span class="m-label m-dim">M</span> produces a Markdown link.</p> | ||
| </div> | ||
| <div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div> | ||
| <ul id="search-results"></ul> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <script src="search-v2.js"></script> | ||
| <script src="searchdata-v2.js" async="async"></script> | ||
| <footer><nav> | ||
| <div class="m-container"> | ||
| <div class="m-row"> | ||
| <div class="m-col-l-10 m-push-l-1"> | ||
| <p>Cubos Docs. Created with <a href="https://doxygen.org/">Doxygen</a> 1.9.1 and <a href="https://mcss.mosra.cz/">m.css</a>.</p> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </nav></footer> | ||
| </body> | ||
| </html> |
Oops, something went wrong.