PduBase.hpp

Go to the documentation of this file.

// ======================================================================
// \title  PduBase.hpp
// \author Brian Campuzano
// \brief  Base class for all CFDP PDU types
//
// This base class provides a common interface for all PDU types,
// enabling proper construction/destruction and type safety.
// ======================================================================

#ifndef Svc_Ccsds_Cfdp_PduBase_HPP
#define Svc_Ccsds_Cfdp_PduBase_HPP

#include <Fw/Buffer/Buffer.hpp>
#include <Fw/FPrimeBasicTypes.hpp>
#include <Fw/Types/Serializable.hpp>
#include <Svc/Ccsds/CfdpManager/Types/PduHeader.hpp>

namespace Svc {
namespace Ccsds {
namespace Cfdp {

class PduBase : public Fw::Serializable {
  protected:
    PduHeader m_header;

  public:
    PduBase() {}

    virtual ~PduBase() = default;

    Fw::SerializeStatus serializeTo(Fw::SerialBufferBase& buffer,
                                    Fw::Endianness mode = Fw::Endianness::BIG) const override = 0;

    Fw::SerializeStatus deserializeFrom(Fw::SerialBufferBase& buffer,
                                        Fw::Endianness mode = Fw::Endianness::BIG) override = 0;

    virtual U32 getBufferSize() const = 0;

    PduTypeEnum::T getType() const { return this->m_header.getType(); }

    PduDirection getDirection() const { return this->m_header.getDirection(); }

    Cfdp::Class::T getTxmMode() const { return this->m_header.getTxmMode(); }

    EntityId getSourceEid() const { return this->m_header.getSourceEid(); }

    TransactionSeq getTransactionSeq() const { return this->m_header.getTransactionSeq(); }

    EntityId getDestEid() const { return this->m_header.getDestEid(); }

    const PduHeader& getHeader() const { return this->m_header; }
};

}  // namespace Cfdp
}  // namespace Ccsds
}  // namespace Svc

// Include all concrete PDU types for convenience (umbrella header pattern)
#include <Svc/Ccsds/CfdpManager/Types/AckPdu.hpp>
#include <Svc/Ccsds/CfdpManager/Types/EofPdu.hpp>
#include <Svc/Ccsds/CfdpManager/Types/FileDataPdu.hpp>
#include <Svc/Ccsds/CfdpManager/Types/FinPdu.hpp>
#include <Svc/Ccsds/CfdpManager/Types/MetadataPdu.hpp>
#include <Svc/Ccsds/CfdpManager/Types/NakPdu.hpp>

#endif  // Svc_Ccsds_Cfdp_PduBase_HPP