RTXI  3.0.0
The Real-Time eXperiment Interface Reference Manual
Public Member Functions
Event::Handler Class Referenceabstract

#include <event.hpp>

Inheritance diagram for Event::Handler:
Inheritance graph
Collaboration diagram for Event::Handler:
Collaboration graph

Public Member Functions

 Handler ()=default
 
 Handler (const Handler &)=default
 
 Handler (Handler &&)=delete
 
Handleroperator= (const Handler &)=default
 
Handleroperator= (Handler &&)=delete
 
virtual ~Handler ()=default
 
virtual void receiveEvent (Object *event)=0
 

Detailed Description

Entity that is signaled when an event is posted.

This is an interface that allows rtxi components and plugins to define how they receive those events. All objects that hope to interact within the rtxi environment with other objects in a non-realtime context must inherit this base class.

See also
Event::Manager::postEvent()

Definition at line 227 of file event.hpp.

Constructor & Destructor Documentation

◆ Handler() [1/3]

Event::Handler::Handler()
default

◆ Handler() [2/3]

Event::Handler::Handler(const Handler)
default

◆ Handler() [3/3]

Event::Handler::Handler(Handler && )
delete

◆ ~Handler()

virtual Event::Handler::~Handler()
virtualdefault

Member Function Documentation

◆ operator=() [1/2]

Handler& Event::Handler::operator=(const Handler)
default

◆ operator=() [2/2]

Handler& Event::Handler::operator=(Handler && )
delete

◆ receiveEvent()

virtual void Event::Handler::receiveEvent(Objectevent)
pure virtual

Function that is called in non-realtime every time an non-realtime event is posted.

Parameters
eventThe the event being posted.
See also
Event::Object
Event::Manager::postEvent()

Implemented in Workspace::Manager, Widgets::Plugin, RT::System, Oscilloscope::Plugin, DataRecorder::Plugin, and Connector::Plugin.


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