FIFE  2008.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Pages
Public Member Functions
FIFE::Command Class Reference

#include <ec_command.h>

Inheritance diagram for FIFE::Command:
Inheritance graph
Collaboration diagram for FIFE::Command:
Collaboration graph

List of all members.

Public Member Functions

 Command ()
virtual ~Command ()
CommandType getCommandType () const
int getCode () const
virtual void consume ()
virtual bool isConsumed () const
virtual void setSource (IEventSource *source)
virtual int getTimeStamp () const
virtual void setTimeStamp (int timestamp)
virtual const std::string & getName () const
virtual std::string getDebugString () const
- Public Member Functions inherited from FIFE::Event
 Event ()
virtual ~Event ()
virtual IEventSource * getSource () const
virtual std::string getAttrStr () const

Detailed Description

Class for commands Commands are arbitrary events e.g. send from one subsystem to another

Definition at line 44 of file ec_command.h.

Constructor & Destructor Documentation

FIFE::Command::Command ( )
inline

Constructor.

Definition at line 48 of file ec_command.h.

virtual FIFE::Command::~Command ( )
inlinevirtual

Destructor.

Definition at line 55 of file ec_command.h.

Member Function Documentation

virtual void FIFE::Command::consume ( )
inlinevirtual

Marks the event as consumed.

Reimplemented from FIFE::Event.

Definition at line 69 of file ec_command.h.

int FIFE::Command::getCode ( ) const
inline

Gets the code of this command. Meaning of code depends on the command type

Returns:
code of this command

Definition at line 66 of file ec_command.h.

CommandType FIFE::Command::getCommandType ( ) const
inline

Gets the type of this command

Returns:
type of this command

Definition at line 60 of file ec_command.h.

virtual std::string FIFE::Command::getDebugString ( ) const
inlinevirtual

Gets the debugstring of the event

Reimplemented from FIFE::Event.

Definition at line 80 of file ec_command.h.

virtual const std::string& FIFE::Command::getName ( ) const
inlinevirtual

Gets the name of the event

Reimplemented from FIFE::Event.

Definition at line 76 of file ec_command.h.

virtual int FIFE::Command::getTimeStamp ( ) const
inlinevirtual

Gets the timestamp of the event

Reimplemented from FIFE::Event.

Definition at line 73 of file ec_command.h.

virtual bool FIFE::Command::isConsumed ( ) const
inlinevirtual

Checks if the event is consumed.

Returns:
true if the event is consumed, false otherwise.

Reimplemented from FIFE::Event.

Definition at line 70 of file ec_command.h.

Referenced by FIFE::EventManager::dispatchCommand().

Here is the caller graph for this function:

virtual void FIFE::Command::setSource ( IEventSource *  source)
inlinevirtual

Sets the source of the event.

Reimplemented from FIFE::Event.

Definition at line 72 of file ec_command.h.

Referenced by FIFE::EventManager::processEvents().

Here is the caller graph for this function:

virtual void FIFE::Command::setTimeStamp ( int  timestamp)
inlinevirtual

Sets the timestamp of the event

Reimplemented from FIFE::Event.

Definition at line 74 of file ec_command.h.

The documentation for this class was generated from the following file: