GroundInterfaceComponentAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  GroundInterfaceComponentAc.hpp
// \author Auto-generated
// \brief  hpp file for GroundInterface component base class
//
// \copyright
// Copyright 2009-2015, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================
 
#ifndef GROUNDINTERFACE_COMP_HPP_
#define GROUNDINTERFACE_COMP_HPP_
 
#include <FpConfig.hpp>
#include <Fw/Port/InputSerializePort.hpp>
#include <Fw/Port/OutputSerializePort.hpp>
#include <Fw/Comp/ActiveComponentBase.hpp>
#include <Os/Mutex.hpp>
#include <Fw/Time/TimePortAc.hpp>
#include <Fw/Log/LogString.hpp>
#include <Fw/Com/ComBuffer.hpp>
#include <Fw/Log/LogBuffer.hpp>
#include <Fw/Time/Time.hpp>
#include <Fw/Log/TextLogString.hpp>
#include <Fw/Buffer/BufferSendPortAc.hpp>
#include <Fw/Log/LogPortAc.hpp>
#if FW_ENABLE_TEXT_LOGGING == 1
#include <Fw/Log/LogTextPortAc.hpp>
#endif
#include <Fw/Com/ComPortAc.hpp>
#include <Fw/Time/TimePortAc.hpp>
#include <Fw/Buffer/BufferGetPortAc.hpp>
#include <Svc/Sched/SchedPortAc.hpp>
 
namespace Svc {
 
  class GroundInterfaceComponentBase :
    public Fw::PassiveComponentBase
  {
 
    // ----------------------------------------------------------------------
    // Friend classes
    // ----------------------------------------------------------------------
 
    friend class GroundInterfaceComponentBaseFriend;
 
  public:
 
    // ----------------------------------------------------------------------
    // Getters for typed input ports
    // ----------------------------------------------------------------------
 
    Fw::InputComPort* get_downlinkPort_InputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    Fw::InputBufferSendPort* get_fileDownlinkBufferSendIn_InputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    Fw::InputBufferSendPort* get_readCallback_InputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    Svc::InputSchedPort* get_schedIn_InputPort(
        NATIVE_INT_TYPE portNum 
    );
 
  public:
 
    // ----------------------------------------------------------------------
    // Connect typed input ports to typed output ports
    // ----------------------------------------------------------------------
 
    void set_fileUplinkBufferSendOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputBufferSendPort *port 
    );
 
    void set_uplinkPort_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputComPort *port 
    );
 
    void set_fileDownlinkBufferSendOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputBufferSendPort *port 
    );
 
    void set_fileUplinkBufferGet_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputBufferGetPort *port 
    );
 
    void set_write_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputBufferSendPort *port 
    );
 
    void set_readPoll_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputBufferSendPort *port 
    );
 
    void set_Log_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputLogPort *port 
    );
 
#if FW_ENABLE_TEXT_LOGGING == 1
    void set_LogText_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputLogTextPort *port 
    );
#endif
 
    void set_Time_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputTimePort *port 
    );
 
#if FW_PORT_SERIALIZATION
 
  public:
 
    // ----------------------------------------------------------------------
    // Connect serialization input ports to typed output ports
    // ----------------------------------------------------------------------
 
    void set_fileUplinkBufferSendOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_uplinkPort_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_fileDownlinkBufferSendOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_fileUplinkBufferGet_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_write_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_readPoll_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_Log_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
#if FW_ENABLE_TEXT_LOGGING == 1
    void set_LogText_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
#endif
 
    void set_Time_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
#endif
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Component construction, initialization, and destruction
    // ----------------------------------------------------------------------
 
#if FW_OBJECT_NAMES == 1
    GroundInterfaceComponentBase(
        const char* compName 
    );
#else
    GroundInterfaceComponentBase(void);
