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
16
#include "
Svc/FramingProtocol/FramingProtocolInterface.hpp
"
17
#include "
Fw/Com/ComPacket.hpp
"
18
19
namespace
Svc
{
31
class
FramingProtocol
{
32
public
:
35
FramingProtocol
();
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:
49
FramingProtocolInterface
*
m_interface
;
50
};
51
}
52
#endif
// SVC_FRAMING_PROTOCOL_HPP
U8
uint8_t U8
8-bit unsigned integer
Definition:
BasicTypes.h:30
ComPacket.hpp
FramingProtocolInterface.hpp
Fw::ComPacket::ComPacketType
ComPacketType
Definition:
ComPacket.hpp:21
Svc::FramingProtocol
abstract class representing a framing protocol
Definition:
FramingProtocol.hpp:31
Svc::FramingProtocol::~FramingProtocol
virtual ~FramingProtocol()
Definition:
FramingProtocol.hpp:36
Svc::FramingProtocol::FramingProtocol
FramingProtocol()
constructor
Definition:
FramingProtocol.cpp:19
Svc::FramingProtocol::frame
virtual void frame(const U8 *const data, const U32 size, Fw::ComPacket::ComPacketType packet_type)=0
frame a given set of bytes
Svc::FramingProtocol::m_interface
FramingProtocolInterface * m_interface
Definition:
FramingProtocol.hpp:49
Svc::FramingProtocol::setup
void setup(FramingProtocolInterface &interface)
setup function called to supply the interface used for allocation and sending
Definition:
FramingProtocol.cpp:21
Svc::FramingProtocolInterface
interface supplied to the framing protocol
Definition:
FramingProtocolInterface.hpp:28
Svc
Definition:
ActiveRateGroupCfg.hpp:18
Svc
FramingProtocol
FramingProtocol.hpp
Generated by
1.9.1