CCSDS::Packet Class Reference

Represents a CCSDS (Consultative Committee for Space Data Systems) packet. More...

#include <CCSDSPacket.h>

Collaboration diagram for CCSDS::Packet:

Public Member Functions
	Packet ()=default
void	setPrimaryHeader (PrimaryHeader data)
	Sets the primary header using the provided PrimaryHeader object.
ResultBool	setPrimaryHeader (std::uint64_t data)
	Sets the primary header using the provided 64-bit data.
ResultBool	setPrimaryHeader (const std::vector< std::uint8_t > &data)
	Sets the primary header using the provided vector of std::uint8_tdata.
void	setPrimaryHeader (const Header &header)
	Sets the primary header using the provided header object.
void	setDataFieldHeader (const std::shared_ptr< SecondaryHeaderAbstract > &header)
	Sets the data field header using the provided SecondaryHeaderAbstract derived header.
template<typename T >
ResultBool	RegisterSecondaryHeader ()
	Registers a new header type with the data field secondary header creation function.
ResultBool	setDataFieldHeader (const std::vector< std::uint8_t > &data, const std::string &headerType)
	Sets the data field header for the packet using a vector of bytes.
ResultBool	setDataFieldHeader (const std::uint8_t *pData, size_t sizeData, const std::string &headerType)
	Sets the data field header for the packet using a raw data pointer.
ResultBool	setDataFieldHeader (const std::vector< std::uint8_t > &data)
	Sets the data field header using the provided vector of bytes.
ResultBool	setDataFieldHeader (const std::uint8_t *pData, size_t sizeData)
	Sets the data field header using the provided pointer and size.
ResultBool	setApplicationData (const std::vector< std::uint8_t > &data)
	Sets the application data for the packet.
ResultBool	setApplicationData (const std::uint8_t *pData, size_t sizeData)
	Sets the application data for the packet.
void	setSequenceFlags (ESequenceFlag flags)
	Sets the sequence flags for the packet's primary header.
ResultBool	setSequenceCount (std::uint16_t count)
	Sets the sequence count for the packet.
void	setDataFieldSize (std::uint16_t size)
	Sets the maximum data packet size for the CCSDS DataField.
void	setUpdatePacketEnable (bool enable)
	needs to be called as soon as possible, probably also from constructor.
ResultBool	deserialize (const std::vector< std::uint8_t > &data)
	Deserializes a vector of bytes into a CCSDS packet.
ResultBool	deserialize (const std::vector< std::uint8_t > &data, const std::string &headerType, std::int32_t headerSize=-1)
	Deserializes a CCSDS packet using a vector and a registered header type.
ResultBool	deserialize (const std::vector< uint8_t > &data, std::uint16_t headerDataSizeBytes)
	Deserializes a CCSDS packet using a vector and a header data size.
ResultBool	deserialize (const std::vector< uint8_t > &headerData, const std::vector< uint8_t > &data)
	Deserializes a CCSDS packet using separate header and data vectors.
std::uint64_t	getPrimaryHeader64bit ()
	Retrieves the primary header of the packet.
std::uint16_t	getFullPacketLength ()
	Retrieves the current size of the CCSDS Packet.
std::vector< uint8_t >	serialize ()
	Retrieves the full packet as a vector of bytes.
std::vector< uint8_t >	getPrimaryHeaderBytes ()
	Retrieves the primary header of the packet as a vector of bytes.
std::vector< uint8_t >	getDataFieldHeaderBytes ()
	Retrieves the secondary header data from the data field.
std::vector< uint8_t >	getApplicationDataBytes ()
	Retrieves the application data from the data field.
std::vector< uint8_t >	getFullDataFieldBytes ()
	Retrieves the full data field data.
std::vector< uint8_t >	getCRCVectorBytes ()
	Retrieves the CRC-16 checksum as a vector of bytes.
std::uint16_t	getCRC ()
	Computes and retrieves the CRC-16 checksum of the packet.
std::uint16_t	getDataFieldMaximumSize () const
	returns the maximum data field size
bool	getDataFieldHeaderFlag ()
	@ returns the data field header flag
