yasmine
sxy::specialized_event< _concrete_event, _event_id, _event_priority > Class Template Reference

Class that inherits event_impl and provides a fixed event ID and priority as well as create methods for creating instances of the event. More...

#include <specialized_event.hpp>

Inheritance diagram for sxy::specialized_event< _concrete_event, _event_id, _event_priority >:
sxy::event_impl sxy::event

Public Member Functions

 specialized_event (const std::string _name=std::string())
 Constructor. More...
 
virtual ~specialized_event () SX_NOEXCEPT SX_OVERRIDE
 
virtual std::string get_name () const SX_OVERRIDE
 Getter for event's name. More...
 
virtual sxy::event_id get_id () const SX_OVERRIDE
 Getter for event's ID. More...
 
- Public Member Functions inherited from sxy::event_impl
 event_impl (const event_id _event_id, const event_priority _event_priority=DEFAULT_EVENT_PRIORITY)
 
virtual ~event_impl () SX_NOEXCEPT SX_OVERRIDE
 
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 constexpr sxy::event_id get_event_id ()
 Static getter for event's ID. More...
 
template<typename ... _param_types>
static sxe::shared_ptr< _concrete_event > create (_param_types... args)
 Method for creating an event with its parameters. More...
 
- Static Public Member Functions inherited from sxy::event_impl
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

template<class _concrete_event, sxy::event_id _event_id, sxy::event_priority _event_priority = DEFAULT_EVENT_PRIORITY>
class sxy::specialized_event< _concrete_event, _event_id, _event_priority >

Class that inherits event_impl and provides a fixed event ID and priority as well as create methods for creating instances of the event.

Constructor & Destructor Documentation

◆ specialized_event()

template<class _concrete_event, sxy::event_id _event_id, sxy::event_priority _event_priority = DEFAULT_EVENT_PRIORITY>
sxy::specialized_event< _concrete_event, _event_id, _event_priority >::specialized_event ( const std::string  _name = std::string())
inlineexplicit

Constructor.

◆ ~specialized_event()

template<class _concrete_event, sxy::event_id _event_id, sxy::event_priority _event_priority = DEFAULT_EVENT_PRIORITY>
virtual sxy::specialized_event< _concrete_event, _event_id, _event_priority >::~specialized_event ( )
inlinevirtual

Member Function Documentation

◆ create()

template<class _concrete_event, sxy::event_id _event_id, sxy::event_priority _event_priority = DEFAULT_EVENT_PRIORITY>
template<typename ... _param_types>
static sxe::shared_ptr< _concrete_event > sxy::specialized_event< _concrete_event, _event_id, _event_priority >::create ( _param_types...  args)
inlinestatic

Method for creating an event with its parameters.

Returns
The created event.

◆ get_event_id()

template<class _concrete_event, sxy::event_id _event_id, sxy::event_priority _event_priority = DEFAULT_EVENT_PRIORITY>
static constexpr sxy::event_id sxy::specialized_event< _concrete_event, _event_id, _event_priority >::get_event_id ( )
inlinestatic

Static getter for event's ID.

Returns
ID of the event.Static method for creating an event

◆ get_id()

template<class _concrete_event, sxy::event_id _event_id, sxy::event_priority _event_priority = DEFAULT_EVENT_PRIORITY>
virtual sxy::event_id sxy::specialized_event< _concrete_event, _event_id, _event_priority >::get_id ( ) const
inlinevirtual

Getter for event's ID.

Returns
ID of the event.

Reimplemented from sxy::event_impl.

◆ get_name()

template<class _concrete_event, sxy::event_id _event_id, sxy::event_priority _event_priority = DEFAULT_EVENT_PRIORITY>
virtual std::string sxy::specialized_event< _concrete_event, _event_id, _event_priority >::get_name ( ) const
inlinevirtual

Getter for event's name.

Returns
Name of the event.

Reimplemented from sxy::event_impl.


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