CCSDSSecondaryHeaderAbstract.h

Go to the documentation of this file.

// Copyright 2025-2026 ExoSpaceLabs
// SPDX-License-Identifier: Apache-2.0
 
#ifndef CCSDS_SECONDARY_HEADER_ABSTRACT_H
#define CCSDS_SECONDARY_HEADER_ABSTRACT_H
 
#include <CCSDSResult.h>
#include <vector>
#include <cstdint>
 
//exclude includes when building for MCU
#ifndef CCSDS_MCU
  #include "CCSDSConfig.h"
#endif //CCSDS_MCU
 
namespace CCSDS {
  class DataField;
  class SecondaryHeaderAbstract {
  public:
    virtual ~SecondaryHeaderAbstract() = default;
 
    [[nodiscard]] virtual ResultBool deserialize(const std::vector<std::uint8_t> &data) = 0;
 
 
    virtual void update(DataField* dataField) = 0;
 
    [[nodiscard]] virtual std::uint16_t getSize() const = 0;
 
    [[nodiscard]] virtual std::vector<std::uint8_t> serialize() const = 0; // Pure virtual method for polymorphism
 
    [[nodiscard]] virtual std::string getType() const = 0; // Pure virtual method for polymorphism
 
#ifndef CCSDS_MCU
    virtual ResultBool loadFromConfig(const Config &config) = 0;
#endif
    void setVariableLength(const bool bEnable){ variableLength =  bEnable;}
    bool variableLength{false};
  };
 
  class BufferHeader final : public SecondaryHeaderAbstract {
  public:
    BufferHeader() = default;
 
    explicit BufferHeader(const std::vector<std::uint8_t>& data) : m_data(data) {
    };
 
    [[nodiscard]] ResultBool deserialize(const std::vector<std::uint8_t> &data) override {m_data = data; return true;};
 
    [[nodiscard]] std::uint16_t getSize() const override { return m_data.size(); }
    [[nodiscard]] std::string getType() const override { return m_type; }
 
    [[nodiscard]] std::vector<std::uint8_t> serialize() const override {return m_data;};
    void update(DataField* dataField) override {m_dataLength = m_data.size();}
#ifndef CCSDS_MCU
    ResultBool loadFromConfig(const Config &config) override{return true;};
#endif
 
  private:
    std::vector<std::uint8_t> m_data;
    std::uint16_t m_dataLength = 0;
    const std::string m_type = "DataOnlyHeader";
  };
 
 
}
 
 
 
 
#endif //CCSDS_SECONDARY_HEADER_ABSTRACT_H