CCSDS::SecondaryHeaderAbstract Class Reference

Abstract base class for a (Packet Utilization Standard) header. More...

#include <CCSDSSecondaryHeaderAbstract.h>

Inheritance diagram for CCSDS::SecondaryHeaderAbstract:

Public Member Functions
virtual	~SecondaryHeaderAbstract ()=default
virtual void	setDataLength (uint16_t dataLength)=0
	Sets the length of the data associated with the packet.
virtual ResultBool	deserialize (const std::vector< uint8_t > &data)=0
	takes a buffer if data (vector uint8) and creates the header
virtual uint16_t	getDataLength () const =0
	Gets the length of the data associated with the packet if applicable.
virtual uint16_t	getSize () const =0
	Gets the size of the header in bytes.
virtual std::vector< uint8_t >	serialize () const =0
	Retrieves the serialized representation of the header.
virtual std::string	getType () const =0
	Retrieves the name of the packet.

Detailed Description

Abstract base class for a (Packet Utilization Standard) header.

Defines the common interface for all header types.

Definition at line 14 of file CCSDSSecondaryHeaderAbstract.h.

Constructor & Destructor Documentation

~SecondaryHeaderAbstract()

virtual CCSDS::SecondaryHeaderAbstract::~SecondaryHeaderAbstract ( )

virtualdefault

Member Function Documentation

deserialize()

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

pure virtual

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

Returns

Boolean true on success or Error.

Implemented in CCSDS::BufferHeader, PusA, PusB, and PusC.

getDataLength()

virtual uint16_t CCSDS::SecondaryHeaderAbstract::getDataLength ( ) const

pure virtual

Gets the length of the data associated with the packet if applicable.

Returns

The length of the data in bytes set in the header.

Implemented in CCSDS::BufferHeader, PusA, PusB, and PusC.

getSize()

virtual uint16_t CCSDS::SecondaryHeaderAbstract::getSize ( ) const

pure virtual

Gets the size of the header in bytes.

Returns

The size of the header in bytes.

Implemented in CCSDS::BufferHeader, PusA, PusB, and PusC.

getType()

virtual std::string CCSDS::SecondaryHeaderAbstract::getType ( ) const

pure virtual

Retrieves the name of the packet.

Returns

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

Implemented in CCSDS::BufferHeader, PusA, PusB, and PusC.

serialize()

virtual std::vector< uint8_t > CCSDS::SecondaryHeaderAbstract::serialize ( ) const

pure virtual

Retrieves the serialized representation of the header.

Returns

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

Implemented in CCSDS::BufferHeader, PusA, PusB, and PusC.

setDataLength()

virtual void CCSDS::SecondaryHeaderAbstract::setDataLength ( uint16_t  dataLength )

pure virtual

Sets the length of the data associated with the packet.

Parameters

dataLength

Length of the data in bytes.

Implemented in CCSDS::BufferHeader, PusA, PusB, and PusC.

---

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

• inc/CCSDSSecondaryHeaderAbstract.h