docs/module-Signals-Message.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: Message</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">Class: Message</h1>

    
<section>

<header>
    
        <h2><span class="attribs"><span class="type-signature"></span></span>
            <span class="ancestors"><a href="module-Signals.html">Signals</a>~</span>Message<span class="signature">()</span><span class="type-signature"></span></h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        
    <h4 class="name" id="Message"><span class="type-signature"></span>new Message<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Just a container to keep the Signals.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="socketcan.js.html">socketcan.js</a>, <a href="socketcan.js.html#line190">line 190</a>
    </li></ul></dd>
    

</dl>


    </div>

    
        <h3 class="subsection-title">Members</h3>

        
<h4 class="name" id="canfd"><span class="type-signature">(readonly) </span>canfd<span class="type-signature"></span></h4>


<div class="description">
    Named information to inform that the frame is CAN_FD format .
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="socketcan.js.html">socketcan.js</a>, <a href="socketcan.js.html#line254">line 254</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="ext"><span class="type-signature">(readonly) </span>ext<span class="type-signature"></span></h4>


<div class="description">
    Extended Frame Format used
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="socketcan.js.html">socketcan.js</a>, <a href="socketcan.js.html#line208">line 208</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="id"><span class="type-signature">(readonly) </span>id<span class="type-signature"></span></h4>


<div class="description">
    CAN identifier
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="socketcan.js.html">socketcan.js</a>, <a href="socketcan.js.html#line201">line 201</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="interval"><span class="type-signature">(readonly) </span>interval<span class="type-signature"></span></h4>


<div class="description">
    This is the time frame that the message gets generated
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="socketcan.js.html">socketcan.js</a>, <a href="socketcan.js.html#line231">line 231</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="len"><span class="type-signature">(readonly) </span>len<span class="type-signature"></span></h4>


<div class="description">
    Length in bytes of resulting CAN message
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="socketcan.js.html">socketcan.js</a>, <a href="socketcan.js.html#line223">line 223</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="mux"><span class="type-signature">(readonly) </span>mux<span class="type-signature"></span></h4>


<div class="description">
    Multiplexor parameter (just one supported right now).
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="socketcan.js.html">socketcan.js</a>, <a href="socketcan.js.html#line247">line 247</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="muxed"><span class="type-signature">(readonly) </span>muxed<span class="type-signature"></span></h4>


<div class="description">
    This tells us the message is mutliplexed.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="socketcan.js.html">socketcan.js</a>, <a href="socketcan.js.html#line239">line 239</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="name"><span class="type-signature">(readonly) </span>name<span class="type-signature"></span></h4>


<div class="description">
    Symbolic name
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="socketcan.js.html">socketcan.js</a>, <a href="socketcan.js.html#line215">line 215</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="signals"><span class="type-signature">(readonly) </span>signals<span class="type-signature"></span></h4>


<div class="description">
    Named array of signals within this message. Accessible via index and name.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="socketcan.js.html">socketcan.js</a>, <a href="socketcan.js.html#line261">line 261</a>
    </li></ul></dd>
    

</dl>


</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Signals.html">Signals</a></li></ul><h3>Classes</h3><ul><li><a href="module-Signals-DatabaseService.html">DatabaseService</a></li><li><a href="module-Signals-Message.html">Message</a></li><li><a href="module-Signals-Signal.html">Signal</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createRawChannel">createRawChannel</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Sun Sep 24 2023 10:29:10 GMT+0200 (Mitteleuropäische Sommerzeit)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>