AMPCSSequence.hpp

Go to the documentation of this file.

// ======================================================================
// \title  AMPCSSequence.hpp
// \author Bocchino
// \brief  AMPCSSequence interface
//
// \copyright
// Copyright (C) 2009-2018 California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================
 
#ifndef Svc_AMPCSSequence_HPP
#define Svc_AMPCSSequence_HPP
 
#include "Svc/CmdSequencer/CmdSequencerImpl.hpp"
 
namespace Svc {
 
  class AMPCSSequence :
    public CmdSequencerComponentImpl::Sequence
  {
 
    public:
 
      struct SequenceHeader {
 
        struct Constants {
 
          typedef enum {
            SIZE = 4
          } t;
 
        };
 
        typedef U8 t[Constants::SIZE];
 
      };
 
      struct Record {
 
        struct TimeFlag {
 
          typedef enum {
            ABSOLUTE = 0x00,
            RELATIVE = 0xFF
          } t;
 
          struct Serial {
 
            typedef U8 t;
 
          };
 
        };
 
        struct Time {
 
          typedef U32 t;
 
        };
 
        struct CmdLength {
 
          typedef U16 t;
 
        };
 
        struct Opcode {
 
          typedef U16 t;
 
        };
 
      };
 
    public:
 
      AMPCSSequence(
          CmdSequencerComponentImpl& component 
      );
 
    public:
 
      bool loadFile(
          const Fw::StringBase& fileName 
      );
 
      bool hasMoreRecords() const;
 
      void nextRecord(
          Sequence::Record& record 
      );
 
      void reset();
 
      void clear();
 
    PRIVATE:
 
      bool readCRCFile(
          Fw::CmdStringArg& crcFileName 
      );
 
      bool readCRC();
 
      bool deserializeCRC();
 
      bool getFileSize(
          const Fw::StringBase& seqFileName 
      );
 
      bool readSequenceFile(
          const Fw::StringBase& seqFileName 
      );
 
      bool readOpenSequenceFile();
 
      bool readSequenceHeader();
 
      bool readRecords();
 
      bool validateCRC();
 
      Fw::SerializeStatus deserializeRecord(
          Sequence::Record& record 
      );
 
      Fw::SerializeStatus deserializeTimeFlag(
          Sequence::Record::Descriptor& descriptor 
      );
 
      Fw::SerializeStatus deserializeTime(
          Fw::Time& timeTag 
      );
 
      Fw::SerializeStatus deserializeCmdLength(
          Record::CmdLength::t& cmdLength 
      );
 
      Fw::SerializeStatus translateCommand(
          Fw::ComBuffer& comBuffer, 
          const Record::CmdLength::t cmdLength 
      );
 
      bool validateRecords();
 
    PRIVATE:
 
      SequenceHeader::t m_sequenceHeader;
 
      CmdSequencerComponentImpl::FPrimeSequence::CRC m_crc;
 
      Os::File m_crcFile;
 
      Os::File m_sequenceFile;
 
  };
 
}
 
#endif