From 71df47f05543079eb219013851f91f394f77511c Mon Sep 17 00:00:00 2001 From: Jacob Hageman Date: Fri, 13 Mar 2020 15:15:32 -0400 Subject: [PATCH] Fix #499, Clarify Get/SetMsgTime effect on cmd msg Partial fix (see also #545), comments/documentation only --- fsw/cfe-core/src/inc/cfe_sb.h | 3 +++ 1 file changed, 3 insertions(+) diff --git a/fsw/cfe-core/src/inc/cfe_sb.h b/fsw/cfe-core/src/inc/cfe_sb.h index 2166d4265..d71096acd 100644 --- a/fsw/cfe-core/src/inc/cfe_sb.h +++ b/fsw/cfe-core/src/inc/cfe_sb.h @@ -882,6 +882,8 @@ void CFE_SB_SetTotalMsgLength(CFE_SB_MsgPtr_t MsgPtr,uint16 TotalLength); ** - If the underlying implementation of software bus messages does not include ** a time field, then this routine will do nothing to the message contents ** and will return #CFE_SB_WRONG_MSG_TYPE. +** - Note default implementation of command messages do not have a time field +** and will trigger the #CFE_SB_WRONG_MSG_TYPE error ** ** \param[in] MsgPtr A pointer to the buffer that contains the software bus message. ** This must point to the first byte of the message header. @@ -1103,6 +1105,7 @@ uint16 CFE_SB_GetCmdCode(CFE_SB_MsgPtr_t MsgPtr); ** \par Assumptions, External Events, and Notes: ** - If the underlying implementation of software bus messages does not ** include a time field, then this routine will return a zero time. +** - Note default implementation of command messages do not have a time field. ** ** \param[in] MsgPtr A pointer to the buffer that contains the software bus message. ** This must point to the first byte of the message header.