RTXI  2.4
The Real-Time eXperiment Interface Documentation
Public Member Functions | Static Public Attributes
Event::Object Class Reference

#include <event.h>

Inheritance diagram for Event::Object:
Inheritance graph
Collaboration diagram for Event::Object:
Collaboration graph

Public Member Functions

 Object (const char *)
 
 ~Object (void)
 
const char * getName (void) const
 
void * getParam (const char *) const
 
void setParam (const char *, void *)
 

Static Public Attributes

const static size_t MAX_PARAMS = 8
 

Detailed Description

Definition at line 128 of file event.h.

Constructor & Destructor Documentation

◆ Object()

Event::Object::Object(const char * nam)

Definition at line 74 of file event.cpp.

◆ ~Object()

Event::Object::~Object(void )

Definition at line 79 of file event.cpp.

Member Function Documentation

◆ getName()

const char* Event::Object::getName(void )const
inline

Obtains the name of the event object that was emitted.

Returns
A string containing the name of event

Definition at line 141 of file event.h.

◆ getParam()

void * Event::Object::getParam(const char * nam)const

Retrieves the paramaters values attached to the event

Parameters
NameThe parameter name for which to retrieve the value of event
Returns
The value connected with the input key

Definition at line 81 of file event.cpp.

◆ setParam()

void Event::Object::setParam(const char * nam,
void * val 
)

Stores a key and value inside event object

Parameters
KeyThe name of the parameter to store inside event object
ValueThe value to store

Definition at line 89 of file event.cpp.

Field Documentation

◆ MAX_PARAMS

const static size_t Event::Object::MAX_PARAMS = 8
static

The agreed maximum number of parameters event objects are allowed to have

Definition at line 165 of file event.h.

◆ value

void* Event::Object::value

Definition at line 174 of file event.h.


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