Files
oopt-gnpy-web-gui/docs/module-fiber.html

1458 lines
16 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Module: fiber</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Module: fiber</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="description"><p>fiber.js
The fiber library describes how to add a fiber connection between any 2 nodes by dragging from source node to destination and defines the fiber manipulation.</p></div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="networkgraph_fiber.js.html">networkgraph/fiber.js</a>, <a href="networkgraph_fiber.js.html#line1">line 1</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="~addFiber"><span class="type-signature">(inner) </span>addFiber<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Check connections rule for dual fiber not single fiber before add it.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="networkgraph_fiber.js.html">networkgraph/fiber.js</a>, <a href="networkgraph_fiber.js.html#line43">line 43</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~addFiberComponent"><span class="type-signature">(inner) </span>addFiberComponent<span class="signature">(cmode, cfrom, cto, clabel, ctext, isImport)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Fiber creation.
Fiber style and configuration data loaded from configurationdata, styledata json.
Check connections rules.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>cmode</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Fiber mode 1 for add.</p></td>
</tr>
<tr>
<td class="name"><code>cfrom</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Source node ID.</p></td>
</tr>
<tr>
<td class="name"><code>cto</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Destination node ID.</p></td>
</tr>
<tr>
<td class="name"><code>clabel</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The Label of the service.</p></td>
</tr>
<tr>
<td class="name"><code>ctext</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The Text of the service.</p></td>
</tr>
<tr>
<td class="name"><code>isImport</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>false -&gt; manual add, true -&gt; automattically added while import json.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="networkgraph_fiber.js.html">networkgraph/fiber.js</a>, <a href="networkgraph_fiber.js.html#line102">line 102</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~clearSingleFiber"><span class="type-signature">(inner) </span>clearSingleFiber<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Clear input/teporary data and other settings.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="networkgraph_fiber.js.html">networkgraph/fiber.js</a>, <a href="networkgraph_fiber.js.html#line964">line 964</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~displayFiberHover"><span class="type-signature">(inner) </span>displayFiberHover<span class="signature">(params)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Displays fiber details when hover the mouse near the single fiber.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>params</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>Fiber details.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="networkgraph_fiber.js.html">networkgraph/fiber.js</a>, <a href="networkgraph_fiber.js.html#line1079">line 1079</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~removeFiber"><span class="type-signature">(inner) </span>removeFiber<span class="signature">(fiberID, isMultiple)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Remove fiber by fiber ID.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fiberID</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Component ID.</p></td>
</tr>
<tr>
<td class="name"><code>isMultiple</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Remove multiple fiber.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="networkgraph_fiber.js.html">networkgraph/fiber.js</a>, <a href="networkgraph_fiber.js.html#line1019">line 1019</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~singleFiberEdit"><span class="type-signature">(inner) </span>singleFiberEdit<span class="signature">(fiberID, callback)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Populate fiber details by fiber ID.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fiberID</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Selected Fiber ID.</p></td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
</td>
<td class="description last"><p>The callback that handles the response.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="networkgraph_fiber.js.html">networkgraph/fiber.js</a>, <a href="networkgraph_fiber.js.html#line789">line 789</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~singleFiberInsertNode"><span class="type-signature">(inner) </span>singleFiberInsertNode<span class="signature">(fiberID, node_type, callback)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Insert a node (ROADM/Attenuator/Amplifier/Raman Amplifier) in the middle of selected fiber.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fiberID</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Selected fiber ID</p></td>
</tr>
<tr>
<td class="name"><code>node_type</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Type of node.</p></td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
</td>
<td class="description last"><p>The callback that handles the response..</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="networkgraph_fiber.js.html">networkgraph/fiber.js</a>, <a href="networkgraph_fiber.js.html#line532">line 532</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~singleFiberMode"><span class="type-signature">(inner) </span>singleFiberMode<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Enable settings for fiber and reset other settings.
Set fiber 1 = enable, 0 = disable.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="networkgraph_fiber.js.html">networkgraph/fiber.js</a>, <a href="networkgraph_fiber.js.html#line29">line 29</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~updateSingleFiber"><span class="type-signature">(inner) </span>updateSingleFiber<span class="signature">(fiberID)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Update fiber.
Update fiber by fiber ID.
Apply connections rules.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fiberID</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Fiber ID.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="networkgraph_fiber.js.html">networkgraph/fiber.js</a>, <a href="networkgraph_fiber.js.html#line861">line 861</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">oopt-gnpy-web-gui-main</a></h2><h3>Modules</h3><ul><li><a href="module-alea.html">alea</a></li><li><a href="module-constraints.html">constraints</a></li><li><a href="module-exampleUtil.html">exampleUtil</a></li><li><a href="module-fiber.html">fiber</a></li><li><a href="module-filesaver.html">filesaver</a></li><li><a href="module-main.html">main</a></li><li><a href="module-mynetwork.html">mynetwork</a></li><li><a href="module-node.html">node</a></li><li><a href="module-patch.html">patch</a></li><li><a href="module-service.html">service</a></li><li><a href="module-validation.html">validation</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-LICENSE.html">LICENSE</a></li><li><a href="tutorial-technical_document.html">technical_document</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Wed Jul 06 2022 19:21:36 GMT+0530 (India Standard Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>