DataField &	getDataField ()
	returns the CCSDS packet's DataField.
Header &	getPrimaryHeader ()
	returns the CCSDS packet's Primary Header.
void	setCrcConfig (const CRC16Config crcConfig)
	Sets the crc configuration of the crc calculation.
void	setCrcConfig (const std::uint16_t polynomial, const std::uint16_t initialValue, const std::uint16_t finalXorValue)
	Sets the crc configuration of the crc calculation.
void	update ()
	Updates Primary headers data field size.
ResultBool	loadFromConfigFile (const std::string &configPath)
	Loads a packet from a configuration file, including secondary header if present.
ResultBool	loadFromConfig (const Config &cfg)
	Loads a packet from a configuration object, including secondary header if present.

Private Attributes
Header	m_primaryHeader {}
	6 bytes / 48 bits / 12 hex
DataField	m_dataField {}
	variable
std::uint16_t	m_CRC16 {}
	Cyclic Redundancy check 16 bits.
CRC16Config	m_CRC16Config
	structure holding configuration of crc calculation.
bool	m_updateStatus {false}
	When setting data thus value should be set to false.
bool	m_enableUpdatePacket {true}
	Enables primary header and secondary header update.
std::uint16_t	m_sequenceCounter {0}

Detailed Description

Represents a CCSDS (Consultative Committee for Space Data Systems) packet.

This class provides functionality to construct and manage a CCSDS packet, which includes both the primary header and the data field. It allows setting and getting the primary header, data field headers (PusA, PusB, PusC), and application data. The packet also includes a CRC-16 checksum for error detection.

The class provides methods for managing the packet's data structure, including printing the headers and data field, calculating the CRC-16, and combining the primary header, data field, and CRC into a complete packet. The header is updated automatically when necessary, and it provides both raw and vector representations of the data for further use or transmission.

The Packet class also handles the internal state for CRC calculation and header updates to ensure data consistency.

Definition at line 59 of file CCSDSPacket.h.

Constructor & Destructor Documentation

Packet()

CCSDS::Packet::Packet ( )

default

Member Function Documentation

deserialize() [1/4]

CCSDS::ResultBool CCSDS::Packet::deserialize

(

const std::vector< std::uint8_t > &

data

)

Deserializes a vector of bytes into a CCSDS packet.

Definition at line 173 of file CCSDSPacket.cpp.

                                                                          {
  RET_IF_ERR_MSG(data.size() <= 7, ErrorCode::INVALID_HEADER_DATA,
                 "Cannot Deserialize Packet, Invalid Data provided data size must be at least 8 bytes");
 
  std::vector<std::uint8_t> dataFieldVector;
  std::copy(data.begin() + 6, data.end(), std::back_inserter(dataFieldVector));
 
  FORWARD_RESULT(deserialize({data[0], data[1], data[2], data[3], data[4], data[5]}, dataFieldVector));
 
  return true;
}

Here is the caller graph for this function:

deserialize() [2/4]

CCSDS::ResultBool CCSDS::Packet::deserialize	(	const std::vector< std::uint8_t > &	data,
		const std::string &	headerType,
		std::int32_t	headerSize = -1
	)

Deserializes a CCSDS packet using a vector and a registered header type.

