<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_class_addon" xml:lang="en-US">
<title>Addon Class Reference</title>
<indexterm><primary>Addon</primary></indexterm>
<para>
<computeroutput>#include &lt;Addon.h&gt;</computeroutput>
</para>
Inheritance diagram for Addon:<para>
    <informalfigure>
        <mediaobject>
            <imageobject>
                <imagedata width="50%" align="center" valign="middle" scalefit="0" fileref="../../dd/dc2/class_addon__inherit__graph.svg"></imagedata>
            </imageobject>
        </mediaobject>
    </informalfigure>
</para>
<simplesect>
    <title>Static Public Attributes    </title>
        <itemizedlist>
            <listitem><para><link linkend="_class_timer">static</link> <link linkend="_class_timer">const</link> <link linkend="_class_timer">int</link> <link linkend="_class_addon_1a41a9fedec6822024fd6ca1a316da6eaa">ADDON_FLAGS_DEFAULT</link> = 1 &lt;&lt; OBJECT_RUN_FLAGS::E_OF_LOOP | 1 &lt;&lt; OBJECT_RUN_FLAGS::E_OF_INFO | 1 &lt;&lt; OBJECT_RUN_FLAGS::E_OF_SETUP</para>
</listitem>
        </itemizedlist>
</simplesect>
Static Public Attributes inherited from <link linkend="_class_component">Component</link>        <itemizedlist>
            <listitem><para><link linkend="_class_timer">static</link> <link linkend="_class_timer">const</link> <link linkend="_class_timer">int</link> <link linkend="_class_component_1a2435f54f8ea88aa317f562b97c48175e">COMPONENT_DEFAULT</link> = 1 &lt;&lt; OBJECT_RUN_FLAGS::E_OF_LOOP | 1 &lt;&lt; OBJECT_RUN_FLAGS::E_OF_SETUP</para>

<para>The default run flags for a component. </para>
</listitem>
            <listitem><para><link linkend="_class_timer">static</link> <link linkend="_class_timer">const</link> <link linkend="_class_timer">int</link> <link linkend="_class_component_1aacfebfd04c61064f59bd407923e3408a">COMPONENT_NO_ID</link> = 0</para>

<para>The default ID for a component. </para>
</listitem>
        </itemizedlist>
<simplesect>
    <title>Additional Inherited Members    </title>
Public Member Functions inherited from <link linkend="_class_component">Component</link>        <itemizedlist>
            <listitem><para><link linkend="_class_timer">void</link> <link linkend="_class_component_1ab0641f7dfd6a83b2bf9c0dabf913bba8">clearFlag</link> (<link linkend="_class_timer">byte</link> <link linkend="_class_timer">flag</link>)</para>

<para>Clears a specific flag for the component. </para>
</listitem>
            <listitem><para><link linkend="_class_component_1a8775db6d1a2c1afc2e77cd3c8f39da6f">Component</link> ()</para>

<para>Default constructor for the <link linkend="_class_component">Component</link> class. </para>
</listitem>
            <listitem><para><link linkend="_class_component_1a105408e9463fdbe926fe2ef78f4003f8">Component</link> (<link linkend="_class_timer">String</link> <link linkend="_class_timer">_name</link>)</para>

<para>Constructor for the <link linkend="_class_component">Component</link> class with a specified name. </para>
</listitem>
            <listitem><para><link linkend="_class_component_1aa06f9abfec867a4d76640a783543b981">Component</link> (<link linkend="_class_timer">String</link> <link linkend="_class_timer">_name</link>, <link linkend="_class_timer">short</link> <link linkend="_class_timer">_id</link>)</para>

<para>Constructor for the <link linkend="_class_component">Component</link> class with a specified name and ID. </para>
</listitem>
            <listitem><para><link linkend="_class_component_1aad8eeba8c6f6b51ef3b85f144b3f050c">Component</link> (<link linkend="_class_timer">String</link> <link linkend="_class_timer">_name</link>, <link linkend="_class_timer">short</link> <link linkend="_class_timer">_id</link>, <link linkend="_class_timer">int</link> <link linkend="_class_timer">_flags</link>)</para>

