peak::core::EventSupportingModule Class Reference

The base class for all modules being able to raise events. More...

#include <peak/common/peak_event_supporting_module.hpp>

Inheritance diagram for peak::core::EventSupportingModule:

Public Member Functions
	EventSupportingModule ()=default
	~EventSupportingModule () override=default
	EventSupportingModule (const EventSupportingModule &other)=delete
EventSupportingModule &	operator= (const EventSupportingModule &other)=delete
	EventSupportingModule (EventSupportingModule &&other)=delete
EventSupportingModule &	operator= (EventSupportingModule &&other)=delete
std::unique_ptr< EventController >	EnableEvents (EventType type)
	Enables events of the given event type. More...
Public Member Functions inherited from peak::core::Module
	Module ()=default
virtual	~Module ()=default
	Module (const Module &other)=delete
Module &	operator= (const Module &other)=delete
	Module (Module &&other)=delete
Module &	operator= (Module &&other)=delete
std::vector< std::shared_ptr< NodeMap > >	NodeMaps () const
	Returns the module's node maps. More...
std::shared_ptr< class Port >	Port () const
	Returns the module's port. More...

Protected Member Functions
virtual PEAK_EVENT_SUPPORTING_MODULE_HANDLE	EventSupportingModuleHandle () const =0
Protected Member Functions inherited from peak::core::Module
virtual PEAK_MODULE_HANDLE	ModuleHandle () const =0

Detailed Description

The base class for all modules being able to raise events.

This class generalizes all modules supporting events (System, Interface, Device, DataStream, Buffer).

Constructor & Destructor Documentation

EventSupportingModule() [1/3]

peak::core::EventSupportingModule::EventSupportingModule ( )

default

~EventSupportingModule()

peak::core::EventSupportingModule::~EventSupportingModule ( )

overridedefault

EventSupportingModule() [2/3]

peak::core::EventSupportingModule::EventSupportingModule ( const EventSupportingModule &  other )

delete

EventSupportingModule() [3/3]

peak::core::EventSupportingModule::EventSupportingModule ( EventSupportingModule &&  other )

delete

Member Function Documentation

EnableEvents()

std::unique_ptr< EventController > peak::core::EventSupportingModule::EnableEvents ( EventType  type )

inline

Enables events of the given event type.

Parameters

[in]

type

The event type to enable.

Returns

Event controller for the given event type

Since

1.0

Exceptions

BadAccessException	Event is already enabled.
InternalErrorException	An internal error has occurred.

EventSupportingModuleHandle()

virtual PEAK_EVENT_SUPPORTING_MODULE_HANDLE peak::core::EventSupportingModule::EventSupportingModuleHandle ( ) const

protectedpure virtual

operator=() [1/2]

EventSupportingModule& peak::core::EventSupportingModule::operator= ( const EventSupportingModule &  other )

delete

operator=() [2/2]

EventSupportingModule& peak::core::EventSupportingModule::operator= ( EventSupportingModule &&  other )

delete

---

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

• peak/common/peak_event_supporting_module.hpp