Public Member Functions

FIFE::Command Class Reference

#include <ec_command.h>

Inheritance diagram for FIFE::Command:
Inheritance graph
[legend]
Collaboration diagram for FIFE::Command:
Collaboration graph
[legend]

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 void setSourceWidget (gcn::Widget *widget)
virtual int getTimeStamp () const
virtual void setTimeStamp (int timestamp)
virtual const std::string & getName () const
virtual std::string getDebugString () const

Detailed Description

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

Definition at line 43 of file ec_command.h.


Constructor & Destructor Documentation

FIFE::Command::Command (  )  [inline]

Constructor.

Definition at line 42 of file ec_command.h.

virtual FIFE::Command::~Command (  )  [inline, virtual]

Destructor.

Definition at line 49 of file ec_command.h.


Member Function Documentation

virtual void FIFE::Command::consume (  )  [inline, virtual]

Marks the event as consumed.

Reimplemented from FIFE::Event.

Definition at line 63 of file ec_command.h.

Referenced by getTimeStamp().

Here is the caller graph for this function:

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 60 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 54 of file ec_command.h.

virtual std::string FIFE::Command::getDebugString (  )  const [inline, virtual]

Gets the debugstring of the event

Reimplemented from FIFE::Event.

Definition at line 76 of file ec_command.h.

References setTimeStamp().

virtual const std::string& FIFE::Command::getName (  )  const [inline, virtual]

Gets the name of the event

Reimplemented from FIFE::Event.

Definition at line 72 of file ec_command.h.

References setSource().

virtual int FIFE::Command::getTimeStamp (  )  const [inline, virtual]

Gets the timestamp of the event

Reimplemented from FIFE::Event.

Definition at line 69 of file ec_command.h.

References consume().

virtual bool FIFE::Command::isConsumed (  )  const [inline, virtual]

Checks if the event is consumed.

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

Reimplemented from FIFE::Event.

Definition at line 64 of file ec_command.h.

Referenced by FIFE::EventManager::dispatchCommand(), and setTimeStamp().

Here is the caller graph for this function:

virtual void FIFE::Command::setSource ( IEventSource source  )  [inline, virtual]

Sets the source of the event.

Reimplemented from FIFE::Event.

Definition at line 66 of file ec_command.h.

Referenced by getName(), and FIFE::EventManager::processEvents().

Here is the caller graph for this function:

virtual void FIFE::Command::setSourceWidget ( gcn::Widget *  widget  )  [inline, virtual]

Set the source of the (widget) event.

See also:
getSourceWidget

Reimplemented from FIFE::Event.

Definition at line 68 of file ec_command.h.

virtual void FIFE::Command::setTimeStamp ( int  timestamp  )  [inline, virtual]

Sets the timestamp of the event

Reimplemented from FIFE::Event.

Definition at line 70 of file ec_command.h.

References isConsumed().

Referenced by getDebugString().

Here is the caller graph for this function:


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