C:/Documents and Settings/gw/My Documents/Other projects/flightos/Modules/moduletemplate.h

Go to the documentation of this file.

/*
  Copyright (c) 2010 Les Newell. All rights reserved

  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program. If not, see <http://www.gnu.org/licenses/>.
*/



//define the module.
class MyModule : public Module
{
    DECLARE_MODULE(MyModule,Module)


    //Only use this to expose sockets and parameters. Do most of your
    //initialisastion in Init()
    MyModule()
    {
        /*Expose sockets to the outside world
        NOTE: the socket name must be a static string.
        Bad Things will happen if you use a string allocated on the stack
        You can use a pointer to a static string.*/
        AddSocket("SocketName", &m_socket);

    }

    //A parameter has changed. This happens at bootup if the EEPROM
    //contains valid data and at run-time if the user changes a
    //parameter over the serial link
    virtual void ParamChanged(Socket * param)
    {
    }

    //Initialise the module
    //set up hardware etc
    virtual void Init()
    {
        //Set how often Loop() should be executed (in milliseconds)
        SetInterval(100);
        //Set this module's priority. -1 is never execute, 100 is maximum.
        SetPriority (10);
    }

    //Here is where you do your work. It is called at the rate defined by SetInterval
    virtual void Loop(const unsigned long& interval)
    {
    }

private:
    Socket8 m_socket;

};

MyModule g_MyModule;