| <!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:08 GMT 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ChainManager (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="ChainManager (Eclipse MOSAIC Parent 20.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,"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="class-use/ChainManager.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 Class</li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/eclipse/mosaic/fed/cell/chain/ChainManager.html" target="_top">Frames</a></li> |
| <li><a href="ChainManager.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.fed.cell.chain</div> |
| <h2 title="Class ChainManager" class="title">Class ChainManager</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>org.eclipse.mosaic.fed.cell.chain.ChainManager</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/lib/util/scheduling/EventManager.html" title="interface in org.eclipse.mosaic.lib.util.scheduling">EventManager</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ChainManager</span> |
| extends <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> |
| implements <a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventManager.html" title="interface in org.eclipse.mosaic.lib.util.scheduling">EventManager</a></pre> |
| <div class="block">The ChainManager receives communication dependent interactions from the CellAmbassador |
| and handles the complete interaction between the cell modules internally |
| and also interfaces towards MOSAIC to advance the simulation.</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"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/cell/chain/ChainManager.html#ChainManager-org.eclipse.mosaic.rti.api.RtiAmbassador-org.eclipse.mosaic.lib.math.RandomNumberGenerator-org.eclipse.mosaic.rti.api.parameters.AmbassadorParameter-">ChainManager</a></span>(<a href="../../../../../../org/eclipse/mosaic/rti/api/RtiAmbassador.html" title="interface in org.eclipse.mosaic.rti.api">RtiAmbassador</a> rti, |
| <a href="../../../../../../org/eclipse/mosaic/lib/math/RandomNumberGenerator.html" title="interface in org.eclipse.mosaic.lib.math">RandomNumberGenerator</a> rng, |
| <a href="../../../../../../org/eclipse/mosaic/rti/api/parameters/AmbassadorParameter.html" title="class in org.eclipse.mosaic.rti.api.parameters">AmbassadorParameter</a> ambassadorParameter)</code> |
| <div class="block">Initialize the ChainManager, which is the EventManager for the communication dependent events |
| and at the same time the only module in the cell to perform interactions towards MOSAIC.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/cell/chain/ChainManager.html#addEvent-org.eclipse.mosaic.lib.util.scheduling.Event-">addEvent</a></span>(<a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/Event.html" title="class in org.eclipse.mosaic.lib.util.scheduling">Event</a> event)</code> |
| <div class="block">Add an <a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/Event.html" title="class in org.eclipse.mosaic.lib.util.scheduling"><code>Event</code></a> to the scheduler.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/cell/chain/ChainManager.html#addStreamListener-org.eclipse.mosaic.fed.cell.viz.StreamListener-">addStreamListener</a></span>(<a href="../../../../../../org/eclipse/mosaic/fed/cell/viz/StreamListener.html" title="interface in org.eclipse.mosaic.fed.cell.viz">StreamListener</a> streamListener)</code> |
| <div class="block">Registers a new <a href="../../../../../../org/eclipse/mosaic/fed/cell/viz/StreamListener.html" title="interface in org.eclipse.mosaic.fed.cell.viz"><code>StreamListener</code></a> which is called when a message finished |
| all stream modules, i.e.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/cell/chain/ChainManager.html#advanceTime-long-">advanceTime</a></span>(long time)</code> |
| <div class="block">Do the actual logic of the Cell for communication dependent events here (i.e., schedule the events).</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/cell/chain/ChainManager.html#finishEvent-org.eclipse.mosaic.fed.cell.message.CellModuleMessage-">finishEvent</a></span>(<a href="../../../../../../org/eclipse/mosaic/fed/cell/message/CellModuleMessage.html" title="class in org.eclipse.mosaic.fed.cell.message">CellModuleMessage</a> cellModuleMessage)</code> |
| <div class="block">When the modules have processed the event, the ChainManager finishes this event |
| and sets a new event to actually simulate the transmission delay of the cell messages.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/mosaic/rti/api/parameters/AmbassadorParameter.html" title="class in org.eclipse.mosaic.rti.api.parameters">AmbassadorParameter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/cell/chain/ChainManager.html#getAmbassadorParameter--">getAmbassadorParameter</a></span>()</code> |
| <div class="block">Get the ambassador parameter (Ambassador-ID, Log-ID, Configuration file).</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <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/fed/cell/chain/ChainManager.html#getRandomNumberGenerator--">getRandomNumberGenerator</a></span>()</code> |
| <div class="block">Generate a random number.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/mosaic/rti/api/RtiAmbassador.html" title="interface in org.eclipse.mosaic.rti.api">RtiAmbassador</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/cell/chain/ChainManager.html#getRti--">getRti</a></span>()</code> </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/fed/cell/chain/ChainManager.html#notifyStreamListeners-org.eclipse.mosaic.fed.cell.viz.StreamListener.StreamParticipant-org.eclipse.mosaic.fed.cell.viz.StreamListener.StreamParticipant-org.eclipse.mosaic.fed.cell.viz.StreamListener.StreamProperties-">notifyStreamListeners</a></span>(<a href="../../../../../../org/eclipse/mosaic/fed/cell/viz/StreamListener.StreamParticipant.html" title="class in org.eclipse.mosaic.fed.cell.viz">StreamListener.StreamParticipant</a> sender, |
| <a href="../../../../../../org/eclipse/mosaic/fed/cell/viz/StreamListener.StreamParticipant.html" title="class in org.eclipse.mosaic.fed.cell.viz">StreamListener.StreamParticipant</a> receiver, |
| <a href="../../../../../../org/eclipse/mosaic/fed/cell/viz/StreamListener.StreamProperties.html" title="class in org.eclipse.mosaic.fed.cell.viz">StreamListener.StreamProperties</a> properties)</code> |
| <div class="block">Notify the <a href="../../../../../../org/eclipse/mosaic/fed/cell/viz/StreamListener.html" title="interface in org.eclipse.mosaic.fed.cell.viz"><code>StreamListener</code></a> with <a href="../../../../../../org/eclipse/mosaic/fed/cell/viz/StreamListener.StreamParticipant.html" title="class in org.eclipse.mosaic.fed.cell.viz"><code>StreamListener.StreamParticipant</code></a>'s (receiver and sender) |
| and the properties of the stream <a href="../../../../../../org/eclipse/mosaic/fed/cell/viz/StreamListener.StreamParticipant.html" title="class in org.eclipse.mosaic.fed.cell.viz"><code>StreamListener.StreamParticipant</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/cell/chain/ChainManager.html#printStatistics--">printStatistics</a></span>()</code> |
| <div class="block">Print statistics about processedMessages for each module.</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/fed/cell/chain/ChainManager.html#sendInteractionToRti-org.eclipse.mosaic.rti.api.Interaction-">sendInteractionToRti</a></span>(<a href="../../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api">Interaction</a> interaction)</code> |
| <div class="block">Send interaction back to MOSAIC.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/cell/chain/ChainManager.html#startEvent-org.eclipse.mosaic.interactions.communication.V2xMessageTransmission-">startEvent</a></span>(<a href="../../../../../../org/eclipse/mosaic/interactions/communication/V2xMessageTransmission.html" title="class in org.eclipse.mosaic.interactions.communication">V2xMessageTransmission</a> v2xMessageTransmission)</code> |
| <div class="block">On arrival of the <a href="../../../../../../org/eclipse/mosaic/interactions/communication/V2xMessageTransmission.html" title="class in org.eclipse.mosaic.interactions.communication"><code>V2xMessageTransmission</code></a>, set the event to introduce the message |
| to the first module of the module chain (which is usually the <a href="../../../../../../org/eclipse/mosaic/fed/cell/module/streammodules/UpstreamModule.html" title="class in org.eclipse.mosaic.fed.cell.module.streammodules"><code>UpstreamModule</code></a>).</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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.lib.util.scheduling.EventManager"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.mosaic.lib.util.scheduling.<a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventManager.html" title="interface in org.eclipse.mosaic.lib.util.scheduling">EventManager</a></h3> |
| <code><a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventManager.html#addEvent-long-org.eclipse.mosaic.lib.util.scheduling.EventProcessor...-">addEvent</a>, <a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventManager.html#newEvent-long-org.eclipse.mosaic.lib.util.scheduling.EventProcessor...-">newEvent</a></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="ChainManager-org.eclipse.mosaic.rti.api.RtiAmbassador-org.eclipse.mosaic.lib.math.RandomNumberGenerator-org.eclipse.mosaic.rti.api.parameters.AmbassadorParameter-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ChainManager</h4> |
| <pre>public ChainManager(<a href="../../../../../../org/eclipse/mosaic/rti/api/RtiAmbassador.html" title="interface in org.eclipse.mosaic.rti.api">RtiAmbassador</a> rti, |
| <a href="../../../../../../org/eclipse/mosaic/lib/math/RandomNumberGenerator.html" title="interface in org.eclipse.mosaic.lib.math">RandomNumberGenerator</a> rng, |
| <a href="../../../../../../org/eclipse/mosaic/rti/api/parameters/AmbassadorParameter.html" title="class in org.eclipse.mosaic.rti.api.parameters">AmbassadorParameter</a> ambassadorParameter)</pre> |
| <div class="block">Initialize the ChainManager, which is the EventManager for the communication dependent events |
| and at the same time the only module in the cell to perform interactions towards MOSAIC.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rti</code> - the reference towards MOSAIC (for requesting timeAdvances and sending interactions).</dd> |
| <dd><code>rng</code> - the RandomGeneratorObject object that is needed by the Geocaster</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="getRti--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRti</h4> |
| <pre>public <a href="../../../../../../org/eclipse/mosaic/rti/api/RtiAmbassador.html" title="interface in org.eclipse.mosaic.rti.api">RtiAmbassador</a> getRti()</pre> |
| </li> |
| </ul> |
| <a name="advanceTime-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>advanceTime</h4> |
| <pre>public void advanceTime(long time)</pre> |
| <div class="block">Do the actual logic of the Cell for communication dependent events here (i.e., schedule the events).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>time</code> - simulation time of the TA (time advance).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startEvent-org.eclipse.mosaic.interactions.communication.V2xMessageTransmission-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startEvent</h4> |
| <pre>public void startEvent(<a href="../../../../../../org/eclipse/mosaic/interactions/communication/V2xMessageTransmission.html" title="class in org.eclipse.mosaic.interactions.communication">V2xMessageTransmission</a> v2xMessageTransmission)</pre> |
| <div class="block">On arrival of the <a href="../../../../../../org/eclipse/mosaic/interactions/communication/V2xMessageTransmission.html" title="class in org.eclipse.mosaic.interactions.communication"><code>V2xMessageTransmission</code></a>, set the event to introduce the message |
| to the first module of the module chain (which is usually the <a href="../../../../../../org/eclipse/mosaic/fed/cell/module/streammodules/UpstreamModule.html" title="class in org.eclipse.mosaic.fed.cell.module.streammodules"><code>UpstreamModule</code></a>). |
| The UpstreamModule actually starts, when the TA for the <a href="../../../../../../org/eclipse/mosaic/interactions/communication/V2xMessageTransmission.html" title="class in org.eclipse.mosaic.interactions.communication"><code>V2xMessageTransmission</code></a> arrives.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>v2xMessageTransmission</code> - sendV2XMessage from MOSAIC (typically send by the applications).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="finishEvent-org.eclipse.mosaic.fed.cell.message.CellModuleMessage-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>finishEvent</h4> |
| <pre>public void finishEvent(<a href="../../../../../../org/eclipse/mosaic/fed/cell/message/CellModuleMessage.html" title="class in org.eclipse.mosaic.fed.cell.message">CellModuleMessage</a> cellModuleMessage)</pre> |
| <div class="block">When the modules have processed the event, the ChainManager finishes this event |
| and sets a new event to actually simulate the transmission delay of the cell messages. |
| This can result in several actions: |
| (feed back to calling module, chain through to next module, and send interactions to MOSAIC).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cellModuleMessage</code> - result from the modules with further information what to do.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addEvent-org.eclipse.mosaic.lib.util.scheduling.Event-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addEvent</h4> |
| <pre>public void addEvent(<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/util/scheduling/Event.html" title="class in org.eclipse.mosaic.lib.util.scheduling">Event</a> event)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventManager.html#addEvent-org.eclipse.mosaic.lib.util.scheduling.Event-">EventManager</a></code></span></div> |
| <div class="block">Add an <a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/Event.html" title="class in org.eclipse.mosaic.lib.util.scheduling"><code>Event</code></a> to the scheduler.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventManager.html#addEvent-org.eclipse.mosaic.lib.util.scheduling.Event-">addEvent</a></code> in interface <code><a href="../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventManager.html" title="interface in org.eclipse.mosaic.lib.util.scheduling">EventManager</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - the event to schedule.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sendInteractionToRti-org.eclipse.mosaic.rti.api.Interaction-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendInteractionToRti</h4> |
| <pre>public void sendInteractionToRti(<a href="../../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api">Interaction</a> interaction)</pre> |
| <div class="block">Send interaction back to MOSAIC.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>interaction</code> - can be either |
| a V2xMessageReception and dedicated for the receiver or |
| an V2xMessageAcknowledgement for the sender.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAmbassadorParameter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAmbassadorParameter</h4> |
| <pre>public <a href="../../../../../../org/eclipse/mosaic/rti/api/parameters/AmbassadorParameter.html" title="class in org.eclipse.mosaic.rti.api.parameters">AmbassadorParameter</a> getAmbassadorParameter()</pre> |
| <div class="block">Get the ambassador parameter (Ambassador-ID, Log-ID, Configuration file).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Ambassador parameter.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRandomNumberGenerator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRandomNumberGenerator</h4> |
| <pre>public <a href="../../../../../../org/eclipse/mosaic/lib/math/RandomNumberGenerator.html" title="interface in org.eclipse.mosaic.lib.math">RandomNumberGenerator</a> getRandomNumberGenerator()</pre> |
| <div class="block">Generate a random number.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Random number.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addStreamListener-org.eclipse.mosaic.fed.cell.viz.StreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addStreamListener</h4> |
| <pre>public void addStreamListener(<a href="../../../../../../org/eclipse/mosaic/fed/cell/viz/StreamListener.html" title="interface in org.eclipse.mosaic.fed.cell.viz">StreamListener</a> streamListener)</pre> |
| <div class="block">Registers a new <a href="../../../../../../org/eclipse/mosaic/fed/cell/viz/StreamListener.html" title="interface in org.eclipse.mosaic.fed.cell.viz"><code>StreamListener</code></a> which is called when a message finished |
| all stream modules, i.e. a message is sent to its target.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>streamListener</code> - the new stream listener</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="notifyStreamListeners-org.eclipse.mosaic.fed.cell.viz.StreamListener.StreamParticipant-org.eclipse.mosaic.fed.cell.viz.StreamListener.StreamParticipant-org.eclipse.mosaic.fed.cell.viz.StreamListener.StreamProperties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>notifyStreamListeners</h4> |
| <pre>public void notifyStreamListeners(<a href="../../../../../../org/eclipse/mosaic/fed/cell/viz/StreamListener.StreamParticipant.html" title="class in org.eclipse.mosaic.fed.cell.viz">StreamListener.StreamParticipant</a> sender, |
| <a href="../../../../../../org/eclipse/mosaic/fed/cell/viz/StreamListener.StreamParticipant.html" title="class in org.eclipse.mosaic.fed.cell.viz">StreamListener.StreamParticipant</a> receiver, |
| <a href="../../../../../../org/eclipse/mosaic/fed/cell/viz/StreamListener.StreamProperties.html" title="class in org.eclipse.mosaic.fed.cell.viz">StreamListener.StreamProperties</a> properties)</pre> |
| <div class="block">Notify the <a href="../../../../../../org/eclipse/mosaic/fed/cell/viz/StreamListener.html" title="interface in org.eclipse.mosaic.fed.cell.viz"><code>StreamListener</code></a> with <a href="../../../../../../org/eclipse/mosaic/fed/cell/viz/StreamListener.StreamParticipant.html" title="class in org.eclipse.mosaic.fed.cell.viz"><code>StreamListener.StreamParticipant</code></a>'s (receiver and sender) |
| and the properties of the stream <a href="../../../../../../org/eclipse/mosaic/fed/cell/viz/StreamListener.StreamParticipant.html" title="class in org.eclipse.mosaic.fed.cell.viz"><code>StreamListener.StreamParticipant</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sender</code> - Sender of the stream.</dd> |
| <dd><code>receiver</code> - Receiver of the Stream.</dd> |
| <dd><code>properties</code> - Stream properties.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="printStatistics--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>printStatistics</h4> |
| <pre>public void printStatistics()</pre> |
| <div class="block">Print statistics about processedMessages for each module.</div> |
| </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/ChainManager.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 Class</li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/eclipse/mosaic/fed/cell/chain/ChainManager.html" target="_top">Frames</a></li> |
| <li><a href="ChainManager.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> |