| <!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 Thu Oct 29 15:52:01 GMT 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>RtiAmbassador (Eclipse MOSAIC Parent 20.0 API)</title> |
| <meta name="date" content="2020-10-29"> |
| <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="RtiAmbassador (Eclipse MOSAIC Parent 20.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/RtiAmbassador.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><a href="../../../../../org/eclipse/mosaic/rti/api/MosaicVersion.html" title="class in org.eclipse.mosaic.rti.api"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html" title="interface in org.eclipse.mosaic.rti.api"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/mosaic/rti/api/RtiAmbassador.html" target="_top">Frames</a></li> |
| <li><a href="RtiAmbassador.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.api</div> |
| <h2 title="Interface RtiAmbassador" class="title">Interface RtiAmbassador</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../org/eclipse/mosaic/rti/api/Interactable.html" title="interface in org.eclipse.mosaic.rti.api">Interactable</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/eclipse/mosaic/rti/MosaicRtiAmbassador.html" title="class in org.eclipse.mosaic.rti">MosaicRtiAmbassador</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">RtiAmbassador</span> |
| extends <a href="../../../../../org/eclipse/mosaic/rti/api/Interactable.html" title="interface in org.eclipse.mosaic.rti.api">Interactable</a></pre> |
| <div class="block">This interface is offered to each <code>FederateAmbassador</code> to allow |
| communication to the RTI. Therefore the RTI has to implement this interface.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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><a href="../../../../../org/eclipse/mosaic/lib/math/RandomNumberGenerator.html" title="interface in org.eclipse.mosaic.lib.math">RandomNumberGenerator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/api/RtiAmbassador.html#createRandomNumberGenerator--">createRandomNumberGenerator</a></span>()</code> |
| <div class="block">Returns a new <a href="../../../../../org/eclipse/mosaic/lib/math/RandomNumberGenerator.html" title="interface in org.eclipse.mosaic.lib.math"><code>RandomNumberGenerator</code></a> which is associated with the current federation.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/mosaic/rti/api/Monitor.html" title="interface in org.eclipse.mosaic.rti.api">Monitor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/api/RtiAmbassador.html#getMonitor--">getMonitor</a></span>()</code> |
| <div class="block">Provides the monitor instance to log specific events, such as begin of |
| the simulation or event triggers.</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/api/RtiAmbassador.html#getNextEventTimestamp--">getNextEventTimestamp</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>com.google.common.collect.ImmutableCollection<<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>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/api/RtiAmbassador.html#getSubscribedInteractions--">getSubscribedInteractions</a></span>()</code> |
| <div class="block">Provides the list of the subscribed interactions.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/api/RtiAmbassador.html#requestAdvanceTime-long-">requestAdvanceTime</a></span>(long time)</code> |
| <div class="block"> |
| This method should be called by a federate ambassador to request advancing |
| its simulation time.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/api/RtiAmbassador.html#requestAdvanceTime-long-long-byte-">requestAdvanceTime</a></span>(long time, |
| long lookahead, |
| byte priority)</code> |
| <div class="block">This method should be called by a federate ambassador to request advancing |
| its simulation time.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.mosaic.rti.api.Interactable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.mosaic.rti.api.<a href="../../../../../org/eclipse/mosaic/rti/api/Interactable.html" title="interface in org.eclipse.mosaic.rti.api">Interactable</a></h3> |
| <code><a href="../../../../../org/eclipse/mosaic/rti/api/Interactable.html#triggerInteraction-org.eclipse.mosaic.rti.api.Interaction-">triggerInteraction</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="requestAdvanceTime-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>requestAdvanceTime</h4> |
| <pre>void requestAdvanceTime(long time) |
| throws <a href="../../../../../org/eclipse/mosaic/rti/api/IllegalValueException.html" title="class in org.eclipse.mosaic.rti.api">IllegalValueException</a></pre> |
| <div class="block"><p> |
| This method should be called by a federate ambassador to request advancing |
| its simulation time. The RTI ambassador forwards this request to the time |
| management and an event representing the request is stored. When the |
| event is scheduled the federate ambassador is called by the RTI. |
| </p><p> |
| This method delivers exactly the same result as <code>requestAdvanceTime(time, 0, 0)</code> |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>time</code> - the simulation time in [ns]</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> - if an invalid time value has been passed</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="requestAdvanceTime-long-long-byte-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>requestAdvanceTime</h4> |
| <pre>void requestAdvanceTime(long time, |
| long lookahead, |
| byte 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">This method should be called by a federate ambassador to request advancing |
| its simulation time. The RTI ambassador forwards this request to the time |
| management and an event representing the request is stored. When the |
| event is scheduled the federate ambassador is called by the RTI.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>time</code> - the simulation time in [ns]</dd> |
| <dd><code>lookahead</code> - the time length in [ns] with which the federate guarantees to not request a time advance again</dd> |
| <dd><code>priority</code> - the priority of the 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> - if an invalid time value has been passed</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNextEventTimestamp--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNextEventTimestamp</h4> |
| <pre>long getNextEventTimestamp() |
| throws <a href="../../../../../org/eclipse/mosaic/rti/api/IllegalValueException.html" title="class in org.eclipse.mosaic.rti.api">IllegalValueException</a></pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSubscribedInteractions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSubscribedInteractions</h4> |
| <pre>com.google.common.collect.ImmutableCollection<<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>> getSubscribedInteractions()</pre> |
| <div class="block">Provides the list of the subscribed interactions.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>set of subscribed interactions</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createRandomNumberGenerator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createRandomNumberGenerator</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> |
| <a href="../../../../../org/eclipse/mosaic/lib/math/RandomNumberGenerator.html" title="interface in org.eclipse.mosaic.lib.math">RandomNumberGenerator</a> createRandomNumberGenerator()</pre> |
| <div class="block">Returns a new <a href="../../../../../org/eclipse/mosaic/lib/math/RandomNumberGenerator.html" title="interface in org.eclipse.mosaic.lib.math"><code>RandomNumberGenerator</code></a> which is associated with the current federation.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new <a href="../../../../../org/eclipse/mosaic/lib/math/RandomNumberGenerator.html" title="interface in org.eclipse.mosaic.lib.math"><code>RandomNumberGenerator</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMonitor--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getMonitor</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> |
| <a href="../../../../../org/eclipse/mosaic/rti/api/Monitor.html" title="interface in org.eclipse.mosaic.rti.api">Monitor</a> getMonitor()</pre> |
| <div class="block">Provides the monitor instance to log specific events, such as begin of |
| the simulation or event triggers.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the monitor instance to log specific events</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="class-use/RtiAmbassador.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><a href="../../../../../org/eclipse/mosaic/rti/api/MosaicVersion.html" title="class in org.eclipse.mosaic.rti.api"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/mosaic/rti/api/TimeManagement.html" title="interface in org.eclipse.mosaic.rti.api"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/mosaic/rti/api/RtiAmbassador.html" target="_top">Frames</a></li> |
| <li><a href="RtiAmbassador.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2020 <a href="https://www.fokus.fraunhofer.de/">Fraunhofer FOKUS</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
