CCSDSUtils.h File Reference

#include <CCSDSPacket.h>
#include <CCSDSManager.h>
#include <string>
#include <vector>

Include dependency graph for CCSDSUtils.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
uint16_t	crc16 (const std::vector< std::uint8_t > &data, std::uint16_t polynomial=0x1021, std::uint16_t initialValue=0xFFFF, std::uint16_t finalXorValue=0x0000)
	Computes the CRC-16 checksum for a given data vector with configurable parameters.
bool	stringEndsWith (const std::string &str, const std::string &suffix)
	Tests if str ends with suffix.
void	printPacket (CCSDS::Packet &packet)
	Prints to console a CCSDS Packets, breaking it down to Primary header and Data field.
void	printPackets (CCSDS::Manager &manager)
	Prints to console a series of CCSDS Packets contained in the manager.
std::string	getBinaryString (std::uint32_t value, std::int32_t bits)
	Converts a given value to its binary representation as a string, with spaces every 4 bits.
std::string	getBitsSpaces (std::int32_t num)
	Generates a string of spaces for formatting binary outputs.
void	printBufferData (const std::vector< std::uint8_t > &buffer, std::int32_t limitBytes=20)
	Prints to console the HEX data from the bytes vector.
void	printData (CCSDS::DataField dataField)
	Prints the data field details, including the secondary header and application data.
void	printHeader (CCSDS::Header &header)
	Prints the header fields and their binary or hexadecimal representations.
CCSDS::ResultBool	printPrimaryHeader (CCSDS::Packet &packet)
	Prints to console the primary header of a provided CCSDS packet.
void	printDataField (CCSDS::Packet &packet)
	Prints the data field and the CRC-16 checksum of the packet.
CCSDS::ResultBool	writeBinaryFile (const std::vector< std::uint8_t > &data, const std::string &filename)
	This function takes in a buffer of data and a file name.
CCSDS::ResultBuffer	readBinaryFile (const std::string &filename)
	Read a specified binary file and return its contents as a buffer.
bool	fileExists (const std::string &fileName)
	filesystem check fore file existence prepared for both windows and linux.

Function Documentation

crc16()

uint16_t crc16	(	const std::vector< std::uint8_t > &	data,
		std::uint16_t	polynomial = 0x1021,
		std::uint16_t	initialValue = 0xFFFF,
		std::uint16_t	finalXorValue = 0x0000
	)

Computes the CRC-16 checksum for a given data vector with configurable parameters.

Parameters

data	A vector of bytes to compute the checksum for.
polynomial	The polynomial used for the CRC calculation (default: CCSDS CRC-16 polynomial 0x1021).
initialValue	The initial value of the CRC register (default: 0xFFFF).
finalXorValue	The final XOR value applied to the CRC result (default: 0x0000).

Returns

The computed 16-bit CRC value.

Definition at line 20 of file CCSDSUtils.cpp.

                                   {
  std::uint16_t crc = initialValue;
 
  for (const auto &byte: data) {
    crc ^= static_cast<std::uint16_t>(byte) << 8; // Align byte with MSB of 16-bit CRC
    for (std::int32_t i = 0; i < 8; ++i) {
      // Process each bit
      if (crc & 0x8000) {
        // Check if MSB is set
        crc = (crc << 1) ^ polynomial; // Shift and XOR with polynomial
      } else {
        crc = crc << 1; // Shift only
      }
    }
  }
 
  return crc ^ finalXorValue; // Apply final XOR
}

Here is the caller graph for this function:

fileExists()

bool fileExists

(

const std::string &

fileName

)

filesystem check fore file existence prepared for both windows and linux.

Parameters

fileName

std::string

Returns

bool

