Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix #1390, Improve event filter documentation #1579

Merged
merged 1 commit into from
May 27, 2021
Merged

Fix #1390, Improve event filter documentation #1579

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions modules/core_api/fsw/inc/cfe_evs.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,8 +288,9 @@ CFE_Status_t CFE_EVS_SendTimedEvent(CFE_TIME_SysTime_t Time, uint16 EventID, uin
** \brief Resets the calling application's event filter for a single event ID.
**
** \par Description
** The effect of resetting an event filter depends on the filter scheme.
** The #CFE_EVS_EventFilter_BINARY scheme resets the filter counter for the specified Event ID.
** Resets the filter such that the next event is treated like the first.
** For example, if the filter was set to only send the first event, the
** next event following the reset would be sent.
**
** \par Assumptions, External Events, and Notes:
** None
Expand Down
4 changes: 3 additions & 1 deletion modules/core_api/fsw/inc/cfe_evs_api_typedefs.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@
#include "common_types.h" /* Basic data types */
#include "cfe_evs_extern_typedefs.h"

/** \name Common Event Filter Mask Values */
/** \name Common Event Filter Mask Values
* Message is sent if (previous event count) & MASK == 0
*/
/** \{ */
#define CFE_EVS_NO_FILTER 0x0000 /**< \brief Stops any filtering. All messages are sent. */
#define CFE_EVS_FIRST_ONE_STOP 0xFFFF /**< \brief Sends the first event. All remaining messages are filtered. */
Expand Down