diff engine/core/eventchannel/command/ec_command.h @ 0:4a0efb7baf70

* Datasets becomes the new trunk and retires after that :-)
author mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
date Sun, 29 Jun 2008 18:44:17 +0000
parents
children 90005975cdbb
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/engine/core/eventchannel/command/ec_command.h	Sun Jun 29 18:44:17 2008 +0000
@@ -0,0 +1,93 @@
+/***************************************************************************
+ *   Copyright (C) 2005-2008 by the FIFE team                              *
+ *   http://www.fifengine.de                                               *
+ *   This file is part of FIFE.                                            *
+ *                                                                         *
+ *   FIFE 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 2 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, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA              *
+ ***************************************************************************/
+
+#ifndef FIFE_EVENTCHANNEL_COMMAND_H
+#define FIFE_EVENTCHANNEL_COMMAND_H
+
+// Standard C++ library includes
+//
+
+// 3rd party library includes
+//
+
+// FIFE includes
+// These includes are split up in two parts, separated by one empty line
+// First block: files included from the FIFE root src directory
+// Second block: files included from the same folder
+//
+#include "eventchannel/base/ec_event.h"
+#include "ec_commandids.h"
+
+namespace FIFE {
+
+	/**  Class for commands
+	 * Commands are arbitrary events e.g. send from one subsystem to another
+	 */
+	class Command: public Event {
+	public:
+		/** Constructor.
+		 */
+		Command(): 
+			Event(),
+			m_commandtype(CMD_UNKNOWN), 
+			m_code(0) {}
+
+		/** Destructor.
+		 */
+		virtual ~Command() {}
+
+		/** Gets the type of this command
+		 * @return type of this command
+		 */
+		CommandType getCommandType() { return m_commandtype; }
+		void setCommandType(CommandType type) { m_commandtype = type; }
+
+		/** Gets the code of this command. Meaning of code depends on the command type
+		 * @return code of this command
+		 */
+		int getCode() { return m_code; }
+		void setCode(int code) { m_code = code; }
+
+		virtual void consume() { Event::consume(); }
+		virtual bool isConsumed() const { return Event::isConsumed(); }
+		virtual IEventSource* getSource() { return Event::getSource(); }
+		virtual void setSource(IEventSource* source) { Event::setSource(source); }
+		virtual gcn::Widget* getSourceWidget() { return Event::getSourceWidget(); }
+		virtual void setSourceWidget(gcn::Widget* widget) { Event::setSourceWidget(widget); }
+		virtual int getTimeStamp() const { return Event::getTimeStamp(); }
+		virtual void setTimeStamp(int timestamp ) { Event::setTimeStamp(timestamp); }
+
+		virtual const std::string& getName() const {
+			const static std::string eventName("Command");
+			return eventName;
+		}
+		virtual std::string getDebugString() const { return Event::getDebugString(); }
+
+
+	private:
+		CommandType m_commandtype;
+		int m_code;
+		void* m_data1;
+		void* m_data2;
+	};
+} //FIFE
+
+#endif