Definition at line 240 of file CCSDSUtils.cpp.

                                           {
  auto res = readBinaryFile(fileName);
  if ( res.has_value()) {
    return true;
  }
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

getBinaryString()

std::string getBinaryString	(	std::uint32_t	value,
		std::int32_t	bits
	)

Converts a given value to its binary representation as a string, with spaces every 4 bits.

Parameters

value	The 32-bit integer value to convert.
bits	The number of significant bits to include in the binary string.

Returns

A string representing the binary value with spaces every 4 bits.

Definition at line 46 of file CCSDSUtils.cpp.

                                                                          {
  std::string binaryString;
  // Calculate the minimum number of bits required to represent in groups of 4
  const std::int32_t paddedBits = ((bits + 3) / 4) * 4; // Round up to the nearest multiple of 4
 
  for (std::int32_t i = paddedBits - 1; i >= 0; --i) {
    binaryString += ((value >> i) & 1) ? '1' : '0';
 
    // Add a space after every 4 bits, except at the end
    if (i % 4 == 0 && i != 0) {
      binaryString += ' ';
    }
  }
  return binaryString;
}

Here is the caller graph for this function:

getBitsSpaces()

std::string getBitsSpaces

(

std::int32_t

num

)

Generates a string of spaces for formatting binary outputs.

Parameters

num	The number of spaces required.

Returns

A string of spaces of length num.

Definition at line 62 of file CCSDSUtils.cpp.

                                              {
  std::string spaces;
 
  for (std::int32_t i = num - 1; i >= 0; --i) {
    spaces += ' ';
  }
 
  return spaces;
}

Here is the caller graph for this function:

printBufferData()

void printBufferData	(	const std::vector< std::uint8_t > &	buffer,
		std::int32_t	limitBytes = 20
	)

Prints to console the HEX data from the bytes vector.

Parameters

buffer
limitBytes

Definition at line 72 of file CCSDSUtils.cpp.

                                                                                       {
  std::cout << "[ ";
  if (buffer.size() > limitBytes) {
    for (size_t i= 0 ; i < static_cast<int>(limitBytes / 2); i++) {
      std::cout << std::hex << std::setfill('0') << std::setw(2) << static_cast<int>(buffer[i]) << " ";
    }
    std::cout << "... ";
    for (size_t i = buffer.size() - static_cast<int>(limitBytes / 2) ; i < buffer.size(); i++) {
      std::cout << std::hex << std::setfill('0') << std::setw(2) << static_cast<int>(buffer[i]) << " ";
    }
  } else {
    for (const unsigned char i: buffer) {
      std::cout << std::hex << std::setfill('0') << std::setw(2) << static_cast<int>(i) << " ";
    }
  }
  std::cout << "]" << std::endl;
}

Here is the caller graph for this function:

printData()

void printData

(

CCSDS::DataField

dataField

)

Prints the data field details, including the secondary header and application data.

Outputs information about the presence of a secondary header and the content of both the secondary header and the application data in hexadecimal format.

Returns

none.

Definition at line 90 of file CCSDSUtils.cpp.

                                         {
  const auto dataFieldHeader = dataField.getDataFieldHeaderBytes();
  auto applicationData = dataField.getApplicationData();
  const std::uint16_t maxSize = (applicationData.size() > dataFieldHeader.size())
                             ? applicationData.size()
                             : dataFieldHeader.size();
 
  std::cout << " [CCSDS DATA] Data Field Length              : " << applicationData.size() + dataFieldHeader.size() << " bytes" << std::endl;
  std::cout << " [CCSDS DATA] Secondary Header Present       : [ " << (dataField.getDataFieldHeaderFlag()
                                                                         ? "True"
                                                                         : "False") << " ]" << std::endl;
  if (!dataFieldHeader.empty()) {
    std::cout << " [CCSDS DATA] Secondary Header         [Hex] : " << getBitsSpaces(
    (maxSize - static_cast<std::uint16_t>(dataFieldHeader.size())) * 4);
    printBufferData(dataFieldHeader);
  }
 
  std::cout << " [CCSDS DATA] Application Data         [Hex] : ";
  printBufferData(applicationData);
  std::cout << std::endl;
}

Here is the call graph for this function:

Here is the caller graph for this function:

printDataField()

void printDataField

(

CCSDS::Packet &

packet

)

Prints the data field and the CRC-16 checksum of the packet.

Outputs the content of the data field and the CRC-16 checksum in hexadecimal format to the standard output.

Returns

none.

Definition at line 173 of file CCSDSUtils.cpp.

                                         {
  auto dataField = packet.getDataField();
 
  printData(dataField);
  std::cout << "[ CCSDSPack ] CRC-16                   [Hex] : [ " << "0x" << std::hex << packet.getCRC() << " ]";
  std::cout << " - [Dec] : "<< std::dec << packet.getCRC() << std::endl;
 
}

Here is the call graph for this function:

Here is the caller graph for this function:

printHeader()

void printHeader

(

CCSDS::Header &

header

)

Prints the header fields and their binary or hexadecimal representations.

Outputs all relevant header fields, including the full primary header, version number, type, data field header flag, APID, sequence flags, sequence count, and data length. Each field is displayed with appropriate formatting and spacing.

Returns

none.

Definition at line 112 of file CCSDSUtils.cpp.

                                      {
  std::cout << " [CCSDS HEADER] Full Primary Header    [Hex] : [ " << getBitsSpaces(17 - 12) << "0x" << std::hex <<
      header.getFullHeader() << " ]" << std::endl;
  std::cout << std::endl;
 
  std::cout << " [CCSDS HEADER] Version Number               : [ " << getBitsSpaces(19 - 4) <<
      getBinaryString(header.getVersionNumber(), 3) << " ]";
  std::cout << " - [Dec] : "<< std::dec <<  static_cast<int>( header.getVersionNumber())  << std::endl;
 
  std::cout << " [CCSDS HEADER] Type                         : [ " << getBitsSpaces(19 - 4) <<
      getBinaryString(header.getType(), 1) << " ]";
  std::cout << " - [Dec] : "<< std::dec << static_cast<int>( header.getType()) << std::endl;
 
  std::cout << " [CCSDS HEADER] Data Field Header Flag       : [ " << getBitsSpaces(19 - 4) << getBinaryString(
  header.getDataFieldHeaderFlag(), 1) << " ]";
  std::cout << " -       : " << (header.getDataFieldHeaderFlag() ? "True" : "False")  << std::endl;
 
  std::cout << " [CCSDS HEADER] APID                         : [ " << getBitsSpaces(17 - 12) <<
    getBinaryString(header.getAPID(), 11) << " ]";
  std::cout << " - [Dec] : " << std::dec << header.getAPID() << std::endl;
  
  std::cout << " [CCSDS HEADER] Sequence Flags               : [ " << getBitsSpaces(19 - 4) <<
    getBinaryString(header.getSequenceFlags(), 2) << " ]";
  std::cout << " -       : ";
  switch(header.getSequenceFlags()) {
    case 0:
      std::cout << "CONTINUING_SEGMENT";
      break;
    case 1:
      std::cout << "FIRST_SEGMENT";
      break;
    case 2:
      std::cout << "LAST_SEGMENT";
      break;
    case 3:
      std::cout << "UNSEGMENTED";
      break;
    default:
      break;
  }
  std::cout << std::endl;
 
  std::cout << " [CCSDS HEADER] Sequence Count               : [ " << getBitsSpaces(0) << getBinaryString(
  header.getSequenceCount(), 14) << " ]";
  std::cout << " - [Dec] : "<< std::dec << header.getSequenceCount() << std::endl;
 
  std::cout << " [CCSDS HEADER] DataLength                   : [ " << getBinaryString(header.getDataLength(), 16) <<
    " ]";
  std::cout << " - [Dec] : "<< std::dec << header.getDataLength() << std::endl;
 
  std::cout << std::endl;
}

Here is the call graph for this function:

Here is the caller graph for this function:

printPacket()

void printPacket

(

CCSDS::Packet &

packet

)

Prints to console a CCSDS Packets, breaking it down to Primary header and Data field.

Parameters

packet

Definition at line 182 of file CCSDSUtils.cpp.

                                      {
  printPrimaryHeader(packet);
  printDataField(packet);
}

Here is the call graph for this function:

Here is the caller graph for this function:

printPackets()

void printPackets

(

CCSDS::Manager &

manager

)

Prints to console a series of CCSDS Packets contained in the manager.

Parameters

manager

Definition at line 187 of file CCSDSUtils.cpp.

                                         {
  std::cout << "[ CCSDS Manager ] Number of Packets    : " << manager.getTotalPackets() << std::endl;
  std::cout << "[ CCSDS Manager ] Sync Pattern Enabled : " << (manager.getSyncPatternEnable() ? "True" : "False") << std::endl;
  std::cout << "[ CCSDS Manager ] Sync Pattern         : 0x" << std::hex << manager.getSyncPattern() << std::dec << std::endl;
 
  auto templatePacket = manager.getTemplate();
  std::cout << "[ CCSDS Manager ] Template             : " << std::endl ;
  printPrimaryHeader(templatePacket);
 
  std::int32_t idx = 1;
  for (auto &packet: manager.getPacketsReference()) {
    std::cout << "__________________________________________________________________________________________________________________" << std::endl;
    std::cout << "[ CCSDS Manager ] Printing Packet [ " << idx << " ]:" << std::endl;
    std::cout << "[ CCSDS Manager ] Packet Length : " << packet.getFullPacketLength() << " bytes" << std::endl;
    std::cout << "[ CCSDS Manager ] Data ";
    printBufferData(packet.serialize(), 20);
    printPacket(packet);
    idx++;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

printPrimaryHeader()

CCSDS::ResultBool printPrimaryHeader

(

CCSDS::Packet &

packet

)

Prints to console the primary header of a provided CCSDS packet.

Parameters

packet

Returns

ResultBool

Definition at line 166 of file CCSDSUtils.cpp.

                                                        {
  CCSDS::Header header;
  FORWARD_RESULT(header.deserialize({packet.getPrimaryHeaderBytes()}));
  printHeader(header);
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

readBinaryFile()

CCSDS::ResultBuffer readBinaryFile

(

const std::string &

filename

)

Read a specified binary file and return its contents as a buffer.

Parameters

filename

Returns

Result vector of std::uint8 or Error

Definition at line 222 of file CCSDSUtils.cpp.

                                                            {
  RET_IF_ERR_MSG(filename.empty(),CCSDS::ErrorCode::FILE_READ_ERROR, "No filename provided");
 
  std::ifstream in(filename, std::ios::binary | std::ios::ate);
  RET_IF_ERR_MSG(!in,CCSDS::ErrorCode::FILE_READ_ERROR, "Failed to open file for reading");
 
  // Get the file size using the 'ate' flag (seeks to the end automatically)
  const std::streamsize size = in.tellg();
  in.seekg(0, std::ios::beg);
 
  // Read the entire file content into the vector
  std::vector<std::uint8_t> data(size);
  in.read(reinterpret_cast<char*>(data.data()), size);
 
  RET_IF_ERR_MSG(!in,CCSDS::ErrorCode::FILE_READ_ERROR, "Failed to read the entire file");
  return data;
}

Here is the caller graph for this function:

stringEndsWith()

bool stringEndsWith	(	const std::string &	str,
		const std::string &	suffix
	)

Tests if str ends with suffix.

equivalent to endsWith(str) in c++20

Parameters

str	string
suffix	string

Returns

boolean

Definition at line 41 of file CCSDSUtils.cpp.

                                                                   {
  return str.size() >= suffix.size() &&
         str.compare(str.size() - suffix.size(), suffix.size(), suffix) == 0;
}

Here is the caller graph for this function:

writeBinaryFile()

CCSDS::ResultBool writeBinaryFile	(	const std::vector< std::uint8_t > &	data,
		const std::string &	filename
	)

This function takes in a buffer of data and a file name.

and writes the data in binary form to the file.

Parameters

data	vector of std::uint8_t
filename	string

Returns

Result boolean true if successful or error

Definition at line 208 of file CCSDSUtils.cpp.

                                                                                              {
  RET_IF_ERR_MSG(filename.empty(),CCSDS::ErrorCode::FILE_WRITE_ERROR, "No filename provided");
  RET_IF_ERR_MSG(data.empty(),CCSDS::ErrorCode::FILE_WRITE_ERROR, "No data provided");
  std::ofstream out(filename, std::ios::binary);
 
  RET_IF_ERR_MSG(!out,CCSDS::ErrorCode::FILE_WRITE_ERROR, "Failed to open file for writing");
 
  // Write the entire vector data to the file in one go
  out.write(reinterpret_cast<const char*>(data.data()), static_cast<std::streamsize>(data.size()));
  RET_IF_ERR_MSG(!out,CCSDS::ErrorCode::FILE_WRITE_ERROR, "Failed to write the data to the file");
 
  return true;
}

Here is the caller graph for this function: