F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
FramingProtocol.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title FramingProtocol.hpp
3 // \author mstarch
4 // \brief hpp file for FramingProtocol class
5 //
6 // \copyright
7 // Copyright 2009-2022, by the California Institute of Technology.
8 // ALL RIGHTS RESERVED. United States Government Sponsorship
9 // acknowledged.
10 //
11 // ======================================================================
12 
13 #ifndef SVC_FRAMING_PROTOCOL_HPP
14 #define SVC_FRAMING_PROTOCOL_HPP
15 
17 #include "Fw/Com/ComPacket.hpp"
18 
19 namespace Svc {
32  public:
36  virtual ~FramingProtocol(){};
37 
40  void setup(FramingProtocolInterface& interface);
41 
46  virtual void frame(const U8* const data, const U32 size, Fw::ComPacket::ComPacketType packet_type) = 0;
47 
48  PROTECTED:
50 };
51 }
52 #endif // SVC_FRAMING_PROTOCOL_HPP
uint8_t U8
8-bit unsigned integer
Definition: BasicTypes.h:30
abstract class representing a framing protocol
FramingProtocol()
constructor
virtual void frame(const U8 *const data, const U32 size, Fw::ComPacket::ComPacketType packet_type)=0
frame a given set of bytes
FramingProtocolInterface * m_interface
void setup(FramingProtocolInterface &interface)
setup function called to supply the interface used for allocation and sending
interface supplied to the framing protocol