Skip to content
Open
Changes from all commits
Commits
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
72 changes: 72 additions & 0 deletions Fw/Types/LinearBufferTemplate.hpp

Copy link
Copy Markdown
Author

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 LinearBufferTemplate is 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.

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

Copy link
Copy Markdown
Author

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 using aliases.

Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
// ======================================================================
// @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.
//!
//! Example: using CmdArgBuffer = LinearBufferTemplate<FW_TYPEID_CMD_BUFF, FW_CMD_ARG_BUFFER_MAX_SIZE>;
//!
//! \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
Loading