TlmChanComponentAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  TlmChanComponentAc.hpp
// \author Auto-generated
// \brief  hpp file for TlmChan component base class
//
// \copyright
// Copyright 2009-2015, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================
 
#ifndef TLMCHAN_COMP_HPP_
#define TLMCHAN_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/Tlm/TlmBuffer.hpp>
#include <Fw/Time/Time.hpp>
#include <Fw/Com/ComBuffer.hpp>
#include <Fw/Tlm/TlmPortAc.hpp>
#include <Fw/Com/ComPortAc.hpp>
#include <Svc/Sched/SchedPortAc.hpp>
#include <Svc/Ping/PingPortAc.hpp>
 
namespace Svc {
 
  class TlmChanComponentBase :
    public Fw::ActiveComponentBase
  {
 
    // ----------------------------------------------------------------------
    // Friend classes
    // ----------------------------------------------------------------------
 
    friend class TlmChanComponentBaseFriend;
 
  public:
 
    // ----------------------------------------------------------------------
    // Getters for typed input ports
    // ----------------------------------------------------------------------
 
    Fw::InputTlmPort* get_TlmRecv_InputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    Fw::InputTlmPort* get_TlmGet_InputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    Svc::InputSchedPort* get_Run_InputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    Svc::InputPingPort* get_pingIn_InputPort(
        NATIVE_INT_TYPE portNum 
    );
 
  public:
 
    // ----------------------------------------------------------------------
    // Connect typed input ports to typed output ports
    // ----------------------------------------------------------------------
 
    void set_PktSend_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputComPort *port 
    );
 
    void set_pingOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Svc::InputPingPort *port 
    );
 
#if FW_PORT_SERIALIZATION
 
  public:
 
    // ----------------------------------------------------------------------
    // Connect serialization input ports to typed output ports
    // ----------------------------------------------------------------------
 
    void set_PktSend_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_pingOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
#endif
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Component construction, initialization, and destruction
    // ----------------------------------------------------------------------
 
#if FW_OBJECT_NAMES == 1
    TlmChanComponentBase(
        const char* compName 
    );
#else
    TlmChanComponentBase(void);
