F´ Flight Software - C/C++ Documentation  NASA-v2.0.1
A framework for building embedded system applications to NASA flight quality standards.
DeframingProtocol.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title DeframingProtocol.hpp
3 // \author mstarch
4 // \brief hpp file for DeframingProtocol class
5 //
6 // \copyright
7 // Copyright 2009-2021, by the California Institute of Technology.
8 // ALL RIGHTS RESERVED. United States Government Sponsorship
9 // acknowledged.
10 //
11 // ======================================================================
12 
14 #include "Fw/Com/ComPacket.hpp"
16 
17 #ifndef DEFRAMING_PROTOCOL_HPP
18 #define DEFRAMING_PROTOCOL_HPP
19 
20 namespace Svc {
21 
22 
34  public:
44  };
48 
51  void setup(DeframingProtocolInterface& interface
52  );
53 
57  U32& needed
58  ) = 0;
59 
60  PROTECTED:
62 };
63 };
64 #endif // OWLS_PROTOCOL_HPP
Svc::DeframingProtocol::DEFRAMING_MAX_STATUS
@ DEFRAMING_MAX_STATUS
Definition: DeframingProtocol.hpp:43
Svc::DeframingProtocol::DEFRAMING_MORE_NEEDED
@ DEFRAMING_MORE_NEEDED
Definition: DeframingProtocol.hpp:42
DeframingProtocolInterface
interface supplied to the deframing protocol
Definition: DeframingProtocolInterface.hpp:26
Svc::DeframingProtocol::DEFRAMING_INVALID_CHECKSUM
@ DEFRAMING_INVALID_CHECKSUM
Definition: DeframingProtocol.hpp:41
Svc::DeframingProtocol::m_interface
DeframingProtocolInterface * m_interface
Definition: DeframingProtocol.hpp:61
Svc::DeframingProtocol::DEFRAMING_STATUS_SUCCESS
@ DEFRAMING_STATUS_SUCCESS
Definition: DeframingProtocol.hpp:39
CircularBuffer.hpp
DeframingProtocolInterface.hpp
Svc::DeframingProtocol::DeframingProtocol
DeframingProtocol()
Definition: DeframingProtocol.cpp:19
Svc::DeframingProtocol::setup
void setup(DeframingProtocolInterface &interface)
Definition: DeframingProtocol.cpp:21
Svc::DeframingProtocol::DeframingStatus
DeframingStatus
Status of the deframing call.
Definition: DeframingProtocol.hpp:38
Svc
Definition: ActiveRateGroupImplCfg.hpp:18
Svc::DeframingProtocol
Abstract base class representing a deframing protocol.
Definition: DeframingProtocol.hpp:33
Types::CircularBuffer
Definition: CircularBuffer.hpp:31
Svc::DeframingProtocol::DEFRAMING_INVALID_SIZE
@ DEFRAMING_INVALID_SIZE
Definition: DeframingProtocol.hpp:40
Svc::DeframingProtocol::deframe
virtual DeframingStatus deframe(Types::CircularBuffer &buffer, U32 &needed)=0
ComPacket.hpp