wns::events::scheduler::Map::Event Class Reference

#include <events/scheduler/Map.hpp>

Inheritance diagram for wns::events::scheduler::Map::Event:

[legend]

Collaboration diagram for wns::events::scheduler::Map::Event:

[legend]

List of all members.

Public Types
enum	State {   NotSubmitted, Queued, Running, Finished,   Canceled }
Public Member Functions
virtual void	cancel ()
	Prefer this over wns::events::scheduler::Interface::cancelEvent().
	Event (const Callable &callable)
wns::simulator::Time	getIssued () const
wns::simulator::Time	getScheduled () const
virtual bool	isCanceled () const
	Return true if the Event was canceled.
virtual bool	isFinished () const
	Return true if the Event was executed (no longer queued, no longer running).
virtual bool	isNotSubmitted () const
	Return true, if the Event is not submitted to the queue so far (initial state).
virtual bool	isQueued () const
	Return true if the Event is queued (waiting for execution).
virtual bool	isRunning () const
	Return true if the Event is currently being executed.
void	operator() ()
Public Attributes
Callable	callable_
wns::simulator::Time	issued_
wns::simulator::Time	scheduled_
Map *	scheduler_
State	state_

---

Detailed Description

Definition at line 58 of file Map.hpp.

---

Member Enumeration Documentation

enum wns::events::scheduler::Map::Event::State

Enumerator:

NotSubmitted
Queued
Running
Finished
Canceled

Definition at line 72 of file Map.hpp.

---

Constructor & Destructor Documentation

wns::events::scheduler::Map::Event::Event

(

const Callable &

callable

)

[inline]

Definition at line 63 of file Map.hpp.

---

Member Function Documentation

virtual void wns::events::scheduler::Map::Event::cancel

(

)

[inline, virtual]

This is likely to perform a little better, because we a) do not need to check if the event is NULL and b) we save a dynamic cast c) can call the specialized method of scheduler directly

Implements wns::events::scheduler::IEvent.

Definition at line 82 of file Map.hpp.

wns::simulator::Time wns::events::scheduler::Map::Event::getIssued

(

)

const [inline, virtual]

Implements wns::events::scheduler::IEvent.

Definition at line 130 of file Map.hpp.

wns::simulator::Time wns::events::scheduler::Map::Event::getScheduled

(

)

const [inline, virtual]

Implements wns::events::scheduler::IEvent.

Definition at line 124 of file Map.hpp.

virtual bool wns::events::scheduler::Map::Event::isCanceled

(

)

const [inline, virtual]

Implements wns::events::scheduler::IEvent.

Definition at line 112 of file Map.hpp.

virtual bool wns::events::scheduler::Map::Event::isFinished

(

)

const [inline, virtual]

Implements wns::events::scheduler::IEvent.

Definition at line 106 of file Map.hpp.

virtual bool wns::events::scheduler::Map::Event::isNotSubmitted

(

)

const [inline, virtual]

Implements wns::events::scheduler::IEvent.

Definition at line 88 of file Map.hpp.

virtual bool wns::events::scheduler::Map::Event::isQueued

(

)

const [inline, virtual]

Implements wns::events::scheduler::IEvent.

Definition at line 94 of file Map.hpp.

virtual bool wns::events::scheduler::Map::Event::isRunning

(

)

const [inline, virtual]

Implements wns::events::scheduler::IEvent.

Definition at line 100 of file Map.hpp.

void wns::events::scheduler::Map::Event::operator()

(

)

[inline]

Definition at line 118 of file Map.hpp.

---

Member Data Documentation

Callable wns::events::scheduler::Map::Event::callable_

Definition at line 135 of file Map.hpp.

wns::simulator::Time wns::events::scheduler::Map::Event::issued_

Definition at line 139 of file Map.hpp.

wns::simulator::Time wns::events::scheduler::Map::Event::scheduled_

Definition at line 137 of file Map.hpp.

Map* wns::events::scheduler::Map::Event::scheduler_

Definition at line 141 of file Map.hpp.

State wns::events::scheduler::Map::Event::state_

Definition at line 143 of file Map.hpp.

---

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

• framework/library/src/events/scheduler/Map.hpp