EventGroup Class Reference

#include <EventCPP.h>

Collaboration diagram for EventGroup:

Public Member Functions
	EventGroup ()
	~EventGroup ()
EventBits_t	clear (EventBits_t bits)
	Clear Event Bits.
EventBits_t	clear_ISR (EventBits_t bits)
EventBits_t	get ()
	Get Event Bits.
EventBits_t	get_ISR ()
EventBits_t	set (EventBits_t bits)
	Set Event Bits.
EventBits_t	set_ISR (EventBits_t bits, portBASE_TYPE &waswoken)
EventBits_t	sync (EventBits_t set, EventBits_t wait, TickType_t ticks=portMAX_DELAY)
	Event Group Sync.
EventBits_t	wait (EventBits_t waitBits, bool clear=true, bool all=false, TickType_t ticks=portMAX_DELAY)
	Wait for Event.

Protected Attributes
EventGroupHandle_t	eventHandle

Constructor & Destructor Documentation

EventGroup()

EventGroup::EventGroup ( )

inline

~EventGroup()

EventGroup::~EventGroup ( )

inline

Member Function Documentation

clear()

EventBits_t EventGroup::clear ( EventBits_t bits )

inline

Clear Event Bits.

Parameters

bits	The Event Bits to Set.

clear_ISR()

EventBits_t EventGroup::clear_ISR ( EventBits_t bits )

inline

get()

EventBits_t EventGroup::get ( )

inline

Get Event Bits.

get_ISR()

EventBits_t EventGroup::get_ISR ( )

inline

set()

EventBits_t EventGroup::set ( EventBits_t bits )

inline

Set Event Bits.

Set Event bits and activate all tasks waiting for those bits.

Parameters

bits	The Event Bits to Set.

set_ISR()

EventBits_t EventGroup::set_ISR ( EventBits_t bits, portBASE_TYPE & waswoken )

inline

sync()

EventBits_t EventGroup::sync ( EventBits_t set, EventBits_t wait, TickType_t ticks = portMAX_DELAY )

inline

Event Group Sync.

Sets the set bits than wait for all of the wait bits, and then clear all those bits.

Returns

the value of the event group befor clearing the bits.

wait()

EventBits_t EventGroup::wait ( EventBits_t waitBits, bool clear = true, bool all = false, TickType_t ticks = portMAX_DELAY )

inline

Wait for Event.

Parameters

waitBits	The bit(s) to wait for
clear	If true, then the bits are cleared after the wait.
all	If true, then wait for ALL the bits to be true, else for ANY of the bits
ticks	How long to wait for the bits to be set

Returns

The value of the event bits (before clearing) at the end of the wait.

Member Data Documentation

eventHandle

EventGroupHandle_t EventGroup::eventHandle

protected

---

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

• EventCPP.h