wns::events::scheduler::IEvent Class Reference

Base class for all scheduler events.

The IEvent is the base class for all event types that are used in all WNS scheduler.

#include <events/scheduler/IEvent.hpp>

Inheritance diagram for wns::events::scheduler::IEvent:

[legend]

Collaboration diagram for wns::events::scheduler::IEvent:

[legend]

List of all members.

Public Member Functions
virtual void	cancel ()=0
	Prefer this over wns::events::scheduler::Interface::cancelEvent().
virtual wns::simulator::Time	getIssued () const =0
virtual wns::simulator::Time	getScheduled () const =0
virtual bool	isCanceled () const =0
	Return true if the Event was canceled.
virtual bool	isFinished () const =0
	Return true if the Event was executed (no longer queued, no longer running).
virtual bool	isNotSubmitted () const =0
	Return true, if the Event is not submitted to the queue so far (initial state).
virtual bool	isQueued () const =0
	Return true if the Event is queued (waiting for execution).
virtual bool	isRunning () const =0
	Return true if the Event is currently being executed.
virtual	~IEvent ()
Protected Member Functions
virtual std::string	doToString () const
	Provides pythonic output.
Classes
class	CancelException
	If an event can be canceled this exception should be thrown by the event scheduler. More...

---

Detailed Description

Definition at line 46 of file IEvent.hpp.

---

Constructor & Destructor Documentation

IEvent::~IEvent

(

)

[virtual]

Definition at line 33 of file IEvent.cpp.

---

Member Function Documentation

virtual void wns::events::scheduler::IEvent::cancel

(

)

[pure 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

Implemented in wns::events::scheduler::Map::Event.

std::string IEvent::doToString

(

)

const [protected, virtual]

Provides the following (pythonic) output:

<mynamespace::MyClass instance at 0xb623bfd> 

Reimplemented from wns::PythonicOutput.

Definition at line 39 of file IEvent.cpp.

virtual wns::simulator::Time wns::events::scheduler::IEvent::getIssued

(

)

const [pure virtual]

Implemented in wns::events::scheduler::Map::Event.

virtual wns::simulator::Time wns::events::scheduler::IEvent::getScheduled

(

)

const [pure virtual]

Implemented in wns::events::scheduler::Map::Event.

virtual bool wns::events::scheduler::IEvent::isCanceled

(

)

const [pure virtual]

Implemented in wns::events::scheduler::Map::Event.

virtual bool wns::events::scheduler::IEvent::isFinished

(

)

const [pure virtual]

Implemented in wns::events::scheduler::Map::Event.

virtual bool wns::events::scheduler::IEvent::isNotSubmitted

(

)

const [pure virtual]

Implemented in wns::events::scheduler::Map::Event.

virtual bool wns::events::scheduler::IEvent::isQueued

(

)

const [pure virtual]

Implemented in wns::events::scheduler::Map::Event.

virtual bool wns::events::scheduler::IEvent::isRunning

(

)

const [pure virtual]

Implemented in wns::events::scheduler::Map::Event.

---

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

• framework/library/src/events/scheduler/IEvent.hpp
• framework/library/src/events/scheduler/IEvent.cpp