Definition at line 185 of file CCSDSPacket.cpp.

                                                                                                                                    {
  RET_IF_ERR_MSG(data.size() <= 8, ErrorCode::INVALID_DATA,
                 "Cannot Deserialize Packet, Invalid Data provided data size must be at least 8 bytes");
  RET_IF_ERR_MSG(headerType == "BufferHeader", ErrorCode::INVALID_SECONDARY_HEADER_DATA,
                 "Cannot Deserialize Packet, BufferHeader is not of defined size");
  RET_IF_ERR_MSG(!m_dataField.getDataFieldHeaderFactory().typeIsRegistered(headerType),
                 ErrorCode::INVALID_SECONDARY_HEADER_DATA,
                 "Cannot Deserialize Packet, Unregistered Secondary header: " + headerType);
  std::uint16_t headerDataSizeBytes{0};
  const auto secondaryHeader = m_dataField.getDataFieldHeaderFactory().create(headerType);
  if (headerType == "PusC" && headerSize > 0) {
    headerDataSizeBytes = headerSize;
  }else {
    headerDataSizeBytes = secondaryHeader->getSize();
  }
 
  std::vector<std::uint8_t> dataFieldHeaderVector;
  std::copy_n(data.begin() + 6, headerDataSizeBytes, std::back_inserter(dataFieldHeaderVector));
  FORWARD_RESULT(secondaryHeader->deserialize(dataFieldHeaderVector ));
  setDataFieldHeader(secondaryHeader);
 
  if (data.size() > (8 + headerDataSizeBytes)) {
    std::vector<std::uint8_t> dataFieldVector;
 
    if (data.size() > (9 + headerDataSizeBytes)) {
      std::copy(data.begin() + 6 + headerDataSizeBytes, data.end(), std::back_inserter(dataFieldVector));
    }
    FORWARD_RESULT(deserialize({data[0], data[1], data[2], data[3], data[4], data[5]}, dataFieldVector));
  }
 
  return true;
}

deserialize() [3/4]

ResultBool CCSDS::Packet::deserialize	(	const std::vector< uint8_t > &	data,
		std::uint16_t	headerDataSizeBytes
	)

Deserializes a CCSDS packet using a vector and a header data size.

deserialize() [4/4]

ResultBool CCSDS::Packet::deserialize	(	const std::vector< uint8_t > &	headerData,
		const std::vector< uint8_t > &	data
	)

Deserializes a CCSDS packet using separate header and data vectors.

getApplicationDataBytes()

std::vector< std::uint8_t > CCSDS::Packet::getApplicationDataBytes

(

)

Retrieves the application data from the data field.

Returns

A vector containing the Application data.

Definition at line 148 of file CCSDSPacket.cpp.

                                                           {
  update();
  return m_dataField.getApplicationData();
}

getCRC()

uint16_t CCSDS::Packet::getCRC

(

)

Computes and retrieves the CRC-16 checksum of the packet.

If the CRC-16 has not already been calculated, this function computes it using the full data field of the packet. The result is cached for future calls to improve performance.

Returns

The 16-bit CRC-16 checksum.

Definition at line 101 of file CCSDSPacket.cpp.

                             {
  update();
  return m_CRC16;
}

Here is the caller graph for this function:

getCRCVectorBytes()

std::vector< std::uint8_t > CCSDS::Packet::getCRCVectorBytes

(

)

Retrieves the CRC-16 checksum as a vector of bytes.

The checksum is split into its most significant byte (MSB) and least significant byte (LSB) and stored in a two-element vector.

Returns

A vector containing the MSB and LSB of the CRC-16 checksum.

Definition at line 115 of file CCSDSPacket.cpp.

                                                     {
  std::vector<std::uint8_t> crc(2);
  const auto crcVar = getCRC();
  crc[0] = (crcVar >> 8) & 0xFF; // MSB (Most Significant Byte)
  crc[1] = crcVar & 0xFF; // LSB (Least Significant Byte)
  return crc;
}

getDataField()

CCSDS::DataField & CCSDS::Packet::getDataField

(

)

returns the CCSDS packet's DataField.

Definition at line 123 of file CCSDSPacket.cpp.

                                          {
  update();
  return m_dataField;
}

Here is the caller graph for this function:

getDataFieldHeaderBytes()

std::vector< std::uint8_t > CCSDS::Packet::getDataFieldHeaderBytes

(

)

Retrieves the secondary header data from the data field.

Returns

A vector containing the Secondary header data.

Definition at line 143 of file CCSDSPacket.cpp.

                                                           {
  update();
  return m_dataField.getDataFieldHeaderBytes();
}

getDataFieldHeaderFlag()

bool CCSDS::Packet::getDataFieldHeaderFlag

(

)

@ returns the data field header flag

Definition at line 110 of file CCSDSPacket.cpp.

                                         {
  update();
  return m_primaryHeader.getDataFieldHeaderFlag();
}

getDataFieldMaximumSize()

uint16_t CCSDS::Packet::getDataFieldMaximumSize

(

)

const