<para>Constructor for the <link linkend="_class_component">Component</link> class with a specified name, ID, and flags. </para>
</listitem>
            <listitem><para><link linkend="_class_component_1aab29a9d52d0fb0f1f68a6f1107fce504">Component</link> (<link linkend="_class_timer">String</link> <link linkend="_class_timer">_name</link>, <link linkend="_class_timer">short</link> <link linkend="_class_timer">_id</link>, <link linkend="_class_timer">int</link> <link linkend="_class_timer">_flags</link>, <link linkend="_class_component">Component</link> *<link linkend="_class_timer">_owner</link>)</para>

<para>Constructor for the <link linkend="_class_component">Component</link> class with a specified name, ID, flags, and owner. </para>
</listitem>
            <listitem><para><link linkend="_class_timer">virtual</link> <link linkend="_class_timer">short</link> <link linkend="_class_component_1ab2e2c2e11b072136d6be468b8db54d22">debug</link> ()</para>

<para>Virtual function to debug the component. </para>
</listitem>
            <listitem><para><link linkend="_class_timer">virtual</link> <link linkend="_class_timer">short</link> <link linkend="_class_component_1a2509b6b05062a9f37be00d6633448f3a">debug</link> (<link linkend="_class_timer">short</link> <link linkend="_class_timer">val0</link>, <link linkend="_class_timer">short</link> <link linkend="_class_timer">val1</link>)</para>

<para>Virtual function to debug the component. </para>
</listitem>
            <listitem><para><link linkend="_class_timer">virtual</link> <link linkend="_class_timer">short</link> <link linkend="_class_component_1a5a88f501e28538492a8b00f7256cfa88">destroy</link> ()</para>

<para>Virtual function to destroy the component. </para>
</listitem>
            <listitem><para><link linkend="_class_timer">void</link> <link linkend="_class_component_1a5944c18d0e1de53f2842149ca364b672">disable</link> ()</para>

<para>Disables the component. </para>
</listitem>
            <listitem><para><link linkend="_class_timer">void</link> <link linkend="_class_component_1af659603312b1770279f3722f8ea303a4">enable</link> ()</para>

<para>Enables the component. </para>
</listitem>
            <listitem><para><link linkend="_class_timer">bool</link> <link linkend="_class_component_1a76d5c1c0f128959a0245cbceeef26443">enabled</link> ()</para>

<para>Checks if the component is enabled. </para>
</listitem>
            <listitem><para><link linkend="_class_timer">bool</link> <link linkend="_class_component_1a6fbb2db0159837bf1e84bc4b27ff0f0a">hasFlag</link> (<link linkend="_class_timer">byte</link> <link linkend="_class_timer">flag</link>)</para>

<para>Checks if the component has a specific flag. </para>
</listitem>
            <listitem><para><link linkend="_class_timer">virtual</link> <link linkend="_class_timer">short</link> <link linkend="_class_component_1ac9ad2cae93058a6aab4d57b1e7800374">info</link> ()</para>

<para>Virtual function to display information about the component. </para>
</listitem>
            <listitem><para><link linkend="_class_timer">virtual</link> <link linkend="_class_timer">short</link> <link linkend="_class_component_1a5ee9563b1698bace212cda16a404ddb4">info</link> (<link linkend="_class_timer">short</link> <link linkend="_class_timer">val0</link>, <link linkend="_class_timer">short</link> <link linkend="_class_timer">val1</link>)</para>

<para>Virtual function to display information about the component. </para>
</listitem>
            <listitem><para><link linkend="_class_timer">virtual</link> <link linkend="_class_timer">short</link> <link linkend="_class_component_1a8f031c6c5e888711277cb9b688405477">loop</link> ()</para>

