Debian Codegraph @

engine/core/eventchannel/command/command.h

raw
1 /***************************************************************************
2 * Copyright (C) 2005-2019 by the FIFE team *
3 * http://www.fifengine.net *
4 * This file is part of FIFE. *
5 * *
6 * FIFE is free software; you can redistribute it and/or *
7 * modify it under the terms of the GNU Lesser General Public *
8 * License as published by the Free Software Foundation; either *
9 * version 2.1 of the License, or (at your option) any later version. *
10 * *
11 * This library 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 GNU *
14 * Lesser General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU Lesser General Public *
17 * License along with this library; if not, write to the *
18 * Free Software Foundation, Inc., *
19 * 51 Franklin Street, 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/event.h"
37 #include "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() const { return m_commandType; }
61
62 /** Sets the type of this command
63 */
64 void setCommandType(CommandType type) { m_commandType = type; }
65
66 /** Gets the code of this command. Meaning of code depends on the command type
67 * @return code of this command
68 */
69 int32_t getCode() const { return m_code; }
70
71 /** Sets the code of this command. Meaning of code depends on the command type
72 */
73 void setCode(int32_t code) { m_code = code; }
74
75 /** Marks events as consumed.
76 */
77 virtual void consume() { Event::consume(); }
78
79 /** Checks whether event is consumed.
80 */
81 virtual bool isConsumed() const { return Event::isConsumed(); }
82
83 /** Gets the source of the event.
84 */
85 virtual IEventSource* getSource() const { return Event::getSource(); }
86
87 /** Sets the source of the event.
88 */
89 virtual void setSource(IEventSource* source) { Event::setSource(source); }
90
91 /** Gets the timestamp of the event.
92 */
93 virtual int32_t getTimeStamp() const { return Event::getTimeStamp(); }
94
95 /** Sets the timestamp of the event.
96 */
97 virtual void setTimeStamp(int32_t timestamp ) { Event::setTimeStamp(timestamp); }
98
99 /** Gets the name of the event.
100 */
101 virtual const std::string& getName() const {
102 const static std::string eventName("Command");
103 return eventName;
104 }
105
106 /** Gets the debugstring of the event.
107 */
108 virtual std::string getDebugString() const { return Event::getDebugString(); }
109
110 private:
111 CommandType m_commandType;
112 int32_t m_code;
113 };
114 } //FIFE
115
116 #endif