F´ Flight Software - C/C++ Documentation  NASA-v2.0.0
A framework for building embedded system applications to NASA flight quality standards.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Svc::FprimeFraming Class Reference

class implementing the fprime serialization protocol More...

#include <Svc/FramingProtocol/FprimeProtocol.hpp>

Inheritance diagram for Svc::FprimeFraming:
Svc::FramingProtocol

Public Member Functions

 FprimeFraming ()
 
void frame (const U8 *const data, const U32 size, Fw::ComPacket::ComPacketType packet_type)
 frame a given set of bytes More...
 
- Public Member Functions inherited from Svc::FramingProtocol
 FramingProtocol ()
 constructor More...
 
void setup (FramingProtocolInterface &interface)
 setup function called to supply the interface used for allocation and sending More...
 

Static Public Attributes

static const FP_FRAME_TOKEN_TYPE START_WORD = static_cast<FP_FRAME_TOKEN_TYPE>(0xdeadbeef)
 

Additional Inherited Members

- Protected Attributes inherited from Svc::FramingProtocol
FramingProtocolInterfacem_interface
 

Detailed Description

class implementing the fprime serialization protocol

Definition at line 25 of file FprimeProtocol.hpp.

Constructor & Destructor Documentation

◆ FprimeFraming()

Svc::FprimeFraming::FprimeFraming ( )

Definition at line 20 of file FprimeProtocol.cpp.

Member Function Documentation

◆ frame()

void Svc::FprimeFraming::frame ( const U8 *const  data,
const U32  size,
Fw::ComPacket::ComPacketType  packet_type 
)
virtual

frame a given set of bytes

Parameters
datapointer to a set of bytes to be framed
sizesize of data pointed to by data
packet_typetype of data supplied for File downlink packets

Implements Svc::FramingProtocol.

Definition at line 24 of file FprimeProtocol.cpp.

Member Data Documentation

◆ START_WORD

const FP_FRAME_TOKEN_TYPE Svc::FprimeFraming::START_WORD = static_cast<FP_FRAME_TOKEN_TYPE>(0xdeadbeef)
static

Definition at line 27 of file FprimeProtocol.hpp.


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