TcDeframerComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_Ccsds_TcDeframerComponentAc_HPP
#define Svc_Ccsds_TcDeframerComponentAc_HPP

#include <atomic>

#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/Prm/PrmGetPortAc.hpp"
#include "Fw/Prm/PrmSetPortAc.hpp"
#include "Fw/Time/TimePortAc.hpp"
#include "Fw/Tlm/TlmPortAc.hpp"
#include "Os/Mutex.hpp"
#include "Svc/Ccsds/Ports/ErrorNotifyPortAc.hpp"
#include "Svc/Ports/CommsPorts/ComDataWithContextPortAc.hpp"
#include "default/config/FwSizeTypeAliasAc.hpp"

namespace Svc {

  namespace Ccsds {

    class TcDeframerComponentBase :
      public Fw::PassiveComponentBase
    {

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

        friend class TcDeframerTesterBase;
        friend class TcDeframerTester;

      protected:

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

        enum {
          NUM_DATAIN_INPUT_PORTS = 1,
          NUM_DATARETURNIN_INPUT_PORTS = 1,
        };

        enum {
          NUM_LOGOUT_OUTPUT_PORTS = 1,
          NUM_LOGTEXTOUT_OUTPUT_PORTS = 1,
          NUM_PRMGETOUT_OUTPUT_PORTS = 1,
          NUM_PRMSETOUT_OUTPUT_PORTS = 1,
          NUM_TIMECALLER_OUTPUT_PORTS = 1,
          NUM_TLMOUT_OUTPUT_PORTS = 1,
        };

        enum {
          NUM_DATAOUT_OUTPUT_PORTS = 1,
          NUM_DATARETURNOUT_OUTPUT_PORTS = 1,
          NUM_ERRORNOTIFY_OUTPUT_PORTS = 1,
        };

        enum {
          EVENTID_INVALIDSPACECRAFTID = 0x0, 
          EVENTID_INVALIDFRAMELENGTH = 0x1, 
          EVENTID_INVALIDVCID = 0x2, 
          EVENTID_INVALIDCRC = 0x3, 
        };

      public:

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

        void init(
            FwEnumStoreType instance = 0 
        );

      public:

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

        Svc::InputComDataWithContextPort* get_dataIn_InputPort(
            FwIndexType portNum 
        );

        Svc::InputComDataWithContextPort* get_dataReturnIn_InputPort(
            FwIndexType portNum 
        );

      public:

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

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

#if FW_ENABLE_TEXT_LOGGING == 1

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

#endif

        void set_prmGetOut_OutputPort(
            FwIndexType portNum, 
            Fw::InputPrmGetPort* port 
        );

        void set_prmSetOut_OutputPort(
            FwIndexType portNum, 
            Fw::InputPrmSetPort* 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_dataOut_OutputPort(
            FwIndexType portNum, 
            Svc::InputComDataWithContextPort* port 
        );

        void set_dataReturnOut_OutputPort(
            FwIndexType portNum, 
            Svc::InputComDataWithContextPort* port 
        );

        void set_errorNotify_OutputPort(
            FwIndexType portNum, 
            Svc::Ccsds::InputErrorNotifyPort* port 
        );

#if FW_PORT_SERIALIZATION

      public:

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

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

#if FW_ENABLE_TEXT_LOGGING == 1

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

#endif

        void set_prmSetOut_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_dataOut_OutputPort(
            FwIndexType portNum, 
            Fw::InputSerializePort* port 
        );

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

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

#endif

      protected:

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

        TcDeframerComponentBase(
            const char* compName = "" 
        );

        virtual ~TcDeframerComponentBase();

      protected:

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

        FwIndexType getNum_dataIn_InputPorts() const;

        FwIndexType getNum_dataReturnIn_InputPorts() const;

      protected:

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

        FwIndexType getNum_logOut_OutputPorts() const;

#if FW_ENABLE_TEXT_LOGGING == 1

        FwIndexType getNum_logTextOut_OutputPorts() const;

#endif

        FwIndexType getNum_prmGetOut_OutputPorts() const;

        FwIndexType getNum_prmSetOut_OutputPorts() const;

        FwIndexType getNum_timeCaller_OutputPorts() const;

        FwIndexType getNum_tlmOut_OutputPorts() const;

      protected:

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

        FwIndexType getNum_dataOut_OutputPorts() const;

        FwIndexType getNum_dataReturnOut_OutputPorts() const;

        FwIndexType getNum_errorNotify_OutputPorts() const;

      protected:

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

        bool isConnected_logOut_OutputPort(
            FwIndexType portNum 
        );

#if FW_ENABLE_TEXT_LOGGING == 1

        bool isConnected_logTextOut_OutputPort(
            FwIndexType portNum 
        );

#endif

        bool isConnected_prmGetOut_OutputPort(
            FwIndexType portNum 
        );

        bool isConnected_prmSetOut_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_dataOut_OutputPort(
            FwIndexType portNum 
        );

        bool isConnected_dataReturnOut_OutputPort(
            FwIndexType portNum 
        );

        bool isConnected_errorNotify_OutputPort(
            FwIndexType portNum 
        );

      protected:

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

        virtual void dataIn_handler(
            FwIndexType portNum, 
            Fw::Buffer& data,
            const ComCfg::FrameContext& context
        ) = 0;

        virtual void dataReturnIn_handler(
            FwIndexType portNum, 
            Fw::Buffer& data,
            const ComCfg::FrameContext& context
        ) = 0;

      protected:

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

        void dataIn_handlerBase(
            FwIndexType portNum, 
            Fw::Buffer& data,
            const ComCfg::FrameContext& context
        );

        void dataReturnIn_handlerBase(
            FwIndexType portNum, 
            Fw::Buffer& data,
            const ComCfg::FrameContext& context
        );

      protected:

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

        void dataOut_out(
            FwIndexType portNum, 
            Fw::Buffer& data,
            const ComCfg::FrameContext& context
        );

        void dataReturnOut_out(
            FwIndexType portNum, 
            Fw::Buffer& data,
            const ComCfg::FrameContext& context
        );

        void errorNotify_out(
            FwIndexType portNum, 
            const Svc::Ccsds::FrameError& errorCode
        );

      protected:

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

        void log_WARNING_LO_InvalidSpacecraftId(
            U16 transmitted,
            U16 configured
        ) const;

        void log_WARNING_HI_InvalidFrameLength(
            U16 transmitted,
            FwSizeType actual
        ) const;

        void log_ACTIVITY_LO_InvalidVcId(
            U16 transmitted,
            U16 configured
        ) const;

        void log_WARNING_HI_InvalidCrc(
            U16 transmitted,
            U16 computed
        ) const;

      protected:

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

        Fw::Time getTime() const;

      protected:

        // ----------------------------------------------------------------------
        // Mutex operations for guarded ports
        //
        // You can override these operations to provide more sophisticated
        // synchronization
        // ----------------------------------------------------------------------

        virtual void lock();

        virtual void unLock();

      private:

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

        static void m_p_dataIn_in(
            Fw::PassiveComponentBase* callComp, 
            FwIndexType portNum, 
            Fw::Buffer& data,
            const ComCfg::FrameContext& context
        );

        static void m_p_dataReturnIn_in(
            Fw::PassiveComponentBase* callComp, 
            FwIndexType portNum, 
            Fw::Buffer& data,
            const ComCfg::FrameContext& context
        );

      private:

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

        Svc::InputComDataWithContextPort m_dataIn_InputPort[NUM_DATAIN_INPUT_PORTS];

        Svc::InputComDataWithContextPort m_dataReturnIn_InputPort[NUM_DATARETURNIN_INPUT_PORTS];

      private:

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

        Fw::OutputLogPort m_logOut_OutputPort[NUM_LOGOUT_OUTPUT_PORTS];

#if FW_ENABLE_TEXT_LOGGING == 1

        Fw::OutputLogTextPort m_logTextOut_OutputPort[NUM_LOGTEXTOUT_OUTPUT_PORTS];

#endif

        Fw::OutputPrmGetPort m_prmGetOut_OutputPort[NUM_PRMGETOUT_OUTPUT_PORTS];

        Fw::OutputPrmSetPort m_prmSetOut_OutputPort[NUM_PRMSETOUT_OUTPUT_PORTS];

        Fw::OutputTimePort m_timeCaller_OutputPort[NUM_TIMECALLER_OUTPUT_PORTS];

        Fw::OutputTlmPort m_tlmOut_OutputPort[NUM_TLMOUT_OUTPUT_PORTS];

      private:

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

        Svc::OutputComDataWithContextPort m_dataOut_OutputPort[NUM_DATAOUT_OUTPUT_PORTS];

        Svc::OutputComDataWithContextPort m_dataReturnOut_OutputPort[NUM_DATARETURNOUT_OUTPUT_PORTS];

        Svc::Ccsds::OutputErrorNotifyPort m_errorNotify_OutputPort[NUM_ERRORNOTIFY_OUTPUT_PORTS];

      private:

        // ----------------------------------------------------------------------
        // Mutexes
        // ----------------------------------------------------------------------

        Os::Mutex m_guardedPortMutex;

    };

  }

}

#endif