ApidManagerComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_Ccsds_ApidManagerComponentAc_HPP
#define Svc_Ccsds_ApidManagerComponentAc_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
#if !FW_DIRECT_PORT_CALLS
#include "Fw/Port/InputSerializePort.hpp"
#endif
#if !FW_DIRECT_PORT_CALLS
#include "Fw/Port/OutputSerializePort.hpp"
#endif
#include "Fw/Time/TimePortAc.hpp"
#include "Os/Mutex.hpp"
#include "Svc/Ccsds/Ports/ApidSequenceCountPortAc.hpp"

namespace Svc {

  namespace Ccsds {

    class ApidManagerComponentBase :
      public Fw::PassiveComponentBase
    {

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

        friend class ApidManagerTesterBase;
        friend class ApidManagerTester;

      protected:

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

        enum {
          NUM_GETAPIDSEQCOUNTIN_INPUT_PORTS = 1,
          NUM_VALIDATEAPIDSEQCOUNTIN_INPUT_PORTS = 1,
        };

        enum {
          NUM_LOGOUT_OUTPUT_PORTS = 1,
          NUM_LOGTEXTOUT_OUTPUT_PORTS = 1,
          NUM_TIMECALLER_OUTPUT_PORTS = 1,
        };

        enum {
          EVENTID_UNEXPECTEDSEQUENCECOUNT = 0x0, 
          EVENTID_APIDTABLEFULL = 0x1, 
        };

      public:

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

        void init(
            FwEnumStoreType instance = 0 
        );

#if !FW_DIRECT_PORT_CALLS

      public:

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

        Svc::Ccsds::InputApidSequenceCountPort* get_getApidSeqCountIn_InputPort(
            FwIndexType portNum 
        );

        Svc::Ccsds::InputApidSequenceCountPort* get_validateApidSeqCountIn_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_timeCaller_OutputPort(
            FwIndexType portNum, 
            Fw::InputTimePort* 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_timeCaller_OutputPort(
            FwIndexType portNum, 
            Fw::InputSerializePort* port 
        );

#endif

      protected:

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

        ApidManagerComponentBase(
            const char* compName = "" 
        );

        virtual ~ApidManagerComponentBase();

      protected:

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

        static constexpr FwIndexType getNum_getApidSeqCountIn_InputPorts() {
          return NUM_GETAPIDSEQCOUNTIN_INPUT_PORTS;
        }

        static constexpr FwIndexType getNum_validateApidSeqCountIn_InputPorts() {
          return NUM_VALIDATEAPIDSEQCOUNTIN_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_timeCaller_OutputPorts() {
          return NUM_TIMECALLER_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_timeCaller_OutputPort(
            FwIndexType portNum 
        ) const;

      protected:

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

        virtual U16 getApidSeqCountIn_handler(
            FwIndexType portNum, 
            const ComCfg::Apid& apid,
            U16 sequenceCount
        ) = 0;

        virtual U16 validateApidSeqCountIn_handler(
            FwIndexType portNum, 
            const ComCfg::Apid& apid,
            U16 sequenceCount
        ) = 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
        // ----------------------------------------------------------------------

        U16 getApidSeqCountIn_handlerBase(
            FwIndexType portNum, 
            const ComCfg::Apid& apid,
            U16 sequenceCount
        );

        U16 validateApidSeqCountIn_handlerBase(
            FwIndexType portNum, 
            const ComCfg::Apid& apid,
            U16 sequenceCount
        );

      protected:

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

        void log_WARNING_LO_UnexpectedSequenceCount(
            U16 transmitted,
            U16 expected
        ) const;

        void log_WARNING_HI_ApidTableFull(U16 invalidApidValue) 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 U16 m_p_getApidSeqCountIn_in(
            Fw::PassiveComponentBase* callComp, 
            FwIndexType portNum, 
            const ComCfg::Apid& apid,
            U16 sequenceCount
        );

        static U16 m_p_validateApidSeqCountIn_in(
            Fw::PassiveComponentBase* callComp, 
            FwIndexType portNum, 
            const ComCfg::Apid& apid,
            U16 sequenceCount
        );

      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;

#if !FW_DIRECT_PORT_CALLS

      private:

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

        Svc::Ccsds::InputApidSequenceCountPort m_getApidSeqCountIn_InputPort[NUM_GETAPIDSEQCOUNTIN_INPUT_PORTS];

        Svc::Ccsds::InputApidSequenceCountPort m_validateApidSeqCountIn_InputPort[NUM_VALIDATEAPIDSEQCOUNTIN_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::OutputTimePort m_timeCaller_OutputPort[NUM_TIMECALLER_OUTPUT_PORTS];

#endif

      private:

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

        Os::Mutex m_guardedPortMutex;

    };

  }

}

#endif