CmdSequencerComponentAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  CmdSequencerComponentAc.hpp
// \author Generated by fpp-to-cpp
// \brief  hpp file for CmdSequencer component base class
// ======================================================================

#ifndef Svc_CmdSequencerComponentAc_HPP
#define Svc_CmdSequencerComponentAc_HPP

#include <atomic>

#include "Fw/Cmd/CmdPortAc.hpp"
#include "Fw/Cmd/CmdRegPortAc.hpp"
#include "Fw/Cmd/CmdResponsePortAc.hpp"
#include "Fw/Cmd/CmdString.hpp"
#include "Fw/Com/ComPortAc.hpp"
#include "Fw/Comp/ActiveComponentBase.hpp"
#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Log/LogPortAc.hpp"
#include "Fw/Log/LogString.hpp"
#if FW_ENABLE_TEXT_LOGGING == 1
#include "Fw/Log/LogTextPortAc.hpp"
#endif
#include "Fw/Port/InputSerializePort.hpp"
#include "Fw/Port/OutputSerializePort.hpp"
#include "Fw/Time/TimePortAc.hpp"
#include "Fw/Tlm/TlmPortAc.hpp"
#include "Fw/Tlm/TlmString.hpp"
#include "Svc/CmdSequencer/CmdSequencer_BlockStateEnumAc.hpp"
#include "Svc/CmdSequencer/CmdSequencer_FileReadStageEnumAc.hpp"
#include "Svc/CmdSequencer/CmdSequencer_SeqModeEnumAc.hpp"
#include "Svc/Ping/PingPortAc.hpp"
#include "Svc/Sched/SchedPortAc.hpp"
#include "Svc/Seq/CmdSeqCancelPortAc.hpp"
#include "Svc/Seq/CmdSeqInPortAc.hpp"
#include "default/config/FwOpcodeTypeAliasAc.hpp"

namespace Svc {

