jahmin
Version:
A JavaScript framework to build browser friendly Human Machine Interfaces for automation
361 lines (284 loc) • 13.8 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>DataTree</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link href="https://fonts.googleapis.com/css?family=PT+Mono" rel="stylesheet">
<link type="text/css" rel="stylesheet" href="css/bootstrap.min.css">
<link type="text/css" rel="stylesheet" href="css/prism.min.css">
<link type="text/css" rel="stylesheet" href="css/template.min.css">
<script type="text/javascript">
window.TEMPLATE_OPTIONS = {"includeDate":true,"dateFormat":"Do MMM YYYY","systemName":"JaHMIn","systemSummary":"A Javascript framework to build Human Machine Interfaces for IoT","systemLogo":"","systemColor":"","navMembers":[{"kind":"class","title":"Classes","summary":"All documented classes."},{"kind":"external","title":"Externals","summary":"All documented external members."},{"kind":"global","title":"Globals","summary":"All documented globals."},{"kind":"mixin","title":"Mixins","summary":"All documented mixins."},{"kind":"interface","title":"Interfaces","summary":"All documented interfaces."},{"kind":"module","title":"Modules","summary":"All documented modules."},{"kind":"namespace","title":"Namespaces","summary":"All documented namespaces."},{"kind":"tutorial","title":"Tutorials","summary":"All available tutorials."}],"footer":"","copyright":"FooDoc Copyright © 2016 The contributors to the JSDoc3 and FooDoc projects.","linenums":true,"collapseSymbols":true,"inverseNav":true,"inlineNav":false,"outputSourceFiles":true,"sourceRootPath":null,"disablePackagePath":true,"outputSourcePath":false,"showTableOfContents":true,"showAccessFilter":true,"analytics":null,"methodHeadingReturns":true,"sort":"linenum, longname, version, since","search":true,"favicon":null,"stylesheets":[],"scripts":[],"monospaceLinks":false,"cleverLinks":false,"theme":"yeti"};
window.DOCLET_TOC_ENABLED = true;
window.DOCLET_AFILTER_ENABLED = false;
</script>
</head>
<body>
<!-- start:navbar.hbs -->
<header class="navbar navbar-default navbar-fixed-top navbar-inverse">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="index.html">
JaHMIn
</a>
<!-- displayed on small devices -->
<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<div class="navbar-collapse collapse" id="topNavigation">
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Globals<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="global.html#VarStatusCodes">VarStatusCodes</a></li>
</ul>
</li>
<li class="dropdown">
<a href="list_class.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="DataCommsEngine.html">DataCommsEngine</a></li>
<li><a href="DataTree.html">DataTree</a></li>
<li><a href="ErrorCodes.html">ErrorCodes</a></li>
<li><a href="ServiceManager.html">ServiceManager</a></li>
<li><a href="ServiceStatusCodes.html">ServiceStatusCodes</a></li>
<li><a href="systemError.html">systemError</a></li>
<li><a href="systemObject.html">systemObject</a></li>
<li><a href="systemVariable.html">systemVariable</a></li>
<li><a href="VarResponse.html">VarResponse</a></li>
</ul>
</li>
<li class="dropdown">
<a href="list_tutorial.html" class="dropdown-toggle" data-toggle="dropdown">Tutorials<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="tutorial-Getting-Started.html">Getting-Started</a></li>
</ul>
</li>
</ul>
<!-- start:lunr-search-navbar.hbs -->
<form class="navbar-form navbar-right" role="search">
<div class="input-group">
<input type="text" class="form-control" placeholder="Search" id="lunr-search-input">
<div class="input-group-btn">
<button class="btn btn-default" id="lunr-search-submit">
<i class="glyphicon glyphicon-search"></i>
</button>
</div>
</div>
</form>
<!-- start:lunr-search-navbar.hbs --> </div>
</div>
</header>
<!-- end:navbar.hbs --> <div class="page-header">
<div class="container">
<span class="kind">class</span>
<h1><span class="name">DataTree</span></h1>
</div>
</div>
<div class="container content">
<div class="row">
<div class="col-md-9 main-content">
<ol class="breadcrumb">
<li><a href="index.html">Home</a></li>
<li><a href="list_class.html">Classes</a></li>
<li class="active">DataTree</li>
</ol>
<section>
<dl class="symbol primary">
<dt class="symbol-title class collapsible-symbol expanded">
<h2 class="class"><span class="signature-new">new </span><span class="name">DataTree</span><span class="signature-params">()</span><span class="signature-type"></span></h2>
</dt>
<dd class="symbol-details class collapsible-symbol expanded" style="max-height: 9999px;">
<div class="symbol-details-inner">
<div class="callout callout-primary"><h5>Description</h5> <div class="description classdesc">Class that contains all the data structure of the App for all the subsystems.
The app state is saved in here.
It is connected automatically to UI element and schedule updates on them.</div>
</div> <div class="callout callout-default"><h5>Details</h5> <form class="form-horizontal details">
<!-- source -->
<div class="form-group">
<label class="col-sm-3 control-label">Source</label>
<div class="col-sm-9">
<p class="form-control-static"><a href="DataModels_DataTree.js.html">DataModels/DataTree.js</a>, <a href="DataModels_DataTree.js.html#line-17">line 17</a></p>
</div>
</div>
</form>
</div> </div>
</dd>
</dl>
<article class="secondary">
<h3>Classes</h3>
<dl class="symbol">
<hr/>
<dt class="symbol-title class public">
<h4 id="DataTree" class="class public"><a href="DataTree.html"><span class="signature-new">new </span><span class="name">DataTree</span><span class="signature-params">()</span><span class="signature-type"></span></a></h4>
</dt>
<dd class="symbol-details class public">
<div class="symbol-details-inner">
</div>
</dd>
</dl>
<h3>Methods</h3>
<dl class="symbol">
<hr/>
<dt class="symbol-title function public collapsible-symbol">
<h4 id="GetVar" class="function public"><span class="name">GetVar</span><span class="signature-params">( <span class="signature-param">varID</span> )</span><span class="signature-type"></span></h4>
</dt>
<dd class="symbol-details function public collapsible-symbol">
<div class="symbol-details-inner">
<div class="callout callout-primary"><h5>Description</h5> <div class="description">Get the current value and status of the related stateVariable.
It returns a proxy to the real stateVariable, this is readonly, as a protection
it will throw if you try to assign a value.</div>
</div> <div class="callout callout-info">
<h5>Parameters</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>varID</code></td>
<td><span class="param-type"><a href="systemObject.html">systemObject</a></span></td>
<td class="last">
identifier of the variable, an object with keys (name,system)
</td>
</tr>
</tbody>
</table>
</div>
<div class="callout callout-default"><h5>Details</h5> <form class="form-horizontal details">
<!-- source -->
<div class="form-group">
<label class="col-sm-3 control-label">Source</label>
<div class="col-sm-9">
<p class="form-control-static"><a href="DataModels_DataTree.js.html">DataModels/DataTree.js</a>, <a href="DataModels_DataTree.js.html#line-30">line 30</a></p>
</div>
</div>
</form>
</div> </div>
</dd>
<hr/>
<dt class="symbol-title function public collapsible-symbol">
<h4 id="Update" class="function public"><span class="name">Update</span><span class="signature-params">( <span class="signature-param">variables</span> )</span><span class="signature-type"></span></h4>
</dt>
<dd class="symbol-details function public collapsible-symbol">
<div class="symbol-details-inner">
<div class="callout callout-primary"><h5>Description</h5> <div class="description">It upadtes with the variable or the list of variables.
This will automatically call UI update of all connected elements.</div>
</div> <div class="callout callout-info">
<h5>Parameters</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>variables</code></td>
<td></td>
<td class="last">
a list or a single systemVariable object with keys (name,system,status,value)
</td>
</tr>
</tbody>
</table>
</div>
<div class="callout callout-default"><h5>Details</h5> <form class="form-horizontal details">
<!-- source -->
<div class="form-group">
<label class="col-sm-3 control-label">Source</label>
<div class="col-sm-9">
<p class="form-control-static"><a href="DataModels_DataTree.js.html">DataModels/DataTree.js</a>, <a href="DataModels_DataTree.js.html#line-50">line 50</a></p>
</div>
</div>
</form>
</div> </div>
</dd>
<hr/>
<dt class="symbol-title function public collapsible-symbol">
<h4 id="ExistVar" class="function public"><span class="name">ExistVar</span><span class="signature-params">( <span class="signature-param">varID</span> )</span><span class="signature-type"></span></h4>
</dt>
<dd class="symbol-details function public collapsible-symbol">
<div class="symbol-details-inner">
<div class="callout callout-primary"><h5>Description</h5> <div class="description">Checks if the variable exist in the current state tree</div>
</div> <div class="callout callout-info">
<h5>Parameters</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>varID</code></td>
<td></td>
<td class="last">
identifier of the variable, an object with keys (name,system)
</td>
</tr>
</tbody>
</table>
</div>
<div class="callout callout-default"><h5>Details</h5> <form class="form-horizontal details">
<!-- source -->
<div class="form-group">
<label class="col-sm-3 control-label">Source</label>
<div class="col-sm-9">
<p class="form-control-static"><a href="DataModels_DataTree.js.html">DataModels/DataTree.js</a>, <a href="DataModels_DataTree.js.html#line-97">line 97</a></p>
</div>
</div>
</form>
</div> </div>
</dd>
</dl>
</article>
</section>
</div>
<div class="col-md-3 side-content">
<nav class="toc hidden-print hidden-sm hidden-xs"></nav>
</div>
</div>
</div>
<footer>
<div class="copyright">FooDoc Copyright © 2016 The contributors to the JSDoc3 and FooDoc projects.</div>
<div class="generated-by">Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on 11th Jun 2021 using the <a href="https://github.com/steveush/foodoc">FooDoc template</a>.</div>
</footer>
<script src="js/jquery.min.js"></script>
<script src="js/bootstrap.min.js"></script>
<script src="js/clipboard.min.js"></script>
<script src="js/prism.min.js"></script>
<script src="js/template.min.js"></script>
<!-- start:lunr-search-modal.hbs -->
<div class="modal fade" id="lunr-search-modal">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
<h4 class="modal-title">Search results</h4>
</div>
<div class="modal-body" id="lunr-search-body">
</div>
<div class="modal-footer" id="lunr-search-footer">
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
</div>
</div><!-- /.modal-content -->
</div><!-- /.modal-dialog -->
</div>
<!-- end:lunr-search-modal.hbs --> <script src="js/lunr.min.js"></script>
</body>
</html>