Manages CCSDS packets and their templates. More...

#include <CCSDSManager.h>

Collaboration diagram for CCSDS::Manager:

Public Member Functions
	Manager ()=default
	Default constructor.

	Manager (Packet packet)
	Constructs a Manager with a given packet template.

void	setSyncPattern (uint32_t syncPattern)
	set sync pattern that should indicate the start of a CCSDS packet.

uint32_t	getSyncPattern () const
	returns the currently set sync pattern.

void	setSyncPatternEnable (bool enable)
	enable sync pattern utilization both in serialization, deserialization, read and write.

bool	getSyncPatternEnable () const
	returns the current settings of the sync pattern enable

ResultBool	setPacketTemplate (Packet packet)
	Sets a new packet template.

void	setDatFieldSize (uint16_t size)
	Sets the size of the data field.

ResultBool	setApplicationData (const std::vector< uint8_t > &data)
	Sets the application data for the packet.

void	setAutoUpdateEnable (bool enable)
	Enables or disables automatic updates for packets.

void	setAutoValidateEnable (bool enable)
	Enables or disables automatic validation of packets.

ResultBuffer	getPacketTemplate ()
	Retrieves the packet template in serialized form.

ResultBuffer	getPacketBufferAtIndex (uint16_t index)
	Retrieves a packet at the specified index.

std::vector< uint8_t >	getPacketsBuffer () const
	Retrieves a buffer containing all the stored packets sequentially.

ResultBuffer	getApplicationDataBuffer ()
	Retrieves the application data from the packets.

ResultBuffer	getApplicationDataBufferAtIndex (uint16_t index)
	Retrieves the application data from a packet at the given index.

uint16_t	getTotalPackets () const
	Retrieves the total number of packets managed.

bool	getAutoUpdateEnable () const
	Checks if automatic updates are enabled.

Packet	getTemplate ()
	Retrieves the packet template.

std::vector< Packet >	getPackets ()
	Retrieves all stored packets.

ResultBool	addPacket (Packet packet)
	Adds a new packet to the list.

ResultBool	addPacketFromBuffer (const std::vector< uint8_t > &packetBuffer)
	Adds a new packet to the list.

ResultBool	load (const std::vector< Packet > &packets)
	Load a vector of packets.

ResultBool	load (const std::vector< uint8_t > &packetsBuffer)
	Load a packet or a series of packets from a buffer.

ResultBool	read (const std::string &binaryFile)
	Load a packet or a series of packets from a binary file.

ResultBool	write (const std::string &binaryFile) const
	Write a packet or a series of packets to a binary file.

ResultBool	readTemplate (const std::string &filename)
	Load a template packet from a binary or configuration file.

void	clear ()
	Clears the manager, removes all packets and template.

void	clearPackets ()
	Clears the packets and sets the counter to 0.

Validator &	getValidatorReference ()
	Returns a reverence to the manager's Validator.

std::vector< Packet > &	getPacketsReference ()
	Returns a reference to the packets vector.

Private Attributes
Packet	m_templatePacket {}
	The template packet used for generating new packets.

bool	m_templateIsSet { false }
	Boolean to indicate if Template has been set or not.

bool	m_updateEnable { true }
	bool indicating whether automatic updates are enabled (default: true).

bool	m_validateEnable { true }
	bool indicating whether automatic validation is enabled (default: true).

bool	m_syncPattEnable { false }
	bool indicating whether automatic sync pattern insertion is enabled (default: false).

std::vector< Packet >	m_packets
	Collection of stored packets.

uint16_t	m_sequenceCount { 0 }

Validator	m_validator {}

uint32_t	m_syncPattern {0x1ACFFC1D}

Detailed Description

Manages CCSDS packets and their templates.

This class provides an interface for managing CCSDS packets, allowing users to set a packet template, configure data field sizes, and retrieve application data and packet instances.

Definition at line 18 of file CCSDSManager.h.

Constructor & Destructor Documentation

◆ Manager() [1/2]

CCSDS::Manager::Manager ( )

default

Default constructor.

◆ Manager() [2/2]

CCSDS::Manager::Manager ( Packet packet )

