Mercurial > fife-parpg

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* 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
comparison
equal deleted inserted replaced
-1:000000000000 0:4a0efb7baf70
1 /***************************************************************************
2 * Copyright (C) 2005-2008 by the FIFE team *
3 * http://www.fifengine.de *
4 * This file is part of FIFE. *
5 * *
6 * FIFE is free software; you can redistribute it and/or modify *
7 * it under the terms of the GNU General Public License as published by *
8 * the Free Software Foundation; either version 2 of the License, or *
9 * (at your option) any later version. *
10 * *
11 * This program is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
14 * GNU General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU General Public License *
17 * along with this program; if not, write to the *
18 * Free Software Foundation, Inc., *
19 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA *
20 ***************************************************************************/
21
22 #ifndef FIFE_EVENTCHANNEL_COMMAND_H
23 #define FIFE_EVENTCHANNEL_COMMAND_H
24
25 // Standard C++ library includes
26 //
27
28 // 3rd party library includes
29 //
30
31 // FIFE includes
32 // These includes are split up in two parts, separated by one empty line
33 // First block: files included from the FIFE root src directory
34 // Second block: files included from the same folder
35 //
36 #include "eventchannel/base/ec_event.h"
37 #include "ec_commandids.h"
38
39 namespace FIFE {
40
41 /** Class for commands
42 * Commands are arbitrary events e.g. send from one subsystem to another
43 */
44 class Command: public Event {
45 public:
46 /** Constructor.
47 */
48 Command():
49 Event(),
50 m_commandtype(CMD_UNKNOWN),
51 m_code(0) {}
52
53 /** Destructor.
54 */
55 virtual ~Command() {}
56
57 /** Gets the type of this command
58 * @return type of this command
59 */
60 CommandType getCommandType() { return m_commandtype; }
61 void setCommandType(CommandType type) { m_commandtype = type; }
62
63 /** Gets the code of this command. Meaning of code depends on the command type
64 * @return code of this command
65 */
66 int getCode() { return m_code; }
67 void setCode(int code) { m_code = code; }
68
69 virtual void consume() { Event::consume(); }
70 virtual bool isConsumed() const { return Event::isConsumed(); }
71 virtual IEventSource* getSource() { return Event::getSource(); }
72 virtual void setSource(IEventSource* source) { Event::setSource(source); }
73 virtual gcn::Widget* getSourceWidget() { return Event::getSourceWidget(); }
74 virtual void setSourceWidget(gcn::Widget* widget) { Event::setSourceWidget(widget); }
75 virtual int getTimeStamp() const { return Event::getTimeStamp(); }
76 virtual void setTimeStamp(int timestamp ) { Event::setTimeStamp(timestamp); }
77
78 virtual const std::string& getName() const {
79 const static std::string eventName("Command");
80 return eventName;
81 }
82 virtual std::string getDebugString() const { return Event::getDebugString(); }
83
84
85 private:
86 CommandType m_commandtype;
87 int m_code;
88 void* m_data1;
89 void* m_data2;
90 };
91 } //FIFE
92
93 #endif