FileDownlink.hpp

Go to the documentation of this file.

// ====================================================================== 
// \title  FileDownlink.hpp
// \author bocchino
// \brief  hpp file for FileDownlink component implementation class
//
// \copyright
// Copyright 2009-2015, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
// 
// ====================================================================== 
 
#ifndef Svc_FileDownlink_HPP
#define Svc_FileDownlink_HPP
 
#include <Svc/FileDownlink/FileDownlinkComponentAc.hpp>
#include <Fw/FilePacket/FilePacket.hpp>
#include <Os/File.hpp>
#include <Os/Mutex.hpp>
 
namespace Svc {
 
  class FileDownlink :
    public FileDownlinkComponentBase
  {
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Types 
      // ----------------------------------------------------------------------
 
      class Mode {
 
        public:
 
          typedef enum { IDLE, DOWNLINK, CANCEL } Type;
 
        public:
 
          Mode(void) : value(IDLE) { }
 
        public:
 
          void set(const Type value) { 
            this->mutex.lock();
            this->value = value; 
            this->mutex.unLock();
          }
 
          Type get(void) { 
            this->mutex.lock();
            const Type value = this->value; 
            this->mutex.unLock();
            return value;
          }
 
        private:
 
          Type value;
 
          Os::Mutex mutex;
 
      };
 
      class File {
 
        public:
 
          File() : size(0) { }
 
        public:
          
          Fw::LogStringArg sourceName;
 
          Fw::LogStringArg destName;
 
          Os::File osFile;
          
          U32 size;
 
        PRIVATE:
 
          ::CFDP::Checksum checksum;
 
        public:
 
          Os::File::Status open(
              const char *const sourceFileName, 
              const char *const destFileName 
          );
 
          Os::File::Status read(
              U8 *const data,
              const U32 byteOffset,
              const U32 size
          );
 
          void getChecksum(::CFDP::Checksum& checksum) {
            checksum = this->checksum;
          }
 
      };
 
      class FilesSent {
 
        public:
 
          FilesSent(FileDownlink *const fileDownlink) : 
            n(0), fileDownlink(fileDownlink) 
          { }
 
        public:
 
          void fileSent(void) {
            ++this->n;
            this->fileDownlink->tlmWrite_FileDownlink_FilesSent(n);
          }
 
        PRIVATE:
 
          U32 n;
 
          FileDownlink *const fileDownlink;
 
      };
 
      class PacketsSent {
 
        public:
 
          PacketsSent(FileDownlink *const fileDownlink) : 
            n(0), fileDownlink(fileDownlink) 
          { }
 
        public:
 
          void packetSent(void) {
            ++this->n;
            this->fileDownlink->tlmWrite_FileDownlink_PacketsSent(n);
          }
 
        PRIVATE:
 
          U32 n;
 
          FileDownlink *const fileDownlink;
 
      };
 
      class Warnings {
 
        public:
 
          Warnings(FileDownlink *const fileDownlink) : 
            n(0), fileDownlink(fileDownlink)
          { }
 
        public:
 
          void fileOpenError(void);
 
          void fileRead(void);
 
        PRIVATE:
 
          void warning(void) {
            ++this->n;
            this->fileDownlink->tlmWrite_FileDownlink_Warnings(n);
          }
 
        PRIVATE:
 
          U32 n;
 
          FileDownlink *const fileDownlink;
 
      };
 
    public:
 
      // ----------------------------------------------------------------------
      // Construction, initialization, and destruction
      // ----------------------------------------------------------------------
 
      FileDownlink(
          const char *const compName, 
          const U16 downlinkPacketSize 
      );
 
      void init(
          const NATIVE_INT_TYPE queueDepth, 
          const NATIVE_INT_TYPE instance 
      );
 
      ~FileDownlink(void);
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Command handler implementations 
      // ----------------------------------------------------------------------
 
      void FileDownlink_SendFile_cmdHandler(
          const FwOpcodeType opCode, 
          const U32 cmdSeq, 
          const Fw::CmdStringArg& sourceFileName, 
          const Fw::CmdStringArg& destFileName 
      );
 
      void FileDownlink_Cancel_cmdHandler(
          const FwOpcodeType opCode, 
          const U32 cmdSeq 
      );
 
      void pingIn_handler(
          const NATIVE_INT_TYPE portNum, 
          U32 key 
      );
 
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Private helper methods 
      // ----------------------------------------------------------------------
 
      Os::File::Status sendDataPacket(const U32 byteOffset);
 
      Os::File::Status sendDataPackets(void);
 
      void sendCancelPacket(void);
 
      void sendEndPacket(void);
 
      void sendStartPacket(void);
 
      void sendFilePacket(const Fw::FilePacket& filePacket);
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Member variables 
      // ----------------------------------------------------------------------
 
      const U32 downlinkPacketSize;
 
      Mode mode;
 
      File file;
 
      FilesSent filesSent;
 
      PacketsSent packetsSent;
 
      Warnings warnings;
 
      U32 sequenceIndex;
 
    };
 
} // end namespace Svc
 
#endif