inlineexplicit

Constructs a Manager with a given packet template.

Parameters

packet The packet template to be used as a reference.

Definition at line 30 of file CCSDSManager.h.

                                    : m_templatePacket(std::move(packet)) {
      m_templateIsSet = true;
      m_validator.setTemplatePacket(m_templatePacket);
      m_validator.configure(true, true, true);
 
    }

Here is the call graph for this function:

Member Function Documentation

◆ addPacket()

CCSDS::ResultBool CCSDS::Manager::addPacket ( Packet packet )

Adds a new packet to the list.

Parameters

packet The new packet to be added.

Definition at line 149 of file CCSDSManager.cpp.

                                                     {
 
  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;
}

Here is the call graph for this function:

◆ addPacketFromBuffer()

CCSDS::ResultBool CCSDS::Manager::addPacketFromBuffer ( const std::vector< uint8_t > & packetBuffer )

Adds a new packet to the list.

Parameters

packetBuffer The new packet to be added in the form of a buffer.

Definition at line 162 of file CCSDSManager.cpp.

                                                                                        {
  Packet packet;
  FORWARD_RESULT(packet.deserialize(packetBuffer));
  FORWARD_RESULT(addPacket(packet));
  return true;
}

Here is the call graph for this function:

◆ clear()

void CCSDS::Manager::clear ( )

Clears the manager, removes all packets and template.

Definition at line 239 of file CCSDSManager.cpp.

                         {
  clearPackets();
  m_templateIsSet = false;
  m_templatePacket= {};
}

◆ clearPackets()

void CCSDS::Manager::clearPackets ( )

Clears the packets and sets the counter to 0.

Definition at line 245 of file CCSDSManager.cpp.

                                {
  m_packets.clear();
  m_sequenceCount = 0;
  m_validator.clear();
}

◆ getApplicationDataBuffer()

CCSDS::ResultBuffer CCSDS::Manager::getApplicationDataBuffer ( )

Retrieves the application data from the packets.

Returns: A ResultBuffer containing the application data.

Definition at line 119 of file CCSDSManager.cpp.

                                                         {
  RET_IF_ERR_MSG(m_packets.empty(), ErrorCode::NO_DATA, "Cannot get Application data, no packets have been set.");
  std::vector<uint8_t> data;
 
  for (int 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;
}

Here is the caller graph for this function:

◆ getApplicationDataBufferAtIndex()

CCSDS::ResultBuffer CCSDS::Manager::getApplicationDataBufferAtIndex ( uint16_t index )

Retrieves the application data from a packet at the given index.

Parameters

index The index of the packet.

Returns: A ResultBuffer containing the application data of the selected packet.

Definition at line 135 of file CCSDSManager.cpp.

                                                                                    {
  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();
}

◆ getAutoUpdateEnable()

bool CCSDS::Manager::getAutoUpdateEnable ( ) const

inline

Checks if automatic updates are enabled.

Returns: True if auto-update is enabled, false otherwise.

Definition at line 152 of file CCSDSManager.h.

152{ return m_updateEnable; }

◆ getPacketBufferAtIndex()

CCSDS::ResultBuffer CCSDS::Manager::getPacketBufferAtIndex ( uint16_t index )

Retrieves a packet at the specified index.

Parameters

index The index of the packet to retrieve.

Returns: A ResultBuffer containing the requested packet.

Definition at line 92 of file CCSDSManager.cpp.

                                                                           {
  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();
}

◆ getPackets()

std::vector< CCSDS::Packet > CCSDS::Manager::getPackets ( )

Retrieves all stored packets.

Returns: A vector containing all managed packets.

Definition at line 145 of file CCSDSManager.cpp.

                                                {
  return m_packets;
}

◆ getPacketsBuffer()

std::vector< uint8_t > CCSDS::Manager::getPacketsBuffer ( ) const

Retrieves a buffer containing all the stored packets sequentially.

Returns: A vector of bytes containing the packets data.

Definition at line 104 of file CCSDSManager.cpp.

                                                        {
  std::vector<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<uint8_t> packetBuffer = packet.serialize();
    buffer.insert(buffer.end(), packetBuffer.begin(), packetBuffer.end());
  }
  return buffer;
}

