Plan/all/com/djrapitops/plan/gathering/domain/TPS.html

505 lines
18 KiB
HTML
Raw Normal View History

2019-08-05 11:13:19 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fi">
<head>
2020-01-24 11:56:15 +01:00
<!-- Generated by javadoc (1.8.0_201) on Fri Jan 24 12:56:09 EET 2020 -->
<title>TPS (Plan 5.0-SNAPSHOT API)</title>
<meta name="date" content="2020-01-24">
2019-08-05 11:13:19 +02:00
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
2020-01-24 11:56:15 +01:00
parent.document.title="TPS (Plan 5.0-SNAPSHOT API)";
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
2019-10-05 10:27:37 +02:00
<li><a href="../../../../../com/djrapitops/plan/gathering/domain/TimeKeeper.html" title="class in com.djrapitops.plan.gathering.domain"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/djrapitops/plan/gathering/domain/UserInfo.html" title="class in com.djrapitops.plan.gathering.domain"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
2019-08-05 11:13:19 +02:00
</ul>
<ul class="navList">
2019-10-05 10:27:37 +02:00
<li><a href="../../../../../index.html?com/djrapitops/plan/gathering/domain/TPS.html" target="_top">Frames</a></li>
2019-08-05 11:13:19 +02:00
<li><a href="TPS.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
2019-10-05 10:27:37 +02:00
<div class="subTitle">com.djrapitops.plan.gathering.domain</div>
2019-08-05 11:13:19 +02:00
<h2 title="Class TPS" class="title">Class TPS</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
2019-10-05 10:27:37 +02:00
<li>com.djrapitops.plan.gathering.domain.TPS</li>
2019-08-05 11:13:19 +02:00
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
2019-10-05 10:27:37 +02:00
<dd><a href="../../../../../com/djrapitops/plan/delivery/domain/DateHolder.html" title="interface in com.djrapitops.plan.delivery.domain">DateHolder</a></dd>
2019-08-05 11:13:19 +02:00
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">TPS</span>
extends java.lang.Object
2019-10-05 10:27:37 +02:00
implements <a href="../../../../../com/djrapitops/plan/delivery/domain/DateHolder.html" title="interface in com.djrapitops.plan.delivery.domain">DateHolder</a></pre>
2019-08-05 11:13:19 +02:00
<div class="block">Class containing single datapoint of TPS / Players online / CPU Usage / Used Memory / Entity Count / Chunks loaded.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
2019-10-05 10:27:37 +02:00
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/gathering/domain/TPS.html#TPS-long-double-int-double-long-int-int-long-">TPS</a></span>(long&nbsp;date,
2019-08-05 11:13:19 +02:00
double&nbsp;ticksPerSecond,
int&nbsp;players,
double&nbsp;cpuUsage,
long&nbsp;usedMemory,
int&nbsp;entityCount,
int&nbsp;chunksLoaded,
long&nbsp;freeDiskSpace)</code>
<div class="block">Constructor.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
2019-10-05 10:27:37 +02:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/gathering/domain/TPS.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;o)</code>&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
2019-10-05 10:27:37 +02:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/gathering/domain/TPS.html#getChunksLoaded--">getChunksLoaded</a></span>()</code>
2019-08-05 11:13:19 +02:00
<div class="block">Get the amount of chunks loaded for the time, when the data was fetched</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>double</code></td>
2019-10-05 10:27:37 +02:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/gathering/domain/TPS.html#getCPUUsage--">getCPUUsage</a></span>()</code>
2019-08-05 11:13:19 +02:00
<div class="block">Get the average CPU Usage for the minute</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>long</code></td>
2019-10-05 10:27:37 +02:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/gathering/domain/TPS.html#getDate--">getDate</a></span>()</code>
2019-08-05 11:13:19 +02:00
<div class="block">Get the date the object holds.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
2019-10-05 10:27:37 +02:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/gathering/domain/TPS.html#getEntityCount--">getEntityCount</a></span>()</code>
2019-08-05 11:13:19 +02:00
<div class="block">Get the amount of entities for the time, when the data was fetched</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>long</code></td>
2019-10-05 10:27:37 +02:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/gathering/domain/TPS.html#getFreeDiskSpace--">getFreeDiskSpace</a></span>()</code>
2019-08-05 11:13:19 +02:00
<div class="block">Get free megabytes of disk space on the server disk.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
2019-10-05 10:27:37 +02:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/gathering/domain/TPS.html#getPlayers--">getPlayers</a></span>()</code>
2019-08-05 11:13:19 +02:00
<div class="block">Get the player for the time, when the data was fetched.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>double</code></td>
2019-10-05 10:27:37 +02:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/gathering/domain/TPS.html#getTicksPerSecond--">getTicksPerSecond</a></span>()</code>
2019-08-05 11:13:19 +02:00
<div class="block">Get the average ticksPerSecond for the minute.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>long</code></td>
2019-10-05 10:27:37 +02:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/gathering/domain/TPS.html#getUsedMemory--">getUsedMemory</a></span>()</code>
2019-08-05 11:13:19 +02:00
<div class="block">Get the used memory for the time, when the data was fetched.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
2019-10-05 10:27:37 +02:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/gathering/domain/TPS.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
2019-10-05 10:27:37 +02:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/gathering/domain/TPS.html#toString--">toString</a></span>()</code>&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="TPS-long-double-int-double-long-int-int-long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TPS</h4>
<pre>public&nbsp;TPS(long&nbsp;date,
double&nbsp;ticksPerSecond,
int&nbsp;players,
double&nbsp;cpuUsage,
long&nbsp;usedMemory,
int&nbsp;entityCount,
int&nbsp;chunksLoaded,
long&nbsp;freeDiskSpace)</pre>
<div class="block">Constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>date</code> - time of the TPS calculation.</dd>
<dd><code>ticksPerSecond</code> - average ticksPerSecond for the last minute.</dd>
<dd><code>players</code> - players for the minute.</dd>
<dd><code>cpuUsage</code> - CPU usage for the minute</dd>
<dd><code>usedMemory</code> - used memory (megabytes) at the time of fetching</dd>
<dd><code>entityCount</code> - amount of entities at the time of fetching</dd>
<dd><code>chunksLoaded</code> - amount of chunks loaded at the time of fetching</dd>
<dd><code>freeDiskSpace</code> - free megabytes in the partition the server is running in.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getDate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDate</h4>
<pre>public&nbsp;long&nbsp;getDate()</pre>
2019-10-05 10:27:37 +02:00
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../com/djrapitops/plan/delivery/domain/DateHolder.html#getDate--">DateHolder</a></code></span></div>
2019-08-05 11:13:19 +02:00
<div class="block">Get the date the object holds.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
2019-10-05 10:27:37 +02:00
<dd><code><a href="../../../../../com/djrapitops/plan/delivery/domain/DateHolder.html#getDate--">getDate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../com/djrapitops/plan/delivery/domain/DateHolder.html" title="interface in com.djrapitops.plan.delivery.domain">DateHolder</a></code></dd>
2019-08-05 11:13:19 +02:00
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Epoch ms - milliseconds passed since January 1st 1970.</dd>
</dl>
</li>
</ul>
<a name="getTicksPerSecond--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTicksPerSecond</h4>
<pre>public&nbsp;double&nbsp;getTicksPerSecond()</pre>
<div class="block">Get the average ticksPerSecond for the minute.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>0-20 double</dd>
</dl>
</li>
</ul>
<a name="getPlayers--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlayers</h4>
<pre>public&nbsp;int&nbsp;getPlayers()</pre>
<div class="block">Get the player for the time, when the data was fetched.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Players online.</dd>
</dl>
</li>
</ul>
<a name="getCPUUsage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCPUUsage</h4>
<pre>public&nbsp;double&nbsp;getCPUUsage()</pre>
<div class="block">Get the average CPU Usage for the minute</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>0-100 double</dd>
</dl>
</li>
</ul>
<a name="getUsedMemory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUsedMemory</h4>
<pre>public&nbsp;long&nbsp;getUsedMemory()</pre>
<div class="block">Get the used memory for the time, when the data was fetched.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Used Memory in Megabyte</dd>
</dl>
</li>
</ul>
<a name="getEntityCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntityCount</h4>
<pre>public&nbsp;int&nbsp;getEntityCount()</pre>
<div class="block">Get the amount of entities for the time, when the data was fetched</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Amount of entities</dd>
</dl>
</li>
</ul>
<a name="getChunksLoaded--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChunksLoaded</h4>
<pre>public&nbsp;int&nbsp;getChunksLoaded()</pre>
<div class="block">Get the amount of chunks loaded for the time, when the data was fetched</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Amount of chunks loaded</dd>
</dl>
</li>
</ul>
<a name="getFreeDiskSpace--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFreeDiskSpace</h4>
<pre>public&nbsp;long&nbsp;getFreeDiskSpace()</pre>
<div class="block">Get free megabytes of disk space on the server disk.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Amount of free megabytes available on disk.</dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;o)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
2019-10-05 10:27:37 +02:00
<li><a href="../../../../../com/djrapitops/plan/gathering/domain/TimeKeeper.html" title="class in com.djrapitops.plan.gathering.domain"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/djrapitops/plan/gathering/domain/UserInfo.html" title="class in com.djrapitops.plan.gathering.domain"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
2019-08-05 11:13:19 +02:00
</ul>
<ul class="navList">
2019-10-05 10:27:37 +02:00
<li><a href="../../../../../index.html?com/djrapitops/plan/gathering/domain/TPS.html" target="_top">Frames</a></li>
2019-08-05 11:13:19 +02:00
<li><a href="TPS.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>