DpWriter.hpp

Go to the documentation of this file.

// ======================================================================
// \title  DpWriter.hpp
// \author bocchino
// \brief  hpp file for DpWriter component implementation class
// ======================================================================
 
#ifndef Svc_DpWriter_HPP
#define Svc_DpWriter_HPP
 
#include <DpCfg.hpp>
 
#include "Fw/Dp/DpContainer.hpp"
#include "Fw/Types/FileNameString.hpp"
#include "Fw/Types/String.hpp"
#include "Fw/Types/SuccessEnumAc.hpp"
#include "Svc/DpWriter/DpWriterComponentAc.hpp"
 
namespace Svc {
 
class DpWriter : public DpWriterComponentBase {
  public:
    // ----------------------------------------------------------------------
    // Construction, initialization, and destruction
    // ----------------------------------------------------------------------
 
    DpWriter(const char* const compName  
    );
 
    ~DpWriter();
 
    void configure(const Fw::StringBase& dpFileNamePrefix  
    );
 
  PRIVATE:
    // ----------------------------------------------------------------------
    // Handler implementations for user-defined typed input ports
    // ----------------------------------------------------------------------
 
    void bufferSendIn_handler(const NATIVE_INT_TYPE portNum,  
                              Fw::Buffer& fwBuffer            
                              ) final;
 
    void schedIn_handler(const NATIVE_INT_TYPE portNum,  
                         U32 context                     
                         ) final;
 
  PRIVATE:
    // ----------------------------------------------------------------------
    // Handler implementations for commands
    // ----------------------------------------------------------------------
 
    void CLEAR_EVENT_THROTTLE_cmdHandler(FwOpcodeType opCode,  
                                         U32 cmdSeq            
                                         ) final;
 
  PRIVATE:
    // ----------------------------------------------------------------------
    // Private helper functions
    // ----------------------------------------------------------------------
 
    Fw::Success::T deserializePacketHeader(Fw::Buffer& buffer,         
                                           Fw::DpContainer& container  
    );
 
    void performProcessing(const Fw::DpContainer& container  
    );
 
    Fw::Success::T writeFile(const Fw::DpContainer& container,    
                             const Fw::FileNameString& fileName,  
                             FwSizeType& fileSize                 
    );
 
    void sendNotification(const Fw::DpContainer& container,    
                          const Fw::FileNameString& fileName,  
                          FwSizeType packetSize                
    );
 
  PRIVATE:
    // ----------------------------------------------------------------------
    // Private member variables
    // ----------------------------------------------------------------------
 
    U32 m_numBuffersReceived = 0;
 
    U64 m_numBytesWritten = 0;
 
    U32 m_numSuccessfulWrites = 0;
 
    U32 m_numFailedWrites = 0;
 
    U32 m_numErrors = 0;
 
    Fw::FileNameString m_dpFileNamePrefix;
};
 
}  // end namespace Svc
 
#endif