FIFE  2008.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Pages
ec_command.h
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 *
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/ec_event.h"
37 #include "ec_commandids.h"
38 
39 namespace FIFE {
40 
44  class Command: public Event {
45  public:
49  Event(),
50  m_commandtype(CMD_UNKNOWN),
51  m_code(0) {}
52 
55  virtual ~Command() {}
56 
60  CommandType getCommandType() const { return m_commandtype; }
61  void setCommandType(CommandType type) { m_commandtype = type; }
62 
66  int32_t getCode() const { return m_code; }
67  void setCode(int32_t 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 int32_t getTimeStamp() const { return Event::getTimeStamp(); }
74  virtual void setTimeStamp(int32_t timestamp ) { Event::setTimeStamp(timestamp); }
75 
76  virtual const std::string& getName() const {
77  const static std::string eventName("Command");
78  return eventName;
79  }
80  virtual std::string getDebugString() const { return Event::getDebugString(); }
81 
82 
83  private:
84  CommandType m_commandtype;
85  int32_t m_code;
86  void* m_data1;
87  void* m_data2;
88  };
89 } //FIFE
90 
91 #endif
virtual const std::string & getName() const
Definition: ec_command.h:76
virtual void consume()
Definition: ec_command.h:69
virtual bool isConsumed() const
Definition: ec_command.h:70
virtual void setSource(IEventSource *source)
Definition: ec_command.h:72
virtual void setSource(IEventSource *source)
Definition: ec_event.h:77
virtual std::string getDebugString() const
Definition: ec_event.h:106
virtual int32_t getTimeStamp() const
Definition: ec_command.h:73
virtual void setTimeStamp(int32_t timestamp)
Definition: ec_command.h:74
virtual IEventSource * getSource() const
Definition: ec_event.h:73
virtual int32_t getTimeStamp() const
Definition: ec_event.h:81
CommandType getCommandType() const
Definition: ec_command.h:60
virtual ~Command()
Definition: ec_command.h:55
virtual void setTimeStamp(int32_t timestamp)
Definition: ec_event.h:85
virtual std::string getDebugString() const
Definition: ec_command.h:80
virtual void consume()
Definition: ec_event.h:64
int32_t getCode() const
Definition: ec_command.h:66
virtual bool isConsumed() const
Definition: ec_event.h:69