#endif
 
    void init(
        NATIVE_INT_TYPE queueDepth, 
        NATIVE_INT_TYPE instance = 0 
    );
 
    virtual ~TlmChanComponentBase(void);
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // ----------------------------------------------------------------------
    // ----------------------------------------------------------------------
 
    virtual void lock(void);
 
    virtual void unLock(void);
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Handlers to implement for typed input ports
    // ----------------------------------------------------------------------
 
    //
    virtual void TlmRecv_handler(
        NATIVE_INT_TYPE portNum, 
        FwChanIdType id, 
        Fw::Time &timeTag, 
        Fw::TlmBuffer &val 
    ) = 0;
 
    //
    virtual void TlmGet_handler(
        NATIVE_INT_TYPE portNum, 
        FwChanIdType id, 
        Fw::Time &timeTag, 
        Fw::TlmBuffer &val 
    ) = 0;
 
    //
    virtual void Run_handler(
        NATIVE_INT_TYPE portNum, 
        NATIVE_UINT_TYPE context 
    ) = 0;
 
    //
    virtual void pingIn_handler(
        NATIVE_INT_TYPE portNum, 
        U32 key 
    ) = 0;
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Port handler base-class functions for typed input ports.
    // ----------------------------------------------------------------------
    // Call these functions directly to bypass the corresponding ports.
    // ----------------------------------------------------------------------
 
    void TlmRecv_handlerBase(
        NATIVE_INT_TYPE portNum, 
        FwChanIdType id, 
        Fw::Time &timeTag, 
        Fw::TlmBuffer &val 
    );
 
    void TlmGet_handlerBase(
        NATIVE_INT_TYPE portNum, 
        FwChanIdType id, 
        Fw::Time &timeTag, 
        Fw::TlmBuffer &val 
    );
 
    void Run_handlerBase(
        NATIVE_INT_TYPE portNum, 
        NATIVE_UINT_TYPE context 
    );
 
    void pingIn_handlerBase(
        NATIVE_INT_TYPE portNum, 
        U32 key 
    );
 
  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 Run_preMsgHook(
        NATIVE_INT_TYPE portNum, 
        NATIVE_UINT_TYPE context 
    );
 
    virtual void pingIn_preMsgHook(
        NATIVE_INT_TYPE portNum, 
        U32 key 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Invocation functions for typed output ports
    // ----------------------------------------------------------------------
 
    void PktSend_out(
        NATIVE_INT_TYPE portNum, 
        Fw::ComBuffer &data, 
        U32 context 
    );
 
    void pingOut_out(
        NATIVE_INT_TYPE portNum, 
        U32 key 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Getters for numbers of input ports
    // ----------------------------------------------------------------------
 
    NATIVE_INT_TYPE getNum_TlmRecv_InputPorts(void);
 
    NATIVE_INT_TYPE getNum_TlmGet_InputPorts(void);
 
    NATIVE_INT_TYPE getNum_Run_InputPorts(void);
 
    NATIVE_INT_TYPE getNum_pingIn_InputPorts(void);
 
 
    // ----------------------------------------------------------------------
    // Enumerations for number of ports
    // ----------------------------------------------------------------------
 
    enum {
       NUM_TLMRECV_INPUT_PORTS = 1,
       NUM_TLMGET_INPUT_PORTS = 1,
       NUM_RUN_INPUT_PORTS = 1,
       NUM_PINGIN_INPUT_PORTS = 1,
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Getters for numbers of output ports
    // ----------------------------------------------------------------------
 
    NATIVE_INT_TYPE getNum_PktSend_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_pingOut_OutputPorts(void);
 
 
    enum {
       NUM_PKTSEND_OUTPUT_PORTS = 1,
       NUM_PINGOUT_OUTPUT_PORTS = 1,
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Connection status queries for output ports
    // ----------------------------------------------------------------------
 
    bool isConnected_PktSend_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_pingOut_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Event logging functions
    // ----------------------------------------------------------------------
 
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Typed input ports
    // ----------------------------------------------------------------------
 
    Fw::InputTlmPort m_TlmRecv_InputPort[NUM_TLMRECV_INPUT_PORTS];
 
    Fw::InputTlmPort m_TlmGet_InputPort[NUM_TLMGET_INPUT_PORTS];
 
    Svc::InputSchedPort m_Run_InputPort[NUM_RUN_INPUT_PORTS];
 
    Svc::InputPingPort m_pingIn_InputPort[NUM_PINGIN_INPUT_PORTS];
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Typed output ports
    // ----------------------------------------------------------------------
 
    Fw::OutputComPort m_PktSend_OutputPort[NUM_PKTSEND_OUTPUT_PORTS];
 
    Svc::OutputPingPort m_pingOut_OutputPort[NUM_PINGOUT_OUTPUT_PORTS];
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Calls for messages received on typed input ports
    // ----------------------------------------------------------------------
 
    static void m_p_TlmRecv_in(
        Fw::PassiveComponentBase* callComp, 
        NATIVE_INT_TYPE portNum, 
        FwChanIdType id, 
        Fw::Time &timeTag, 
        Fw::TlmBuffer &val 
    );
 
    static void m_p_TlmGet_in(
        Fw::PassiveComponentBase* callComp, 
        NATIVE_INT_TYPE portNum, 
        FwChanIdType id, 
        Fw::Time &timeTag, 
        Fw::TlmBuffer &val 
    );
 
    static void m_p_Run_in(
        Fw::PassiveComponentBase* callComp, 
        NATIVE_INT_TYPE portNum, 
        NATIVE_UINT_TYPE context 
    );
 
    static void m_p_pingIn_in(
        Fw::PassiveComponentBase* callComp, 
        NATIVE_INT_TYPE portNum, 
        U32 key 
    );
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Message dispatch functions
    // ----------------------------------------------------------------------
 
    virtual MsgDispatchStatus doDispatch(void);
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Mutexes
    // ----------------------------------------------------------------------
 
    Os::Mutex m_guardedPortMutex;
 
 
 
  };
 
} // end namespace Svc
#endif