User Manual, Developers Guide and API Documentation

wns::events::scheduler::CommandQueue::Command Class Reference

internal representation of ICommand More...

Inheritance diagram for wns::events::scheduler::CommandQueue::Command:

Inheritance graph
[legend]
Collaboration diagram for wns::events::scheduler::CommandQueue::Command:

Collaboration graph
[legend]

List of all members.

Public Types

enum  State {
  NotSubmitted, Queued, Running, Finished,
  Canceled
}

Public Member Functions

 Command (const wns::events::scheduler::Callable &callable)
virtual bool isCanceled () const
 Return true if the Command was canceled.
virtual bool isFinished () const
 Return true if the Command was executed (no longer queued, no longer running).
virtual bool isNotSubmitted () const
 Return true, if the Command is not submitted to the queue so far (initial state).
virtual bool isQueued () const
 Return true if the Command is queued (waiting for execution).
virtual bool isRunning () const
 Return true if the Command is currently being executed.
void operator() ()
 forward call to callable

Public Attributes

wns::events::scheduler::Callable callable_
State state_


Detailed Description

All members are public since this is a private class of the CommandQueue and thus cannot be accessed from outside.

Definition at line 96 of file CommandQueue.hpp.


Member Enumeration Documentation

Enumerator:
NotSubmitted 
Queued 
Running 
Finished 
Canceled 

Definition at line 116 of file CommandQueue.hpp.


Constructor & Destructor Documentation

wns::events::scheduler::CommandQueue::Command::Command ( const wns::events::scheduler::Callable callable  )  [inline]

Definition at line 101 of file CommandQueue.hpp.


Member Function Documentation

virtual bool wns::events::scheduler::CommandQueue::Command::isCanceled (  )  const [inline, virtual]

Implements wns::events::scheduler::ICommand.

Definition at line 149 of file CommandQueue.hpp.

virtual bool wns::events::scheduler::CommandQueue::Command::isFinished (  )  const [inline, virtual]

Implements wns::events::scheduler::ICommand.

Definition at line 143 of file CommandQueue.hpp.

virtual bool wns::events::scheduler::CommandQueue::Command::isNotSubmitted (  )  const [inline, virtual]

Implements wns::events::scheduler::ICommand.

Definition at line 125 of file CommandQueue.hpp.

virtual bool wns::events::scheduler::CommandQueue::Command::isQueued (  )  const [inline, virtual]

Implements wns::events::scheduler::ICommand.

Definition at line 131 of file CommandQueue.hpp.

virtual bool wns::events::scheduler::CommandQueue::Command::isRunning (  )  const [inline, virtual]

Implements wns::events::scheduler::ICommand.

Definition at line 137 of file CommandQueue.hpp.

void wns::events::scheduler::CommandQueue::Command::operator() (  )  [inline]

Definition at line 111 of file CommandQueue.hpp.


Member Data Documentation

Definition at line 154 of file CommandQueue.hpp.

Definition at line 156 of file CommandQueue.hpp.


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

Generated on Sat May 26 03:32:53 2012 for openWNS by  doxygen 1.5.5