Module.h

00001 /*  
00002       This file is part of Smoothie (http://smoothieware.org/). The motion control part is heavily based on Grbl (https://github.com/simen/grbl).
00003       Smoothie 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.
00004       Smoothie 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.
00005       You should have received a copy of the GNU General Public License along with Smoothie. If not, see <http://www.gnu.org/licenses/>. 
00006 */
00007 
00008 #ifndef MODULE_H
00009 #define MODULE_H
00010 
00011 #include <string>
00012 using std::string;
00013 
00014 // Module base class
00015 // All modules must extend this class, see http://smoothieware.org/moduleexample 
00016 class Kernel;
00017 class Module {
00018     public:
00019         Module();
00020         virtual void on_module_loaded();
00021         virtual void register_for_event(int event_id);
00022         virtual void on_main_loop(void * argument);
00023         virtual void on_console_line_received(  void * argument);
00024         virtual void on_gcode_received(         void * argument);
00025         virtual void on_gcode_execute(          void * argument);
00026         virtual void on_stepper_wake_up(        void * argument);
00027         virtual void on_speed_change(           void * argument);
00028         virtual void on_block_begin(            void * argument);
00029         virtual void on_block_end(              void * argument);
00030         virtual void on_config_reload(          void * argument);
00031         virtual void on_play(                   void * argument);
00032         virtual void on_pause(                  void * argument);
00033         virtual void on_idle(                   void * argument);
00034         Kernel * kernel;
00035 };
00036 
00037 #endif