<para>Virtual function to run the component in a loop. </para>
</listitem>
            <listitem><para><link linkend="_class_timer">virtual</link> <link linkend="_class_timer">short</link> <link linkend="_class_component_1a91ac0196b944c9f1c9db4142395738df">onError</link> (<link linkend="_class_timer">short</link> <link linkend="_class_component_1aba3a6b372b8f2efde31c1556c7107cf0">id</link>, <link linkend="_class_timer">short</link> error)</para>
</listitem>
            <listitem><para><link linkend="_class_timer">virtual</link> <link linkend="_class_timer">short</link> <link linkend="_class_component_1a9551f96bacf5477e5efb04ad3985e95f">onMessage</link> (<link linkend="_class_timer">int</link> <link linkend="_class_component_1aba3a6b372b8f2efde31c1556c7107cf0">id</link>, <link linkend="_osr-fw-base_2src_2enums_8h_1af647086e100e6e572160d67b627db67b">E_CALLS</link> verb, <link linkend="_osr-fw-base_2src_2enums_8h_1a881f3b5416932fb0f5774c343d8bacf4">E_MessageFlags</link> <link linkend="_class_component_1ad2627608e8e3bab6ae2598f56138803a">flags</link>, <link linkend="_class_timer">const</link> <link linkend="_class_timer">void</link> *<link linkend="_class_timer">user</link>, <link linkend="_class_component">Component</link> *<link linkend="_class_timer">src</link>)</para>

<para>Handles incoming messages. </para>
</listitem>
            <listitem><para><link linkend="_class_timer">virtual</link> <link linkend="_class_timer">short</link> <link linkend="_class_component_1abb477935ff940965ad5e5712b5785d12">onRawResponse</link> (<link linkend="_class_timer">short</link> <link linkend="_class_timer">size</link>, <link linkend="_class_timer">uint8_t</link> rxBuffer[])</para>
</listitem>
            <listitem><para><link linkend="_class_timer">virtual</link> <link linkend="_class_timer">short</link> <link linkend="_class_component_1aa872a02516634c1be99503a8de65113f">onRegisterMethods</link> (<link linkend="_class_bridge">Bridge</link> *bridge)</para>
</listitem>
            <listitem><para><link linkend="_class_timer">virtual</link> <link linkend="_class_timer">short</link> <link linkend="_class_component_1a881f4ed620349bc9e0706daa12b81674">onResponse</link> (<link linkend="_class_timer">short</link> error)</para>
</listitem>
            <listitem><para><link linkend="_class_timer">void</link> <link linkend="_class_component_1a423dca2635dd4b5f3cc5e1942d0942b3">setFlag</link> (<link linkend="_class_timer">byte</link> <link linkend="_class_timer">flag</link>)</para>

<para>Sets a specific flag for the component. </para>
</listitem>
            <listitem><para><link linkend="_class_timer">virtual</link> <link linkend="_class_timer">short</link> <link linkend="_class_component_1a7a6699a2366b7f67b0efa76cc4821088">setup</link> ()</para>

<para>Virtual function to set up the component. </para>
</listitem>
            <listitem><para><link linkend="_class_component_1ab8378fa275af98e568a7e91d33d867af">~Component</link> ()</para>

<para>Destructor for the <link linkend="_class_component">Component</link> class. </para>
</listitem>
        </itemizedlist>
</simplesect>
Public Member Functions inherited from <link linkend="_class_modbus_gateway">ModbusGateway</link>        <itemizedlist>
            <listitem><para><link linkend="_class_timer">short</link> <link linkend="_class_modbus_gateway_1aaed7ceff9ed90a73b3edc860d2795d7f">getAddress</link> ()</para>
</listitem>
            <listitem><para><link linkend="_osr-fw-base_2examples_2pid_2enums_8h_1aff1341ea5077cc6097a0d7db89be4cf6">MB_FC</link> <link linkend="_class_modbus_gateway_1a5c58a1e93cb3300108c27d6f3eaac3cb">getFunctionCode</link> ()</para>
</listitem>
            <listitem><para><link linkend="_class_timer">short</link> <link linkend="_class_modbus_gateway_1a680298496fefeef0355f7fb406494aaf">getNumberAddresses</link> ()</para>
