RTXI  3.0.0
The Real-Time eXperiment Interface Reference Manual
Data Structures | Enumerations | Functions
Event Namespace Reference

Data Structures

class  Object
 
class  Handler
 
class  Manager
 

Enumerations

enum  Type {
  RT_PERIOD_EVENT = 0 , RT_PREPERIOD_EVENT , RT_POSTPERIOD_EVENT , RT_GET_PERIOD_EVENT ,
  RT_THREAD_INSERT_EVENT , RT_THREAD_REMOVE_EVENT , RT_THREAD_PAUSE_EVENT , RT_THREAD_UNPAUSE_EVENT ,
  RT_DEVICE_INSERT_EVENT , RT_DEVICE_REMOVE_EVENT , RT_DEVICE_PAUSE_EVENT , RT_DEVICE_UNPAUSE_EVENT ,
  RT_WIDGET_PARAMETER_CHANGE_EVENT , RT_WIDGET_STATE_CHANGE_EVENT , RT_SHUTDOWN_EVENT , IO_LINK_INSERT_EVENT ,
  IO_LINK_REMOVE_EVENT , IO_BLOCK_QUERY_EVENT , IO_BLOCK_OUTPUTS_QUERY_EVENT , IO_CONNECTION_QUERY_EVENT ,
  IO_ALL_CONNECTIONS_QUERY_EVENT , PLUGIN_INSERT_EVENT , PLUGIN_REMOVE_EVENT , DAQ_DEVICE_QUERY_EVENT ,
  SETTINGS_OBJECT_INSERT_EVENT , SETTINGS_OBJECT_REMOVE_EVENT , OPEN_FILE_EVENT , START_RECORDING_EVENT ,
  STOP_RECORDING_EVENT , ASYNC_DATA_EVENT , THRESHOLD_CROSSING_EVENT , START_GENICAM_RECORDING_EVENT ,
  PAUSE_GENICAM_RECORDING_EVENT , STOP_GENICAM_RECORDING_EVENT , GENICAM_SNAPSHOT_EVENT , GENERIC_WIDGET_EVENT ,
  MANAGER_SHUTDOWN_EVENT , NOOP
}
 

Functions

std::string type_to_string (Type event_type)
 

Detailed Description

Event Oriented Classes

Objects contained within this namespace are responsible for dispatching signals.

All RTXI plugins and managers use the event system to communicate with each other. The RT::System also uses the event system to change it's own state, although it internally changes the format to account for transmitting information to the real-time thread.

Enumeration Type Documentation

◆ Type

All possible event types are enumerated here

Enumerator
RT_PERIOD_EVENT 
RT_PREPERIOD_EVENT 
RT_POSTPERIOD_EVENT 
RT_GET_PERIOD_EVENT 
RT_THREAD_INSERT_EVENT 
RT_THREAD_REMOVE_EVENT 
RT_THREAD_PAUSE_EVENT 
RT_THREAD_UNPAUSE_EVENT 
RT_DEVICE_INSERT_EVENT 
RT_DEVICE_REMOVE_EVENT 
RT_DEVICE_PAUSE_EVENT 
RT_DEVICE_UNPAUSE_EVENT 
RT_WIDGET_PARAMETER_CHANGE_EVENT 
RT_WIDGET_STATE_CHANGE_EVENT 
RT_SHUTDOWN_EVENT 
IO_LINK_INSERT_EVENT 
IO_LINK_REMOVE_EVENT 
IO_BLOCK_QUERY_EVENT 
IO_BLOCK_OUTPUTS_QUERY_EVENT 
IO_CONNECTION_QUERY_EVENT 
IO_ALL_CONNECTIONS_QUERY_EVENT 
PLUGIN_INSERT_EVENT 
PLUGIN_REMOVE_EVENT 
DAQ_DEVICE_QUERY_EVENT 
SETTINGS_OBJECT_INSERT_EVENT 
SETTINGS_OBJECT_REMOVE_EVENT 
OPEN_FILE_EVENT 
START_RECORDING_EVENT 
STOP_RECORDING_EVENT 
ASYNC_DATA_EVENT 
THRESHOLD_CROSSING_EVENT 
START_GENICAM_RECORDING_EVENT 
PAUSE_GENICAM_RECORDING_EVENT 
STOP_GENICAM_RECORDING_EVENT 
GENICAM_SNAPSHOT_EVENT 
GENERIC_WIDGET_EVENT 
MANAGER_SHUTDOWN_EVENT 
NOOP 

Definition at line 54 of file event.hpp.

Function Documentation

◆ type_to_string()

std::string Event::type_to_string(Event::Type event_type)

converts the event type to a human readable name of event

Parameters
event_typetype of event that was emitted
Returns
A string representation of the event type

Definition at line 30 of file event.cpp.