CCSDSManager.cpp

Go to the documentation of this file.

// Copyright 2025-2026 ExoSpaceLabs
// SPDX-License-Identifier: Apache-2.0
 
#include <random>
#include <utility>
#include <algorithm>
#include "CCSDSManager.h"
#include "CCSDSUtils.h"
 
void CCSDS::Manager::setSyncPattern(std::uint32_t syncPattern) { m_syncPattern = syncPattern; }
 
uint32_t CCSDS::Manager::getSyncPattern() const { return m_syncPattern; }
 
void CCSDS::Manager::setSyncPatternEnable(const bool enable) { m_syncPattEnable = enable; }
 
bool CCSDS::Manager::getSyncPatternEnable() const { return m_syncPattEnable; }
 
CCSDS::ResultBool CCSDS::Manager::setPacketTemplate(Packet packet) {
  RET_IF_ERR_MSG(m_templateIsSet, ErrorCode::TEMPLATE_SET_FAILURE, "Cannot set Template as it is already set, please clear Manager first");
  m_templatePacket.setUpdatePacketEnable(false);
  m_templatePacket = std::move(packet);
  m_validator.setTemplatePacket(m_templatePacket);
  m_validator.configure(true, true, true);
  m_validateEnable = true;
  m_templateIsSet = true;
  return true;
}
 
CCSDS::ResultBool CCSDS::Manager::loadTemplateConfigFile(const std::string &configPath) {
 
  Packet templatePacket;
  FORWARD_RESULT(templatePacket.loadFromConfigFile(configPath));
  m_templatePacket = std::move(templatePacket);
  m_templateIsSet = true;
  return true;;
}
#ifndef CCSDS_MCU
  CCSDS::ResultBool CCSDS::Manager::loadTemplateConfig(const Config &cfg) {
 
  Packet templatePacket;
  FORWARD_RESULT(templatePacket.loadFromConfig(cfg));
  m_templatePacket = std::move(templatePacket);
  m_templateIsSet = true;
  return true;;
}
#endif
void CCSDS::Manager::setDataFieldSize(const std::uint16_t size) {
  m_templatePacket.setDataFieldSize(size);
}
 
uint16_t CCSDS::Manager::getDataFieldSize() const {
  return m_templatePacket.getDataFieldMaximumSize();
}
 
CCSDS::ResultBool CCSDS::Manager::setApplicationData(const std::vector<std::uint8_t> &data) {
  RET_IF_ERR_MSG(data.empty(), ErrorCode::NO_DATA, "Cannot set Application data, Provided data is empty");
  RET_IF_ERR_MSG(!m_templateIsSet, ErrorCode::INVALID_HEADER_DATA, "Cannot set Application data, No template has been set");
 
  const auto maxBytesPerPacket = m_templatePacket.getDataFieldMaximumSize();
  const auto dataBytesSize = data.size();
 
  if (!m_packets.empty()) {
    m_packets.clear();
  }
 
  std::uint32_t i = 0;
  auto remainderBytes = static_cast<std::int32_t>(dataBytesSize);
  auto sequenceFlag = UNSEGMENTED;
  while (i < dataBytesSize) {
    Packet newPacket = m_templatePacket;
    std::vector<std::uint8_t> tmp;
    if (remainderBytes > maxBytesPerPacket) {
      tmp.insert(tmp.end(), data.begin() + i, data.begin() + i + maxBytesPerPacket);
      remainderBytes -= maxBytesPerPacket;
      if (i == 0) {
        sequenceFlag = FIRST_SEGMENT;
        m_sequenceCount++;
      } else {
        sequenceFlag = CONTINUING_SEGMENT;
      }
      i += maxBytesPerPacket;
      FORWARD_RESULT(newPacket.setApplicationData(tmp));
      newPacket.setSequenceFlags(sequenceFlag);
      FORWARD_RESULT(newPacket.setSequenceCount(m_sequenceCount));
    } else {
      tmp.insert(tmp.end(), data.begin() + i, data.begin() + i + remainderBytes);
      i += remainderBytes;
      if (sequenceFlag != UNSEGMENTED) {
        newPacket.setSequenceFlags(LAST_SEGMENT);
        FORWARD_RESULT(newPacket.setSequenceCount(m_sequenceCount));
      }
      FORWARD_RESULT(newPacket.setApplicationData(tmp));
    }
    newPacket.setUpdatePacketEnable(m_updateEnable);
    m_packets.push_back(std::move(newPacket));
    m_sequenceCount++;
  }
  return true;
}
 