Here is the caller graph for this function:

◆ getPacketsReference()

std::vector< Packet > & CCSDS::Manager::getPacketsReference ( )

inline

Returns a reference to the packets vector.

Note: changing the data will affect the packets stored in the manager.

Definition at line 239 of file CCSDSManager.h.

239{ return m_packets; }

Here is the caller graph for this function:

◆ getPacketTemplate()

CCSDS::ResultBuffer CCSDS::Manager::getPacketTemplate ( )

Retrieves the packet template in serialized form.

Returns: A ResultBuffer containing the serialized packet template.

Definition at line 86 of file CCSDSManager.cpp.

                                                  {
  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;
}

◆ getSyncPattern()

uint32_t CCSDS::Manager::getSyncPattern ( ) const

returns the currently set sync pattern.

Returns: uint32_t

Definition at line 9 of file CCSDSManager.cpp.

9{ return m_syncPattern; }

Here is the caller graph for this function:

◆ getSyncPatternEnable()

bool CCSDS::Manager::getSyncPatternEnable ( ) const

returns the current settings of the sync pattern enable

Returns: bool

Definition at line 13 of file CCSDSManager.cpp.

13{ return m_syncPattEnable; }

Here is the caller graph for this function:

◆ getTemplate()

Packet CCSDS::Manager::getTemplate ( )

inline

Retrieves the packet template.

Returns: The stored packet template.

Definition at line 159 of file CCSDSManager.h.

159{ return m_templatePacket; };

Here is the caller graph for this function:

◆ getTotalPackets()

uint16_t CCSDS::Manager::getTotalPackets ( ) const

Retrieves the total number of packets managed.

Returns: The total number of stored packets.

Definition at line 141 of file CCSDSManager.cpp.

                                             {
  return m_packets.size();
}

Here is the caller graph for this function:

◆ getValidatorReference()

Validator & CCSDS::Manager::getValidatorReference ( )

inline

Returns a reverence to the manager's Validator.

Note: changing settings of this instance will affect the manager

Definition at line 232 of file CCSDSManager.h.

232{ return m_validator; }

◆ load() [1/2]

CCSDS::ResultBool CCSDS::Manager::load ( const std::vector< Packet > & packets )

Load a vector of packets.

Parameters

packets The packets

Definition at line 170 of file CCSDSManager.cpp.

                                                                                 {
 
  for (const auto& packet: packets) {
    FORWARD_RESULT(addPacket(packet));
  }
  return true;
}

Here is the caller graph for this function:

◆ load() [2/2]

CCSDS::ResultBool CCSDS::Manager::load ( const std::vector< uint8_t > & packetsBuffer )

Load a packet or a series of packets from a buffer.

Parameters

packetsBuffer The buffer holding packet data.

