MNE-CPP  0.1.9
A Framework for Electrophysiology
Public Member Functions | Protected Attributes | List of all members
EVENTSLIB::EVENTSINTERNAL::EventUpdate Struct Reference

#include <eventsharedmemmanager.h>

Public Member Functions

 EventUpdate ()
 
 EventUpdate (int sample, int creator, enum EventUpdateType t)
 
long long getCreationTime () const
 
int getSample () const
 
int getCreatorId () const
 
enum EventUpdateType getType () const
 
void setType (enum EventUpdateType t)
 
std::string eventTypeToText ()
 

Protected Attributes

int m_EventSample
 
int m_CreatorId
 
long long m_CreationTime
 
enum EventUpdateType m_TypeOfUpdate
 

Detailed Description

The EventUpdate class serves as a minimal class definition to store updates in the shared memory buffer. The updates are events that happened and need to be processed by a shared memory reader object.

Definition at line 91 of file eventsharedmemmanager.h.

Constructor & Destructor Documentation

◆ EventUpdate() [1/2]

EVENTSINTERNAL::EventUpdate::EventUpdate ( )

Constructor.

Definition at line 80 of file eventsharedmemmanager.cpp.

◆ EventUpdate() [2/2]

EVENTSINTERNAL::EventUpdate::EventUpdate ( int  sample,
int  creator,
enum EventUpdateType  t 
)

Constructor with members defined.

Parameters
[in]sample
[in]creator
[in]t

Definition at line 86 of file eventsharedmemmanager.cpp.

Member Function Documentation

◆ eventTypeToText()

std::string EVENTSINTERNAL::EventUpdate::eventTypeToText ( )

Retrieve a text descriptive tag for each option in the type of update variable.

Returns

Definition at line 131 of file eventsharedmemmanager.cpp.

◆ getCreationTime()

long long EVENTSINTERNAL::EventUpdate::getCreationTime ( ) const

Retrieve the creation time.

Returns
A long integer with the creation time.

Definition at line 96 of file eventsharedmemmanager.cpp.

◆ getCreatorId()

int EVENTSINTERNAL::EventUpdate::getCreatorId ( ) const

retrieve the creator's id.

Returns
Creator's id.

Definition at line 110 of file eventsharedmemmanager.cpp.

◆ getSample()

int EVENTSINTERNAL::EventUpdate::getSample ( ) const

Retrieve the sample number.

Returns
Sample.

Definition at line 103 of file eventsharedmemmanager.cpp.

◆ getType()

EVENTSINTERNAL::EventUpdateType EVENTSINTERNAL::EventUpdate::getType ( ) const

Retrieve the type.

Returns
Type.

Definition at line 117 of file eventsharedmemmanager.cpp.

◆ setType()

void EVENTSINTERNAL::EventUpdate::setType ( enum EventUpdateType  t)

set the type of the event update.

Parameters
[in]t

Definition at line 124 of file eventsharedmemmanager.cpp.

Member Data Documentation

◆ m_CreationTime

long long EVENTSLIB::EVENTSINTERNAL::EventUpdate::m_CreationTime
protected

Creation time point.

Definition at line 154 of file eventsharedmemmanager.h.

◆ m_CreatorId

int EVENTSLIB::EVENTSINTERNAL::EventUpdate::m_CreatorId
protected

Id of the creator.

Definition at line 153 of file eventsharedmemmanager.h.

◆ m_EventSample

int EVENTSLIB::EVENTSINTERNAL::EventUpdate::m_EventSample
protected

Sample for the event.

Definition at line 152 of file eventsharedmemmanager.h.

◆ m_TypeOfUpdate

enum EventUpdateType EVENTSLIB::EVENTSINTERNAL::EventUpdate::m_TypeOfUpdate
protected

Type of update.

Definition at line 155 of file eventsharedmemmanager.h.


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