FileUplinkComponentAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  FileUplinkComponentAc.hpp
// \author Auto-generated
// \brief  hpp file for FileUplink component base class
//
// \copyright
// Copyright 2009-2015, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================
 
#ifndef FILEUPLINK_COMP_HPP_
#define FILEUPLINK_COMP_HPP_
 
#include <FpConfig.hpp>
#include <Fw/Port/InputSerializePort.hpp>
#include <Fw/Port/OutputSerializePort.hpp>
#include <Fw/Comp/ActiveComponentBase.hpp>
#include <Fw/Tlm/TlmString.hpp>
#include <Fw/Time/TimePortAc.hpp>
#include <Fw/Log/LogString.hpp>
#include <Fw/Time/Time.hpp>
#include <Fw/Tlm/TlmBuffer.hpp>
#include <Fw/Log/LogBuffer.hpp>
#include <Fw/Log/TextLogString.hpp>
#include <Fw/Buffer/BufferSendPortAc.hpp>
#include <Fw/Time/TimePortAc.hpp>
#include <Fw/Tlm/TlmPortAc.hpp>
#include <Fw/Log/LogPortAc.hpp>
#include <Svc/Ping/PingPortAc.hpp>
#if FW_ENABLE_TEXT_LOGGING == 1
#include <Fw/Log/LogTextPortAc.hpp>
#endif
 
namespace Svc {
 
  class FileUplinkComponentBase :
    public Fw::ActiveComponentBase
  {
 
    // ----------------------------------------------------------------------
    // Friend classes
    // ----------------------------------------------------------------------
 
    friend class FileUplinkComponentBaseFriend;
 
  public:
 
    // ----------------------------------------------------------------------
    // Getters for typed input ports
    // ----------------------------------------------------------------------
 
    Fw::InputBufferSendPort* get_bufferSendIn_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_timeCaller_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputTimePort *port 
    );
 
    void set_bufferSendOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputBufferSendPort *port 
    );
 
    void set_tlmOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputTlmPort *port 
    );
 
    void set_eventOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputLogPort *port 
    );
 
    void set_pingOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Svc::InputPingPort *port 
    );
 
#if FW_ENABLE_TEXT_LOGGING == 1
    void set_LogText_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputLogTextPort *port 
    );
#endif
 
#if FW_PORT_SERIALIZATION
 
  public:
 
    // ----------------------------------------------------------------------
    // Connect serialization input ports to typed output ports
    // ----------------------------------------------------------------------
 
    void set_timeCaller_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_bufferSendOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_tlmOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_eventOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_pingOut_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
 
#endif
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Component construction, initialization, and destruction
    // ----------------------------------------------------------------------
 
#if FW_OBJECT_NAMES == 1
    FileUplinkComponentBase(
        const char* compName 
    );
#else
    FileUplinkComponentBase(void);
