FileUplink.hpp

Go to the documentation of this file.

// ====================================================================== 
// \title  FileUplink.hpp
// \author bocchino
// \brief  hpp file for FileUplink component implementation class
//
// \copyright
// Copyright 2009-2016, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
// 
// ====================================================================== 
 
#ifndef Svc_FileUplink_HPP
#define Svc_FileUplink_HPP
 
#include <Svc/FileUplink/FileUplinkComponentAc.hpp>
#include <Fw/FilePacket/FilePacket.hpp>
#include <Os/File.hpp>
 
namespace Svc {
 
  class FileUplink :
    public FileUplinkComponentBase
  {
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Types 
      // ----------------------------------------------------------------------
 
      typedef enum { START, DATA } ReceiveMode;
 
      class File {
 
        public:
          
          U32 size;
         
          Fw::LogStringArg name;
 
          Os::File osFile;
 
        PRIVATE:
 
          ::CFDP::Checksum checksum;
 
        public:
 
          Os::File::Status open(
              const Fw::FilePacket::StartPacket& startPacket
          );
 
          Os::File::Status write(
              const U8 *const data,
              const U32 byteOffset,
              const U32 length
          );
 
          void getChecksum(::CFDP::Checksum& checksum) {
            checksum = this->checksum;
          }
 
      };
 
      class FilesReceived {
 
        public:
 
          FilesReceived(FileUplink *const fileUplink) : 
            n(0), fileUplink(fileUplink) 
          { }
 
        public:
 
          void fileReceived(void) {
            ++this->n;
            this->fileUplink->tlmWrite_FileUplink_FilesReceived(n);
          }
 
        PRIVATE:
 
          U32 n;
 
          FileUplink *const fileUplink;
 
      };
 
      class PacketsReceived {
 
        public:
 
          PacketsReceived(FileUplink *const fileUplink) : 
            n(0), fileUplink(fileUplink)
          { }
 
        public:
 
          void packetReceived(void) {
            ++this->n;
            this->fileUplink->tlmWrite_FileUplink_PacketsReceived(n);
          }
 
        PRIVATE:
 
          U32 n;
 
          FileUplink *const fileUplink;
 
      };
 
      class Warnings {
 
        public:
 
          Warnings(FileUplink *const fileUplink) : 
            n(0), fileUplink(fileUplink)
          { }
 
        public:
 
          void invalidReceiveMode(const Fw::FilePacket::Type packetType);
 
          void fileOpen(Fw::LogStringArg& fileName);
 
          void packetOutOfBounds(
              const U32 sequenceIndex,
              Fw::LogStringArg& fileName
          );
 
          void packetOutOfOrder(
              const U32 sequenceIndex,
              const U32 lastSequenceIndex
          );
 
          void fileWrite(Fw::LogStringArg& fileName);
 
          void badChecksum(
              const U32 computed,
              const U32 read
          );
 
        PRIVATE:
 
          void warning(void) {
            ++this->n;
            this->fileUplink->tlmWrite_FileUplink_Warnings(n);
          }
 
        PRIVATE:
 
          U32 n;
 
          FileUplink *const fileUplink;
 
      };
 
    public:
 
      // ----------------------------------------------------------------------
      // Construction, initialization, and destruction
      // ----------------------------------------------------------------------
 
      FileUplink(
          const char *const name 
      );
 
      void init(
          const NATIVE_INT_TYPE queueDepth, 
          const NATIVE_INT_TYPE instance 
      );
 
      ~FileUplink(void);
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Handler implementations for user-defined typed input ports
      // ----------------------------------------------------------------------
 
      void bufferSendIn_handler(
          const NATIVE_INT_TYPE portNum, 
          Fw::Buffer& buffer
      );
 
      void pingIn_handler(
          const NATIVE_INT_TYPE portNum, 
          U32 key 
      );
 
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Private helper functions 
      // ----------------------------------------------------------------------
 
      void handleStartPacket(const Fw::FilePacket::StartPacket& startPacket);
 
      void handleDataPacket(const Fw::FilePacket::DataPacket& dataPacket);
 
      void handleEndPacket(const Fw::FilePacket::EndPacket& endPacket);
 
      void handleCancelPacket(void);
 
      void checkSequenceIndex(const U32 sequenceIndex);
 
      void compareChecksums(const Fw::FilePacket::EndPacket& endPacket);
 
      void goToStartMode(void);
 
      void goToDataMode(void);
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Member variables 
      // ----------------------------------------------------------------------
 
      ReceiveMode receiveMode;
 
      U32 lastSequenceIndex;
 
      File file;
 
      FilesReceived filesReceived;
 
      PacketsReceived packetsReceived;
 
      Warnings warnings;
 
  };
 
}
 
#endif