Represents a PUS Type B (Event Reporting) header. More...

#include <PusServices.h>

Inheritance diagram for PusB:

Collaboration diagram for PusB:

Public Member Functions
	PusB ()=default

	PusB (const std::uint8_t version, const std::uint8_t serviceType, const std::uint8_t serviceSubtype, const std::uint8_t sourceID, const std::uint8_t eventID, const std::uint16_t dataLength)
	Constructs a PusB object with all fields explicitly set.

std::uint8_t	getVersion () const

std::uint8_t	getServiceType () const

std::uint8_t	getServiceSubtype () const

std::uint8_t	getSourceID () const

std::uint16_t	getEventID () const

std::uint16_t	getDataLength () const

std::uint16_t	getSize () const override
	Gets the size of the header in bytes.

std::string	getType () const override
	Retrieves the name of the packet.

std::vector< std::uint8_t >	serialize () const override
	Retrieves the serialized representation of the header.

CCSDS::ResultBool	deserialize (const std::vector< std::uint8_t > &data) override
	takes a buffer if data (vector std::uint8) and creates the header

void	update (CCSDS::DataField *dataField) override
	Defines how the packet secondary header is updated using the data field as reference.

CCSDS::ResultBool	loadFromConfig (const ::Config &cfg) override

Public Member Functions inherited from CCSDS::SecondaryHeaderAbstract
virtual	~SecondaryHeaderAbstract ()=default

virtual ResultBool	loadFromConfig (const Config &config)=0

void	setVariableLength (const bool bEnable)

Private Attributes
std::uint8_t	m_version {}

std::uint8_t	m_serviceType {}

std::uint8_t	m_serviceSubType {}

std::uint8_t	m_sourceID {}

std::uint16_t	m_eventID {}

std::uint16_t	m_dataLength {}

const std::string	m_type = "PusB"

const std::uint16_t	m_size = 8

Additional Inherited Members
Public Attributes inherited from CCSDS::SecondaryHeaderAbstract
bool	variableLength {false}

Detailed Description

Represents a PUS Type B (Event Reporting) header.

Contains fields used for event reporting.

Field Summary:

Version: 3 bits, PUS standard version.
Service Type: 8 bits, type of service (e.g., 0x02 for event reporting).
Service Subtype: 8 bits, subtype of the service.
Source ID: 8 bits, source identifier (e.g., satellite ID).
Event ID: 16 bits, identifier of the event.
Data Length: 16 bits, length of the event data in bytes.

Definition at line 84 of file PusServices.h.

Constructor & Destructor Documentation

◆ PusB() [1/2]

PusB::PusB ( )

default

◆ PusB() [2/2]

PusB::PusB	(	const std::uint8_t	version,
		const std::uint8_t	serviceType,
		const std::uint8_t	serviceSubtype,
		const std::uint8_t	sourceID,
		const std::uint8_t	eventID,
		const std::uint16_t	dataLength
	)

inlineexplicit

Constructs a PusB object with all fields explicitly set.

Parameters

version	PUS version (3 bits).
serviceType	Service type (8 bits).
serviceSubtype	Service subtype (8 bits).
sourceID	Source identifier (8 bits).
eventID	Event identifier (16 bits).
dataLength	Length of the event data (16 bits).

Definition at line 97 of file PusServices.h.

                                                                                                     : m_version(version & 0x7),
      m_serviceType(serviceType), m_serviceSubType(serviceSubtype), m_sourceID(sourceID), m_eventID(eventID),
      m_dataLength(dataLength) {
    }

Member Function Documentation

◆ deserialize()

CCSDS::ResultBool PusB::deserialize ( const std::vector< std::uint8_t > & data )

overridevirtual

takes a buffer if data (vector std::uint8) and creates the header

Returns: Boolean true on success or Error.

Implements CCSDS::SecondaryHeaderAbstract.

Definition at line 35 of file PusServices.cpp.

                                                                   {
  RET_IF_ERR_MSG(data.size() != m_size, CCSDS::ErrorCode::INVALID_SECONDARY_HEADER_DATA,
                 "PUS-B header not correct size (size != 8 bytes)");
  m_version = data[0] & 0x7;
  m_serviceType = data[1];
  m_serviceSubType = data[2];
  m_sourceID = data[3];
  m_eventID = data[4] << 8 | data[5];
  m_dataLength = data[6] << 8 | data[7];
  return true;
}

◆ getDataLength()

std::uint16_t PusB::getDataLength ( ) const

inline

Definition at line 108 of file PusServices.h.

108{ return m_dataLength; }

◆ getEventID()

std::uint16_t PusB::getEventID ( ) const

inline

Definition at line 107 of file PusServices.h.

107{ return m_eventID; }

◆ getServiceSubtype()

std::uint8_t PusB::getServiceSubtype ( ) const

inline

Definition at line 105 of file PusServices.h.

105{ return m_serviceSubType; }

◆ getServiceType()

std::uint8_t PusB::getServiceType ( ) const

inline

Definition at line 104 of file PusServices.h.

104{ return m_serviceType; }

◆ getSize()

std::uint16_t PusB::getSize ( ) const

inlineoverridevirtual

Gets the size of the header in bytes.

Returns: The size of the header in bytes.

Implements CCSDS::SecondaryHeaderAbstract.

Definition at line 109 of file PusServices.h.

109{ return m_size; }

◆ getSourceID()

std::uint8_t PusB::getSourceID ( ) const

inline

Definition at line 106 of file PusServices.h.

106{ return m_sourceID; }

◆ getType()

std::string PusB::getType ( ) const

inlineoverridevirtual

Retrieves the name of the packet.

Returns: A vector containing the header bytes. (does not include data field)

Implements CCSDS::SecondaryHeaderAbstract.