#endif
 
    void init(
        NATIVE_INT_TYPE queueDepth, 
        NATIVE_INT_TYPE instance = 0 
    );
 
    virtual ~FileUplinkComponentBase(void);
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Handlers to implement for typed input ports
    // ----------------------------------------------------------------------
 
    //
    virtual void bufferSendIn_handler(
        NATIVE_INT_TYPE portNum, 
        Fw::Buffer &fwBuffer 
    ) = 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 bufferSendIn_handlerBase(
        NATIVE_INT_TYPE portNum, 
        Fw::Buffer &fwBuffer 
    );
 
    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 bufferSendIn_preMsgHook(
        NATIVE_INT_TYPE portNum, 
        Fw::Buffer &fwBuffer 
    );
 
    virtual void pingIn_preMsgHook(
        NATIVE_INT_TYPE portNum, 
        U32 key 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Invocation functions for typed output ports
    // ----------------------------------------------------------------------
 
    void bufferSendOut_out(
        NATIVE_INT_TYPE portNum, 
        Fw::Buffer &fwBuffer 
    );
 
    void pingOut_out(
        NATIVE_INT_TYPE portNum, 
        U32 key 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Getters for numbers of input ports
    // ----------------------------------------------------------------------
 
    NATIVE_INT_TYPE getNum_bufferSendIn_InputPorts(void);
 
    NATIVE_INT_TYPE getNum_pingIn_InputPorts(void);
 
 
    // ----------------------------------------------------------------------
    // Enumerations for number of ports
    // ----------------------------------------------------------------------
 
    enum {
       NUM_BUFFERSENDIN_INPUT_PORTS = 1,
       NUM_PINGIN_INPUT_PORTS = 1,
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Getters for numbers of output ports
    // ----------------------------------------------------------------------
 
    NATIVE_INT_TYPE getNum_timeCaller_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_bufferSendOut_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_tlmOut_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_eventOut_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_pingOut_OutputPorts(void);
 
#if FW_ENABLE_TEXT_LOGGING == 1
    NATIVE_INT_TYPE getNum_LogText_OutputPorts(void);
#endif
 
 
    enum {
       NUM_TIMECALLER_OUTPUT_PORTS = 1,
       NUM_BUFFERSENDOUT_OUTPUT_PORTS = 1,
       NUM_TLMOUT_OUTPUT_PORTS = 1,
       NUM_EVENTOUT_OUTPUT_PORTS = 1,
       NUM_PINGOUT_OUTPUT_PORTS = 1,
       NUM_LOGTEXT_OUTPUT_PORTS = 1,
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Connection status queries for output ports
    // ----------------------------------------------------------------------
 
    bool isConnected_timeCaller_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_bufferSendOut_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_tlmOut_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_eventOut_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_pingOut_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
#if FW_ENABLE_TEXT_LOGGING == 1
    bool isConnected_LogText_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
#endif
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Event IDs
    // ----------------------------------------------------------------------
 
    enum {
      EVENTID_FILEUPLINK_BADCHECKSUM = 0, /* During receipt of a file, the computed checksum value did not match the stored value */
      EVENTID_FILEUPLINK_FILEOPENERROR = 1, /* An error occurred opening a file */
      EVENTID_FILEUPLINK_FILERECEIVED = 2, /* The File Uplink component successfully received a file */
      EVENTID_FILEUPLINK_FILEWRITEERROR = 3, /* An error occurred writing to a file */
      EVENTID_FILEUPLINK_INVALIDRECEIVEMODE = 4, /* The File Uplink component received a packet with a type that was invalid for the current receive mode */
      EVENTID_FILEUPLINK_PACKETOUTOFBOUNDS = 5, /* During receipt of a file, the File Uplink component encountered a packet with offset and size out of bounds for the current file */
      EVENTID_FILEUPLINK_PACKETOUTOFORDER = 6, /* The File Uplink component encountered an out-of-order packet during file receipt */
      EVENTID_FILEUPLINK_UPLINKCANCELED = 7, /* The File Uplink component received a CANCEL packet */
    };
 
    // ----------------------------------------------------------------------
    // Event Throttle values - sets initial value of countdown variable
    // ----------------------------------------------------------------------
 
    enum {
      EVENTID_FILEUPLINK_FILEWRITEERROR_THROTTLE = 5, 
      EVENTID_FILEUPLINK_INVALIDRECEIVEMODE_THROTTLE = 5, 
      EVENTID_FILEUPLINK_PACKETOUTOFBOUNDS_THROTTLE = 5, 
      EVENTID_FILEUPLINK_PACKETOUTOFORDER_THROTTLE = 20, 
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Event logging functions
    // ----------------------------------------------------------------------
 
    /* During receipt of a file, the computed checksum value did not match the stored value */
    void log_WARNING_HI_FileUplink_BadChecksum(
        Fw::LogStringArg& fileName, 
        U32 computed, 
        U32 read 
    );
 
 
    /* An error occurred opening a file */
    void log_WARNING_HI_FileUplink_FileOpenError(
        Fw::LogStringArg& fileName 
    );
 
 
    /* The File Uplink component successfully received a file */
    void log_ACTIVITY_HI_FileUplink_FileReceived(
        Fw::LogStringArg& fileName 
    );
 
 
    /* An error occurred writing to a file */
    void log_WARNING_HI_FileUplink_FileWriteError(
        Fw::LogStringArg& fileName 
    );
 
    // reset throttle value for FileUplink_FileWriteError
    void log_WARNING_HI_FileUplink_FileWriteError_ThrottleClear(void);
 
    /* The File Uplink component received a packet with a type that was invalid for the current receive mode */
    void log_WARNING_HI_FileUplink_InvalidReceiveMode(
        U32 packetType, 
        U32 mode 
    );
 
    // reset throttle value for FileUplink_InvalidReceiveMode
    void log_WARNING_HI_FileUplink_InvalidReceiveMode_ThrottleClear(void);
 
    /* During receipt of a file, the File Uplink component encountered a packet with offset and size out of bounds for the current file */
    void log_WARNING_HI_FileUplink_PacketOutOfBounds(
        U32 packetIndex, 
        Fw::LogStringArg& fileName 
    );
 
    // reset throttle value for FileUplink_PacketOutOfBounds
    void log_WARNING_HI_FileUplink_PacketOutOfBounds_ThrottleClear(void);
 
    /* The File Uplink component encountered an out-of-order packet during file receipt */
    void log_WARNING_HI_FileUplink_PacketOutOfOrder(
        U32 packetIndex, 
        U32 lastPacketIndex 
    );
 
    // reset throttle value for FileUplink_PacketOutOfOrder
    void log_WARNING_HI_FileUplink_PacketOutOfOrder_ThrottleClear(void);
 
    /* The File Uplink component received a CANCEL packet */
    void log_ACTIVITY_HI_FileUplink_UplinkCanceled(
        void
    );
 
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Channel IDs
    // ----------------------------------------------------------------------
 
    enum {
      CHANNELID_FILEUPLINK_FILESRECEIVED = 0, 
      CHANNELID_FILEUPLINK_PACKETSRECEIVED = 1, 
      CHANNELID_FILEUPLINK_WARNINGS = 2, 
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Telemetry write functions
    // ----------------------------------------------------------------------
 
    /* The total number of complete files received */
    void tlmWrite_FileUplink_FilesReceived(
        U32 arg 
    );
 
    /* The total number of packets received */
    void tlmWrite_FileUplink_PacketsReceived(
        U32 arg 
    );
 
    /* The total number of warnings issued */
    void tlmWrite_FileUplink_Warnings(
        U32 arg 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Time
    // ----------------------------------------------------------------------
 
    Fw::Time getTime(void);
 
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Typed input ports
    // ----------------------------------------------------------------------
 
    Fw::InputBufferSendPort m_bufferSendIn_InputPort[NUM_BUFFERSENDIN_INPUT_PORTS];
 
    Svc::InputPingPort m_pingIn_InputPort[NUM_PINGIN_INPUT_PORTS];
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Typed output ports
    // ----------------------------------------------------------------------
 
    Fw::OutputTimePort m_timeCaller_OutputPort[NUM_TIMECALLER_OUTPUT_PORTS];
 
    Fw::OutputBufferSendPort m_bufferSendOut_OutputPort[NUM_BUFFERSENDOUT_OUTPUT_PORTS];
 
    Fw::OutputTlmPort m_tlmOut_OutputPort[NUM_TLMOUT_OUTPUT_PORTS];
 
    Fw::OutputLogPort m_eventOut_OutputPort[NUM_EVENTOUT_OUTPUT_PORTS];
 
    Svc::OutputPingPort m_pingOut_OutputPort[NUM_PINGOUT_OUTPUT_PORTS];
 
#if FW_ENABLE_TEXT_LOGGING == 1
    Fw::OutputLogTextPort m_LogText_OutputPort[NUM_LOGTEXT_OUTPUT_PORTS];
#endif
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Calls for messages received on typed input ports
    // ----------------------------------------------------------------------
 
    static void m_p_bufferSendIn_in(
        Fw::PassiveComponentBase* callComp, 
        NATIVE_INT_TYPE portNum, 
        Fw::Buffer &fwBuffer 
    );
 
    static void m_p_pingIn_in(
        Fw::PassiveComponentBase* callComp, 
        NATIVE_INT_TYPE portNum, 
        U32 key 
    );
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Message dispatch functions
    // ----------------------------------------------------------------------
 
    virtual MsgDispatchStatus doDispatch(void);
 
 
  PRIVATE:
    // ----------------------------------------------------------------------
    // Counter values for event throttling
    // ----------------------------------------------------------------------
    NATIVE_UINT_TYPE m_FileUplink_FileWriteErrorThrottle; 
    NATIVE_UINT_TYPE m_FileUplink_InvalidReceiveModeThrottle; 
    NATIVE_UINT_TYPE m_FileUplink_PacketOutOfBoundsThrottle; 
    NATIVE_UINT_TYPE m_FileUplink_PacketOutOfOrderThrottle; 
 
  };
 
} // end namespace Svc
#endif