returns the maximum data field size

Definition at line 106 of file CCSDSPacket.cpp.

                                                    {
  return m_dataField.getDataFieldAvailableBytesSize();
}

getFullDataFieldBytes()

std::vector< std::uint8_t > CCSDS::Packet::getFullDataFieldBytes

(

)

Retrieves the full data field data.

i.e. Application data and Secondary header data if applicable.

Returns

A vector containing the data field data.

Definition at line 153 of file CCSDSPacket.cpp.

                                                         {
  return m_dataField.serialize();
}

getFullPacketLength()

uint16_t CCSDS::Packet::getFullPacketLength

(

)

Retrieves the current size of the CCSDS Packet.

Returns

16bit unsigned integer

Definition at line 253 of file CCSDSPacket.cpp.

                                          {
  // where 8 is derived from 6 bytes for Primary header and 2 bytes for CRC16.
  return 8 + m_dataField.getDataFieldUsedBytesSize();
}

getPrimaryHeader()

CCSDS::Header & CCSDS::Packet::getPrimaryHeader

(

)

returns the CCSDS packet's Primary Header.

Definition at line 128 of file CCSDSPacket.cpp.

                                           {
  update();
  return m_primaryHeader;
}

Here is the caller graph for this function:

getPrimaryHeader64bit()

uint64_t CCSDS::Packet::getPrimaryHeader64bit

(

)

Retrieves the primary header of the packet.

This function ensures that the primary header is updated by calling the updatePrimaryHeader() function, and then returns the full 48-bit primary header as a 64-bit integer.

Returns

The 64-bit primary header of the packet.

Definition at line 133 of file CCSDSPacket.cpp.

                                            {
  update();
  return m_primaryHeader.getFullHeader();
};

getPrimaryHeaderBytes()

std::vector< std::uint8_t > CCSDS::Packet::getPrimaryHeaderBytes

(

)

Retrieves the primary header of the packet as a vector of bytes.

Extracts the 48-bit primary header and converts it into a six-element vector, ordered from the most significant byte (MSB) to the least significant byte (LSB).

Returns

A vector containing the six bytes of the primary header.

Definition at line 138 of file CCSDSPacket.cpp.

                                                         {
  update();
  return m_primaryHeader.serialize();
}

loadFromConfig()

CCSDS::ResultBool CCSDS::Packet::loadFromConfig

(

const Config &

cfg

)

Loads a packet from a configuration object, including secondary header if present.

Parameters

cfg	configuration object.

Returns

ResultBool

