BufferLoggerComponentAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  BufferLoggerComponentAc.hpp
// \author Auto-generated
// \brief  hpp file for BufferLogger component base class
//
// \copyright
// Copyright 2009-2015, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================
 
#ifndef BUFFERLOGGER_COMP_HPP_
#define BUFFERLOGGER_COMP_HPP_
 
#include <FpConfig.hpp>
#include <Fw/Port/InputSerializePort.hpp>
#include <Fw/Port/OutputSerializePort.hpp>
#include <Fw/Comp/ActiveComponentBase.hpp>
#include <Fw/Cmd/CmdString.hpp>
#include <Fw/Tlm/TlmString.hpp>
#include <Fw/Time/TimePortAc.hpp>
#include <Fw/Log/LogString.hpp>
#include <Fw/Cmd/CmdArgBuffer.hpp>
#include <Fw/Com/ComBuffer.hpp>
#include <Fw/Log/LogBuffer.hpp>
#include <Fw/Time/Time.hpp>
#include <Fw/Log/TextLogString.hpp>
#include <Fw/Tlm/TlmBuffer.hpp>
#include <Fw/Buffer/BufferSendPortAc.hpp>
#include <Fw/Cmd/CmdPortAc.hpp>
#include <Fw/Cmd/CmdRegPortAc.hpp>
#include <Fw/Cmd/CmdResponsePortAc.hpp>
#include <Fw/Com/ComPortAc.hpp>
#include <Fw/Log/LogPortAc.hpp>
#if FW_ENABLE_TEXT_LOGGING == 1
#include <Fw/Log/LogTextPortAc.hpp>
#endif
#include <Fw/Time/TimePortAc.hpp>
#include <Svc/Ping/PingPortAc.hpp>
#include <Svc/Sched/SchedPortAc.hpp>
#include <Fw/Tlm/TlmPortAc.hpp>
 
namespace Svc {
 
  class BufferLoggerComponentBase :
    public Fw::ActiveComponentBase
  {
 
    // ----------------------------------------------------------------------
    // Friend classes
    // ----------------------------------------------------------------------
 
    friend class BufferLoggerComponentBaseFriend;
 
  public:
 
    // ----------------------------------------------------------------------
    // Getters for typed input ports
    // ----------------------------------------------------------------------
 
    Fw::InputBufferSendPort* get_bufferSendIn_InputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    Fw::InputCmdPort* get_cmdIn_InputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    Fw::InputComPort* get_comIn_InputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    Svc::InputPingPort* get_pingIn_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_bufferSendOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputBufferSendPort *port 
    );
 
    void set_cmdRegOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputCmdRegPort *port 
    );
 
    void set_cmdResponseOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputCmdResponsePort *port 
    );
 
    void set_eventOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputLogPort *port 
    );
 
#if FW_ENABLE_TEXT_LOGGING == 1
    void set_eventOutText_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputLogTextPort *port 
    );
#endif
 
    void set_pingOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Svc::InputPingPort *port 
    );
 
    void set_timeCaller_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputTimePort *port 
    );
 
    void set_tlmOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputTlmPort *port 
    );
 
#if FW_PORT_SERIALIZATION
 
  public:
 
    // ----------------------------------------------------------------------
    // Connect serialization input ports to typed output ports
    // ----------------------------------------------------------------------
 
    void set_bufferSendOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_cmdRegOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_cmdResponseOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_eventOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
#if FW_ENABLE_TEXT_LOGGING == 1
    void set_eventOutText_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
#endif
 
    void set_pingOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_timeCaller_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_tlmOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
#endif
 
  public:
 
    // ----------------------------------------------------------------------
    // Command registration
    // ----------------------------------------------------------------------
 
    void regCommands(void);
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Component construction, initialization, and destruction
    // ----------------------------------------------------------------------
 
#if FW_OBJECT_NAMES == 1
    BufferLoggerComponentBase(
        const char* compName 
    );
#else
    BufferLoggerComponentBase(void);
