SeqDispatcher.hpp

Go to the documentation of this file.

// ======================================================================
// \title  SeqDispatcher.hpp
// \author zimri.leisher
// \brief  hpp file for SeqDispatcher component implementation class
// ======================================================================

#ifndef SeqDispatcher_HPP
#define SeqDispatcher_HPP

#include "Fw/Types/StringBase.hpp"
#include "Svc/Seq/BlockStateEnumAc.hpp"
#include "Svc/SeqDispatcher/SeqDispatcherComponentAc.hpp"
#include "Svc/SeqDispatcher/SeqDispatcher_CmdSequencerStateEnumAc.hpp"
#include "config/FppConstantsAc.hpp"

namespace Svc {

class SeqDispatcher final : public SeqDispatcherComponentBase {
  public:
    // ----------------------------------------------------------------------
    // Construction, initialization, and destruction
    // ----------------------------------------------------------------------

    SeqDispatcher(const char* const compName 
    );

    ~SeqDispatcher();

  protected:
    void seqDoneIn_handler(FwIndexType portNum,             
                           FwOpcodeType opCode,             
                           U32 cmdSeq,                      
                           const Fw::CmdResponse& response  
    );

    void seqStartIn_handler(FwIndexType portNum,             
                            const Fw::StringBase& fileName,  
                            const Svc::SeqArgs& args         
    );

    void seqRunIn_handler(FwIndexType portNum,             
                          const Fw::StringBase& fileName,  
                          const Svc::SeqArgs& args         
    );

  private:
    // number of sequences dispatched (successful or otherwise)
    U32 m_dispatchedCount = 0;
    // number of errors from dispatched sequences (CmdResponse::EXECUTION_ERROR)
    U32 m_errorCount = 0;
    // number of sequencers in state AVAILABLE
    U32 m_sequencersAvailable = SeqDispatcherSequencerPorts;
    // number of sequences canceled via the CANCEL_NAME command
    U32 m_canceledCount = 0;

    struct DispatchEntry {
        FwOpcodeType opCode;  
        U32 cmdSeq;
        // store the state of each sequencer
        SeqDispatcher_CmdSequencerState state;
        // store the sequence currently running for each sequencer
        Fw::String sequenceRunning = "<no seq>";
    } m_entryTable[SeqDispatcherSequencerPorts];  

    FwIndexType getNextAvailableSequencerIdx();

    void runSequence(FwIndexType sequencerIdx,
                     const Fw::ConstStringBase& fileName,
                     BlockState block,
                     const Svc::SeqArgs& args);

    // ----------------------------------------------------------------------
    // Command handler implementations
    // ----------------------------------------------------------------------

    void RUN_cmdHandler(const FwOpcodeType opCode,        
                        const U32 cmdSeq,                 
                        const Fw::CmdStringArg& fileName, 
                        const BlockState& block);

    void RUN_ARGS_cmdHandler(const FwOpcodeType opCode,        
                             const U32 cmdSeq,                 
                             const Fw::CmdStringArg& fileName, 
                             const BlockState& block,          
                             const Svc::SeqArgs& buffer);      
    void LOG_STATUS_cmdHandler(const FwOpcodeType opCode, 
                               const U32 cmdSeq);         
    void CANCEL_NAME_cmdHandler(const FwOpcodeType opCode,         
                                const U32 cmdSeq,                  
                                const Fw::CmdStringArg& fileName); 
    void CANCEL_ALL_cmdHandler(const FwOpcodeType opCode, 
                               const U32 cmdSeq);         
};

}  // namespace Svc

#endif