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.

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

Improve EVS event filter documentation #1390

Closed
skliper opened this issue Apr 20, 2021 · 0 comments · Fixed by #1579 or #1584
Closed

Improve EVS event filter documentation #1390

skliper opened this issue Apr 20, 2021 · 0 comments · Fixed by #1579 or #1584
Labels
cFE-EVS CFS-41 docs This change only affects documentation.
Milestone

Comments

@skliper
Copy link
Contributor

skliper commented Apr 20, 2021

Is your feature request related to a problem? Please describe.
CFE_EVS_ResetFilter API documentation not clear, would help to add something like it will treat the next event with that EID like it was the first (independent of filter method) along with an example.

** \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.

Add description of how they actually work:

/** \name Common Event Filter Mask Values */
/** \{ */
#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. */
#define CFE_EVS_FIRST_TWO_STOP 0xFFFE /**< \brief Sends the first 2 events. All remaining messages are filtered. */
#define CFE_EVS_FIRST_4_STOP 0xFFFC /**< \brief Sends the first 4 events. All remaining messages are filtered. */
#define CFE_EVS_FIRST_8_STOP 0xFFF8 /**< \brief Sends the first 8 events. All remaining messages are filtered. */
#define CFE_EVS_FIRST_16_STOP 0xFFF0 /**< \brief Sends the first 16 events. All remaining messages are filtered. */
#define CFE_EVS_FIRST_32_STOP 0xFFE0 /**< \brief Sends the first 32 events. All remaining messages are filtered. */
#define CFE_EVS_FIRST_64_STOP 0xFFC0 /**< \brief Sends the first 64 events. All remaining messages are filtered. */
#define CFE_EVS_EVERY_OTHER_ONE 0x0001 /**< \brief Sends every other event. */
#define CFE_EVS_EVERY_OTHER_TWO 0x0002 /**< \brief Sends two, filters one, sends two, filters one, etc */
#define CFE_EVS_EVERY_FOURTH_ONE 0x0003 /**< \brief Sends every fourth event message. All others are filtered. */
/** \} */

Describe the solution you'd like
Improve documentation

Describe alternatives you've considered
None

Additional context
Code review, note conversion to variables is in #1439

Requester Info
Jacob Hageman - NASA/GSFC

@skliper skliper added this to the 7.0.0 milestone Apr 20, 2021
@skliper skliper added docs This change only affects documentation. and removed enhancement labels Apr 29, 2021
skliper added a commit to skliper/cFE that referenced this issue May 25, 2021
astrogeco added a commit that referenced this issue May 27, 2021
Fix #1390, Improve event filter documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cFE-EVS CFS-41 docs This change only affects documentation.
Projects
None yet
2 participants