AosDeframerComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_Ccsds_AosDeframerComponentAc_HPP
#define Svc_Ccsds_AosDeframerComponentAc_HPP

#include <atomic>

#include "Fw/Buffer/BufferGetPortAc.hpp"
#include "Fw/Buffer/BufferSendPortAc.hpp"
#include "Fw/Comp/ActiveComponentBase.hpp"
#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Log/LogPortAc.hpp"
#include "Fw/Log/LogString.hpp"
#include "Fw/Log/LogTextPortAc.hpp"
#if !FW_DIRECT_PORT_CALLS
#include "Fw/Port/InputSerializePort.hpp"
#endif
#if !FW_DIRECT_PORT_CALLS
#include "Fw/Port/OutputSerializePort.hpp"
#endif
#include "Fw/Prm/PrmGetPortAc.hpp"
#include "Fw/Prm/PrmSetPortAc.hpp"
#include "Fw/Time/TimePortAc.hpp"
#include "Fw/Tlm/TlmPortAc.hpp"
#include "Fw/Tlm/TlmString.hpp"
#include "Os/Mutex.hpp"
#include "Svc/Ccsds/Ports/ErrorNotifyPortAc.hpp"
#include "Svc/Ports/CommsPorts/ComDataWithContextPortAc.hpp"
#include "default/config/FwSizeTypeAliasAc.hpp"
#include "default/config/PvnEnumAc.hpp"

namespace Svc {

  namespace Ccsds {

    class AosDeframerComponentBase :
      public Fw::PassiveComponentBase
    {

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

        friend class AosDeframerTesterBase;
        friend class AosDeframerTester;

      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_ALLOCATE_OUTPUT_PORTS = 1,
          NUM_DATAOUT_OUTPUT_PORTS = 1,
          NUM_DATARETURNOUT_OUTPUT_PORTS = 1,
          NUM_DEALLOCATE_OUTPUT_PORTS = 1,
          NUM_ERRORNOTIFY_OUTPUT_PORTS = 1,
        };

        enum {
          EVENTID_INVALIDSPACECRAFTID = 0x0, 
          EVENTID_INVALIDFRAMELENGTH = 0x1, 
          EVENTID_INVALIDVCID = 0x2, 
          EVENTID_INVALIDFECF = 0x3, 
          EVENTID_INVALIDTFVN = 0x4, 
          EVENTID_DISABLEDPVN = 0x5, 
          EVENTID_IDLEFRAME = 0x6, 
          EVENTID_SPANNINGPACKETALLOCFAILED = 0x7, 
          EVENTID_VCFRAMECOUNTGAP = 0x8, 
          EVENTID_SPANNINGPACKETABANDONED = 0x9, 
          EVENTID_INVALIDFHP = 0xa, 
        };

        enum {
          CHANNELID_LATESTVCFRAMECOUNT = 0x0, 
          CHANNELID_FRAMESPROCESSED = 0x1, 
          CHANNELID_PACKETSEXTRACTED = 0x2, 
          CHANNELID_CRCERRORCOUNT = 0x3, 
        };

      public:

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

        void init(
            FwEnumStoreType instance = 0 
        );

#if !FW_DIRECT_PORT_CALLS

      public:

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

        Svc::InputComDataWithContextPort* get_dataIn_InputPort(
            FwIndexType portNum 
        );

        Svc::InputComDataWithContextPort* get_dataReturnIn_InputPort(
            FwIndexType portNum 
        );

#endif

#if !FW_DIRECT_PORT_CALLS

      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 
        );

#endif

#if !FW_DIRECT_PORT_CALLS

      public:

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

        void set_allocate_OutputPort(
            FwIndexType portNum, 
            Fw::InputBufferGetPort* port 
        );

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

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

