Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
rp::hal::Event Class Reference

#include <event.h>

Inheritance diagram for rp::hal::Event:
Inheritance graph
[legend]

Public Types

enum  { EVENT_OK = 1, EVENT_TIMEOUT = 0xFFFFFFFF, EVENT_FAILED = 0 }
 

Public Member Functions

 Event (bool isAutoReset=true, bool isSignal=false)
 
void set (bool isSignal=true)
 
unsigned long wait (unsigned long timeout=0xFFFFFFFF)
 
 ~ Event ()
 

Protected Member Functions

void release ()
 

Protected Attributes

pthread_condattr_t _cond_attr
 
pthread_mutex_t _cond_locker
 
pthread_cond_t _cond_var
 
bool _is_signalled
 
bool _isAutoReset
 

Detailed Description

Definition at line 38 of file event.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
EVENT_OK 
EVENT_TIMEOUT 
EVENT_FAILED 

Definition at line 42 of file event.h.

Constructor & Destructor Documentation

◆ Event()

rp::hal::Event::Event ( bool  isAutoReset = true,
bool  isSignal = false 
)
inline

Definition at line 49 of file event.h.

◆ ~ Event()

rp::hal::Event::~ Event ( )
inline

Definition at line 73 of file event.h.

Member Function Documentation

◆ release()

void rp::hal::Event::release ( )
inlineprotected

Definition at line 186 of file event.h.

◆ set()

void rp::hal::Event::set ( bool  isSignal = true)
inline

Definition at line 78 of file event.h.

◆ wait()

unsigned long rp::hal::Event::wait ( unsigned long  timeout = 0xFFFFFFFF)
inline

Definition at line 106 of file event.h.

Member Data Documentation

◆ _cond_attr

pthread_condattr_t rp::hal::Event::_cond_attr
protected

Definition at line 201 of file event.h.

◆ _cond_locker

pthread_mutex_t rp::hal::Event::_cond_locker
protected

Definition at line 200 of file event.h.

◆ _cond_var

pthread_cond_t rp::hal::Event::_cond_var
protected

Definition at line 199 of file event.h.

◆ _is_signalled

bool rp::hal::Event::_is_signalled
protected

Definition at line 202 of file event.h.

◆ _isAutoReset

bool rp::hal::Event::_isAutoReset
protected

Definition at line 203 of file event.h.


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


rplidar_ros
Author(s):
autogenerated on Fri Aug 2 2024 08:42:14