FilePacket.hpp

Go to the documentation of this file.

// ====================================================================== 
// \title  FilePacket.hpp
// \author bocchino
// \brief  hpp file for FilePacket
//
// \copyright
// Copyright 2009-2016, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
// 
// ====================================================================== 
 
#ifndef Fw_FilePacket_HPP
#define Fw_FilePacket_HPP
 
#include <CFDP/Checksum/Checksum.hpp>
#include <Fw/Buffer/Buffer.hpp>
#include <Fw/Types/BasicTypes.hpp>
#include <Fw/Types/SerialBuffer.hpp>
#include <Fw/Types/Serializable.hpp>
 
namespace Fw {
 
  union FilePacket {
 
    public:
 
      // ----------------------------------------------------------------------
      // Types
      // ----------------------------------------------------------------------
 
      typedef enum {
        T_START = 0,
        T_DATA = 1,
        T_END = 2,
        T_CANCEL = 3,
        T_NONE = 255
      } Type;
 
      class PathName {
 
          friend union FilePacket;
 
        public:
 
          enum { MAX_LENGTH = 255 };
 
        public:
          
          U8 length;
 
          const char *value;
 
        public:
 
          void initialize(
              const char *const value 
          );
 
          U32 bufferSize(void) const;
 
        PRIVATE:
 
          SerializeStatus fromSerialBuffer(SerialBuffer& serialBuffer);
 
          SerializeStatus toSerialBuffer(SerialBuffer& serialBuffer) const;
 
      };
 
      class Header {
 
          friend union FilePacket;
 
        public:
 
          Type type;
 
          U32 sequenceIndex;
          
          enum { HEADERSIZE = sizeof(U8) + sizeof(U32) };
 
        PRIVATE:
 
          void initialize(
              const Type type, 
              const U32 sequenceIndex 
          );
 
          U32 bufferSize(void) const;
 
          SerializeStatus fromSerialBuffer(SerialBuffer& serialBuffer);
 
          SerializeStatus toSerialBuffer(SerialBuffer& serialBuffer) const;
 
      };
 
      struct StartPacket {
 
          friend union FilePacket;
 
        public:
 
          Header header;
 
          U32 fileSize;
 
          PathName sourcePath;
 
          PathName destinationPath;
 
        public:
 
          void initialize(
              const U32 fileSize, 
              const char *const sourcePath, 
              const char *const destinationPath 
          );
 
          U32 bufferSize(void) const;
 
          SerializeStatus toBuffer(Buffer& buffer) const;
 
        PRIVATE:
 
          SerializeStatus fromSerialBuffer(SerialBuffer& serialBuffer);
 
          SerializeStatus toSerialBuffer(SerialBuffer& serialBuffer) const;
 
      };
 
      class DataPacket {
 
          friend union FilePacket;
 
        public:
 
          Header header;
 
          U32 byteOffset;
 
          U16 dataSize;
 
          const U8 *data;
 
          enum { HEADERSIZE = Header::HEADERSIZE +
              sizeof(U32) +
              sizeof(U16) };
 
 
        public:
 
          void initialize(
              const U32 sequenceIndex, 
              const U32 byteOffset, 
              const U16 dataSize, 
              const U8 *const data 
          );
 
          U32 bufferSize(void) const;
 
          SerializeStatus toBuffer(Buffer& buffer) const;
 
        PRIVATE:
 
          SerializeStatus fromSerialBuffer(SerialBuffer& serialBuffer);
 
          U32 fixedLengthSize(void) const;
          
          SerializeStatus toSerialBuffer(SerialBuffer& serialBuffer) const;
 
      };
 
      class EndPacket {
 
          friend union FilePacket;
 
        public:
 
          Header header;
 
          void setChecksum(const CFDP::Checksum& checksum);
 
          void getChecksum(CFDP::Checksum& checksum) const;
 
          U32 bufferSize(void) const;
 
          SerializeStatus toBuffer(Buffer& buffer) const;
 
        public:
          
          void initialize(
              const U32 sequenceIndex, 
              const CFDP::Checksum& checksum 
          );
 
        PRIVATE:
 
          U32 checksumValue;
 
          SerializeStatus fromSerialBuffer(SerialBuffer& serialBuffer);
 
          SerializeStatus toSerialBuffer(SerialBuffer& serialBuffer) const;
 
      };
 
      class CancelPacket {
 
          friend union FilePacket;
 
        public:
 
          Header header;
 
        public:
 
          void initialize(
              const U32 sequenceIndex 
          );
 
          U32 bufferSize(void) const;
 
          SerializeStatus toBuffer(Buffer& buffer) const;
 
        PRIVATE:
 
          SerializeStatus fromSerialBuffer(SerialBuffer& serialBuffer);
 
      };
 
    public:
 
      // ----------------------------------------------------------------------
      // Constructor
      // ----------------------------------------------------------------------
 
      FilePacket(void) { this->header.type = T_NONE; }
 
    public:
 
      // ----------------------------------------------------------------------
      // Public instance methods
      // ----------------------------------------------------------------------
 
      SerializeStatus fromBuffer(const Buffer& buffer);
 
      const Header& asHeader(void) const;
 
      const StartPacket& asStartPacket(void) const;
 
      const DataPacket& asDataPacket(void) const;
 
      const EndPacket& asEndPacket(void) const;
 
      const CancelPacket& asCancelPacket(void) const;
 
      void fromStartPacket(const StartPacket& startPacket);
 
      void fromDataPacket(const DataPacket& dataPacket);
 
      void fromEndPacket(const EndPacket& endPacket);
 
      void fromCancelPacket(const CancelPacket& cancelPacket);
 
      U32 bufferSize(void) const;
 
      SerializeStatus toBuffer(Buffer& buffer) const;
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Private methods
      // ----------------------------------------------------------------------
 
      SerializeStatus fromSerialBuffer(SerialBuffer& serialBuffer);
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Private data 
      // ----------------------------------------------------------------------
 
      Header header;
 
      StartPacket startPacket;
 
      DataPacket dataPacket;
 
      EndPacket endPacket;
 
      CancelPacket cancelPacket;
 
  };
 
}
 
#endif