#endif
 
    void init(
        NATIVE_INT_TYPE queueDepth, 
        NATIVE_INT_TYPE instance = 0 
    );
 
    virtual ~BufferLoggerComponentBase(void);
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Handlers to implement for typed input ports
    // ----------------------------------------------------------------------
 
    //
    virtual void bufferSendIn_handler(
        NATIVE_INT_TYPE portNum, 
        Fw::Buffer &fwBuffer 
    ) = 0;
 
    //
    virtual void comIn_handler(
        NATIVE_INT_TYPE portNum, 
        Fw::ComBuffer &data, 
        U32 context 
    ) = 0;
 
    //
    virtual void pingIn_handler(
        NATIVE_INT_TYPE portNum, 
        U32 key 
    ) = 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 bufferSendIn_handlerBase(
        NATIVE_INT_TYPE portNum, 
        Fw::Buffer &fwBuffer 
    );
 
    void comIn_handlerBase(
        NATIVE_INT_TYPE portNum, 
        Fw::ComBuffer &data, 
        U32 context 
    );
 
    void pingIn_handlerBase(
        NATIVE_INT_TYPE portNum, 
        U32 key 
    );
 
    void schedIn_handlerBase(
        NATIVE_INT_TYPE portNum, 
        NATIVE_UINT_TYPE context 
    );
 
  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 comIn_preMsgHook(
        NATIVE_INT_TYPE portNum, 
        Fw::ComBuffer &data, 
        U32 context 
    );
 
    virtual void pingIn_preMsgHook(
        NATIVE_INT_TYPE portNum, 
        U32 key 
    );
 
    virtual void schedIn_preMsgHook(
        NATIVE_INT_TYPE portNum, 
        NATIVE_UINT_TYPE context 
    );
 
  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_cmdIn_InputPorts(void);
 
    NATIVE_INT_TYPE getNum_comIn_InputPorts(void);
 
    NATIVE_INT_TYPE getNum_pingIn_InputPorts(void);
 
    NATIVE_INT_TYPE getNum_schedIn_InputPorts(void);
 
 
    // ----------------------------------------------------------------------
    // Enumerations for number of ports
    // ----------------------------------------------------------------------
 
    enum {
       NUM_BUFFERSENDIN_INPUT_PORTS = 1,
       NUM_CMDIN_INPUT_PORTS = 1,
       NUM_COMIN_INPUT_PORTS = 1,
       NUM_PINGIN_INPUT_PORTS = 1,
       NUM_SCHEDIN_INPUT_PORTS = 1,
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Getters for numbers of output ports
    // ----------------------------------------------------------------------
 
    NATIVE_INT_TYPE getNum_bufferSendOut_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_cmdRegOut_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_cmdResponseOut_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_eventOut_OutputPorts(void);
 
#if FW_ENABLE_TEXT_LOGGING == 1
    NATIVE_INT_TYPE getNum_eventOutText_OutputPorts(void);
#endif
 
    NATIVE_INT_TYPE getNum_pingOut_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_timeCaller_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_tlmOut_OutputPorts(void);
 
 
    enum {
       NUM_BUFFERSENDOUT_OUTPUT_PORTS = 1,
       NUM_CMDREGOUT_OUTPUT_PORTS = 1,
       NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1,
       NUM_EVENTOUT_OUTPUT_PORTS = 1,
       NUM_EVENTOUTTEXT_OUTPUT_PORTS = 1,
       NUM_PINGOUT_OUTPUT_PORTS = 1,
       NUM_TIMECALLER_OUTPUT_PORTS = 1,
       NUM_TLMOUT_OUTPUT_PORTS = 1,
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Connection status queries for output ports
    // ----------------------------------------------------------------------
 
    bool isConnected_bufferSendOut_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_cmdRegOut_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_cmdResponseOut_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_eventOut_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
#if FW_ENABLE_TEXT_LOGGING == 1
    bool isConnected_eventOutText_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
#endif
 
    bool isConnected_pingOut_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_timeCaller_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_tlmOut_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Command enums
    // ----------------------------------------------------------------------
 
    typedef enum {
      LOGGING_ON, /*  */
      LOGGING_OFF, /*  */
      LogState_MAX
    } LogState;
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Command opcodes
    // ----------------------------------------------------------------------
 
    enum {
      OPCODE_BL_OPENFILE = 0x00, /* Open a new log file with specified name; also resets unique file counter to 0 */
      OPCODE_BL_CLOSEFILE = 0x01, /* Close the currently open log file, if any */
      OPCODE_BL_SETLOGGING = 0x02, /* Sets the volatile logging state */
      OPCODE_BL_FLUSHFILE = 0x03, /* Flushes the current open log file to disk; a no-op with fprime's unbuffered file I/O, so always returns success */
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Command handlers to implement
    // ----------------------------------------------------------------------
 
    /* Open a new log file with specified name; also resets unique file counter to 0 */
    virtual void BL_OpenFile_cmdHandler(
        FwOpcodeType opCode, 
        U32 cmdSeq, 
        const Fw::CmdStringArg& file 
    ) = 0;
 
    /* Close the currently open log file, if any */
    virtual void BL_CloseFile_cmdHandler(
        FwOpcodeType opCode, 
        U32 cmdSeq 
    ) = 0;
 
    /* Sets the volatile logging state */
    virtual void BL_SetLogging_cmdHandler(
        FwOpcodeType opCode, 
        U32 cmdSeq, 
        LogState state 
    ) = 0;
 
    /* Flushes the current open log file to disk; a no-op with fprime's unbuffered file I/O, so always returns success */
    virtual void BL_FlushFile_cmdHandler(
        FwOpcodeType opCode, 
        U32 cmdSeq 
    ) = 0;
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Pre-message hooks for async commands.
    // ----------------------------------------------------------------------
    // Each of these functions is invoked just before processing the
    // corresponding command. By default they do nothing. You can
    // override them to provide specific pre-command behavior.
    // ----------------------------------------------------------------------
 
    virtual void BL_OpenFile_preMsgHook(
        FwOpcodeType opCode, 
        U32 cmdSeq 
    );
 
    virtual void BL_CloseFile_preMsgHook(
        FwOpcodeType opCode, 
        U32 cmdSeq 
    );
 
    virtual void BL_SetLogging_preMsgHook(
        FwOpcodeType opCode, 
        U32 cmdSeq 
    );
 
    virtual void BL_FlushFile_preMsgHook(
        FwOpcodeType opCode, 
        U32 cmdSeq 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Command handler base-class functions.
    // Call these functions directly to bypass the command input port.
    // ----------------------------------------------------------------------
 
    void BL_OpenFile_cmdHandlerBase(
        FwOpcodeType opCode, 
        U32 cmdSeq, 
        Fw::CmdArgBuffer &args 
    );
 
    void BL_CloseFile_cmdHandlerBase(
        FwOpcodeType opCode, 
        U32 cmdSeq, 
        Fw::CmdArgBuffer &args 
    );
 
    void BL_SetLogging_cmdHandlerBase(
        FwOpcodeType opCode, 
        U32 cmdSeq, 
        Fw::CmdArgBuffer &args 
    );
 
    void BL_FlushFile_cmdHandlerBase(
        FwOpcodeType opCode, 
        U32 cmdSeq, 
        Fw::CmdArgBuffer &args 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Command response
    // ----------------------------------------------------------------------
 
    void cmdResponse_out(
        FwOpcodeType opCode, 
        U32 cmdSeq, 
        Fw::CommandResponse response 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Event IDs
    // ----------------------------------------------------------------------
 
    enum {
      EVENTID_BL_LOGFILECLOSED = 0x00, /* The Buffer Logger closed a log file */
      EVENTID_BL_LOGFILEOPENERROR = 0x01, /* The Buffer Logger encountered an error opening a log file */
      EVENTID_BL_LOGFILEVALIDATIONERROR = 0x02, /* The Buffer Logger encountered an error writing a validation file */
      EVENTID_BL_LOGFILEWRITEERROR = 0x03, /* The Buffer Logger encountered an error writing to a log file */
      EVENTID_BL_ACTIVATED = 0x04, /* Buffer logger was activated */
      EVENTID_BL_DEATIVATED = 0x05, /* Buffer logger was deactivated */
      EVENTID_BL_NOLOGFILEOPENINITERROR = 0x06, /* No log file open command was received by BufferLogger */
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Event logging functions
    // ----------------------------------------------------------------------
 
    /* The Buffer Logger closed a log file */
    void log_DIAGNOSTIC_BL_LogFileClosed(
        Fw::LogStringArg& file 
    );
 
 
    /* The Buffer Logger encountered an error opening a log file */
    void log_WARNING_HI_BL_LogFileOpenError(
        U32 errornum, 
        Fw::LogStringArg& file 
    );
 
 
    /* The Buffer Logger encountered an error writing a validation file */
    void log_WARNING_HI_BL_LogFileValidationError(
        Fw::LogStringArg& validationFile, 
        U32 status 
    );
 
 
    /* The Buffer Logger encountered an error writing to a log file */
    void log_WARNING_HI_BL_LogFileWriteError(
        U32 errornum, 
        U32 bytesWritten, 
        U32 bytesToWrite, 
        Fw::LogStringArg& file 
    );
 
 
    /* Buffer logger was activated */
    void log_ACTIVITY_LO_BL_Activated(
        void
    );
 
 
    /* Buffer logger was deactivated */
    void log_ACTIVITY_LO_BL_Deativated(
        void
    );
 
 
    /* No log file open command was received by BufferLogger */
    void log_WARNING_HI_BL_NoLogFileOpenInitError(
        void
    );
 
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Channel IDs
    // ----------------------------------------------------------------------
 
    enum {
      CHANNELID_BUFFERLOGGER_NUMLOGGEDBUFFERS = 0, 
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Telemetry write functions
    // ----------------------------------------------------------------------
 
    /* The number of buffers logged */
    void tlmWrite_BufferLogger_NumLoggedBuffers(
        U32 arg 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Time
    // ----------------------------------------------------------------------
 
    Fw::Time getTime(void);
 
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Typed input ports
    // ----------------------------------------------------------------------
 
    Fw::InputBufferSendPort m_bufferSendIn_InputPort[NUM_BUFFERSENDIN_INPUT_PORTS];
 
    Fw::InputCmdPort m_cmdIn_InputPort[NUM_CMDIN_INPUT_PORTS];
 
    Fw::InputComPort m_comIn_InputPort[NUM_COMIN_INPUT_PORTS];
 
    Svc::InputPingPort m_pingIn_InputPort[NUM_PINGIN_INPUT_PORTS];
 
    Svc::InputSchedPort m_schedIn_InputPort[NUM_SCHEDIN_INPUT_PORTS];
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Typed output ports
    // ----------------------------------------------------------------------
 
    Fw::OutputBufferSendPort m_bufferSendOut_OutputPort[NUM_BUFFERSENDOUT_OUTPUT_PORTS];
 
    Fw::OutputCmdRegPort m_cmdRegOut_OutputPort[NUM_CMDREGOUT_OUTPUT_PORTS];
 
    Fw::OutputCmdResponsePort m_cmdResponseOut_OutputPort[NUM_CMDRESPONSEOUT_OUTPUT_PORTS];
 
    Fw::OutputLogPort m_eventOut_OutputPort[NUM_EVENTOUT_OUTPUT_PORTS];
 
#if FW_ENABLE_TEXT_LOGGING == 1
    Fw::OutputLogTextPort m_eventOutText_OutputPort[NUM_EVENTOUTTEXT_OUTPUT_PORTS];
#endif
 
    Svc::OutputPingPort m_pingOut_OutputPort[NUM_PINGOUT_OUTPUT_PORTS];
 
    Fw::OutputTimePort m_timeCaller_OutputPort[NUM_TIMECALLER_OUTPUT_PORTS];
 
    Fw::OutputTlmPort m_tlmOut_OutputPort[NUM_TLMOUT_OUTPUT_PORTS];
 
  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_cmdIn_in(
        Fw::PassiveComponentBase* callComp, 
        NATIVE_INT_TYPE portNum, 
        FwOpcodeType opCode, 
        U32 cmdSeq, 
        Fw::CmdArgBuffer &args 
    );
 
    static void m_p_comIn_in(
        Fw::PassiveComponentBase* callComp, 
        NATIVE_INT_TYPE portNum, 
        Fw::ComBuffer &data, 
        U32 context 
    );
 
    static void m_p_pingIn_in(
        Fw::PassiveComponentBase* callComp, 
        NATIVE_INT_TYPE portNum, 
        U32 key 
    );
 
    static void m_p_schedIn_in(
        Fw::PassiveComponentBase* callComp, 
        NATIVE_INT_TYPE portNum, 
        NATIVE_UINT_TYPE context 
    );
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Message dispatch functions
    // ----------------------------------------------------------------------
 
    virtual MsgDispatchStatus doDispatch(void);
 
 
  PRIVATE:
    // ----------------------------------------------------------------------
    // Counter values for event throttling
    // ----------------------------------------------------------------------
 
  };
 
} // end namespace Svc
#endif