forked from nasa/fprime
-
Notifications
You must be signed in to change notification settings - Fork 0
Add LinearBufferTemplate: template class for fixed-size linear buffers #166
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
Open
devin-ai-integration
wants to merge
3
commits into
devel
Choose a base branch
from
devin/1781058666-linear-buffer-template
base: devel
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
2d19106
Add LinearBufferTemplate: template class for fixed-size linear buffers
devin-ai-integration[bot] fbd7149
Fix clang-format violations in LinearBufferTemplate
devin-ai-integration[bot] 59ca5f0
Remove Doxygen code block to fix spell-check CI
devin-ai-integration[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| // ====================================================================== | ||
| // @file LinearBufferTemplate.hpp | ||
| // @author Devin (from nasa/fprime#5018) | ||
| // @brief A linear buffer template parameterized by type ID and size | ||
| // ====================================================================== | ||
|
|
||
| #ifndef FW_LINEAR_BUFFER_TEMPLATE_HPP | ||
| #define FW_LINEAR_BUFFER_TEMPLATE_HPP | ||
|
|
||
| #include <Fw/FPrimeBasicTypes.hpp> | ||
| #include <Fw/Types/Assert.hpp> | ||
| #include <Fw/Types/Serializable.hpp> | ||
|
|
||
| namespace Fw { | ||
|
|
||
| //! \brief A linear buffer template parameterized by type ID and buffer size | ||
| //! | ||
| //! This class template provides a fixed-size linear serialization buffer | ||
| //! derived from LinearBufferBase. It replaces the many hand-coded concrete | ||
| //! buffer classes (CmdArgBuffer, LogBuffer, TlmBuffer, etc.) that share | ||
| //! identical structure, eliminating boilerplate and reducing error potential. | ||
| //! | ||
| //! Usage: | ||
| //! \code | ||
| //! using CmdArgBuffer = LinearBufferTemplate<FW_TYPEID_CMD_BUFF, FW_CMD_ARG_BUFFER_MAX_SIZE>; | ||
| //! \endcode | ||
| //! | ||
| //! \tparam TypeId Serialized type identifier (from SerIds.hpp or project-specific) | ||
| //! \tparam MaxSize Maximum buffer capacity in bytes | ||
| template <int TypeId, FwSizeType MaxSize> | ||
| class LinearBufferTemplate final : public LinearBufferBase { | ||
| public: | ||
| enum { | ||
| SERIALIZED_TYPE_ID = TypeId, //!< type id for serialization | ||
| SERIALIZED_SIZE = STATIC_SERIALIZED_SIZE(MaxSize), //!< size when serialized: buffer + stored size | ||
| }; | ||
|
|
||
| LinearBufferTemplate() = default; | ||
|
|
||
| LinearBufferTemplate(const U8* args, FwSizeType size) { | ||
| const SerializeStatus stat = this->setBuff(args, size); | ||
| FW_ASSERT(FW_SERIALIZE_OK == stat, static_cast<FwAssertArgType>(stat)); | ||
| } | ||
|
|
||
| LinearBufferTemplate(const LinearBufferTemplate& other) : LinearBufferBase() { | ||
| const SerializeStatus stat = this->setBuff(other.getBuffAddr(), other.getSize()); | ||
| FW_ASSERT(FW_SERIALIZE_OK == stat, static_cast<FwAssertArgType>(stat)); | ||
| } | ||
|
|
||
| ~LinearBufferTemplate() override = default; | ||
|
|
||
| LinearBufferTemplate& operator=(const LinearBufferTemplate& other) { | ||
| if (this == &other) { | ||
| return *this; | ||
| } | ||
| const SerializeStatus stat = this->setBuff(other.getBuffAddr(), other.getSize()); | ||
| FW_ASSERT(FW_SERIALIZE_OK == stat, static_cast<FwAssertArgType>(stat)); | ||
| return *this; | ||
| } | ||
|
|
||
| DEPRECATED(FwSizeType getBuffCapacity() const, "Use getCapacity() instead") { | ||
| return this->getCapacity(); | ||
| } | ||
|
|
||
| FwSizeType getCapacity() const override { return sizeof this->m_bufferData; } | ||
|
|
||
| U8* getBuffAddr() override { return this->m_bufferData; } | ||
|
|
||
| const U8* getBuffAddr() const override { return this->m_bufferData; } | ||
|
|
||
| private: | ||
| U8 m_bufferData[MaxSize]; | ||
| }; | ||
|
|
||
| } // namespace Fw | ||
|
|
||
| #endif | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚩 Template not yet used anywhere in the codebase
The
LinearBufferTemplateis introduced but not yet used to replace any existing concrete buffer class (TlmBuffer, LogBuffer, CmdArgBuffer, etc.). The comment in the usage example (Fw/Types/LinearBufferTemplate.hpp:25) shows the intended replacement pattern, but a follow-up PR would be needed to actually substitute the existing hand-coded classes. This means the template is effectively dead code until adopted. This is presumably intentional (incremental rollout), but worth confirming.Was this helpful? React with 👍 or 👎 to provide feedback.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correct — this is intentional. This PR only introduces the template (step 1 of nasa#5018). Follow-up PRs will migrate the existing concrete buffer classes to
usingaliases.