Event Flags

API interface for the built-in-task Event Flags. More...

Collaboration diagram for Event Flags:

Functions
qBool_t	qTask_EventFlags_Modify (qTask_t *const Task, const qTask_Flag_t flags, const qBool_t action)
	Modify the EventFlags for the provided task. More...
qTask_Flag_t	qTask_EventFlags_Read (const qTask_t *const Task)
	Returns the current value of the task's EventFlags. More...
qBool_t	qTask_EventFlags_Check (qTask_t *const Task, qTask_Flag_t flagsToCheck, const qBool_t clearOnExit, const qBool_t checkForAll)
	Check for flags set to qTrue inside the task Event-Flags. More...

Detailed Description

API interface for the built-in-task Event Flags.

Function Documentation

qTask_EventFlags_Check()

qBool_t qTask_EventFlags_Check	(	qTask_t *const	Task,
		qTask_Flag_t	flagsToCheck,
		const qBool_t	clearOnExit,
		const qBool_t	checkForAll
	)

Check for flags set to qTrue inside the task Event-Flags.

Parameters

[in]	Task	Pointer to the task node.
[in]	flagsToCheck	A bitwise value that indicates the flags to test inside the EventFlags. Can be combined with a bitwise OR. QEVENTFLAG_01 | QEVENTFLAG_02 | ... | QEVENTFLAG_20
[in]	clearOnExit	If is set to qTrue then any flags set in the value passed as the FlagsToCheck parameter will be cleared in the event group before this function returns only when the condition is meet.
[in]	checkForAll	Used to create either a logical AND test (where all flags must be set) or a logical OR test (where one or more flags must be set) as follows:

If is set to qTrue, this API will return qTrue when either all the flags set in the value passed as the flagsToCheck parameter are set in the task's EventFlags.

If is set to qFalse, this API will return qTrue when any of the flags set in the value passed as the flagsToCheck parameter are set in the task's EventFlags.

Returns

qTrue if the condition is meet, otherwise return qFalse.

qTask_EventFlags_Modify()

qBool_t qTask_EventFlags_Modify	(	qTask_t *const	Task,
		const qTask_Flag_t	flags,
		const qBool_t	action
	)

Modify the EventFlags for the provided task.

Note

Any EventFlag set will cause a task activation.

Parameters

[in]	Task	Pointer to the task node.
[in]	flags	The flags to modify. Can be combined with a bitwise OR. QEVENTFLAG_01 | QEVENTFLAG_02 | ... | QEVENTFLAG_20
[in]	action	QEVENTFLAG_SET or QEVENTFLAG_CLEAR

Returns

qTrue on success. Otherwise return qFalse.

qTask_EventFlags_Read()

qTask_Flag_t qTask_EventFlags_Read

(

const qTask_t *const

Task

)

Returns the current value of the task's EventFlags.

Parameters

Task	Pointer to the task node.

Returns

The EventFlag value of the task.