Google Git
Sign in
eclipse / gerrit / www.eclipse.org / mosaic / 217d1a3f17a8391a16675cbcf59004b3c6a76080 / . / java_docs / org / eclipse / mosaic / rti / time / AbstractTimeManagement.html
blob: f7cb57cc18bdb123ca86958a7782f52ca168f5a4 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_262) on Wed Mar 10 21:50:05 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AbstractTimeManagement (Eclipse MOSAIC Parent 21.0 API)</title>
<meta name="date" content="2021-03-10">
<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) {
parent.document.title="AbstractTimeManagement (Eclipse MOSAIC Parent 21.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":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="class-use/AbstractTimeManagement.html">Use</a></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">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../org/eclipse/mosaic/rti/time/AbstractTimeManagement.PerformanceCalculator.html" title="class in org.eclipse.mosaic.rti.time"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/mosaic/rti/time/AbstractTimeManagement.html" target="_top">Frames</a></li>
<li><a href="AbstractTimeManagement.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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">
<div class="subTitle">org.eclipse.mosaic.rti.time</div>
<h2 title="Class AbstractTimeManagement" class="title">Class AbstractTimeManagement</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Observable.html?is-external=true" title="class or interface in java.util">java.util.Observable</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.mosaic.rti.time.AbstractTimeManagement</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html" title="interface in org.eclipse.mosaic.rti.api">TimeManagement</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/eclipse/mosaic/rti/time/MultiThreadedTimeManagement.html" title="class in org.eclipse.mosaic.rti.time">MultiThreadedTimeManagement</a>, <a href="../../../../../org/eclipse/mosaic/rti/time/SequentialTimeManagement.html" title="class in org.eclipse.mosaic.rti.time">SequentialTimeManagement</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">AbstractTimeManagement</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Observable.html?is-external=true" title="class or interface in java.util">Observable</a>
implements <a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html" title="interface in org.eclipse.mosaic.rti.api">TimeManagement</a></pre>
<div class="block">Abstract class providing base functions for initialization, progress printing and finishing of
<a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html" title="interface in org.eclipse.mosaic.rti.api"><code>TimeManagement</code></a> implementations.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/time/AbstractTimeManagement.PerformanceCalculator.html" title="class in org.eclipse.mosaic.rti.time">AbstractTimeManagement.PerformanceCalculator</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Queue.html?is-external=true" title="class or interface in java.util">Queue</a>&lt;<a href="../../../../../org/eclipse/mosaic/rti/api/time/FederateEvent.html" title="class in org.eclipse.mosaic.rti.api.time">FederateEvent</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/time/AbstractTimeManagement.html#events">events</a></span></code>
<div class="block">Ordered queue holding all requested times of federates.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../org/eclipse/mosaic/rti/ExternalWatchDog.html" title="class in org.eclipse.mosaic.rti">ExternalWatchDog</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/time/AbstractTimeManagement.html#externalWatchDog">externalWatchDog</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../org/eclipse/mosaic/rti/api/ComponentProvider.html" title="interface in org.eclipse.mosaic.rti.api">ComponentProvider</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/time/AbstractTimeManagement.html#federation">federation</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DecimalFormat.html?is-external=true" title="class or interface in java.text">DecimalFormat</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/time/AbstractTimeManagement.html#FORMAT_ONE_DIGIT">FORMAT_ONE_DIGIT</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DecimalFormat.html?is-external=true" title="class or interface in java.text">DecimalFormat</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/time/AbstractTimeManagement.html#FORMAT_TWO_DIGIT">FORMAT_TWO_DIGIT</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected org.slf4j.Logger</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/time/AbstractTimeManagement.html#logger">logger</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/time/AbstractTimeManagement.html#time">time</a></span></code>
<div class="block">The current simulation time of the federation in nanoseconds.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../org/eclipse/mosaic/rti/api/WatchDog.html" title="interface in org.eclipse.mosaic.rti.api">WatchDog</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/time/AbstractTimeManagement.html#watchDog">watchDog</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/time/AbstractTimeManagement.html#AbstractTimeManagement-org.eclipse.mosaic.rti.api.ComponentProvider-org.eclipse.mosaic.rti.MosaicComponentParameters-">AbstractTimeManagement</a></span>(<a href="../../../../../org/eclipse/mosaic/rti/api/ComponentProvider.html" title="interface in org.eclipse.mosaic.rti.api">ComponentProvider</a>&nbsp;federation,
<a href="../../../../../org/eclipse/mosaic/rti/MosaicComponentParameters.html" title="class in org.eclipse.mosaic.rti">MosaicComponentParameters</a>&nbsp;componentParameters)</code>&nbsp;</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/time/AbstractTimeManagement.html#finishSimulationRun-int-">finishSimulationRun</a></span>(int&nbsp;statusCode)</code>
<div class="block">The method is called once after the simulation has reached the end time.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/time/AbstractTimeManagement.html#getEndTime--">getEndTime</a></span>()</code>
<div class="block">Getter for end time.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/time/AbstractTimeManagement.html#getNextEventTimestamp--">getNextEventTimestamp</a></span>()</code>
<div class="block">Returns the time stamp of the next event.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/time/AbstractTimeManagement.html#getSimulationTime--">getSimulationTime</a></span>()</code>
<div class="block">Getter for current simulation time.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/time/AbstractTimeManagement.html#prepareSimulationRun--">prepareSimulationRun</a></span>()</code>
<div class="block">The method is called once before the simulation is started.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/time/AbstractTimeManagement.html#printProgress-long-org.eclipse.mosaic.rti.time.PerformanceInformation-">printProgress</a></span>(long&nbsp;currentRealTimeNs,
<a href="../../../../../org/eclipse/mosaic/rti/time/PerformanceInformation.html" title="class in org.eclipse.mosaic.rti.time">PerformanceInformation</a>&nbsp;performanceInformation)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/time/AbstractTimeManagement.html#requestAdvanceTime-java.lang.String-long-long-byte-">requestAdvanceTime</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;federateId,
long&nbsp;time,
long&nbsp;lookahead,
byte&nbsp;priority)</code>
<div class="block">Stores a schedulable event representing the requested time.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/time/AbstractTimeManagement.html#startExternalWatchDog-java.lang.String-int-">startExternalWatchDog</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;simId,
int&nbsp;port)</code>
<div class="block">Starts the external watchdog thread.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/mosaic/rti/api/WatchDog.html" title="interface in org.eclipse.mosaic.rti.api">WatchDog</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/time/AbstractTimeManagement.html#startWatchDog-java.lang.String-int-">startWatchDog</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;simId,
int&nbsp;maxIdleTime)</code>
<div class="block">Starts the watchdog thread.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/time/AbstractTimeManagement.html#updateWatchDog--">updateWatchDog</a></span>()</code>
<div class="block">Updates the watchdog thread to show that wa are still alive.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.Observable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.util.<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Observable.html?is-external=true" title="class or interface in java.util">Observable</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Observable.html?is-external=true#addObserver-java.util.Observer-" title="class or interface in java.util">addObserver</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Observable.html?is-external=true#clearChanged--" title="class or interface in java.util">clearChanged</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Observable.html?is-external=true#countObservers--" title="class or interface in java.util">countObservers</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Observable.html?is-external=true#deleteObserver-java.util.Observer-" title="class or interface in java.util">deleteObserver</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Observable.html?is-external=true#deleteObservers--" title="class or interface in java.util">deleteObservers</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Observable.html?is-external=true#hasChanged--" title="class or interface in java.util">hasChanged</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Observable.html?is-external=true#notifyObservers--" title="class or interface in java.util">notifyObservers</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Observable.html?is-external=true#notifyObservers-java.lang.Object-" title="class or interface in java.util">notifyObservers</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Observable.html?is-external=true#setChanged--" title="class or interface in java.util">setChanged</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.mosaic.rti.api.TimeManagement">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.mosaic.rti.api.<a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html" title="interface in org.eclipse.mosaic.rti.api">TimeManagement</a></h3>
<code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html#runSimulation--">runSimulation</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="FORMAT_ONE_DIGIT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FORMAT_ONE_DIGIT</h4>
<pre>protected static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/text/DecimalFormat.html?is-external=true" title="class or interface in java.text">DecimalFormat</a> FORMAT_ONE_DIGIT</pre>
</li>
</ul>
<a name="FORMAT_TWO_DIGIT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FORMAT_TWO_DIGIT</h4>
<pre>protected static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/text/DecimalFormat.html?is-external=true" title="class or interface in java.text">DecimalFormat</a> FORMAT_TWO_DIGIT</pre>
</li>
</ul>
<a name="logger">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logger</h4>
<pre>protected final&nbsp;org.slf4j.Logger logger</pre>
</li>
</ul>
<a name="events">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>events</h4>
<pre>protected final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Queue.html?is-external=true" title="class or interface in java.util">Queue</a>&lt;<a href="../../../../../org/eclipse/mosaic/rti/api/time/FederateEvent.html" title="class in org.eclipse.mosaic.rti.api.time">FederateEvent</a>&gt; events</pre>
<div class="block">Ordered queue holding all requested times of federates.
TODO: the ordering of this queue has to be revisited:
<ul>
<li/> <a href="../../../../../org/eclipse/mosaic/rti/api/parameters/FederatePriority.html" title="class in org.eclipse.mosaic.rti.api.parameters"><code>FederatePriority</code></a> is used as reference values
<li/> <a href="../../../../../org/eclipse/mosaic/rti/api/time/FederateEvent.html#compareTo-org.eclipse.mosaic.rti.api.time.FederateEvent-"><code>FederateEvent.compareTo(org.eclipse.mosaic.rti.api.time.FederateEvent)</code></a> orders events reversed as described FederatePriority
<li/> maybe it's enough to just reverse the compareTo logic
</ul></div>
</li>
</ul>
<a name="federation">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>federation</h4>
<pre>protected final&nbsp;<a href="../../../../../org/eclipse/mosaic/rti/api/ComponentProvider.html" title="interface in org.eclipse.mosaic.rti.api">ComponentProvider</a> federation</pre>
</li>
</ul>
<a name="time">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>time</h4>
<pre>protected&nbsp;long time</pre>
<div class="block">The current simulation time of the federation in nanoseconds.</div>
</li>
</ul>
<a name="watchDog">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>watchDog</h4>
<pre>protected&nbsp;<a href="../../../../../org/eclipse/mosaic/rti/api/WatchDog.html" title="interface in org.eclipse.mosaic.rti.api">WatchDog</a> watchDog</pre>
</li>
</ul>
<a name="externalWatchDog">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>externalWatchDog</h4>
<pre>protected&nbsp;<a href="../../../../../org/eclipse/mosaic/rti/ExternalWatchDog.html" title="class in org.eclipse.mosaic.rti">ExternalWatchDog</a> externalWatchDog</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractTimeManagement-org.eclipse.mosaic.rti.api.ComponentProvider-org.eclipse.mosaic.rti.MosaicComponentParameters-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractTimeManagement</h4>
<pre>protected&nbsp;AbstractTimeManagement(<a href="../../../../../org/eclipse/mosaic/rti/api/ComponentProvider.html" title="interface in org.eclipse.mosaic.rti.api">ComponentProvider</a>&nbsp;federation,
<a href="../../../../../org/eclipse/mosaic/rti/MosaicComponentParameters.html" title="class in org.eclipse.mosaic.rti">MosaicComponentParameters</a>&nbsp;componentParameters)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getSimulationTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSimulationTime</h4>
<pre>public&nbsp;long&nbsp;getSimulationTime()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html#getSimulationTime--">TimeManagement</a></code></span></div>
<div class="block">Getter for current simulation time.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html#getSimulationTime--">getSimulationTime</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html" title="interface in org.eclipse.mosaic.rti.api">TimeManagement</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current simulation time</dd>
</dl>
</li>
</ul>
<a name="getEndTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEndTime</h4>
<pre>public&nbsp;long&nbsp;getEndTime()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html#getEndTime--">TimeManagement</a></code></span></div>
<div class="block">Getter for end time.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html#getEndTime--">getEndTime</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html" title="interface in org.eclipse.mosaic.rti.api">TimeManagement</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>end time of the running simulation</dd>
</dl>
</li>
</ul>
<a name="requestAdvanceTime-java.lang.String-long-long-byte-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requestAdvanceTime</h4>
<pre>public&nbsp;void&nbsp;requestAdvanceTime(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;federateId,
long&nbsp;time,
long&nbsp;lookahead,
byte&nbsp;priority)
throws <a href="../../../../../org/eclipse/mosaic/rti/api/IllegalValueException.html" title="class in org.eclipse.mosaic.rti.api">IllegalValueException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html#requestAdvanceTime-java.lang.String-long-long-byte-">TimeManagement</a></code></span></div>
<div class="block">Stores a schedulable event representing the requested time. When the event
is scheduled the associated federate ambassador is called by the time
management.<br />
This method is to be called only by an <code>RtiAmbassador</code>
instance!</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html#requestAdvanceTime-java.lang.String-long-long-byte-">requestAdvanceTime</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html" title="interface in org.eclipse.mosaic.rti.api">TimeManagement</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>federateId</code> - unique string identifying the calling federate</dd>
<dd><code>time</code> - requested time</dd>
<dd><code>lookahead</code> - time after the requested time in which the calling federate
will not schedule any further events or send any interactions</dd>
<dd><code>priority</code> - priority of the event<br />
only events with equal priority are scheduled in parallel
even if they have the same time</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/eclipse/mosaic/rti/api/IllegalValueException.html" title="class in org.eclipse.mosaic.rti.api">IllegalValueException</a></code> - an exception if a parameter has an invalid value</dd>
</dl>
</li>
</ul>
<a name="prepareSimulationRun--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepareSimulationRun</h4>
<pre>protected&nbsp;void&nbsp;prepareSimulationRun()
throws <a href="../../../../../org/eclipse/mosaic/rti/api/IllegalValueException.html" title="class in org.eclipse.mosaic.rti.api">IllegalValueException</a>,
<a href="../../../../../org/eclipse/mosaic/rti/api/InternalFederateException.html" title="class in org.eclipse.mosaic.rti.api">InternalFederateException</a></pre>
<div class="block">The method is called once before the simulation is started. It calls the
initialize method of all joined federates.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/eclipse/mosaic/rti/api/IllegalValueException.html" title="class in org.eclipse.mosaic.rti.api">IllegalValueException</a></code> - a parameter has an invalid value</dd>
<dd><code><a href="../../../../../org/eclipse/mosaic/rti/api/InternalFederateException.html" title="class in org.eclipse.mosaic.rti.api">InternalFederateException</a></code> - an exception inside of a joined federate occurs</dd>
</dl>
</li>
</ul>
<a name="finishSimulationRun-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>finishSimulationRun</h4>
<pre>public&nbsp;void&nbsp;finishSimulationRun(int&nbsp;statusCode)
throws <a href="../../../../../org/eclipse/mosaic/rti/api/InternalFederateException.html" title="class in org.eclipse.mosaic.rti.api">InternalFederateException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html#finishSimulationRun-int-">TimeManagement</a></code></span></div>
<div class="block">The method is called once after the simulation has reached the end time.
It calls the finishSimulation method of all joined federates.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html#finishSimulationRun-int-">finishSimulationRun</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html" title="interface in org.eclipse.mosaic.rti.api">TimeManagement</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>statusCode</code> - the status code number describing the success or failure of the simulation</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/eclipse/mosaic/rti/api/InternalFederateException.html" title="class in org.eclipse.mosaic.rti.api">InternalFederateException</a></code> - an exception inside of a joined federate occurs</dd>
</dl>
</li>
</ul>
<a name="getNextEventTimestamp--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNextEventTimestamp</h4>
<pre>public&nbsp;long&nbsp;getNextEventTimestamp()
throws <a href="../../../../../org/eclipse/mosaic/rti/api/IllegalValueException.html" title="class in org.eclipse.mosaic.rti.api">IllegalValueException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html#getNextEventTimestamp--">TimeManagement</a></code></span></div>
<div class="block">Returns the time stamp of the next event.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html#getNextEventTimestamp--">getNextEventTimestamp</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html" title="interface in org.eclipse.mosaic.rti.api">TimeManagement</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>time stamp of the next event</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/eclipse/mosaic/rti/api/IllegalValueException.html" title="class in org.eclipse.mosaic.rti.api">IllegalValueException</a></code> - a parameter has an invalid value</dd>
</dl>
</li>
</ul>
<a name="startWatchDog-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startWatchDog</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
public&nbsp;<a href="../../../../../org/eclipse/mosaic/rti/api/WatchDog.html" title="interface in org.eclipse.mosaic.rti.api">WatchDog</a>&nbsp;startWatchDog(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;simId,
int&nbsp;maxIdleTime)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html#startWatchDog-java.lang.String-int-">TimeManagement</a></code></span></div>
<div class="block">Starts the watchdog thread.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html#startWatchDog-java.lang.String-int-">startWatchDog</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html" title="interface in org.eclipse.mosaic.rti.api">TimeManagement</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>simId</code> - Id of the simulation</dd>
<dd><code>maxIdleTime</code> - Period of idle time in seconds after which the thread reacts</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the new <a href="../../../../../org/eclipse/mosaic/rti/api/WatchDog.html" title="interface in org.eclipse.mosaic.rti.api"><code>WatchDog</code></a></dd>
</dl>
</li>
</ul>
<a name="updateWatchDog--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateWatchDog</h4>
<pre>public&nbsp;void&nbsp;updateWatchDog()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html#updateWatchDog--">TimeManagement</a></code></span></div>
<div class="block">Updates the watchdog thread to show that wa are still alive.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html#updateWatchDog--">updateWatchDog</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html" title="interface in org.eclipse.mosaic.rti.api">TimeManagement</a></code></dd>
</dl>
</li>
</ul>
<a name="startExternalWatchDog-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startExternalWatchDog</h4>
<pre>public&nbsp;void&nbsp;startExternalWatchDog(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;simId,
int&nbsp;port)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html#startExternalWatchDog-java.lang.String-int-">TimeManagement</a></code></span></div>
<div class="block">Starts the external watchdog thread.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html#startExternalWatchDog-java.lang.String-int-">startExternalWatchDog</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html" title="interface in org.eclipse.mosaic.rti.api">TimeManagement</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>simId</code> - Id of the simulation</dd>
<dd><code>port</code> - Connection port.</dd>
</dl>
</li>
</ul>
<a name="printProgress-long-org.eclipse.mosaic.rti.time.PerformanceInformation-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>printProgress</h4>
<pre>protected&nbsp;void&nbsp;printProgress(long&nbsp;currentRealTimeNs,
<a href="../../../../../org/eclipse/mosaic/rti/time/PerformanceInformation.html" title="class in org.eclipse.mosaic.rti.time">PerformanceInformation</a>&nbsp;performanceInformation)</pre>
</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="class-use/AbstractTimeManagement.html">Use</a></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">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../org/eclipse/mosaic/rti/time/AbstractTimeManagement.PerformanceCalculator.html" title="class in org.eclipse.mosaic.rti.time"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/mosaic/rti/time/AbstractTimeManagement.html" target="_top">Frames</a></li>
<li><a href="AbstractTimeManagement.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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 ======= -->
<p class="legalCopy"><small>Copyright &#169; 2020&#x2013;2021 <a href="https://www.fokus.fraunhofer.de/">Fraunhofer FOKUS</a>. All rights reserved.</small></p>
</body>
</html>