Diff: libs/Module.h

Revision:

0:31e91bb0ef3c

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/libs/Module.h	Tue Jul 31 21:11:18 2012 +0000
@@ -0,0 +1,37 @@
+/*  
+      This file is part of Smoothie (http://smoothieware.org/). The motion control part is heavily based on Grbl (https://github.com/simen/grbl).
+      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.
+      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.
+      You should have received a copy of the GNU General Public License along with Smoothie. If not, see <http://www.gnu.org/licenses/>. 
+*/
+
+#ifndef MODULE_H
+#define MODULE_H
+
+#include <string>
+using std::string;
+
+// Module base class
+// All modules must extend this class, see http://smoothieware.org/moduleexample 
+class Kernel;
+class Module {
+    public:
+        Module();
+        virtual void on_module_loaded();
+        virtual void register_for_event(int event_id);
+        virtual void on_main_loop(void * argument);
+        virtual void on_console_line_received(  void * argument);
+        virtual void on_gcode_received(         void * argument);
+        virtual void on_gcode_execute(          void * argument);
+        virtual void on_stepper_wake_up(        void * argument);
+        virtual void on_speed_change(           void * argument);
+        virtual void on_block_begin(            void * argument);
+        virtual void on_block_end(              void * argument);
+        virtual void on_config_reload(          void * argument);
+        virtual void on_play(                   void * argument);
+        virtual void on_pause(                  void * argument);
+        virtual void on_idle(                   void * argument);
+        Kernel * kernel;
+};
+
+#endif