</listitem>
            <listitem><para><link linkend="_class_timer">virtual</link> <link linkend="_class_timer">String</link> <link linkend="_class_modbus_gateway_1a9903e131718805f2658f68f96389f934">getRegisterDescription</link> (<link linkend="_class_timer">short</link> flags=0)</para>
</listitem>
            <listitem><para><link linkend="_class_timer">const</link> <link linkend="_class_timer">char</link> * <link linkend="_class_modbus_gateway_1a13a4de4fa5b5bbf94a9a91de8e0fbd5f">getRegisterMode</link> ()</para>
</listitem>
            <listitem><para><link linkend="_class_modbus_gateway_1a78bde10e865f221affe774b2850470a6">ModbusGateway</link> ()</para>
</listitem>
            <listitem><para><link linkend="_class_modbus_gateway_1aeefdee0066e75a03f92a7cd64f5cd923">ModbusGateway</link> (<link linkend="_class_timer">short</link> <link linkend="_class_timer">_addr</link>)</para>
</listitem>
            <listitem><para><link linkend="_class_modbus_gateway_1ac72b8f93fa8050a9c71bbe862f592734">ModbusGateway</link> (<link linkend="_class_timer">short</link> <link linkend="_class_timer">_addr</link>, <link linkend="_class_timer">short</link> <link linkend="_class_timer">_fc</link>)</para>
</listitem>
            <listitem><para><link linkend="_class_timer">void</link> <link linkend="_class_modbus_gateway_1ad711fa3496ac0ac5d63f7e7080e1cb3d">setAddress</link> (<link linkend="_class_timer">short</link> <link linkend="_class_timer">_addr</link>)</para>
</listitem>
            <listitem><para><link linkend="_class_timer">void</link> <link linkend="_class_modbus_gateway_1a8c7b6c6b51675430e188f6394ce954ee">setFunctionCode</link> (<link linkend="_osr-fw-base_2examples_2pid_2enums_8h_1aff1341ea5077cc6097a0d7db89be4cf6">MB_FC</link> <link linkend="_class_timer">fc</link>)</para>
</listitem>
            <listitem><para><link linkend="_class_timer">void</link> <link linkend="_class_modbus_gateway_1ada2cf17a72c4de2a05aef802f0d4d295">setGateway</link> (<link linkend="_class_mudbus">Mudbus</link> *<link linkend="_class_modbus_gateway_1a009e368330030aac35cabd6b1daf7387">mudbus</link>)</para>
</listitem>
            <listitem><para><link linkend="_class_timer">void</link> <link linkend="_class_modbus_gateway_1a6170d47d3030ff71417815f00229aeb2">setNumberAddresses</link> (<link linkend="_class_timer">short</link> <link linkend="_class_timer">_nbAddr</link>)</para>
</listitem>
            <listitem><para><link linkend="_class_timer">void</link> <link linkend="_class_modbus_gateway_1afc6d54612f4e6cfee3b3740c7cc550dd">setRegisterMode</link> (<link linkend="_osr-fw-base_2src_2enums_8h_1a1f6ea713f12845dd4706bc8f0d5da9cf">MB_REGISTER_MODE</link> mode)</para>
</listitem>
        </itemizedlist>
Public Attributes inherited from <link linkend="_class_component">Component</link>        <itemizedlist>
            <listitem><para><link linkend="_class_timer">int</link> <link linkend="_class_component_1ad2627608e8e3bab6ae2598f56138803a">flags</link></para>

<para>The run flags for the component. </para>
</listitem>
            <listitem><para><link linkend="_class_timer">const</link> <link linkend="_class_timer">short</link> <link linkend="_class_component_1aba3a6b372b8f2efde31c1556c7107cf0">id</link></para>

<para>The ID of the component. </para>
</listitem>
            <listitem><para><link linkend="_types_8h_1ab14fc3b0e7b9535ec25836108ce96a45">millis_t</link> <link linkend="_class_component_1a9bd1750a52031e6b5d60a0f6c7de5c8b">last</link></para>