void CCSDS::Manager::setAutoUpdateEnable(const bool enable) {
  m_updateEnable = enable;
  for (auto &packet: m_packets) {
    packet.setUpdatePacketEnable(enable);
  }
}
 
void CCSDS::Manager::setAutoValidateEnable(const bool enable) {
  m_validateEnable = enable;
}
 
CCSDS::ResultBuffer CCSDS::Manager::getPacketTemplate() {
  auto data = m_templatePacket.serialize();
  RET_IF_ERR_MSG(data.empty(), ErrorCode::NO_DATA, "Cannot get Packet template data, data is empty (impossible)"); // possibly redundant.
  return data;
}
 
CCSDS::ResultBuffer CCSDS::Manager::getPacketBufferAtIndex(const std::uint16_t index) {
  RET_IF_ERR_MSG(index < 0 || index >= m_packets.size(), ErrorCode::INVALID_DATA,
                 "Cannot get packet, index is out of bounds");
  if (m_validateEnable) {
    m_packets[index].update();
    const std::string errorMessage = "Validation failure for packet at index " + std::to_string(index);
    RET_IF_ERR_MSG(!m_validator.validate(m_packets[index]), ErrorCode::VALIDATION_FAILURE,
                   errorMessage);
  }
  return m_packets[index].serialize();
}
 
std::vector<std::uint8_t> CCSDS::Manager::getPacketsBuffer() const {
  std::vector<std::uint8_t> buffer;
  for (auto packet : m_packets) {
    if (m_syncPattEnable) {
      buffer.push_back(m_syncPattern >> 24 & 0xff);
      buffer.push_back(m_syncPattern >> 16 & 0xff);
      buffer.push_back(m_syncPattern >> 8 & 0xff);
      buffer.push_back(m_syncPattern & 0xff);
    }
    std::vector<std::uint8_t> packetBuffer = packet.serialize();
    buffer.insert(buffer.end(), packetBuffer.begin(), packetBuffer.end());
  }
  return buffer;
}
 
CCSDS::ResultBuffer CCSDS::Manager::getApplicationDataBuffer() {
  RET_IF_ERR_MSG(m_packets.empty(), ErrorCode::NO_DATA, "Cannot get Application data, no packets have been set.");
  std::vector<std::uint8_t> data;
 
  for (std::uint32_t index = 0; index < m_packets.size(); index++) {
    if (m_validateEnable) {
      const std::string errorMessage = "Validation failure for packet at index" + std::to_string(index);
      RET_IF_ERR_MSG(!m_validator.validate(m_packets[index]), ErrorCode::VALIDATION_FAILURE,
                     errorMessage);
    }
    auto applicationData = m_packets[index].getApplicationDataBytes();
    data.insert(data.end(), applicationData.begin(), applicationData.end());
  }
  return data;
}
 
CCSDS::ResultBuffer CCSDS::Manager::getApplicationDataBufferAtIndex(const std::uint16_t index) {
  RET_IF_ERR_MSG(index < 0 || index >= m_packets.size(), ErrorCode::INVALID_DATA,
                 "Cannot get Application data, index is out of bounds");
  return m_packets[index].getApplicationDataBytes();
}
 
uint16_t CCSDS::Manager::getTotalPackets() const {
  return m_packets.size();
}
 
std::vector<CCSDS::Packet> CCSDS::Manager::getPackets() {
  return m_packets;
}
 
