CCSDSPacket.h

Go to the documentation of this file.

// Copyright 2025-2026 ExoSpaceLabs
// SPDX-License-Identifier: Apache-2.0
 
#ifndef CCSDS_PACKET_H
#define CCSDS_PACKET_H
 
#include <CCSDSResult.h>
#include <vector>
#include "CCSDSHeader.h"
#include "CCSDSDataField.h"
 
namespace CCSDS {
 
  struct CRC16Config {
    std::uint16_t polynomial = 0x1021;
    std::uint16_t initialValue = 0xFFFF;
    std::uint16_t finalXorValue = 0x0000;
  };
 
 
  class Packet {
  public:
    Packet() = default;
 
    void setPrimaryHeader(PrimaryHeader data);
 
    [[nodiscard]] ResultBool setPrimaryHeader(std::uint64_t data);
 
    [[nodiscard]] ResultBool setPrimaryHeader(const std::vector<std::uint8_t> &data);
 
    void setPrimaryHeader(const Header &header);
 
    void setDataFieldHeader(const std::shared_ptr<SecondaryHeaderAbstract> &header);
 
    template <typename T>
    ResultBool RegisterSecondaryHeader() {
      FORWARD_RESULT( m_dataField.RegisterSecondaryHeader<T>());
      return true;
    }
 
    [[nodiscard]] ResultBool setDataFieldHeader(const std::vector<std::uint8_t> &data, const std::string &headerType);
 
    [[nodiscard]] ResultBool setDataFieldHeader(const std::uint8_t *pData, size_t sizeData, const std::string &headerType);
 
    [[nodiscard]] ResultBool setDataFieldHeader(const std::vector<std::uint8_t> &data);
 
    [[nodiscard]] ResultBool setDataFieldHeader(const std::uint8_t *pData, size_t sizeData);
 
    [[nodiscard]] ResultBool setApplicationData(const std::vector<std::uint8_t> &data);
 
    [[nodiscard]] ResultBool setApplicationData(const std::uint8_t *pData, size_t sizeData);
 
    void setSequenceFlags(ESequenceFlag flags);
 
    [[nodiscard]] ResultBool setSequenceCount(std::uint16_t count);
 
    void setDataFieldSize(std::uint16_t size);
 
    void setUpdatePacketEnable(bool enable);
 
    [[nodiscard]] ResultBool deserialize(const std::vector<std::uint8_t> &data);
 
    [[nodiscard]] ResultBool deserialize(const std::vector<std::uint8_t> &data, const std::string& headerType, std::int32_t headerSize = -1);
 
    [[nodiscard]] ResultBool deserialize(const std::vector<uint8_t> &data, std::uint16_t headerDataSizeBytes);
 
    [[nodiscard]] ResultBool deserialize(const std::vector<uint8_t> &headerData, const std::vector<uint8_t> &data);
 
    std::uint64_t getPrimaryHeader64bit();
 
    std::uint16_t getFullPacketLength();
 
    std::vector<uint8_t> serialize();
 
    std::vector<uint8_t> getPrimaryHeaderBytes();
 
    std::vector<uint8_t> getDataFieldHeaderBytes();
 
    std::vector<uint8_t> getApplicationDataBytes();
 
    std::vector<uint8_t> getFullDataFieldBytes();
 
    std::vector<uint8_t> getCRCVectorBytes();
 
    std::uint16_t getCRC();
 
    std::uint16_t getDataFieldMaximumSize() const;
 
    bool getDataFieldHeaderFlag();
 
    DataField &getDataField();
 
    Header &getPrimaryHeader();
 
    void setCrcConfig(const CRC16Config crcConfig) {m_CRC16Config = crcConfig;}
 
 
    void setCrcConfig(const std::uint16_t polynomial, const std::uint16_t initialValue, const std::uint16_t finalXorValue) {m_CRC16Config = {polynomial, initialValue, finalXorValue};}
 
    void update();
 
    ResultBool loadFromConfigFile(const std::string &configPath);
 
#ifndef CCSDS_MCU
    ResultBool loadFromConfig(const Config &cfg);
#endif
 
  private:
    Header m_primaryHeader{};        
    DataField m_dataField{};         
    std::uint16_t m_CRC16{};              
    CRC16Config m_CRC16Config;       
    bool m_updateStatus{false};      
    bool m_enableUpdatePacket{true}; 
    std::uint16_t m_sequenceCounter{0};
  };
}
#endif // CCSDS_PACKET_H