<para>The last tick time in milliseconds. </para>
</listitem>
            <listitem><para><link linkend="_class_timer">String</link> <link linkend="_class_component_1acf12509f5baeb0096cad073f7d3575d4">name</link></para>

<para>The name of the component. </para>
</listitem>
            <listitem><para><link linkend="_class_timer">int</link> <link linkend="_class_component_1a89ecb049c2d7c026913e60f1393237dc">nFlags</link></para>

<para>The network capabilities of the component. </para>
</listitem>
            <listitem><para><link linkend="_types_8h_1ab14fc3b0e7b9535ec25836108ce96a45">millis_t</link> <link linkend="_class_component_1a62bafa07263df702e1c33cd60ddc25b8">now</link></para>

<para>The current time in milliseconds. </para>
</listitem>
            <listitem><para><link linkend="_class_component">Component</link> * <link linkend="_class_component_1abe8dcb7fc6074ff862cc4b9866196e21">owner</link></para>

<para>The owner of the component. </para>
</listitem>
        </itemizedlist>
Public Attributes inherited from <link linkend="_class_modbus_gateway">ModbusGateway</link>        <itemizedlist>
            <listitem><para><link linkend="_class_timer">short</link> <link linkend="_class_modbus_gateway_1afe42c727b139008073bdeefbfd039eec">addr</link></para>
</listitem>
            <listitem><para><link linkend="_osr-fw-base_2examples_2pid_2enums_8h_1aff1341ea5077cc6097a0d7db89be4cf6">MB_FC</link> <link linkend="_class_modbus_gateway_1adfa9598d37ed50b06433e58c92389048">fn</link></para>
</listitem>
            <listitem><para><link linkend="_types_8h_1a65f85814a8290f9797005d3b28e7e5fc">uchar</link> <link linkend="_class_modbus_gateway_1a60eadb64880be33ef9f8fafc2fd0979f">lastMQSlot</link></para>
</listitem>
            <listitem><para><link linkend="_class_mudbus">Mudbus</link> * <link linkend="_class_modbus_gateway_1a009e368330030aac35cabd6b1daf7387">mudbus</link></para>
</listitem>
            <listitem><para><link linkend="_class_timer">short</link> <link linkend="_class_modbus_gateway_1a6652fb1d4b0a59277b996b2fb4de4e32">nbAddr</link></para>
</listitem>
            <listitem><para><link linkend="_class_timer">short</link> <link linkend="_class_modbus_gateway_1a6a5d7233939da7d48dcd6c977bdc960b">registerMode</link></para>
</listitem>
        </itemizedlist>
<section>
<title>Detailed Description</title>
<para>
Definition at line <link linkend="__addon_8h_source_1l00013">13</link> of file <link linkend="__addon_8h_source">Addon.h</link>.</para>
</section>
<section>
<title>Member Data Documentation</title>
<anchor xml:id="_class_addon_1a41a9fedec6822024fd6ca1a316da6eaa"/><section>
    <title>ADDON_FLAGS_DEFAULT</title>
<indexterm><primary>ADDON_FLAGS_DEFAULT</primary><secondary>Addon</secondary></indexterm>
<indexterm><primary>Addon</primary><secondary>ADDON_FLAGS_DEFAULT</secondary></indexterm>
<para><computeroutput><link linkend="_class_timer">const</link> <link linkend="_class_timer">int</link> Addon::ADDON_FLAGS_DEFAULT = 1 &lt;&lt; OBJECT_RUN_FLAGS::E_OF_LOOP | 1 &lt;&lt; OBJECT_RUN_FLAGS::E_OF_INFO | 1 &lt;&lt; OBJECT_RUN_FLAGS::E_OF_SETUP<computeroutput>[static]</computeroutput></computeroutput></para><para>
Definition at line <link linkend="__addon_8h_source_1l00017">17</link> of file <link linkend="__addon_8h_source">Addon.h</link>.</para>
</section>
<para>
The documentation for this class was generated from the following file:</para>
<link linkend="__addon_8h">Addon.h</link></section>
</section>