  class CmdSequencerComponentBase :
    public Fw::ActiveComponentBase
  {

      // ----------------------------------------------------------------------
      // Friend classes
      // ----------------------------------------------------------------------

      friend class CmdSequencerTesterBase;
      friend class CmdSequencerTester;

    protected:

      // ----------------------------------------------------------------------
      // Constants
      // ----------------------------------------------------------------------

      enum {
        NUM_CMDIN_INPUT_PORTS = 1,
      };

      enum {
        NUM_CMDRESPONSEIN_INPUT_PORTS = 1,
        NUM_PINGIN_INPUT_PORTS = 1,
        NUM_SCHEDIN_INPUT_PORTS = 1,
        NUM_SEQCANCELIN_INPUT_PORTS = 1,
        NUM_SEQRUNIN_INPUT_PORTS = 1,
      };

      enum {
        NUM_LOGTEXT_OUTPUT_PORTS = 1,
        NUM_CMDREGOUT_OUTPUT_PORTS = 1,
        NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1,
        NUM_LOGOUT_OUTPUT_PORTS = 1,
        NUM_TIMECALLER_OUTPUT_PORTS = 1,
        NUM_TLMOUT_OUTPUT_PORTS = 1,
      };

      enum {
        NUM_COMCMDOUT_OUTPUT_PORTS = 1,
        NUM_PINGOUT_OUTPUT_PORTS = 1,
        NUM_SEQDONE_OUTPUT_PORTS = 1,
        NUM_SEQSTARTOUT_OUTPUT_PORTS = 1,
      };

      enum {
        OPCODE_CS_RUN = 0x0, 
        OPCODE_CS_VALIDATE = 0x1, 
        OPCODE_CS_CANCEL = 0x2, 
        OPCODE_CS_START = 0x3, 
        OPCODE_CS_STEP = 0x4, 
        OPCODE_CS_AUTO = 0x5, 
        OPCODE_CS_MANUAL = 0x6, 
        OPCODE_CS_JOIN_WAIT = 0x7, 
      };

      enum {
        EVENTID_CS_SEQUENCELOADED = 0x0, 
        EVENTID_CS_SEQUENCECANCELED = 0x1, 
        EVENTID_CS_FILEREADERROR = 0x2, 
        EVENTID_CS_FILEINVALID = 0x3, 
        EVENTID_CS_RECORDINVALID = 0x4, 
        EVENTID_CS_FILESIZEERROR = 0x5, 
        EVENTID_CS_FILENOTFOUND = 0x6, 
        EVENTID_CS_FILECRCFAILURE = 0x7, 
        EVENTID_CS_COMMANDCOMPLETE = 0x8, 
        EVENTID_CS_SEQUENCECOMPLETE = 0x9, 
        EVENTID_CS_COMMANDERROR = 0xa, 
        EVENTID_CS_INVALIDMODE = 0xb, 
        EVENTID_CS_RECORDMISMATCH = 0xc, 
        EVENTID_CS_TIMEBASEMISMATCH = 0xd, 
        EVENTID_CS_TIMECONTEXTMISMATCH = 0xe, 
        EVENTID_CS_PORTSEQUENCESTARTED = 0xf, 
        EVENTID_CS_UNEXPECTEDCOMPLETION = 0x10, 
        EVENTID_CS_MODESWITCHED = 0x11, 
        EVENTID_CS_NOSEQUENCEACTIVE = 0x12, 
        EVENTID_CS_SEQUENCEVALID = 0x13, 
        EVENTID_CS_SEQUENCETIMEOUT = 0x14, 
        EVENTID_CS_CMDSTEPPED = 0x15, 
        EVENTID_CS_CMDSTARTED = 0x16, 
        EVENTID_CS_JOINWAITING = 0x17, 
        EVENTID_CS_JOINWAITINGNOTCOMPLETE = 0x18, 
        EVENTID_CS_NORECORDS = 0x19,
      };

      enum {
        CHANNELID_CS_LOADCOMMANDS = 0x0, 
        CHANNELID_CS_CANCELCOMMANDS = 0x1, 
        CHANNELID_CS_ERRORS = 0x2, 
        CHANNELID_CS_COMMANDSEXECUTED = 0x3, 
        CHANNELID_CS_SEQUENCESCOMPLETED = 0x4, 
      };

    public:

      // ----------------------------------------------------------------------
      // Component initialization
      // ----------------------------------------------------------------------

      void init(
          FwSizeType queueDepth, 
          FwEnumStoreType instance = 0 
      );

    public:

      // ----------------------------------------------------------------------
      // Getters for special input ports
      // ----------------------------------------------------------------------

      Fw::InputCmdPort* get_cmdIn_InputPort(
          FwIndexType portNum 
      );

    public:

      // ----------------------------------------------------------------------
      // Getters for typed input ports
      // ----------------------------------------------------------------------

      Fw::InputCmdResponsePort* get_cmdResponseIn_InputPort(
          FwIndexType portNum 
      );

      Svc::InputPingPort* get_pingIn_InputPort(
          FwIndexType portNum 
      );

      Svc::InputSchedPort* get_schedIn_InputPort(
          FwIndexType portNum 
      );

      Svc::InputCmdSeqCancelPort* get_seqCancelIn_InputPort(
          FwIndexType portNum 
      );

      Svc::InputCmdSeqInPort* get_seqRunIn_InputPort(
          FwIndexType portNum 
      );

    public:

      // ----------------------------------------------------------------------
      // Connect input ports to special output ports
      // ----------------------------------------------------------------------

#if FW_ENABLE_TEXT_LOGGING == 1

      void set_LogText_OutputPort(
          FwIndexType portNum, 
          Fw::InputLogTextPort* port 
      );

#endif

      void set_cmdRegOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputCmdRegPort* port 
      );

      void set_cmdResponseOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputCmdResponsePort* port 
      );

      void set_logOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputLogPort* port 
      );

      void set_timeCaller_OutputPort(
          FwIndexType portNum, 
          Fw::InputTimePort* port 
      );

      void set_tlmOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputTlmPort* port 
      );

    public:

      // ----------------------------------------------------------------------
      // Connect typed input ports to typed output ports
      // ----------------------------------------------------------------------

      void set_comCmdOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputComPort* port 
      );

      void set_pingOut_OutputPort(
          FwIndexType portNum, 
          Svc::InputPingPort* port 
      );

      void set_seqDone_OutputPort(
          FwIndexType portNum, 
          Fw::InputCmdResponsePort* port 
      );

      void set_seqStartOut_OutputPort(
          FwIndexType portNum, 
          Svc::InputCmdSeqInPort* port 
      );