#endif
 
    void init(
        NATIVE_INT_TYPE instance = 0 
    );
 
    virtual ~GroundInterfaceComponentBase(void);
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // ----------------------------------------------------------------------
    // ----------------------------------------------------------------------
 
    virtual void lock(void);
 
    virtual void unLock(void);
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Handlers to implement for typed input ports
    // ----------------------------------------------------------------------
 
    //
    virtual void downlinkPort_handler(
        NATIVE_INT_TYPE portNum, 
        Fw::ComBuffer &data, 
        U32 context 
    ) = 0;
 
    //
    virtual void fileDownlinkBufferSendIn_handler(
        NATIVE_INT_TYPE portNum, 
        Fw::Buffer &fwBuffer 
    ) = 0;
 
    //
    virtual void readCallback_handler(
        NATIVE_INT_TYPE portNum, 
        Fw::Buffer &fwBuffer 
    ) = 0;
 
    //
    virtual void schedIn_handler(
        NATIVE_INT_TYPE portNum, 
        NATIVE_UINT_TYPE context 
    ) = 0;
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Port handler base-class functions for typed input ports.
    // ----------------------------------------------------------------------
    // Call these functions directly to bypass the corresponding ports.
    // ----------------------------------------------------------------------
 
    void downlinkPort_handlerBase(
        NATIVE_INT_TYPE portNum, 
        Fw::ComBuffer &data, 
        U32 context 
    );
 
    void fileDownlinkBufferSendIn_handlerBase(
        NATIVE_INT_TYPE portNum, 
        Fw::Buffer &fwBuffer 
    );
 
    void readCallback_handlerBase(
        NATIVE_INT_TYPE portNum, 
        Fw::Buffer &fwBuffer 
    );
 
    void schedIn_handlerBase(
        NATIVE_INT_TYPE portNum, 
        NATIVE_UINT_TYPE context 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Invocation functions for typed output ports
    // ----------------------------------------------------------------------
 
    void fileUplinkBufferSendOut_out(
        NATIVE_INT_TYPE portNum, 
        Fw::Buffer &fwBuffer 
    );
 
    void uplinkPort_out(
        NATIVE_INT_TYPE portNum, 
        Fw::ComBuffer &data, 
        U32 context 
    );
 
    void fileDownlinkBufferSendOut_out(
        NATIVE_INT_TYPE portNum, 
        Fw::Buffer &fwBuffer 
    );
 
    Fw::Buffer fileUplinkBufferGet_out(
        NATIVE_INT_TYPE portNum, 
        U32 size 
    );
 
    void write_out(
        NATIVE_INT_TYPE portNum, 
        Fw::Buffer &fwBuffer 
    );
 
    void readPoll_out(
        NATIVE_INT_TYPE portNum, 
        Fw::Buffer &fwBuffer 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Getters for numbers of input ports
    // ----------------------------------------------------------------------
 
    NATIVE_INT_TYPE getNum_downlinkPort_InputPorts(void);
 
    NATIVE_INT_TYPE getNum_fileDownlinkBufferSendIn_InputPorts(void);
 
    NATIVE_INT_TYPE getNum_readCallback_InputPorts(void);
 
    NATIVE_INT_TYPE getNum_schedIn_InputPorts(void);
 
 
    // ----------------------------------------------------------------------
    // Enumerations for number of ports
    // ----------------------------------------------------------------------
 
    enum {
       NUM_DOWNLINKPORT_INPUT_PORTS = 1,
       NUM_FILEDOWNLINKBUFFERSENDIN_INPUT_PORTS = 1,
       NUM_READCALLBACK_INPUT_PORTS = 1,
       NUM_SCHEDIN_INPUT_PORTS = 1,
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Getters for numbers of output ports
    // ----------------------------------------------------------------------
 
    NATIVE_INT_TYPE getNum_fileUplinkBufferSendOut_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_uplinkPort_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_fileDownlinkBufferSendOut_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_fileUplinkBufferGet_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_write_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_readPoll_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_Log_OutputPorts(void);
 
#if FW_ENABLE_TEXT_LOGGING == 1
    NATIVE_INT_TYPE getNum_LogText_OutputPorts(void);
#endif
 
    NATIVE_INT_TYPE getNum_Time_OutputPorts(void);
 
 
    enum {
       NUM_FILEUPLINKBUFFERSENDOUT_OUTPUT_PORTS = 1,
       NUM_UPLINKPORT_OUTPUT_PORTS = 1,
       NUM_FILEDOWNLINKBUFFERSENDOUT_OUTPUT_PORTS = 1,
       NUM_FILEUPLINKBUFFERGET_OUTPUT_PORTS = 1,
       NUM_WRITE_OUTPUT_PORTS = 1,
       NUM_READPOLL_OUTPUT_PORTS = 1,
       NUM_LOG_OUTPUT_PORTS = 1,
       NUM_LOGTEXT_OUTPUT_PORTS = 1,
       NUM_TIME_OUTPUT_PORTS = 1,
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Connection status queries for output ports
    // ----------------------------------------------------------------------
 
    bool isConnected_fileUplinkBufferSendOut_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_uplinkPort_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_fileDownlinkBufferSendOut_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_fileUplinkBufferGet_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_write_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_readPoll_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_Log_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
#if FW_ENABLE_TEXT_LOGGING == 1
    bool isConnected_LogText_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
#endif
 
    bool isConnected_Time_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Event IDs
    // ----------------------------------------------------------------------
 
    enum {
      EVENTID_GROUNDINTERFACEERROR = 0, /* An error in the ground interface, here to make the UTs happy. */
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Event logging functions
    // ----------------------------------------------------------------------
 
    /* An error in the ground interface, here to make the UTs happy. */
    void log_WARNING_HI_GroundInterfaceError(
        void
    );
 
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Time
    // ----------------------------------------------------------------------
 
    Fw::Time getTime(void);
 
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Typed input ports
    // ----------------------------------------------------------------------
 
    Fw::InputComPort m_downlinkPort_InputPort[NUM_DOWNLINKPORT_INPUT_PORTS];
 
    Fw::InputBufferSendPort m_fileDownlinkBufferSendIn_InputPort[NUM_FILEDOWNLINKBUFFERSENDIN_INPUT_PORTS];
 
    Fw::InputBufferSendPort m_readCallback_InputPort[NUM_READCALLBACK_INPUT_PORTS];
 
    Svc::InputSchedPort m_schedIn_InputPort[NUM_SCHEDIN_INPUT_PORTS];
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Typed output ports
    // ----------------------------------------------------------------------
 
    Fw::OutputBufferSendPort m_fileUplinkBufferSendOut_OutputPort[NUM_FILEUPLINKBUFFERSENDOUT_OUTPUT_PORTS];
 
    Fw::OutputComPort m_uplinkPort_OutputPort[NUM_UPLINKPORT_OUTPUT_PORTS];
 
    Fw::OutputBufferSendPort m_fileDownlinkBufferSendOut_OutputPort[NUM_FILEDOWNLINKBUFFERSENDOUT_OUTPUT_PORTS];
 
    Fw::OutputBufferGetPort m_fileUplinkBufferGet_OutputPort[NUM_FILEUPLINKBUFFERGET_OUTPUT_PORTS];
 
    Fw::OutputBufferSendPort m_write_OutputPort[NUM_WRITE_OUTPUT_PORTS];
 
    Fw::OutputBufferSendPort m_readPoll_OutputPort[NUM_READPOLL_OUTPUT_PORTS];
 
    Fw::OutputLogPort m_Log_OutputPort[NUM_LOG_OUTPUT_PORTS];
 
#if FW_ENABLE_TEXT_LOGGING == 1
    Fw::OutputLogTextPort m_LogText_OutputPort[NUM_LOGTEXT_OUTPUT_PORTS];
#endif
 
    Fw::OutputTimePort m_Time_OutputPort[NUM_TIME_OUTPUT_PORTS];
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Calls for messages received on typed input ports
    // ----------------------------------------------------------------------
 
    static void m_p_downlinkPort_in(
        Fw::PassiveComponentBase* callComp, 
        NATIVE_INT_TYPE portNum, 
        Fw::ComBuffer &data, 
        U32 context 
    );
 
    static void m_p_fileDownlinkBufferSendIn_in(
        Fw::PassiveComponentBase* callComp, 
        NATIVE_INT_TYPE portNum, 
        Fw::Buffer &fwBuffer 
    );
 
    static void m_p_readCallback_in(
        Fw::PassiveComponentBase* callComp, 
        NATIVE_INT_TYPE portNum, 
        Fw::Buffer &fwBuffer 
    );
 
    static void m_p_schedIn_in(
        Fw::PassiveComponentBase* callComp, 
        NATIVE_INT_TYPE portNum, 
        NATIVE_UINT_TYPE context 
    );
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Mutexes
    // ----------------------------------------------------------------------
 
    Os::Mutex m_guardedPortMutex;
 
 
  PRIVATE:
    // ----------------------------------------------------------------------
    // Counter values for event throttling
    // ----------------------------------------------------------------------
 
  };
 
} // end namespace Svc
#endif