PduHeader.hpp

Go to the documentation of this file.

// ======================================================================
// \title  PduHeader.hpp
// \author Brian Campuzano
// \brief  hpp file for CFDP PDU Header
// ======================================================================

#ifndef Svc_Ccsds_Cfdp_PduHeader_HPP
#define Svc_Ccsds_Cfdp_PduHeader_HPP

#include <Fw/Buffer/Buffer.hpp>
#include <Fw/FPrimeBasicTypes.hpp>
#include <Fw/Types/Serializable.hpp>
#include <Svc/Ccsds/CfdpManager/Types/ClassEnumAc.hpp>
#include <Svc/Ccsds/CfdpManager/Types/PduTypeEnumEnumAc.hpp>
#include <config/EntityIdAliasAc.hpp>
#include <config/TransactionSeqAliasAc.hpp>

namespace Svc {
namespace Ccsds {
namespace Cfdp {

// CFDP PDU Type
enum class PduType : U8 {
    PDU_TYPE_DIRECTIVE = 0,  // File directive PDU
    PDU_TYPE_FILE_DATA = 1   // File data PDU
};

// CFDP PduDirection
enum class PduDirection : U8 {
    DIRECTION_TOWARD_RECEIVER = 0,  // Toward file receiver
    DIRECTION_TOWARD_SENDER = 1     // Toward file sender
};

// CFDP CRC Flag
enum class CrcFlag : U8 {
    CRC_NOT_PRESENT = 0,  // CRC not present
    CRC_PRESENT = 1       // CRC present
};

// CFDP Large File Flag
enum class LargeFileFlag : U8 {
    LARGE_FILE_32_BIT = 0,  // 32-bit file size
    LARGE_FILE_64_BIT = 1   // 64-bit file size
};

class PduHeader {
  private:
    PduTypeEnum::T m_type;

    U8 m_version;

    PduType m_pduType;

    PduDirection m_direction;

    Cfdp::Class::T m_class;

    CrcFlag m_crcFlag;

    LargeFileFlag m_largeFileFlag;

    U8 m_segmentationControl;

    U8 m_segmentMetadataFlag;

    U16 m_pduDataLength;

    EntityId m_sourceEid;

    TransactionSeq m_transactionSeq;

    EntityId m_destEid;

  public:
    enum { MIN_HEADERSIZE = 7 };  // Minimum fixed portion

    void initialize(PduTypeEnum::T type,
                    PduDirection direction,
                    Cfdp::Class::T txmMode,
                    EntityId sourceEid,
                    TransactionSeq transactionSeq,
                    EntityId destEid);

    U32 getBufferSize() const;

    static U8 getValueEncodedSize(U64 value);

    Fw::SerializeStatus fromSerialBuffer(Fw::SerialBufferBase& serialBuffer);

    Fw::SerializeStatus toSerialBuffer(Fw::SerialBufferBase& serialBuffer) const;

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

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

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

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

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

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

    U16 getPduDataLength() const { return this->m_pduDataLength; }

    void setPduDataLength(U16 length) { this->m_pduDataLength = length; }

    LargeFileFlag getLargeFileFlag() const { return this->m_largeFileFlag; }

    bool hasSegmentMetadata() const { return this->m_segmentMetadataFlag != 0; }

    void setLargeFileFlag(LargeFileFlag flag) { this->m_largeFileFlag = flag; }

    friend class MetadataPdu;
    friend class FileDataPdu;
    friend class EofPdu;
    friend class FinPdu;
    friend class AckPdu;
    friend class NakPdu;
};

PduTypeEnum::T peekPduType(const Fw::Buffer& buffer);

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

#endif  // Svc_Ccsds_Cfdp_PduHeader_HPP