Definition at line 37 of file CCSDSPacket.cpp.

                                                             {
  std::uint8_t versionNumber;
  std::uint8_t type;
  std::uint8_t APID{0};
  std::uint8_t dataFieldHeaderFlag;
  std::uint16_t sequenceCount;
  ESequenceFlag sequenceFlag{};
  bool segmented{false};
 
  RET_IF_ERR_MSG(!cfg.isKey( "ccsds_version_number"), ErrorCode::CONFIG_FILE_ERROR,
                 "Config: Missing int field: ccsds_version_number");
  RET_IF_ERR_MSG(!cfg.isKey( "ccsds_type"), ErrorCode::CONFIG_FILE_ERROR,
                 "Config: Missing bool field: ccsds_type");
  RET_IF_ERR_MSG(!cfg.isKey("ccsds_data_field_header_flag"), ErrorCode::CONFIG_FILE_ERROR,
                 "Config: Missing bool field: ccsds_data_field_header_flag");
  RET_IF_ERR_MSG(!cfg.isKey( "ccsds_APID"), ErrorCode::CONFIG_FILE_ERROR,
                 "Config: Missing int field: ccsds_APID");
  RET_IF_ERR_MSG(!cfg.isKey( "ccsds_segmented"), ErrorCode::CONFIG_FILE_ERROR,
                 "Config: Missing bool field: ccsds_segmented");
 
  ASSIGN_OR_PRINT(versionNumber, cfg.get< int>( "ccsds_version_number"));
  ASSIGN_OR_PRINT(type, cfg.get<bool>( "ccsds_type"));
  ASSIGN_OR_PRINT(dataFieldHeaderFlag, cfg.get<bool>("ccsds_data_field_header_flag"));
  ASSIGN_OR_PRINT(APID, cfg.get< int>( "ccsds_APID"));
  ASSIGN_OR_PRINT(segmented, cfg.get<bool>( "ccsds_segmented"));
 
  m_primaryHeader.setVersionNumber(versionNumber);
  m_primaryHeader.setType(type);
  m_primaryHeader.setDataFieldHeaderFlag(dataFieldHeaderFlag);
  m_primaryHeader.setAPID(APID);
  if (segmented) {
    sequenceCount = 1;
    sequenceFlag = FIRST_SEGMENT;
  }else {
    sequenceCount = 0;
    sequenceFlag = UNSEGMENTED;
  }
  m_primaryHeader.setSequenceFlags(sequenceFlag);
  m_primaryHeader.setSequenceCount(sequenceCount);
 
  if (cfg.isKey( "data_field_size")) { // optional field
    std::uint16_t dataFieldSize;
    ASSIGN_OR_PRINT(dataFieldSize, cfg.get< int>( "data_field_size"));
    m_dataField.setDataPacketSize(dataFieldSize);
  }
 
  if (cfg.isKey("define_secondary_header")) { // optional field
    bool secondaryHeaderFlag{false};
    ASSIGN_OR_PRINT(secondaryHeaderFlag, cfg.get<bool>("define_secondary_header"));
    if (secondaryHeaderFlag) {
      FORWARD_RESULT( m_dataField.setDataFieldHeader(cfg));
    }
  }
 
  if (cfg.isKey("application_data")) { // optional field
    std::vector<std::uint8_t> applicationData{};
    ASSIGN_OR_PRINT(applicationData, cfg.get<std::vector<std::uint8_t>>("application_data"));
    FORWARD_RESULT( m_dataField.setApplicationData(applicationData));
  }
 
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

loadFromConfigFile()

CCSDS::ResultBool CCSDS::Packet::loadFromConfigFile

(

const std::string &

configPath

)

Loads a packet from a configuration file, including secondary header if present.

Parameters

configPath

path to the configuration file.

Returns

ResultBool

Definition at line 30 of file CCSDSPacket.cpp.

                                                                           {
  Config cfg;
  cfg.load(configPath);
  FORWARD_RESULT(loadFromConfig(cfg));
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterSecondaryHeader()

template<typename T >

ResultBool CCSDS::Packet::RegisterSecondaryHeader ( )

inline

Registers a new header type with the data field secondary header creation function.

This function adds a new header type to the factory by associating the header's type string with a shared pointer to the header.

Parameters

header

A shared pointer to a SecondaryHeaderAbstract object to register.

Returns

ResultBool.

Definition at line 128 of file CCSDSPacket.h.

                                         {
      FORWARD_RESULT( m_dataField.RegisterSecondaryHeader<T>());
      return true;
    }

Here is the call graph for this function:

serialize()

std::vector< std::uint8_t > CCSDS::Packet::serialize

(

)

Retrieves the full packet as a vector of bytes.

Combines the primary header, data field, and CRC-16 checksum into a single vector. Ensures that the header and data field sizes meet minimum requirements.

Note

Header size must be 6 bytes and data field size must be greater than 1 byte.

Returns

A vector containing the full packet in byte form.

Definition at line 157 of file CCSDSPacket.cpp.

                                             {
  auto header = getPrimaryHeaderBytes();
  auto dataField = m_dataField.serialize();
  const auto crc = getCRCVectorBytes();
 
  std::vector<std::uint8_t> packet;
  packet.reserve(header.size() + dataField.size() + crc.size());
  packet.insert(packet.end(), header.begin(), header.end());
  if (!getFullDataFieldBytes().empty()) {
    packet.insert(packet.end(), dataField.begin(), dataField.end());
  }
  packet.insert(packet.end(), crc.begin(), crc.end());
 
  return packet;
}

setApplicationData() [1/2]

CCSDS::ResultBool CCSDS::Packet::setApplicationData	(	const std::uint8_t *	pData,
		size_t	sizeData
	)

Sets the application data for the packet.

This function sets the application data in the data field of the packet using a pointer to the data and its size.

Note

The method will log an error to standard error and ErrorCode is returned by ResultBool if provided data is invalid.

Parameters

pData	A pointer to the application data.
sizeData	The size of the application data.

Returns

ResultBool.

Definition at line 318 of file CCSDSPacket.cpp.

                                                                                              {
  FORWARD_RESULT(m_dataField.setApplicationData( pData,sizeData ));
  m_updateStatus = false;
  return true;
}

setApplicationData() [2/2]

CCSDS::ResultBool CCSDS::Packet::setApplicationData

(

const std::vector< std::uint8_t > &

data

)

Sets the application data for the packet.

This function sets the application data in the data field of the packet using a vector of bytes.

Note

The method will log an error to standard error and ErrorCode is returned by ResultBool if provided data is invalid.

Parameters

data	The vector containing the application data.

Returns

ResultBool.

Definition at line 312 of file CCSDSPacket.cpp.

                                                                                 {
  FORWARD_RESULT(m_dataField.setApplicationData( data ));
  m_updateStatus = false;
  return true;
}

Here is the caller graph for this function:

setCrcConfig() [1/2]

void CCSDS::Packet::setCrcConfig ( const CRC16Config  crcConfig )

inline

Sets the crc configuration of the crc calculation.

This method sets the following variables to be used when performing the crc calculation of data passed as a structure of CRC16Config.

• polynomial
• initial value
• final xor value

Parameters

crcConfig

Definition at line 367 of file CCSDSPacket.h.

{m_CRC16Config = crcConfig;}

setCrcConfig() [2/2]

void CCSDS::Packet::setCrcConfig ( const std::uint16_t  polynomial, const std::uint16_t  initialValue, const std::uint16_t  finalXorValue  )

inline

Sets the crc configuration of the crc calculation.

This method sets the following variables to be used when performing the crc calculation of data passed as a structure of CRC16Config.

• polynomial
• initial value
• final xor value

Parameters

polynomial
initialValue
finalXorValue

Definition at line 383 of file CCSDSPacket.h.

{m_CRC16Config = {polynomial, initialValue, finalXorValue};}

setDataFieldHeader() [1/5]

void CCSDS::Packet::setDataFieldHeader

(

const std::shared_ptr< SecondaryHeaderAbstract > &

header

)

Sets the data field header using the provided SecondaryHeaderAbstract derived header.

This function sets the data field header of the packet using a SecondaryHeaderAbstract derived header object.

Parameters

header

The SecondaryHeaderAbstract header object.

Returns

none.

Definition at line 282 of file CCSDSPacket.cpp.

                                                                                         {
  m_dataField.setDataFieldHeader(header);
  m_updateStatus = false;
}

setDataFieldHeader() [2/5]

CCSDS::ResultBool CCSDS::Packet::setDataFieldHeader	(	const std::uint8_t *	pData,
		size_t	sizeData
	)

Sets the data field header using the provided pointer and size.

This function sets the data field header of the packet using a pointer to the header data and its size.

Note

The method will log an error to standard error and ErrorCode is returned by ResultBool if provided data is invalid.

Parameters

pData	A pointer to the header data.
sizeData	The size of the header data.

Returns

ResultBool.

Definition at line 306 of file CCSDSPacket.cpp.

                                                                                              {
  FORWARD_RESULT(m_dataField.setDataFieldHeader( pData,sizeData ));
  m_updateStatus = false;
  return true;;
}

setDataFieldHeader() [3/5]

CCSDS::ResultBool CCSDS::Packet::setDataFieldHeader	(	const std::uint8_t *	pData,
		size_t	sizeData,
		const std::string &	headerType
	)

Sets the data field header for the packet using a raw data pointer.

This method updates the data field header of the packet by providing a pointer to the raw data and its size, along with the PUS (Packet Utilization Standard) type if applicable.

Note

The method will log an error to standard error and ErrorCode is returned by ResultBool if provided data is invalid.

Parameters

pData	Pointer to the raw data for the data field header.
sizeData	The size of the data pointed to by pData, in bytes.
headerType	The PUS type that specifies the purpose of the data.

Returns

ResultBool

Definition at line 293 of file CCSDSPacket.cpp.

                                                                                 {
  FORWARD_RESULT(m_dataField.setDataFieldHeader( pData, sizeData, headerType ));
  m_updateStatus = false;
  return true;
}

setDataFieldHeader() [4/5]

ResultBool CCSDS::Packet::setDataFieldHeader

(

const std::vector< std::uint8_t > &

data

)

Sets the data field header using the provided vector of bytes.

This function sets the data field header of the packet using a vector of bytes.

Note

The method will log an error to standard error and ErrorCode is returned by ResultBool if provided data is invalid.

Parameters

data	The vector containing the header bytes.

Returns

ResultBool.

setDataFieldHeader() [5/5]

ResultBool CCSDS::Packet::setDataFieldHeader	(	const std::vector< std::uint8_t > &	data,
		const std::string &	headerType
	)

Sets the data field header for the packet using a vector of bytes.

This method updates the data field header of the packet by providing the data as a vector of bytes and specifying the PUS (Packet Utilization Standard) type if applicable.

Note

The method will log an error to standard error and ErrorCode is returned by ResultBool if provided data is invalid.

Parameters

data	A vector containing the data for the data field header.
headerType	The PUS type that specifies the purpose of the data.

Returns

ResultBool

setDataFieldSize()

void CCSDS::Packet::setDataFieldSize

(

std::uint16_t

size

)

Sets the maximum data packet size for the CCSDS DataField.

This method updates the maximum allowed size for the data packet. The data packet size is used to validate that the combined size of the header and application data does not exceed this limit.

Parameters

size	The maximum size of the data packet, in bytes.

Definition at line 337 of file CCSDSPacket.cpp.

                                                         {
  m_dataField.setDataPacketSize(size);
}

setPrimaryHeader() [1/4]

void CCSDS::Packet::setPrimaryHeader

(

const Header &

header

)

Sets the primary header using the provided header object.

This function sets the primary header of the packet using the header object

Parameters

header

Returns

ResultBool.

Definition at line 272 of file CCSDSPacket.cpp.

                                                       {
  m_primaryHeader = header;
}

setPrimaryHeader() [2/4]

ResultBool CCSDS::Packet::setPrimaryHeader

(

const std::vector< std::uint8_t > &

data

)

Sets the primary header using the provided vector of std::uint8_tdata.

This function sets the primary header of the packet using vector of 8-bit integers as the header data.

Note

The method will log an error to standard error and ErrorCode is returned by ResultBool if provided data is invalid.

Parameters

data	The vector of 8-bit integers primary header data.

Returns

ResultBool.

setPrimaryHeader() [3/4]

void CCSDS::Packet::setPrimaryHeader

(

PrimaryHeader

data

)

Sets the primary header using the provided PrimaryHeader object.

This function sets the primary header of the packet using a PrimaryHeader object as the header data.

Parameters

data	The PrimaryHeader object containing the header data.

Returns

none.

Definition at line 276 of file CCSDSPacket.cpp.

                                                           {
  m_primaryHeader.setData(data);
  m_sequenceCounter = m_primaryHeader.getSequenceCount();
  m_updateStatus = false;
}

Here is the call graph for this function:

setPrimaryHeader() [4/4]

CCSDS::ResultBool CCSDS::Packet::setPrimaryHeader

(

std::uint64_t

data

)

Sets the primary header using the provided 64-bit data.

This function sets the primary header of the packet using a 64-bit integer as the header data.

Note

The method will log an error to standard error and ErrorCode is returned by ResultBool if provided data is invalid.

Parameters

data	The 64-bit primary header data.

Returns

ResultBool.

Definition at line 258 of file CCSDSPacket.cpp.

                                                                    {
  FORWARD_RESULT(m_primaryHeader.setData( data ));
  m_sequenceCounter = m_primaryHeader.getSequenceCount();
  m_updateStatus = false;
  return true;
}

setSequenceCount()

CCSDS::ResultBool CCSDS::Packet::setSequenceCount

(

std::uint16_t

count

)

Sets the sequence count for the packet.

Definition at line 329 of file CCSDSPacket.cpp.

                                                                     {
  RET_IF_ERR_MSG(m_primaryHeader.getSequenceFlags() == UNSEGMENTED && count != 0, ErrorCode::INVALID_DATA,
                 "Unable to set non 0 value for UNSEGMENTED packet");
  m_sequenceCounter = count;
  m_updateStatus = false;
  return true;
}

Here is the caller graph for this function:

setSequenceFlags()

void CCSDS::Packet::setSequenceFlags

(

ESequenceFlag

flags

)

Sets the sequence flags for the packet's primary header.

This method updates the sequence flags in the primary header of the packet. The sequence flags indicate the position or type of the data segment within the CCSDS telemetry transfer frame (e.g., first segment, last segment, etc.).

Parameters

flags

The sequence flag to be set, represented by the ESequenceFlag enum : std::uint8_t.

Definition at line 324 of file CCSDSPacket.cpp.

                                                            {
  m_primaryHeader.setSequenceFlags(flags);
  m_updateStatus = false;
}

Here is the caller graph for this function:

setUpdatePacketEnable()

void CCSDS::Packet::setUpdatePacketEnable

(

bool

enable

)

needs to be called as soon as possible, probably also from constructor.

Parameters

enable

Definition at line 341 of file CCSDSPacket.cpp.

                                                         {
  m_enableUpdatePacket = enable;
  m_dataField.setDataFieldHeaderAutoUpdateStatus(enable);
}

Here is the caller graph for this function:

update()

void CCSDS::Packet::update

(

)

Updates Primary headers data field size.

Uses the currently set data field size to set the header.

Returns

none.

Definition at line 11 of file CCSDSPacket.cpp.

                         {
  if (!m_updateStatus && m_enableUpdatePacket) {
    const auto dataField = m_dataField.serialize();
    const auto dataFiledSize = static_cast<std::uint16_t>(dataField.size());
    const auto dataFieldHeaderFlag(m_dataField.getDataFieldHeaderFlag());
    m_primaryHeader.setDataLength(dataFiledSize);
    m_primaryHeader.setDataFieldHeaderFlag(dataFieldHeaderFlag);
    // todo this part needs to be moved out of conditional updating
    if (m_primaryHeader.getSequenceFlags() == UNSEGMENTED) {
      m_primaryHeader.setSequenceCount(0);
    } else {
      m_primaryHeader.setSequenceCount(m_sequenceCounter);
    }
    m_CRC16 = crc16(dataField, m_CRC16Config.polynomial, m_CRC16Config.initialValue, m_CRC16Config.finalXorValue);
    m_updateStatus = true;
  }
}

Here is the call graph for this function:

Member Data Documentation

m_CRC16

std::uint16_t CCSDS::Packet::m_CRC16 {}

private

Cyclic Redundancy check 16 bits.

Definition at line 415 of file CCSDSPacket.h.

{};              

m_CRC16Config

CRC16Config CCSDS::Packet::m_CRC16Config

private

structure holding configuration of crc calculation.

Definition at line 416 of file CCSDSPacket.h.

m_dataField

DataField CCSDS::Packet::m_dataField {}

private

variable

Definition at line 414 of file CCSDSPacket.h.

{};         

m_enableUpdatePacket

bool CCSDS::Packet::m_enableUpdatePacket {true}

private

Enables primary header and secondary header update.

Definition at line 418 of file CCSDSPacket.h.

{true}; 

m_primaryHeader

Header CCSDS::Packet::m_primaryHeader {}

private

6 bytes / 48 bits / 12 hex

Definition at line 413 of file CCSDSPacket.h.

{};        

m_sequenceCounter

std::uint16_t CCSDS::Packet::m_sequenceCounter {0}

private

Definition at line 419 of file CCSDSPacket.h.

{0};

m_updateStatus

bool CCSDS::Packet::m_updateStatus {false}

private

When setting data thus value should be set to false.

Definition at line 417 of file CCSDSPacket.h.

{false};      

---

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

• inc/CCSDSPacket.h
• src/CCSDSPacket.cpp