sxy::event_impl Class Reference

Events that are processed by the state machine. An event can have an ID, a name and a priority (for processing by the async state machine). More...

#include <event_impl.hpp>

Inheritance diagram for sxy::event_impl:

Public Member Functions
	event_impl (const event_id _event_id, const event_priority _event_priority=DEFAULT_EVENT_PRIORITY)
virtual	~event_impl () SX_NOEXCEPT SX_OVERRIDE
virtual event_id	get_id () const SX_OVERRIDE
	Getter of event's ID. More...
virtual std::string	get_name () const SX_OVERRIDE
	Getter of event's name. More...
virtual event_priority	get_priority () const SX_OVERRIDE
	Getter of event's priority. More...
virtual bool	operator> (const event &_rhs) const SX_OVERRIDE
	Method for comparing the priorities between the current event and a given event. More...
Public Member Functions inherited from sxy::event
	event ()
virtual	~event () SX_NOEXCEPT

Static Public Member Functions
static event_sptr	create (const event_id _event_id, const event_priority _event_priority=DEFAULT_EVENT_PRIORITY)
	Static method for creating an event with the given ID and a priority. has DEFAULT_EVENT_PRIORITY as default value. More...

Detailed Description

Events that are processed by the state machine. An event can have an ID, a name and a priority (for processing by the async state machine).

Constructor & Destructor Documentation

event_impl()

sxy::event_impl::event_impl ( const event_id  _event_id, const event_priority  _event_priority = DEFAULT_EVENT_PRIORITY  )

explicit

~event_impl()

sxy::event_impl::~event_impl ( )

virtual

Member Function Documentation

create()

event_sptr sxy::event_impl::create ( const event_id  _event_id, const event_priority  _event_priority = DEFAULT_EVENT_PRIORITY  )

static

Static method for creating an event with the given ID and a priority. has DEFAULT_EVENT_PRIORITY as default value.

Parameters

_event_id	ID of the event that is created.
_event_priority	Priority of the event that is created. DEFAULT_EVENT_PRIORITY is the default value.

Returns

The created event.

get_id()

event_id sxy::event_impl::get_id ( ) const

virtual

Getter of event's ID.

Returns

ID of event.

Implements sxy::event.

Reimplemented in sxy::specialized_event< _concrete_event, _event_id, _event_priority >, and sxy::specialized_event< completion_event, Y_COMPLETION_EVENT_ID, sxy::DEFAULT_EVENT_PRIORITY >.

get_name()

std::string sxy::event_impl::get_name ( ) const

virtual

Getter of event's name.

Returns

Name of event.

Implements sxy::event.

Reimplemented in sxy::specialized_event< _concrete_event, _event_id, _event_priority >, and sxy::specialized_event< completion_event, Y_COMPLETION_EVENT_ID, sxy::DEFAULT_EVENT_PRIORITY >.

get_priority()

event_priority sxy::event_impl::get_priority ( ) const

virtual

Getter of event's priority.

Returns

Priority of event.

Implements sxy::event.

operator>()

bool sxy::event_impl::operator> ( const event &  _rhs ) const

virtual

Method for comparing the priorities between the current event and a given event.

Parameters

_rhs	Reference to an event whose priority is compared with the current event's priority.

Returns

True if the current event has a greater priority, else false.

Implements sxy::event.

---

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

• event_impl.hpp
• event_impl.cpp