CCSDS::ResultBool CCSDS::Manager::addPacket(Packet packet) {
 
  if (m_validateEnable && !m_updateEnable) {
    if (!m_templateIsSet) {
      m_validator.configure(true, true, false);
    }
    RET_IF_ERR_MSG(m_validator.validate(packet), ErrorCode::VALIDATION_FAILURE, "packet is not valid");
  }
  packet.setUpdatePacketEnable(m_updateEnable);
  m_packets.push_back(std::move(packet));
  return true;
}
 
CCSDS::ResultBool CCSDS::Manager::addPacketFromBuffer(const std::vector<std::uint8_t>& packetBuffer) {
  Packet packet;
  FORWARD_RESULT(packet.deserialize(packetBuffer));
  FORWARD_RESULT(addPacket(packet));
  return true;
}
 
 
[[nodiscard]] CCSDS::ResultBool CCSDS::Manager::load(const std::vector<Packet>& packets) {
 
  for (const auto& packet: packets) {
    FORWARD_RESULT(addPacket(packet));
  }
  return true;
}
 
[[nodiscard]] CCSDS::ResultBool CCSDS::Manager::load(const std::vector<std::uint8_t>& packetsBuffer) {
  RET_IF_ERR_MSG(packetsBuffer.size() < 8, ErrorCode::INVALID_DATA, "invalid packet buffer size");
  std::uint32_t offset{0};
  while (offset < packetsBuffer.size()) {
    std::vector<std::uint8_t> headerData;
    if (m_syncPattEnable) {
      const std::uint32_t value = (static_cast<std::uint32_t>(packetsBuffer[offset]) << 24) |
                             (static_cast<std::uint32_t>(packetsBuffer[offset+1]) << 16) |
                             (static_cast<std::uint32_t>(packetsBuffer[offset+2]) << 8)  |
                             (static_cast<std::uint32_t>(packetsBuffer[offset+3]));
      RET_IF_ERR_MSG(value != m_syncPattern, ErrorCode::INVALID_DATA, "Sync Pattern mismatch.");
      offset += 4;
    }
    headerData.clear();
    copy_n(packetsBuffer.begin() + offset, 6, std::back_inserter(headerData));
    Header header;
    FORWARD_RESULT( header.deserialize(headerData));
 
    const std::uint16_t packetSize = header.getDataLength() + 8;
    std::vector<std::uint8_t>packetData;
    packetData.clear();
    copy_n(packetsBuffer.begin() + offset, packetSize, std::back_inserter(packetData));
    FORWARD_RESULT(addPacketFromBuffer(packetData));
    offset += packetSize;
  }
  return true;
}
 
CCSDS::ResultBool CCSDS::Manager::read(const std::string &binaryFile) {
  std::vector<std::uint8_t> buffer;
  ASSIGN_CP(buffer, readBinaryFile(binaryFile));
  FORWARD_RESULT(load(buffer));
  return true;
}
 
CCSDS::ResultBool CCSDS::Manager::write(const std::string& binaryFile) const {
  FORWARD_RESULT(writeBinaryFile(getPacketsBuffer(),binaryFile));
  return true;
}
 
 
CCSDS::ResultBool CCSDS::Manager::readTemplate(const std::string& filename) {
  Packet templatePacket;
  templatePacket.setUpdatePacketEnable(false);
  if (stringEndsWith(filename, ".bin")) {
    std::vector<std::uint8_t> buffer;
    ASSIGN_CP(buffer, readBinaryFile(filename));
    FORWARD_RESULT(templatePacket.deserialize(buffer));
  }else if (stringEndsWith(filename, ".cfg")) {
    FORWARD_RESULT(templatePacket.loadFromConfigFile(filename));
  } else {
    return Error{INVALID_DATA,"Cannot load template, invalid file provided [supported extensions [.bin, .cfg]]"};
  }
  FORWARD_RESULT(setPacketTemplate(templatePacket));
  return true;
}
 
void CCSDS::Manager::clear() {
  clearPackets();
  m_templateIsSet = false;
  m_templatePacket= {};
}
 
void CCSDS::Manager::clearPackets() {
  m_packets.clear();
  m_sequenceCount = 0;
  m_validator.clear();
}