blob: 7c9f4d725337f26fa2571e364b059d7ec58f262b [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 Thu Oct 29 15:52:11 GMT 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Uses of Class org.eclipse.mosaic.fed.cell.config.model.CNetworkProperties (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="Uses of Class org.eclipse.mosaic.fed.cell.config.model.CNetworkProperties (Eclipse MOSAIC Parent 20.0 API)";
}
}
catch(err) {
}
//-->
</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><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">Class</a></li>
<li class="navBarCell1Rev">Use</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</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/eclipse/mosaic/fed/cell/config/model/class-use/CNetworkProperties.html" target="_top">Frames</a></li>
<li><a href="CNetworkProperties.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h2 title="Uses of Class org.eclipse.mosaic.fed.cell.config.model.CNetworkProperties" class="title">Uses of Class<br>org.eclipse.mosaic.fed.cell.config.model.CNetworkProperties</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
<caption><span>Packages that use <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="#org.eclipse.mosaic.fed.cell.config">org.eclipse.mosaic.fed.cell.config</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="#org.eclipse.mosaic.fed.cell.config.model">org.eclipse.mosaic.fed.cell.config.model</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="#org.eclipse.mosaic.fed.cell.data">org.eclipse.mosaic.fed.cell.data</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="#org.eclipse.mosaic.fed.cell.message">org.eclipse.mosaic.fed.cell.message</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="#org.eclipse.mosaic.fed.cell.utility">org.eclipse.mosaic.fed.cell.utility</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList"><a name="org.eclipse.mosaic.fed.cell.config">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a> in <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/package-summary.html">org.eclipse.mosaic.fed.cell.config</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing fields, and an explanation">
<caption><span>Fields in <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/package-summary.html">org.eclipse.mosaic.fed.cell.config</a> declared as <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a></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>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a></code></td>
<td class="colLast"><span class="typeNameLabel">CNetwork.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/CNetwork.html#globalNetwork">globalNetwork</a></span></code>
<div class="block">global network definition.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing fields, and an explanation">
<caption><span>Fields in <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/package-summary.html">org.eclipse.mosaic.fed.cell.config</a> with type parameters of type <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a></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>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a>&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">CNetwork.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/CNetwork.html#servers">servers</a></span></code>
<div class="block">List of configured servers.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.eclipse.mosaic.fed.cell.config.model">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a> in <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/package-summary.html">org.eclipse.mosaic.fed.cell.config.model</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation">
<caption><span>Subclasses of <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a> in <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/package-summary.html">org.eclipse.mosaic.fed.cell.config.model</a></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>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CMobileNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CMobileNetworkProperties</a></span></code>
<div class="block"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CMobileNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model"><code>CMobileNetworkProperties</code></a> extends the <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model"><code>CNetworkProperties</code></a> with specific geographical extensions (area).</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.eclipse.mosaic.fed.cell.data">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a> in <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/data/package-summary.html">org.eclipse.mosaic.fed.cell.data</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/data/package-summary.html">org.eclipse.mosaic.fed.cell.data</a> that return <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a></code></td>
<td class="colLast"><span class="typeNameLabel">SimulationData.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/data/SimulationData.html#getRegionOfNode-java.lang.String-">getRegionOfNode</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;nodeId)</code>
<div class="block">Returns the base region of a node from the region table.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a></code></td>
<td class="colLast"><span class="typeNameLabel">ConfigurationData.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/data/ConfigurationData.html#getServerRegion-java.lang.String-">getServerRegion</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;serverGroupName)</code>
<div class="block">Checks if server has been configured in network.json and
return it.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/data/package-summary.html">org.eclipse.mosaic.fed.cell.data</a> with parameters of type <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><span class="typeNameLabel">SimulationData.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/data/SimulationData.html#setRegionOfNode-java.lang.String-org.eclipse.mosaic.fed.cell.config.model.CNetworkProperties-">setRegionOfNode</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;nodeId,
<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a>&nbsp;region)</code>
<div class="block">Set or update the region for a node.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.eclipse.mosaic.fed.cell.message">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a> in <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/message/package-summary.html">org.eclipse.mosaic.fed.cell.message</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/message/package-summary.html">org.eclipse.mosaic.fed.cell.message</a> that return types with arguments of type <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>com.google.common.collect.Multimap&lt;<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a>,<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>&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">GeocasterResult.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/message/GeocasterResult.html#getReceivers--">getReceivers</a></span>()</code>
<div class="block">Returns all the receivers in a base region.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation">
<caption><span>Constructor parameters in <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/message/package-summary.html">org.eclipse.mosaic.fed.cell.message</a> with type arguments of type <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/message/GeocasterResult.html#GeocasterResult-com.google.common.collect.Multimap-org.eclipse.mosaic.fed.cell.config.model.TransmissionMode-org.eclipse.mosaic.lib.objects.v2x.V2xMessage-boolean-">GeocasterResult</a></span>(com.google.common.collect.Multimap&lt;<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a>,<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>&gt;&nbsp;receivers,
<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/TransmissionMode.html" title="enum in org.eclipse.mosaic.fed.cell.config.model">TransmissionMode</a>&nbsp;downstreamMode,
<a href="../../../../../../../../org/eclipse/mosaic/lib/objects/v2x/V2xMessage.html" title="class in org.eclipse.mosaic.lib.objects.v2x">V2xMessage</a>&nbsp;v2xMessage,
boolean&nbsp;isFullMessage)</code>
<div class="block">Creates a new <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/message/GeocasterResult.html" title="class in org.eclipse.mosaic.fed.cell.message"><code>GeocasterResult</code></a> object.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.eclipse.mosaic.fed.cell.utility">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a> in <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/package-summary.html">org.eclipse.mosaic.fed.cell.utility</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/package-summary.html">org.eclipse.mosaic.fed.cell.utility</a> that return <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a></code></td>
<td class="colLast"><span class="typeNameLabel">RegionsIndex.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/RegionsIndex.html#getRegion-org.eclipse.mosaic.lib.geo.CartesianPoint-">getRegion</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/lib/geo/CartesianPoint.html" title="interface in org.eclipse.mosaic.lib.geo">CartesianPoint</a>&nbsp;cartesianPoint)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a></code></td>
<td class="colLast"><span class="typeNameLabel">RegionUtility.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/RegionUtility.html#getRegionByName-java.lang.String-">getRegionByName</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;regionName)</code>
<div class="block">Get a whole region handle for a region name string.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a></code></td>
<td class="colLast"><span class="typeNameLabel">RegionUtility.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/RegionUtility.html#getRegionForNode-java.lang.String-">getRegionForNode</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;node)</code>
<div class="block">Convenience function for getting the region of a specified node.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a></code></td>
<td class="colLast"><span class="typeNameLabel">RegionUtility.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/RegionUtility.html#getRegionForPosition-org.eclipse.mosaic.lib.geo.CartesianPoint-">getRegionForPosition</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/lib/geo/CartesianPoint.html" title="interface in org.eclipse.mosaic.lib.geo">CartesianPoint</a>&nbsp;position)</code>
<div class="block">Get the base region for a given cartesian position.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/package-summary.html">org.eclipse.mosaic.fed.cell.utility</a> that return types with arguments of type <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a>&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">RegionUtility.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/RegionUtility.html#getAllRegions-boolean-boolean-">getAllRegions</a></span>(boolean&nbsp;includeGlobal,
boolean&nbsp;includeServers)</code>
<div class="block">Get the list of all configured regions, optionally including the "globalNetwork".</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a>&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">RegionUtility.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/RegionUtility.html#getRegionsForDestinationArea-org.eclipse.mosaic.lib.geo.GeoArea-">getRegionsForDestinationArea</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/lib/geo/GeoArea.html" title="interface in org.eclipse.mosaic.lib.geo">GeoArea</a>&nbsp;geoArea)</code>
<div class="block">Get all regions for a destination area (of a geocast message).</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/package-summary.html">org.eclipse.mosaic.fed.cell.utility</a> with parameters of type <a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><span class="typeNameLabel">CapacityUtility.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/CapacityUtility.html#availableCapacity-org.eclipse.mosaic.fed.cell.config.model.TransmissionMode-org.eclipse.mosaic.fed.cell.config.model.CNetworkProperties-org.eclipse.mosaic.lib.objects.communication.CellConfiguration-">availableCapacity</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/TransmissionMode.html" title="enum in org.eclipse.mosaic.fed.cell.config.model">TransmissionMode</a>&nbsp;mode,
<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a>&nbsp;region,
<a href="../../../../../../../../org/eclipse/mosaic/lib/objects/communication/CellConfiguration.html" title="class in org.eclipse.mosaic.lib.objects.communication">CellConfiguration</a>&nbsp;nodeCellConfiguration)</code>
<div class="block">The method returns the available bandwidth for a node in a region.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><span class="typeNameLabel">DelayUtility.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/DelayUtility.html#calculateDelay-org.eclipse.mosaic.fed.cell.config.model.CNetworkProperties-org.eclipse.mosaic.fed.cell.config.model.TransmissionMode-java.lang.String-org.eclipse.mosaic.lib.math.RandomNumberGenerator-">calculateDelay</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a>&nbsp;region,
<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/TransmissionMode.html" title="enum in org.eclipse.mosaic.fed.cell.config.model">TransmissionMode</a>&nbsp;mode,
<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;nodeId,
<a href="../../../../../../../../org/eclipse/mosaic/lib/math/RandomNumberGenerator.html" title="interface in org.eclipse.mosaic.lib.math">RandomNumberGenerator</a>&nbsp;rng)</code>
<div class="block">Calculates the core delay for the given region.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><span class="typeNameLabel">CapacityUtility.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/CapacityUtility.html#consumeCapacity-org.eclipse.mosaic.fed.cell.config.model.TransmissionMode-org.eclipse.mosaic.fed.cell.config.model.CNetworkProperties-org.eclipse.mosaic.lib.objects.communication.CellConfiguration-long-">consumeCapacity</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/TransmissionMode.html" title="enum in org.eclipse.mosaic.fed.cell.config.model">TransmissionMode</a>&nbsp;mode,
<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a>&nbsp;region,
<a href="../../../../../../../../org/eclipse/mosaic/lib/objects/communication/CellConfiguration.html" title="class in org.eclipse.mosaic.lib.objects.communication">CellConfiguration</a>&nbsp;nodeCellConfiguration,
long&nbsp;consume)</code>
<div class="block">Consumes some of the available bandwidth based on the given message.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><span class="typeNameLabel">RegionCapacityUtility.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/RegionCapacityUtility.html#consumeCapacityDown-org.eclipse.mosaic.fed.cell.config.model.CNetworkProperties-long-">consumeCapacityDown</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a>&nbsp;region,
long&nbsp;bandwidthToConsumeInBps)</code>
<div class="block">Consumes the capacity in a region in the downlink direction.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><span class="typeNameLabel">RegionCapacityUtility.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/RegionCapacityUtility.html#consumeCapacityUp-org.eclipse.mosaic.fed.cell.config.model.CNetworkProperties-long-">consumeCapacityUp</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a>&nbsp;region,
long&nbsp;bandwidthToConsumeInBps)</code>
<div class="block">Consumes the capacity in a region in the uplink direction.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../../../org/eclipse/mosaic/lib/model/transmission/TransmissionResult.html" title="class in org.eclipse.mosaic.lib.model.transmission">TransmissionResult</a></code></td>
<td class="colLast"><span class="typeNameLabel">RetransmissionLossUtility.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/RetransmissionLossUtility.html#determineTransmissionAttempts-org.eclipse.mosaic.lib.math.RandomNumberGenerator-org.eclipse.mosaic.fed.cell.config.model.CNetworkProperties-org.eclipse.mosaic.fed.cell.config.model.TransmissionMode-">determineTransmissionAttempts</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/lib/math/RandomNumberGenerator.html" title="interface in org.eclipse.mosaic.lib.math">RandomNumberGenerator</a>&nbsp;rng,
<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a>&nbsp;region,
<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/TransmissionMode.html" title="enum in org.eclipse.mosaic.fed.cell.config.model">TransmissionMode</a>&nbsp;mode)</code>
<div class="block">Determine the number and success of the transmission attempts
for the given message in the according region
with the help of the DirectTransmission.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><span class="typeNameLabel">RegionCapacityUtility.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/RegionCapacityUtility.html#freeCapacityDown-org.eclipse.mosaic.fed.cell.config.model.CNetworkProperties-long-">freeCapacityDown</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a>&nbsp;region,
long&nbsp;bandwidthToFreeInBps)</code>
<div class="block">Frees bandwidth for the given region.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><span class="typeNameLabel">CapacityUtility.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/CapacityUtility.html#freeCapacityUp-org.eclipse.mosaic.fed.cell.config.model.CNetworkProperties-org.eclipse.mosaic.lib.objects.communication.CellConfiguration-long-">freeCapacityUp</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a>&nbsp;region,
<a href="../../../../../../../../org/eclipse/mosaic/lib/objects/communication/CellConfiguration.html" title="class in org.eclipse.mosaic.lib.objects.communication">CellConfiguration</a>&nbsp;nodeCellConfiguration,
long&nbsp;freed)</code>
<div class="block">Frees the capacity in the region and for the node.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><span class="typeNameLabel">RegionCapacityUtility.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/RegionCapacityUtility.html#freeCapacityUp-org.eclipse.mosaic.fed.cell.config.model.CNetworkProperties-long-">freeCapacityUp</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a>&nbsp;region,
long&nbsp;bandwidthToFreeInBps)</code>
<div class="block">Frees bandwidth for the given region in case the message was successfully delivered.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">RegionUtility.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/RegionUtility.html#getNodesForRegion-org.eclipse.mosaic.fed.cell.config.model.CNetworkProperties-">getNodesForRegion</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a>&nbsp;region)</code>
<div class="block">Gets all nodes in the given region.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><span class="typeNameLabel">RegionCapacityUtility.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/RegionCapacityUtility.html#isAvailable-org.eclipse.mosaic.fed.cell.config.model.TransmissionMode-org.eclipse.mosaic.fed.cell.config.model.CNetworkProperties-">isAvailable</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/TransmissionMode.html" title="enum in org.eclipse.mosaic.fed.cell.config.model">TransmissionMode</a>&nbsp;mode,
<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a>&nbsp;region)</code>
<div class="block">This methods checks whether the region has enough capacity left to allow a new transmission in that region.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><span class="typeNameLabel">CapacityUtility.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/CapacityUtility.html#isAvailable-org.eclipse.mosaic.fed.cell.config.model.TransmissionMode-org.eclipse.mosaic.fed.cell.config.model.CNetworkProperties-org.eclipse.mosaic.lib.objects.communication.CellConfiguration-">isAvailable</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/TransmissionMode.html" title="enum in org.eclipse.mosaic.fed.cell.config.model">TransmissionMode</a>&nbsp;mode,
<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a>&nbsp;region,
<a href="../../../../../../../../org/eclipse/mosaic/lib/objects/communication/CellConfiguration.html" title="class in org.eclipse.mosaic.lib.objects.communication">CellConfiguration</a>&nbsp;nodeCellConfiguration)</code>
<div class="block">Checks whether a new transmission is possible or whether the minimal bandwidths are undershot.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><span class="typeNameLabel">CapacityUtility.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/CapacityUtility.html#isCapacitySufficient-org.eclipse.mosaic.fed.cell.config.model.TransmissionMode-org.eclipse.mosaic.fed.cell.config.model.CNetworkProperties-org.eclipse.mosaic.lib.objects.communication.CellConfiguration-long-">isCapacitySufficient</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/TransmissionMode.html" title="enum in org.eclipse.mosaic.fed.cell.config.model">TransmissionMode</a>&nbsp;mode,
<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a>&nbsp;region,
<a href="../../../../../../../../org/eclipse/mosaic/lib/objects/communication/CellConfiguration.html" title="class in org.eclipse.mosaic.lib.objects.communication">CellConfiguration</a>&nbsp;nodeCellConfiguration,
long&nbsp;neededBandwidth)</code>
<div class="block">Checks if the bandwidth of the given region and of the given node
is sufficient to perform the transmission.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><span class="typeNameLabel">RegionCapacityUtility.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/RegionCapacityUtility.html#isCapacitySufficient-org.eclipse.mosaic.fed.cell.config.model.TransmissionMode-org.eclipse.mosaic.fed.cell.config.model.CNetworkProperties-long-">isCapacitySufficient</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/TransmissionMode.html" title="enum in org.eclipse.mosaic.fed.cell.config.model">TransmissionMode</a>&nbsp;mode,
<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a>&nbsp;region,
long&nbsp;neededBandwidthInBps)</code>
<div class="block">Checks if the message is deliverable for the given region depending on needed bandwidth, the available
capacity and the transmission mode.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><span class="typeNameLabel">RegionCapacityUtility.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/RegionCapacityUtility.html#isCapacitySufficientDown-org.eclipse.mosaic.fed.cell.config.model.CNetworkProperties-long-">isCapacitySufficientDown</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a>&nbsp;region,
long&nbsp;neededBandwidthInBps)</code>
<div class="block">Checks if the message is deliverable for the given region in dependency of the needed bandwidth and the available
capacity in the downlink direction.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><span class="typeNameLabel">RegionCapacityUtility.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/utility/RegionCapacityUtility.html#isCapacitySufficientUp-org.eclipse.mosaic.fed.cell.config.model.CNetworkProperties-long-">isCapacitySufficientUp</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">CNetworkProperties</a>&nbsp;region,
long&nbsp;neededBandwidthInBps)</code>
<div class="block">Checks if the message is deliverable for the given region in dependency of the needed bandwidth and the available
capacity in the uplink direction.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</li>
</ul>
</div>
<!-- ======= 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><a href="../../../../../../../../org/eclipse/mosaic/fed/cell/config/model/CNetworkProperties.html" title="class in org.eclipse.mosaic.fed.cell.config.model">Class</a></li>
<li class="navBarCell1Rev">Use</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</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/eclipse/mosaic/fed/cell/config/model/class-use/CNetworkProperties.html" target="_top">Frames</a></li>
<li><a href="CNetworkProperties.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2020 <a href="https://www.fokus.fraunhofer.de/">Fraunhofer FOKUS</a>. All rights reserved.</small></p>
</body>
</html>