#if FW_PORT_SERIALIZATION

    public:

      // ----------------------------------------------------------------------
      // Connect serial input ports to special output ports
      // ----------------------------------------------------------------------

#if FW_ENABLE_TEXT_LOGGING == 1

      void set_LogText_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#endif

      void set_cmdRegOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_cmdResponseOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_logOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_timeCaller_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_tlmOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#endif

#if FW_PORT_SERIALIZATION

    public:

      // ----------------------------------------------------------------------
      // Connect serial input ports to typed output ports
      // ----------------------------------------------------------------------

      void set_comCmdOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_pingOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_seqDone_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_seqStartOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#endif

    public:

      // ----------------------------------------------------------------------
      // Command registration
      // ----------------------------------------------------------------------

      void regCommands();

    protected:

      // ----------------------------------------------------------------------
      // Component construction and destruction
      // ----------------------------------------------------------------------

      CmdSequencerComponentBase(
          const char* compName = "" 
      );

      virtual ~CmdSequencerComponentBase();

    protected:

      // ----------------------------------------------------------------------
      // Getters for numbers of special input ports
      // ----------------------------------------------------------------------

      static constexpr FwIndexType getNum_cmdIn_InputPorts() {
        return NUM_CMDIN_INPUT_PORTS;
      }

    protected:

      // ----------------------------------------------------------------------
      // Getters for numbers of typed input ports
      // ----------------------------------------------------------------------

      static constexpr FwIndexType getNum_cmdResponseIn_InputPorts() {
        return NUM_CMDRESPONSEIN_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_pingIn_InputPorts() {
        return NUM_PINGIN_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_schedIn_InputPorts() {
        return NUM_SCHEDIN_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_seqCancelIn_InputPorts() {
        return NUM_SEQCANCELIN_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_seqRunIn_InputPorts() {
        return NUM_SEQRUNIN_INPUT_PORTS;
      }

    protected:

      // ----------------------------------------------------------------------
      // Getters for numbers of special output ports
      // ----------------------------------------------------------------------

#if FW_ENABLE_TEXT_LOGGING == 1

      static constexpr FwIndexType getNum_LogText_OutputPorts() {
        return NUM_LOGTEXT_OUTPUT_PORTS;
      }

#endif

      static constexpr FwIndexType getNum_cmdRegOut_OutputPorts() {
        return NUM_CMDREGOUT_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_cmdResponseOut_OutputPorts() {
        return NUM_CMDRESPONSEOUT_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_logOut_OutputPorts() {
        return NUM_LOGOUT_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_timeCaller_OutputPorts() {
        return NUM_TIMECALLER_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_tlmOut_OutputPorts() {
        return NUM_TLMOUT_OUTPUT_PORTS;
      }

    protected:

      // ----------------------------------------------------------------------
      // Getters for numbers of typed output ports
      // ----------------------------------------------------------------------

      static constexpr FwIndexType getNum_comCmdOut_OutputPorts() {
        return NUM_COMCMDOUT_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_pingOut_OutputPorts() {
        return NUM_PINGOUT_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_seqDone_OutputPorts() {
        return NUM_SEQDONE_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_seqStartOut_OutputPorts() {
        return NUM_SEQSTARTOUT_OUTPUT_PORTS;
      }

    protected:

      // ----------------------------------------------------------------------
      // Connection status queries for special output ports
      // ----------------------------------------------------------------------

#if FW_ENABLE_TEXT_LOGGING == 1

      bool isConnected_LogText_OutputPort(
          FwIndexType portNum 
      );

#endif

      bool isConnected_cmdRegOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_cmdResponseOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_logOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_timeCaller_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_tlmOut_OutputPort(
          FwIndexType portNum 
      );

    protected:

      // ----------------------------------------------------------------------
      // Connection status queries for typed output ports
      // ----------------------------------------------------------------------

      bool isConnected_comCmdOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_pingOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_seqDone_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_seqStartOut_OutputPort(
          FwIndexType portNum 
      );

    protected:

      // ----------------------------------------------------------------------
      // Handlers to implement for typed input ports
      // ----------------------------------------------------------------------

      virtual void cmdResponseIn_handler(
          FwIndexType portNum, 
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdResponse& response 
      ) = 0;

      virtual void pingIn_handler(
          FwIndexType portNum, 
          U32 key 
      ) = 0;

      virtual void schedIn_handler(
          FwIndexType portNum, 
          U32 context 
      ) = 0;

      virtual void seqCancelIn_handler(
          FwIndexType portNum 
      ) = 0;

      virtual void seqRunIn_handler(
          FwIndexType portNum, 
          const Fw::StringBase& filename 
      ) = 0;

    protected:

      // ----------------------------------------------------------------------
      // Port handler base-class functions for typed input ports
      //
      // Call these functions directly to bypass the corresponding ports
      // ----------------------------------------------------------------------

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

      void pingIn_handlerBase(
          FwIndexType portNum, 
          U32 key 
      );

      void schedIn_handlerBase(
          FwIndexType portNum, 
          U32 context 
      );

      void seqCancelIn_handlerBase(
          FwIndexType portNum 
      );

      void seqRunIn_handlerBase(
          FwIndexType portNum, 
          const Fw::StringBase& filename 
      );

    protected:

      // ----------------------------------------------------------------------
      // Pre-message hooks for typed async input ports
      //
      // Each of these functions is invoked just before processing a message
      // on the corresponding port. By default, they do nothing. You can
      // override them to provide specific pre-message behavior.
      // ----------------------------------------------------------------------

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

      virtual void pingIn_preMsgHook(
          FwIndexType portNum, 
          U32 key 
      );

      virtual void schedIn_preMsgHook(
          FwIndexType portNum, 
          U32 context 
      );

      virtual void seqCancelIn_preMsgHook(
          FwIndexType portNum 
      );

      virtual void seqRunIn_preMsgHook(
          FwIndexType portNum, 
          const Fw::StringBase& filename 
      );

    protected:

      // ----------------------------------------------------------------------
      // Invocation functions for typed output ports
      // ----------------------------------------------------------------------

      void comCmdOut_out(
          FwIndexType portNum, 
          Fw::ComBuffer& data, 
          U32 context 
      );

      void pingOut_out(
          FwIndexType portNum, 
          U32 key 
      );

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

      void seqStartOut_out(
          FwIndexType portNum, 
          const Fw::StringBase& filename 
      );

    protected:

      // ----------------------------------------------------------------------
      // Command response
      // ----------------------------------------------------------------------

      void cmdResponse_out(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdResponse response 
      );

    protected:

      // ----------------------------------------------------------------------
      // Command handlers to implement
      // ----------------------------------------------------------------------

      virtual void CS_RUN_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdStringArg& fileName, 
          Svc::CmdSequencer_BlockState block 
      ) = 0;

      virtual void CS_VALIDATE_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdStringArg& fileName 
      ) = 0;

      virtual void CS_CANCEL_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      ) = 0;

      virtual void CS_START_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      ) = 0;

      virtual void CS_STEP_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      ) = 0;

      virtual void CS_AUTO_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      ) = 0;

      virtual void CS_MANUAL_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      ) = 0;

      virtual void CS_JOIN_WAIT_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      ) = 0;

    protected:

      // ----------------------------------------------------------------------
      // Command handler base-class functions
      //
      // Call these functions directly to bypass the command input port
      // ----------------------------------------------------------------------

      void CS_RUN_cmdHandlerBase(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

      void CS_VALIDATE_cmdHandlerBase(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

      void CS_CANCEL_cmdHandlerBase(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

      void CS_START_cmdHandlerBase(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

      void CS_STEP_cmdHandlerBase(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

      void CS_AUTO_cmdHandlerBase(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

      void CS_MANUAL_cmdHandlerBase(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

      void CS_JOIN_WAIT_cmdHandlerBase(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

    protected:

      // ----------------------------------------------------------------------
      // Pre-message hooks for async commands
      //
      // Each of these functions is invoked just before processing the
      // corresponding command. By default they do nothing. You can
      // override them to provide specific pre-command behavior.
      // ----------------------------------------------------------------------

      virtual void CS_RUN_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

      virtual void CS_VALIDATE_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

      virtual void CS_CANCEL_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

      virtual void CS_START_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

      virtual void CS_STEP_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

      virtual void CS_AUTO_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

      virtual void CS_MANUAL_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

      virtual void CS_JOIN_WAIT_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

    protected:

      // ----------------------------------------------------------------------
      // Event logging functions
      // ----------------------------------------------------------------------

      void log_ACTIVITY_LO_CS_SequenceLoaded(
          const Fw::StringBase& fileName 
      ) const;

      void log_ACTIVITY_HI_CS_SequenceCanceled(
          const Fw::StringBase& fileName 
      ) const;

      void log_WARNING_HI_CS_FileReadError(
          const Fw::StringBase& fileName 
      ) const;

      void log_WARNING_HI_CS_FileInvalid(
          const Fw::StringBase& fileName, 
          Svc::CmdSequencer_FileReadStage stage, 
          I32 error 
      ) const;

      void log_WARNING_HI_CS_RecordInvalid(
          const Fw::StringBase& fileName, 
          U32 recordNumber, 
          I32 error 
      ) const;

      void log_WARNING_HI_CS_FileSizeError(
          const Fw::StringBase& fileName, 
          U32 size 
      ) const;

      void log_WARNING_HI_CS_FileNotFound(
          const Fw::StringBase& fileName 
      ) const;

      void log_WARNING_HI_CS_FileCrcFailure(
          const Fw::StringBase& fileName, 
          U32 storedCRC, 
          U32 computedCRC 
      ) const;

      void log_ACTIVITY_LO_CS_CommandComplete(
          const Fw::StringBase& fileName, 
          U32 recordNumber, 
          FwOpcodeType opCode 
      ) const;

      void log_ACTIVITY_HI_CS_SequenceComplete(
          const Fw::StringBase& fileName 
      ) const;

      void log_WARNING_HI_CS_CommandError(
          const Fw::StringBase& fileName, 
          U32 recordNumber, 
          FwOpcodeType opCode, 
          U32 errorStatus 
      ) const;

      void log_WARNING_HI_CS_InvalidMode() const;

      void log_WARNING_HI_CS_RecordMismatch(
          const Fw::StringBase& fileName, 
          U32 header_records, 
          U32 extra_bytes 
      ) const;

      void log_WARNING_HI_CS_TimeBaseMismatch(
          const Fw::StringBase& fileName, 
          U16 time_base, 
          U16 seq_time_base 
      ) const;

      void log_WARNING_HI_CS_TimeContextMismatch(
          const Fw::StringBase& fileName, 
          U8 currTimeBase, 
          U8 seqTimeBase 
      ) const;

      void log_ACTIVITY_HI_CS_PortSequenceStarted(
          const Fw::StringBase& filename 
      ) const;

      void log_WARNING_HI_CS_UnexpectedCompletion(
          FwOpcodeType opcode 
      ) const;

      void log_ACTIVITY_HI_CS_ModeSwitched(
          Svc::CmdSequencer_SeqMode mode 
      ) const;

      void log_WARNING_LO_CS_NoSequenceActive() const;

      void log_ACTIVITY_HI_CS_SequenceValid(
          const Fw::StringBase& filename 
      ) const;

      void log_WARNING_HI_CS_SequenceTimeout(
          const Fw::StringBase& filename, 
          U32 command 
      ) const;

      void log_ACTIVITY_HI_CS_CmdStepped(
          const Fw::StringBase& filename, 
          U32 command 
      ) const;

      void log_ACTIVITY_HI_CS_CmdStarted(
          const Fw::StringBase& filename 
      ) const;

      void log_ACTIVITY_HI_CS_JoinWaiting(
          const Fw::StringBase& filename, 
          U32 recordNumber, 
          FwOpcodeType opCode 
      ) const;

      void log_WARNING_HI_CS_JoinWaitingNotComplete() const;

      void log_WARNING_LO_CS_NoRecords(
          const Fw::StringBase& fileName 
      ) const;

    protected:

      // ----------------------------------------------------------------------
      // Telemetry write functions
      // ----------------------------------------------------------------------

      void tlmWrite_CS_LoadCommands(
          U32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CS_CancelCommands(
          U32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CS_Errors(
          U32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CS_CommandsExecuted(
          U32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CS_SequencesCompleted(
          U32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

    protected:

      // ----------------------------------------------------------------------
      // Time
      // ----------------------------------------------------------------------

      Fw::Time getTime() const;

    private:

      // ----------------------------------------------------------------------
      // Message dispatch functions
      // ----------------------------------------------------------------------

      virtual MsgDispatchStatus doDispatch();

    private:

      // ----------------------------------------------------------------------
      // Calls for messages received on special input ports
      // ----------------------------------------------------------------------

      static void m_p_cmdIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

    private:

      // ----------------------------------------------------------------------
      // Calls for messages received on typed input ports
      // ----------------------------------------------------------------------

      static void m_p_cmdResponseIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdResponse& response 
      );

      static void m_p_pingIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          U32 key 
      );

      static void m_p_schedIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          U32 context 
      );

      static void m_p_seqCancelIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum 
      );

      static void m_p_seqRunIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          const Fw::StringBase& filename 
      );

    private:

      // ----------------------------------------------------------------------
      // Special input ports
      // ----------------------------------------------------------------------

      Fw::InputCmdPort m_cmdIn_InputPort[NUM_CMDIN_INPUT_PORTS];

    private:

      // ----------------------------------------------------------------------
      // Typed input ports
      // ----------------------------------------------------------------------

      Fw::InputCmdResponsePort m_cmdResponseIn_InputPort[NUM_CMDRESPONSEIN_INPUT_PORTS];

      Svc::InputPingPort m_pingIn_InputPort[NUM_PINGIN_INPUT_PORTS];

      Svc::InputSchedPort m_schedIn_InputPort[NUM_SCHEDIN_INPUT_PORTS];

      Svc::InputCmdSeqCancelPort m_seqCancelIn_InputPort[NUM_SEQCANCELIN_INPUT_PORTS];

      Svc::InputCmdSeqInPort m_seqRunIn_InputPort[NUM_SEQRUNIN_INPUT_PORTS];

    private:

      // ----------------------------------------------------------------------
      // Special output ports
      // ----------------------------------------------------------------------

#if FW_ENABLE_TEXT_LOGGING == 1

      Fw::OutputLogTextPort m_LogText_OutputPort[NUM_LOGTEXT_OUTPUT_PORTS];

#endif

      Fw::OutputCmdRegPort m_cmdRegOut_OutputPort[NUM_CMDREGOUT_OUTPUT_PORTS];

      Fw::OutputCmdResponsePort m_cmdResponseOut_OutputPort[NUM_CMDRESPONSEOUT_OUTPUT_PORTS];

      Fw::OutputLogPort m_logOut_OutputPort[NUM_LOGOUT_OUTPUT_PORTS];

      Fw::OutputTimePort m_timeCaller_OutputPort[NUM_TIMECALLER_OUTPUT_PORTS];

      Fw::OutputTlmPort m_tlmOut_OutputPort[NUM_TLMOUT_OUTPUT_PORTS];

    private:

      // ----------------------------------------------------------------------
      // Typed output ports
      // ----------------------------------------------------------------------

      Fw::OutputComPort m_comCmdOut_OutputPort[NUM_COMCMDOUT_OUTPUT_PORTS];

      Svc::OutputPingPort m_pingOut_OutputPort[NUM_PINGOUT_OUTPUT_PORTS];

      Fw::OutputCmdResponsePort m_seqDone_OutputPort[NUM_SEQDONE_OUTPUT_PORTS];

      Svc::OutputCmdSeqInPort m_seqStartOut_OutputPort[NUM_SEQSTARTOUT_OUTPUT_PORTS];

  };

}

#endif