        void set_deallocate_OutputPort(
            FwIndexType portNum, 
            Fw::InputBufferSendPort* port 
        );

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

#endif

#if !FW_DIRECT_PORT_CALLS && 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_DIRECT_PORT_CALLS && 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_deallocate_OutputPort(
            FwIndexType portNum, 
            Fw::InputSerializePort* port 
        );

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

#endif

      protected:

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

        AosDeframerComponentBase(
            const char* compName = "" 
        );

        virtual ~AosDeframerComponentBase();

      protected:

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

        static constexpr FwIndexType getNum_dataIn_InputPorts() {
          return NUM_DATAIN_INPUT_PORTS;
        }

        static constexpr FwIndexType getNum_dataReturnIn_InputPorts() {
          return NUM_DATARETURNIN_INPUT_PORTS;
        }

      protected:

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

        static constexpr FwIndexType getNum_logOut_OutputPorts() {
          return NUM_LOGOUT_OUTPUT_PORTS;
        }

#if FW_ENABLE_TEXT_LOGGING == 1

        static constexpr FwIndexType getNum_logTextOut_OutputPorts() {
          return NUM_LOGTEXTOUT_OUTPUT_PORTS;
        }

#endif

        static constexpr FwIndexType getNum_prmGetOut_OutputPorts() {
          return NUM_PRMGETOUT_OUTPUT_PORTS;
        }

        static constexpr FwIndexType getNum_prmSetOut_OutputPorts() {
          return NUM_PRMSETOUT_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_allocate_OutputPorts() {
          return NUM_ALLOCATE_OUTPUT_PORTS;
        }

        static constexpr FwIndexType getNum_dataOut_OutputPorts() {
          return NUM_DATAOUT_OUTPUT_PORTS;
        }

        static constexpr FwIndexType getNum_dataReturnOut_OutputPorts() {
          return NUM_DATARETURNOUT_OUTPUT_PORTS;
        }

        static constexpr FwIndexType getNum_deallocate_OutputPorts() {
          return NUM_DEALLOCATE_OUTPUT_PORTS;
        }

        static constexpr FwIndexType getNum_errorNotify_OutputPorts() {
          return NUM_ERRORNOTIFY_OUTPUT_PORTS;
        }

      protected:

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

        bool isConnected_logOut_OutputPort(
            FwIndexType portNum 
        ) const;

#if FW_ENABLE_TEXT_LOGGING == 1

        bool isConnected_logTextOut_OutputPort(
            FwIndexType portNum 
        ) const;

#endif

        bool isConnected_prmGetOut_OutputPort(
            FwIndexType portNum 
        ) const;

        bool isConnected_prmSetOut_OutputPort(
            FwIndexType portNum 
        ) const;

        bool isConnected_timeCaller_OutputPort(
            FwIndexType portNum 
        ) const;

        bool isConnected_tlmOut_OutputPort(
            FwIndexType portNum 
        ) const;

      protected:

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

        bool isConnected_allocate_OutputPort(
            FwIndexType portNum 
        ) const;

        bool isConnected_dataOut_OutputPort(
            FwIndexType portNum 
        ) const;

        bool isConnected_dataReturnOut_OutputPort(
            FwIndexType portNum 
        ) const;

        bool isConnected_deallocate_OutputPort(
            FwIndexType portNum 
        ) const;

        bool isConnected_errorNotify_OutputPort(
            FwIndexType portNum 
        ) const;

      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;

#if FW_DIRECT_PORT_CALLS
      public:
#else
      protected:
#endif

        // ----------------------------------------------------------------------
        // 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
        // ----------------------------------------------------------------------

        Fw::Buffer allocate_out(
            FwIndexType portNum, 
            FwSizeType size 
        ) const;

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

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

        void deallocate_out(
            FwIndexType portNum, 
            Fw::Buffer& fwBuffer 
        ) const;

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

      protected:

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

        void log_WARNING_LO_InvalidSpacecraftId(
            U16 transmitted,
            U16 configured
        ) const;

        void log_WARNING_HI_InvalidFrameLength(
            FwSizeType actual,
            U32 expected
        ) const;

        void log_ACTIVITY_LO_InvalidVcId(
            U8 transmitted,
            U8 configured
        ) const;

        void log_WARNING_HI_InvalidFecf(
            U16 transmitted,
            U16 computed
        ) const;

        void log_WARNING_HI_InvalidTfvn(
            U8 transmitted,
            U8 expected
        ) const;

        void log_WARNING_HI_DisabledPvn(
            U8 vcId,
            U8 pvn
        ) const;

        void log_ACTIVITY_LO_IdleFrame(U8 vcId) const;

        void log_WARNING_HI_SpanningPacketAllocFailed(
            U8 vcId,
            const ComCfg::Pvn& pvn,
            FwSizeType packetSize
        ) const;

        void log_WARNING_HI_VcFrameCountGap(
            U8 vcId,
            U32 received,
            U32 expected
        ) const;

        void log_WARNING_HI_SpanningPacketAbandoned(
            U8 vcId,
            const ComCfg::Pvn& pvn,
            FwSizeType bytesReceived,
            FwSizeType bytesExpected
        ) const;

        void log_WARNING_HI_InvalidFhp(
            U8 vcId,
            FwSizeType fhpReceived,
            FwSizeType dataZoneSize
        ) const;

      protected:

        // ----------------------------------------------------------------------
        // Telemetry serialized write
        // ----------------------------------------------------------------------

        void tlmWrite(
            FwChanIdType id, 
            Fw::TlmBuffer& _tlmBuff, 
            Fw::Time _tlmTime = Fw::Time() 
        ) const;

      protected:

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

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

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

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

        void tlmWrite_CrcErrorCount(
            U32 arg, 
            Fw::Time _tlmTime = Fw::Time() 
        ) 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:

        // ----------------------------------------------------------------------
        // Invocation functions for special output ports
        // ----------------------------------------------------------------------

        void logOut_out(
            FwIndexType portNum, 
            FwEventIdType id, 
            Fw::Time& timeTag, 
            const Fw::LogSeverity& severity, 
            Fw::LogBuffer& args 
        ) const;

#if FW_ENABLE_TEXT_LOGGING

        void logTextOut_out(
            FwIndexType portNum, 
            FwEventIdType id, 
            Fw::Time& timeTag, 
            const Fw::LogSeverity& severity, 
            Fw::TextLogString& text 
        ) const;

#endif

        void timeCaller_out(
            FwIndexType portNum, 
            Fw::Time& time 
        ) const;

        void tlmOut_out(
            FwIndexType portNum, 
            FwChanIdType id, 
            Fw::Time& timeTag, 
            Fw::TlmBuffer& val 
        ) const;

#if !FW_DIRECT_PORT_CALLS

      private:

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

        Svc::InputComDataWithContextPort m_dataIn_InputPort[NUM_DATAIN_INPUT_PORTS];

        Svc::InputComDataWithContextPort m_dataReturnIn_InputPort[NUM_DATARETURNIN_INPUT_PORTS];

#endif

#if !FW_DIRECT_PORT_CALLS

      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];

#endif

#if !FW_DIRECT_PORT_CALLS

      private:

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

        Fw::OutputBufferGetPort m_allocate_OutputPort[NUM_ALLOCATE_OUTPUT_PORTS];

        Svc::OutputComDataWithContextPort m_dataOut_OutputPort[NUM_DATAOUT_OUTPUT_PORTS];

        Svc::OutputComDataWithContextPort m_dataReturnOut_OutputPort[NUM_DATARETURNOUT_OUTPUT_PORTS];

        Fw::OutputBufferSendPort m_deallocate_OutputPort[NUM_DEALLOCATE_OUTPUT_PORTS];

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

#endif

      private:

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

        Os::Mutex m_guardedPortMutex;

    };

  }

}

#endif