FIFE  6e1afdbeda11afe9ac53e6023a4be96ef88f1dc6
command.h
Go to the documentation of this file.
1 /***************************************************************************
2  * Copyright (C) 2005-2017 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 //
37 #include "commandids.h"
38 
39 namespace FIFE {
40 
44  class Command: public Event {
45  public:
49  Event(),
51  m_code(0) {}
52 
55  virtual ~Command() {}
56 
61 
64  void setCommandType(CommandType type) { m_commandType = type; }
65 
69  int32_t getCode() const { return m_code; }
70 
73  void setCode(int32_t code) { m_code = code; }
74 
77  virtual void consume() { Event::consume(); }
78 
81  virtual bool isConsumed() const { return Event::isConsumed(); }
82 
85  virtual IEventSource* getSource() const { return Event::getSource(); }
86 
89  virtual void setSource(IEventSource* source) { Event::setSource(source); }
90 
93  virtual int32_t getTimeStamp() const { return Event::getTimeStamp(); }
94 
97  virtual void setTimeStamp(int32_t timestamp ) { Event::setTimeStamp(timestamp); }
98 
101  virtual const std::string& getName() const {
102  const static std::string eventName("Command");
103  return eventName;
104  }
105 
108  virtual std::string getDebugString() const { return Event::getDebugString(); }
109 
110  private:
112  int32_t m_code;
113  };
114 } //FIFE
115 
116 #endif
virtual const std::string & getName() const
Gets the name of the event.
Definition: command.h:101
virtual void consume()
Marks events as consumed.
Definition: command.h:77
virtual bool isConsumed() const
Checks whether event is consumed.
Definition: command.h:81
CommandType m_commandType
Definition: command.h:111
int32_t m_code
Definition: command.h:112
virtual void setSource(IEventSource *source)
Sets the source of the event.
Definition: command.h:89
virtual void setSource(IEventSource *source)
Sets the source of the event.
Definition: event.h:77
CommandType
Types for different commands.
Definition: commandids.h:41
Base class for all events.
Definition: event.h:49
virtual std::string getDebugString() const
Gets the debugstring of the event.
Definition: event.h:106
virtual int32_t getTimeStamp() const
Gets the timestamp of the event.
Definition: command.h:93
virtual void setTimeStamp(int32_t timestamp)
Sets the timestamp of the event.
Definition: command.h:97
virtual IEventSource * getSource() const
Gets the source of the event.
Definition: event.h:73
virtual int32_t getTimeStamp() const
Gets the timestamp of the event.
Definition: event.h:81
Class for commands Commands are arbitrary events e.g.
Definition: command.h:44
Command()
Constructor.
Definition: command.h:48
CommandType getCommandType() const
Gets the type of this command.
Definition: command.h:60
void setCommandType(CommandType type)
Sets the type of this command.
Definition: command.h:64
void setCode(int32_t code)
Sets the code of this command.
Definition: command.h:73
virtual ~Command()
Destructor.
Definition: command.h:55
virtual void setTimeStamp(int32_t timestamp)
Sets the timestamp of the event.
Definition: event.h:85
virtual std::string getDebugString() const
Gets the debugstring of the event.
Definition: command.h:108
virtual IEventSource * getSource() const
Gets the source of the event.
Definition: command.h:85
Representation of event source (a thing sending events)
Definition: ieventsource.h:42
virtual void consume()
Marks the event as consumed.
Definition: event.h:64
int32_t getCode() const
Gets the code of this command.
Definition: command.h:69
virtual bool isConsumed() const
Checks if the event is consumed.
Definition: event.h:69