Definition at line 178 of file CCSDSManager.cpp.

                                                                                        {
  RET_IF_ERR_MSG(packetsBuffer.size() < 8, ErrorCode::INVALID_DATA, "invalid packet buffer size");
  int offset{0};
  while (offset < packetsBuffer.size()) {
    std::vector<uint8_t> headerData;
    if (m_syncPattEnable) {
      const uint32_t value = (static_cast<uint32_t>(packetsBuffer[offset]) << 24) |
                             (static_cast<uint32_t>(packetsBuffer[offset+1]) << 16) |
                             (static_cast<uint32_t>(packetsBuffer[offset+2]) << 8)  |
                             (static_cast<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 uint16_t packetSize = header.getDataLength() + 8;
    std::vector<uint8_t>packetData;
    packetData.clear();
    copy_n(packetsBuffer.begin() + offset, packetSize, std::back_inserter(packetData));
    FORWARD_RESULT(addPacketFromBuffer(packetData));
    offset += packetSize;
  }
  return true;
}

Here is the call graph for this function:

◆ read()

CCSDS::ResultBool CCSDS::Manager::read ( const std::string & binaryFile )

Load a packet or a series of packets from a binary file.

Parameters

binaryFile path to the file holding packet data.

Definition at line 206 of file CCSDSManager.cpp.

                                                              {
  std::vector<uint8_t> buffer;
  ASSIGN_CP(buffer, readBinaryFile(binaryFile));
  FORWARD_RESULT(load(buffer));
  return true;
}

Here is the call graph for this function:

◆ readTemplate()

CCSDS::ResultBool CCSDS::Manager::readTemplate ( const std::string & filename )

Load a template packet from a binary or configuration file.

Parameters

filename path to the file holding template.

Definition at line 219 of file CCSDSManager.cpp.

                                                                    {
  Packet templatePacket;
 
  if (stringEndsWith(filename, ".bin")) {
    std::vector<uint8_t> buffer;
    ASSIGN_CP(buffer, readBinaryFile(filename));
    FORWARD_RESULT(templatePacket.deserialize(buffer));
  }else if (stringEndsWith(filename, ".cfg")) {
    Config cfg;
    FORWARD_RESULT(cfg.load(filename));
    std::vector<uint8_t> buffer;
    ASSIGN_CP(buffer,cfg.get<std::vector<uint8_t>>("template_data"));
    FORWARD_RESULT(templatePacket.deserialize(buffer));
  } else {
    return Error{INVALID_DATA,"Cannot load template, invalid file provided [supported extensions [.bin, .cfg]]"};
  }
  FORWARD_RESULT(setPacketTemplate(templatePacket));
  return true;
}

Here is the call graph for this function:

◆ setApplicationData()

CCSDS::ResultBool CCSDS::Manager::setApplicationData ( const std::vector< uint8_t > & data )

Sets the application data for the packet.

Parameters

data	The application data as a vector of bytes.

Returns: ResultBool indicating success or failure.

Definition at line 29 of file CCSDSManager.cpp.

                                                                               {
  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();
  }
 
  int i = 0;
  auto remainderBytes = static_cast<int>(dataBytesSize);
  auto sequenceFlag = UNSEGMENTED;
  while (i < dataBytesSize) {
    Packet newPacket = m_templatePacket;
    std::vector<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;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAutoUpdateEnable()

void CCSDS::Manager::setAutoUpdateEnable ( bool enable )

Enables or disables automatic updates for packets.

Parameters

enable Set to true to enable automatic updates, false to disable.

Definition at line 75 of file CCSDSManager.cpp.

                                                        {
  m_updateEnable = enable;
  for (auto &packet: m_packets) {
    packet.setUpdatePacketEnable(enable);
  }
}

◆ setAutoValidateEnable()

void CCSDS::Manager::setAutoValidateEnable ( bool enable )

Enables or disables automatic validation of packets.

Parameters

enable Set to true to enable automatic validation, false to disable.

Definition at line 82 of file CCSDSManager.cpp.

                                                          {
  m_validateEnable = enable;
}

Here is the caller graph for this function:

◆ setDatFieldSize()

void CCSDS::Manager::setDatFieldSize ( uint16_t size )

Sets the size of the data field.

Parameters

size	The new data field size in bytes.

Definition at line 25 of file CCSDSManager.cpp.

                                                      {
  m_templatePacket.setDataFieldSize(size);
}

Here is the caller graph for this function:

◆ setPacketTemplate()

CCSDS::ResultBool CCSDS::Manager::setPacketTemplate ( Packet packet )

Sets a new packet template.

Parameters

packet The new packet template to use.

Definition at line 15 of file CCSDSManager.cpp.

                                                             {
  RET_IF_ERR_MSG(m_templateIsSet, ErrorCode::SOMETHING_WENT_WRONG, "Cannot set Template as it is already set, please clear Manager first");
  m_templatePacket = std::move(packet);
  m_validator.setTemplatePacket(m_templatePacket);
  m_validator.configure(true, true, true);
  m_validateEnable = true;
  m_templateIsSet = true;
  return true;
}

Here is the caller graph for this function:

◆ setSyncPattern()

void CCSDS::Manager::setSyncPattern ( uint32_t syncPattern )

set sync pattern that should indicate the start of a CCSDS packet.

insertion is disabled by default. use setSyncPatternEnable to enable.

Parameters

syncPattern uint32_t (default 0x1ACFFC1D)

Definition at line 7 of file CCSDSManager.cpp.

7{ m_syncPattern = syncPattern; }

Here is the caller graph for this function:

◆ setSyncPatternEnable()

void CCSDS::Manager::setSyncPatternEnable ( bool enable )

enable sync pattern utilization both in serialization, deserialization, read and write.

Parameters

enable bool (default false)

Definition at line 11 of file CCSDSManager.cpp.

11{ m_syncPattEnable = enable; }

Here is the caller graph for this function:

◆ write()

CCSDS::ResultBool CCSDS::Manager::write ( const std::string & binaryFile ) const

Write a packet or a series of packets to a binary file.

Parameters

binaryFile destination file path for packets data.

Definition at line 213 of file CCSDSManager.cpp.

                                                                     {
  FORWARD_RESULT(writeBinaryFile(getPacketsBuffer(),binaryFile));
  return true;
}

Here is the call graph for this function:

Member Data Documentation

◆ m_packets

std::vector<Packet> CCSDS::Manager::m_packets

private

Collection of stored packets.

Definition at line 247 of file CCSDSManager.h.

◆ m_sequenceCount

uint16_t CCSDS::Manager::m_sequenceCount { 0 }

private

Definition at line 248 of file CCSDSManager.h.

248{ 0 };

◆ m_syncPattEnable

bool CCSDS::Manager::m_syncPattEnable { false }

private

bool indicating whether automatic sync pattern insertion is enabled (default: false).

Definition at line 246 of file CCSDSManager.h.

246{ false };

◆ m_syncPattern

uint32_t CCSDS::Manager::m_syncPattern {0x1ACFFC1D}

private

Definition at line 251 of file CCSDSManager.h.

251{0x1ACFFC1D};

◆ m_templateIsSet

bool CCSDS::Manager::m_templateIsSet { false }

private

Boolean to indicate if Template has been set or not.

Definition at line 243 of file CCSDSManager.h.

243{ false };

◆ m_templatePacket

Packet CCSDS::Manager::m_templatePacket {}

private

The template packet used for generating new packets.

Definition at line 242 of file CCSDSManager.h.

242{};

◆ m_updateEnable

bool CCSDS::Manager::m_updateEnable { true }

private

bool indicating whether automatic updates are enabled (default: true).

Definition at line 244 of file CCSDSManager.h.

244{ true };

◆ m_validateEnable

bool CCSDS::Manager::m_validateEnable { true }

private

bool indicating whether automatic validation is enabled (default: true).

Definition at line 245 of file CCSDSManager.h.

245{ true };

◆ m_validator

Validator CCSDS::Manager::m_validator {}

private

Definition at line 250 of file CCSDSManager.h.

250{};

The documentation for this class was generated from the following files:

inc/CCSDSManager.h
src/CCSDSManager.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Manager() [1/2]

◆ Manager() [2/2]

Member Function Documentation

◆ addPacket()

◆ addPacketFromBuffer()

◆ clear()

◆ clearPackets()

◆ getApplicationDataBuffer()

◆ getApplicationDataBufferAtIndex()

◆ getAutoUpdateEnable()

◆ getPacketBufferAtIndex()

◆ getPackets()

◆ getPacketsBuffer()

◆ getPacketsReference()

◆ getPacketTemplate()

◆ getSyncPattern()

◆ getSyncPatternEnable()

◆ getTemplate()

◆ getTotalPackets()

◆ getValidatorReference()

◆ load() [1/2]

◆ load() [2/2]

◆ read()

◆ readTemplate()

◆ setApplicationData()

◆ setAutoUpdateEnable()

◆ setAutoValidateEnable()

◆ setDatFieldSize()

◆ setPacketTemplate()

◆ setSyncPattern()

◆ setSyncPatternEnable()

◆ write()

Member Data Documentation

◆ m_packets

◆ m_sequenceCount

◆ m_syncPattEnable

◆ m_syncPattern

◆ m_templateIsSet

◆ m_templatePacket

◆ m_updateEnable

◆ m_validateEnable

◆ m_validator