Definition at line 110 of file PusServices.h.

110{ return m_type; }

PusB::m_type

const std::string m_type

Definition PusServices.h:128

◆ getVersion()

std::uint8_t PusB::getVersion ( ) const

inline

Definition at line 103 of file PusServices.h.

103{ return m_version; }

◆ loadFromConfig()

CCSDS::ResultBool PusB::loadFromConfig ( const ::Config & cfg )

override

Definition at line 130 of file PusServices.cpp.

                                                      {
  std::uint8_t version = 0;
  std::uint8_t serviceType = 0;
  std::uint8_t serviceSubType = 0;
  std::uint8_t sourceId = 0;
  std::uint8_t eventId = 0;
 
  RET_IF_ERR_MSG(!cfg.isKey("pus_version"), CCSDS::ErrorCode::CONFIG_FILE_ERROR,"Config: Missing string field: pus_version");
  RET_IF_ERR_MSG(!cfg.isKey("pus_service_type"), CCSDS::ErrorCode::CONFIG_FILE_ERROR,"Config: Missing string field: pus_service_type");
  RET_IF_ERR_MSG(!cfg.isKey("pus_service_sub_type"), CCSDS::ErrorCode::CONFIG_FILE_ERROR,"Config: Missing string field: pus_service_sub_type");
  RET_IF_ERR_MSG(!cfg.isKey("pus_source_id"), CCSDS::ErrorCode::CONFIG_FILE_ERROR,"Config: Missing string field: pus_source_id");
  RET_IF_ERR_MSG(!cfg.isKey("pus_event_id"), CCSDS::ErrorCode::CONFIG_FILE_ERROR,"Config: Missing string field: pus_event_id");
 
  ASSIGN_OR_PRINT(version, cfg.get<int>("pus_version"));
  ASSIGN_OR_PRINT(serviceType, cfg.get<int>("pus_service_type"));
  ASSIGN_OR_PRINT(serviceSubType,cfg.get< int>("pus_service_sub_type"));
  ASSIGN_OR_PRINT(sourceId,cfg.get<int>("pus_source_id"));
  ASSIGN_OR_PRINT(eventId,cfg.get<int>("pus_event_id"));
 
  m_version = version & 0x7;
  m_serviceType = serviceType & 0xFF;
  m_serviceSubType = serviceSubType & 0xFF;
  m_sourceID = sourceId & 0xFF;
  m_eventID = eventId & 0xFFFF;
 
  return true;
}

Here is the call graph for this function:

◆ serialize()

std::vector< std::uint8_t > PusB::serialize ( ) const

overridevirtual

Retrieves the serialized representation of the header.

Returns: A vector containing the header bytes. (does not include data field)

Implements CCSDS::SecondaryHeaderAbstract.

Definition at line 47 of file PusServices.cpp.

                                            {
  std::vector data{
    static_cast<std::uint8_t>(m_version & 0x7),
    m_serviceType,
    m_serviceSubType,
    m_sourceID,
    static_cast<std::uint8_t>(m_eventID >> 8 & 0xFF),
    static_cast<std::uint8_t>(m_eventID & 0xFF),
    static_cast<std::uint8_t>(m_dataLength >> 8 & 0xFF),
    static_cast<std::uint8_t>(m_dataLength & 0xFF),
  };
 
  return data;
}

◆ update()

void PusB::update ( CCSDS::DataField * dataField )

overridevirtual

Defines how the packet secondary header is updated using the data field as reference.

This method is called every time a data get is performed from the packet, that is if update is enabled and method successfully registered.

Parameters

dataField

Implements CCSDS::SecondaryHeaderAbstract.

Definition at line 62 of file PusServices.cpp.

                                           {
  m_dataLength = dataField->getApplicationDataBytesSize();
}

Here is the call graph for this function:

Member Data Documentation

◆ m_dataLength

std::uint16_t PusB::m_dataLength {}

private

Definition at line 126 of file PusServices.h.

126{}; // Data Length 16 Length of the event data in bytes

◆ m_eventID

std::uint16_t PusB::m_eventID {}

private

Definition at line 125 of file PusServices.h.

125{}; // Event ID 16 ID of the event being reported

◆ m_serviceSubType

std::uint8_t PusB::m_serviceSubType {}

private

Definition at line 123 of file PusServices.h.

123{}; // Service Subtype 8 Subtype of the service (e.g., specific event type)

◆ m_serviceType

std::uint8_t PusB::m_serviceType {}

private

Definition at line 122 of file PusServices.h.

122{}; // Service Type 8 Type of service (e.g., 0x02 for event reporting)

◆ m_size

const std::uint16_t PusB::m_size = 8

private

Definition at line 129 of file PusServices.h.

◆ m_sourceID

std::uint8_t PusB::m_sourceID {}

private

Definition at line 124 of file PusServices.h.

124{}; // Source ID 8 ID of the source (e.g., satellite or sensor)

◆ m_type

const std::string PusB::m_type = "PusB"

private

Definition at line 128 of file PusServices.h.

◆ m_version

std::uint8_t PusB::m_version {}

private

Definition at line 121 of file PusServices.h.

121{}; // Version 3 Version of the PUS standard

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

inc/PusServices.h
src/PusServices.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PusB() [1/2]

◆ PusB() [2/2]

Member Function Documentation

◆ deserialize()

◆ getDataLength()

◆ getEventID()

◆ getServiceSubtype()

◆ getServiceType()

◆ getSize()

◆ getSourceID()

◆ getType()

◆ getVersion()

◆ loadFromConfig()

◆ serialize()

◆ update()

Member Data Documentation

◆ m_dataLength

◆ m_eventID

◆ m_serviceSubType

◆ m_serviceType

◆ m_size

◆ m_sourceID

◆ m_type

◆ m_version