TmFramer.hpp

Go to the documentation of this file.

// ======================================================================
// \title  TmFramer.hpp
// \author thomas-bc
// \brief  hpp file for TmFramer component implementation class
// ======================================================================

#ifndef Svc_Ccsds_TmFramer_HPP
#define Svc_Ccsds_TmFramer_HPP

#include "Svc/Ccsds/TmFramer/TmFramerComponentAc.hpp"
#include "Svc/Ccsds/Types/FppConstantsAc.hpp"
#include "Svc/Ccsds/Types/TMHeaderSerializableAc.hpp"
#include "Svc/Ccsds/Types/TMTrailerSerializableAc.hpp"

namespace Svc {

namespace Ccsds {

class TmFramer final : public TmFramerComponentBase {
    friend class TmFramerTester;

    static_assert(ComCfg::TmFrameFixedSize > TMHeader::SERIALIZED_SIZE + TMTrailer::SERIALIZED_SIZE,
                  "TM Frame Fixed Size must be at least large enough to hold header, trailer and data");

    static_assert(static_cast<FwSizeType>(TMHeader::SERIALIZED_SIZE) == static_cast<FwSizeType>(TmHeaderSize),
                  "Svc.Ccsds.TmHeaderSize must match TMHeader");
    static_assert(static_cast<FwSizeType>(TMTrailer::SERIALIZED_SIZE) == static_cast<FwSizeType>(TmTrailerSize),
                  "Svc.Ccsds.TmTrailerSize must match TMTrailer");

    static constexpr FwSizeType TmPayloadCapacity = static_cast<FwSizeType>(TmDataFieldSize);

    enum class BufferOwnershipState {
        NOT_OWNED,  
        OWNED,      
    };

  public:
    // ----------------------------------------------------------------------
    // Component construction and destruction
    // ----------------------------------------------------------------------

    TmFramer(const char* const compName  
    );

    ~TmFramer();

  private:
    // ----------------------------------------------------------------------
    // Handler implementations for typed input ports
    // ----------------------------------------------------------------------

    void comStatusIn_handler(FwIndexType portNum,    
                             Fw::Success& condition  
                             ) override;

    void dataIn_handler(FwIndexType portNum,  
                        Fw::Buffer& data,
                        const ComCfg::FrameContext& context) override;

    void dataReturnIn_handler(FwIndexType portNum,  
                              Fw::Buffer& data,
                              const ComCfg::FrameContext& context) override;

    // ----------------------------------------------------------------------
    // Members
    // ----------------------------------------------------------------------
  private:
    // Because the TM protocol use fixed width frames, and only one frame is in transit between ComQueue and
    // ComInterface at a time, we can use a member fixed-size buffer to hold the frame data
    U8 m_frameBuffer[ComCfg::TmFrameFixedSize];                        
    BufferOwnershipState m_bufferState = BufferOwnershipState::OWNED;  

    // Current implementation uses a single virtual channel, so we can use a single virtual frame count
    U8 m_masterFrameCount;   
    U8 m_virtualFrameCount;  
};

}  // namespace Ccsds
}  // namespace Svc

#endif