| <!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>Ns3Ambassador (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="Ns3Ambassador (Eclipse MOSAIC Parent 20.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":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/Ns3Ambassador.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/ns3/ambassador/Ns3Ambassador.html" target="_top">Frames</a></li> |
| <li><a href="Ns3Ambassador.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><a href="#nested.classes.inherited.from.class.org.eclipse.mosaic.rti.api.AbstractFederateAmbassador">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.eclipse.mosaic.lib.coupling.AbstractNetworkAmbassador">Field</a> | </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.ns3.ambassador</div> |
| <h2 title="Class Ns3Ambassador" class="title">Class Ns3Ambassador</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="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html" title="class in org.eclipse.mosaic.rti.api">org.eclipse.mosaic.rti.api.AbstractFederateAmbassador</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/eclipse/mosaic/lib/coupling/AbstractNetworkAmbassador.html" title="class in org.eclipse.mosaic.lib.coupling">org.eclipse.mosaic.lib.coupling.AbstractNetworkAmbassador</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.mosaic.fed.ns3.ambassador.Ns3Ambassador</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../../../org/eclipse/mosaic/rti/api/FederateAmbassador.html" title="interface in org.eclipse.mosaic.rti.api">FederateAmbassador</a>>, <a href="../../../../../../org/eclipse/mosaic/rti/api/FederateAmbassador.html" title="interface in org.eclipse.mosaic.rti.api">FederateAmbassador</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">Ns3Ambassador</span> |
| extends <a href="../../../../../../org/eclipse/mosaic/lib/coupling/AbstractNetworkAmbassador.html" title="class in org.eclipse.mosaic.lib.coupling">AbstractNetworkAmbassador</a></pre> |
| <div class="block">Implementation of the ambassador for the ns-3 network simulator.</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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.eclipse.mosaic.rti.api.AbstractFederateAmbassador"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.eclipse.mosaic.rti.api.<a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html" title="class in org.eclipse.mosaic.rti.api">AbstractFederateAmbassador</a></h3> |
| <code><a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.InteractionQueue.html" title="class in org.eclipse.mosaic.rti.api">AbstractFederateAmbassador.InteractionQueue</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.eclipse.mosaic.lib.coupling.AbstractNetworkAmbassador"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.mosaic.lib.coupling.<a href="../../../../../../org/eclipse/mosaic/lib/coupling/AbstractNetworkAmbassador.html" title="class in org.eclipse.mosaic.lib.coupling">AbstractNetworkAmbassador</a></h3> |
| <code><a href="../../../../../../org/eclipse/mosaic/lib/coupling/AbstractNetworkAmbassador.html#config">config</a>, <a href="../../../../../../org/eclipse/mosaic/lib/coupling/AbstractNetworkAmbassador.html#dockerFederateExecutor">dockerFederateExecutor</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.eclipse.mosaic.rti.api.AbstractFederateAmbassador"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.mosaic.rti.api.<a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html" title="class in org.eclipse.mosaic.rti.api">AbstractFederateAmbassador</a></h3> |
| <code><a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html#ambassadorParameter">ambassadorParameter</a>, <a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html#descriptor">descriptor</a>, <a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html#endTime">endTime</a>, <a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html#interactionQueue">interactionQueue</a>, <a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html#log">log</a>, <a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html#lookahead">lookahead</a>, <a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html#rti">rti</a></code></li> |
| </ul> |
| </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"> </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/ns3/ambassador/Ns3Ambassador.html#Ns3Ambassador-org.eclipse.mosaic.rti.api.parameters.AmbassadorParameter-">Ns3Ambassador</a></span>(<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">Creates a new <a href="../../../../../../org/eclipse/mosaic/fed/ns3/ambassador/Ns3Ambassador.html" title="class in org.eclipse.mosaic.fed.ns3.ambassador"><code>Ns3Ambassador</code></a> object.</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><a href="../../../../../../org/eclipse/mosaic/rti/api/federatestarter/DockerFederateExecutor.html" title="class in org.eclipse.mosaic.rti.api.federatestarter">DockerFederateExecutor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/ns3/ambassador/Ns3Ambassador.html#createDockerFederateExecutor-java.lang.String-org.eclipse.mosaic.rti.config.CLocalHost.OperatingSystem-">createDockerFederateExecutor</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> imageName, |
| <a href="../../../../../../org/eclipse/mosaic/rti/config/CLocalHost.OperatingSystem.html" title="enum in org.eclipse.mosaic.rti.config">CLocalHost.OperatingSystem</a> os)</code> |
| <div class="block">Creates a Docker federate executor.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/mosaic/rti/api/FederateExecutor.html" title="interface in org.eclipse.mosaic.rti.api">FederateExecutor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/ns3/ambassador/Ns3Ambassador.html#createFederateExecutor-java.lang.String-int-org.eclipse.mosaic.rti.config.CLocalHost.OperatingSystem-">createFederateExecutor</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> host, |
| int port, |
| <a href="../../../../../../org/eclipse/mosaic/rti/config/CLocalHost.OperatingSystem.html" title="enum in org.eclipse.mosaic.rti.config">CLocalHost.OperatingSystem</a> os)</code> |
| <div class="block">If a federate should be started by MOSAIC, an implementation of <a href="../../../../../../org/eclipse/mosaic/rti/api/FederateExecutor.html" title="interface in org.eclipse.mosaic.rti.api"><code>FederateExecutor</code></a> must be |
| provided.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/ns3/ambassador/Ns3Ambassador.html#receiveTypedInteraction-org.eclipse.mosaic.interactions.communication.AdHocCommunicationConfiguration-">receiveTypedInteraction</a></span>(<a href="../../../../../../org/eclipse/mosaic/interactions/communication/AdHocCommunicationConfiguration.html" title="class in org.eclipse.mosaic.interactions.communication">AdHocCommunicationConfiguration</a> interaction)</code> |
| <div class="block">Receive an <a href="../../../../../../org/eclipse/mosaic/interactions/communication/AdHocCommunicationConfiguration.html" title="class in org.eclipse.mosaic.interactions.communication"><code>AdHocCommunicationConfiguration</code></a> and send it to the federate if the corresponding node is simulated.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.mosaic.lib.coupling.AbstractNetworkAmbassador"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.mosaic.lib.coupling.<a href="../../../../../../org/eclipse/mosaic/lib/coupling/AbstractNetworkAmbassador.html" title="class in org.eclipse.mosaic.lib.coupling">AbstractNetworkAmbassador</a></h3> |
| <code><a href="../../../../../../org/eclipse/mosaic/lib/coupling/AbstractNetworkAmbassador.html#connectToFederate-java.lang.String-java.io.InputStream-java.io.InputStream-">connectToFederate</a>, <a href="../../../../../../org/eclipse/mosaic/lib/coupling/AbstractNetworkAmbassador.html#connectToFederate-java.lang.String-int-">connectToFederate</a>, <a href="../../../../../../org/eclipse/mosaic/lib/coupling/AbstractNetworkAmbassador.html#finishSimulation--">finishSimulation</a>, <a href="../../../../../../org/eclipse/mosaic/lib/coupling/AbstractNetworkAmbassador.html#initialize-long-long-">initialize</a>, <a href="../../../../../../org/eclipse/mosaic/lib/coupling/AbstractNetworkAmbassador.html#isTimeConstrained--">isTimeConstrained</a>, <a href="../../../../../../org/eclipse/mosaic/lib/coupling/AbstractNetworkAmbassador.html#isTimeRegulating--">isTimeRegulating</a>, <a href="../../../../../../org/eclipse/mosaic/lib/coupling/AbstractNetworkAmbassador.html#processInteraction-org.eclipse.mosaic.rti.api.Interaction-">processInteraction</a>, <a href="../../../../../../org/eclipse/mosaic/lib/coupling/AbstractNetworkAmbassador.html#processTimeAdvanceGrant-long-">processTimeAdvanceGrant</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.mosaic.rti.api.AbstractFederateAmbassador"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.mosaic.rti.api.<a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html" title="class in org.eclipse.mosaic.rti.api">AbstractFederateAmbassador</a></h3> |
| <code><a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html#advanceTime-long-">advanceTime</a>, <a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html#compareTo-org.eclipse.mosaic.rti.api.FederateAmbassador-">compareTo</a>, <a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html#getEndTime--">getEndTime</a>, <a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html#getId--">getId</a>, <a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html#getPriority--">getPriority</a>, <a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html#receiveInteraction-org.eclipse.mosaic.rti.api.Interaction-">receiveInteraction</a>, <a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html#setFederateDescriptor-org.eclipse.mosaic.rti.api.parameters.FederateDescriptor-">setFederateDescriptor</a>, <a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html#setRtiAmbassador-org.eclipse.mosaic.rti.api.RtiAmbassador-">setRtiAmbassador</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 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> |
| </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="Ns3Ambassador-org.eclipse.mosaic.rti.api.parameters.AmbassadorParameter-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Ns3Ambassador</h4> |
| <pre>public Ns3Ambassador(<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">Creates a new <a href="../../../../../../org/eclipse/mosaic/fed/ns3/ambassador/Ns3Ambassador.html" title="class in org.eclipse.mosaic.fed.ns3.ambassador"><code>Ns3Ambassador</code></a> object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ambassadorParameter</code> - Parameter to specify the ambassador.</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="createFederateExecutor-java.lang.String-int-org.eclipse.mosaic.rti.config.CLocalHost.OperatingSystem-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createFederateExecutor</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 <a href="../../../../../../org/eclipse/mosaic/rti/api/FederateExecutor.html" title="interface in org.eclipse.mosaic.rti.api">FederateExecutor</a> createFederateExecutor(<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> host, |
| int port, |
| <a href="../../../../../../org/eclipse/mosaic/rti/config/CLocalHost.OperatingSystem.html" title="enum in org.eclipse.mosaic.rti.config">CLocalHost.OperatingSystem</a> os)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html#createFederateExecutor-java.lang.String-int-org.eclipse.mosaic.rti.config.CLocalHost.OperatingSystem-">AbstractFederateAmbassador</a></code></span></div> |
| <div class="block">If a federate should be started by MOSAIC, an implementation of <a href="../../../../../../org/eclipse/mosaic/rti/api/FederateExecutor.html" title="interface in org.eclipse.mosaic.rti.api"><code>FederateExecutor</code></a> must be |
| provided. This method must return a nonnull object. The default implementation returns a <a href="../../../../../../org/eclipse/mosaic/rti/api/federatestarter/NopFederateExecutor.html" title="class in org.eclipse.mosaic.rti.api.federatestarter"><code>NopFederateExecutor</code></a>, |
| which does nothing when called.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/eclipse/mosaic/rti/api/FederateAmbassador.html#createFederateExecutor-java.lang.String-int-org.eclipse.mosaic.rti.config.CLocalHost.OperatingSystem-">createFederateExecutor</a></code> in interface <code><a href="../../../../../../org/eclipse/mosaic/rti/api/FederateAmbassador.html" title="interface in org.eclipse.mosaic.rti.api">FederateAmbassador</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html#createFederateExecutor-java.lang.String-int-org.eclipse.mosaic.rti.config.CLocalHost.OperatingSystem-">createFederateExecutor</a></code> in class <code><a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html" title="class in org.eclipse.mosaic.rti.api">AbstractFederateAmbassador</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>host</code> - name of the host (as specified in /etc/hosts.xml)</dd> |
| <dd><code>port</code> - port number to be used by this federate</dd> |
| <dd><code>os</code> - operating system enum</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../../../../../../org/eclipse/mosaic/rti/api/FederateExecutor.html" title="interface in org.eclipse.mosaic.rti.api"><code>FederateExecutor</code></a> which starts the federate</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createDockerFederateExecutor-java.lang.String-org.eclipse.mosaic.rti.config.CLocalHost.OperatingSystem-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createDockerFederateExecutor</h4> |
| <pre>public <a href="../../../../../../org/eclipse/mosaic/rti/api/federatestarter/DockerFederateExecutor.html" title="class in org.eclipse.mosaic.rti.api.federatestarter">DockerFederateExecutor</a> createDockerFederateExecutor(<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> imageName, |
| <a href="../../../../../../org/eclipse/mosaic/rti/config/CLocalHost.OperatingSystem.html" title="enum in org.eclipse.mosaic.rti.config">CLocalHost.OperatingSystem</a> os)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html#createDockerFederateExecutor-java.lang.String-org.eclipse.mosaic.rti.config.CLocalHost.OperatingSystem-">AbstractFederateAmbassador</a></code></span></div> |
| <div class="block">Creates a Docker federate executor.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/eclipse/mosaic/rti/api/FederateAmbassador.html#createDockerFederateExecutor-java.lang.String-org.eclipse.mosaic.rti.config.CLocalHost.OperatingSystem-">createDockerFederateExecutor</a></code> in interface <code><a href="../../../../../../org/eclipse/mosaic/rti/api/FederateAmbassador.html" title="interface in org.eclipse.mosaic.rti.api">FederateAmbassador</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html#createDockerFederateExecutor-java.lang.String-org.eclipse.mosaic.rti.config.CLocalHost.OperatingSystem-">createDockerFederateExecutor</a></code> in class <code><a href="../../../../../../org/eclipse/mosaic/rti/api/AbstractFederateAmbassador.html" title="class in org.eclipse.mosaic.rti.api">AbstractFederateAmbassador</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>imageName</code> - name of the docker image containing the federate</dd> |
| <dd><code>os</code> - operating system enum from <a href="../../../../../../org/eclipse/mosaic/rti/config/CLocalHost.html" title="class in org.eclipse.mosaic.rti.config"><code>CLocalHost</code></a></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../../../../../../org/eclipse/mosaic/rti/api/FederateExecutor.html" title="interface in org.eclipse.mosaic.rti.api"><code>FederateExecutor</code></a> which starts the federate in a docker container</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="receiveTypedInteraction-org.eclipse.mosaic.interactions.communication.AdHocCommunicationConfiguration-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>receiveTypedInteraction</h4> |
| <pre>protected void receiveTypedInteraction(<a href="../../../../../../org/eclipse/mosaic/interactions/communication/AdHocCommunicationConfiguration.html" title="class in org.eclipse.mosaic.interactions.communication">AdHocCommunicationConfiguration</a> interaction) |
| 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 class: <code><a href="../../../../../../org/eclipse/mosaic/lib/coupling/AbstractNetworkAmbassador.html#receiveTypedInteraction-org.eclipse.mosaic.interactions.communication.AdHocCommunicationConfiguration-">AbstractNetworkAmbassador</a></code></span></div> |
| <div class="block">Receive an <a href="../../../../../../org/eclipse/mosaic/interactions/communication/AdHocCommunicationConfiguration.html" title="class in org.eclipse.mosaic.interactions.communication"><code>AdHocCommunicationConfiguration</code></a> and send it to the federate if the corresponding node is simulated. |
| If the node is not simulated (only added but did not move yet) the configuration interaction will be saved for later.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../org/eclipse/mosaic/lib/coupling/AbstractNetworkAmbassador.html#receiveTypedInteraction-org.eclipse.mosaic.interactions.communication.AdHocCommunicationConfiguration-">receiveTypedInteraction</a></code> in class <code><a href="../../../../../../org/eclipse/mosaic/lib/coupling/AbstractNetworkAmbassador.html" title="class in org.eclipse.mosaic.lib.coupling">AbstractNetworkAmbassador</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>interaction</code> - the AdHoc configuration interaction</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></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/Ns3Ambassador.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/ns3/ambassador/Ns3Ambassador.html" target="_top">Frames</a></li> |
| <li><a href="Ns3Ambassador.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><a href="#nested.classes.inherited.from.class.org.eclipse.mosaic.rti.api.AbstractFederateAmbassador">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.eclipse.mosaic.lib.coupling.AbstractNetworkAmbassador">Field</a> | </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> |