PrmDbComponentAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  PrmDbComponentAc.hpp
// \author Auto-generated
// \brief  hpp file for PrmDb component base class
//
// \copyright
// Copyright 2009-2015, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================
 
#ifndef PRMDB_COMP_HPP_
#define PRMDB_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/Cmd/CmdString.hpp>
#include <Fw/Time/TimePortAc.hpp>
#include <Fw/Log/LogString.hpp>
#include <Fw/Prm/PrmBuffer.hpp>
#include <Fw/Cmd/CmdArgBuffer.hpp>
#include <Fw/Time/Time.hpp>
#include <Fw/Log/LogBuffer.hpp>
#include <Fw/Log/TextLogString.hpp>
#include <Fw/Prm/PrmGetPortAc.hpp>
#include <Fw/Prm/PrmSetPortAc.hpp>
#include <Svc/Ping/PingPortAc.hpp>
#include <Fw/Cmd/CmdPortAc.hpp>
#include <Fw/Cmd/CmdResponsePortAc.hpp>
#include <Fw/Cmd/CmdRegPortAc.hpp>
#include <Fw/Time/TimePortAc.hpp>
#include <Fw/Log/LogPortAc.hpp>
#if FW_ENABLE_TEXT_LOGGING == 1
#include <Fw/Log/LogTextPortAc.hpp>
#endif
 
namespace Svc {
 
  class PrmDbComponentBase :
    public Fw::ActiveComponentBase
  {
 
    // ----------------------------------------------------------------------
    // Friend classes
    // ----------------------------------------------------------------------
 
    friend class PrmDbComponentBaseFriend;
 
  public:
 
    // ----------------------------------------------------------------------
    // Getters for typed input ports
    // ----------------------------------------------------------------------
 
    Fw::InputPrmGetPort* get_getPrm_InputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    Fw::InputPrmSetPort* get_setPrm_InputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    Svc::InputPingPort* get_pingIn_InputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    Fw::InputCmdPort* get_CmdDisp_InputPort(
        NATIVE_INT_TYPE portNum 
    );
 
  public:
 
    // ----------------------------------------------------------------------
    // Connect typed input ports to typed output ports
    // ----------------------------------------------------------------------
 
    void set_pingOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Svc::InputPingPort *port 
    );
 
    void set_CmdStatus_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputCmdResponsePort *port 
    );
 
    void set_CmdReg_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputCmdRegPort *port 
    );
 
    void set_Time_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputTimePort *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
 
#if FW_PORT_SERIALIZATION
 
  public:
 
    // ----------------------------------------------------------------------
    // Connect serialization input ports to typed output ports
    // ----------------------------------------------------------------------
 
    void set_pingOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_CmdStatus_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_CmdReg_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_Time_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
 
#endif
 
  public:
 
    // ----------------------------------------------------------------------
    // Command registration
    // ----------------------------------------------------------------------
 
    void regCommands(void);
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Component construction, initialization, and destruction
    // ----------------------------------------------------------------------
 
#if FW_OBJECT_NAMES == 1
    PrmDbComponentBase(
        const char* compName 
    );
#else
    PrmDbComponentBase(void);
#endif
 
    void init(
        NATIVE_INT_TYPE queueDepth, 
        NATIVE_INT_TYPE instance = 0 
    );
 
    virtual ~PrmDbComponentBase(void);
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // ----------------------------------------------------------------------
    // ----------------------------------------------------------------------
 
    virtual void lock(void);
 
    virtual void unLock(void);
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Handlers to implement for typed input ports
    // ----------------------------------------------------------------------
 
    //
    virtual Fw::ParamValid getPrm_handler(
        NATIVE_INT_TYPE portNum, 
        FwPrmIdType id, 
        Fw::ParamBuffer &val 
    ) = 0;
 
    //
    virtual void setPrm_handler(
        NATIVE_INT_TYPE portNum, 
        FwPrmIdType id, 
        Fw::ParamBuffer &val 
    ) = 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.
    // ----------------------------------------------------------------------
 
    Fw::ParamValid getPrm_handlerBase(
        NATIVE_INT_TYPE portNum, 
        FwPrmIdType id, 
        Fw::ParamBuffer &val 
    );
 
    void setPrm_handlerBase(
        NATIVE_INT_TYPE portNum, 
        FwPrmIdType id, 
        Fw::ParamBuffer &val 
    );
 
    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 setPrm_preMsgHook(
        NATIVE_INT_TYPE portNum, 
        FwPrmIdType id, 
        Fw::ParamBuffer &val 
    );
 
    virtual void pingIn_preMsgHook(
        NATIVE_INT_TYPE portNum, 
        U32 key 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Invocation functions for typed output ports
    // ----------------------------------------------------------------------
 
    void pingOut_out(
        NATIVE_INT_TYPE portNum, 
        U32 key 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Getters for numbers of input ports
    // ----------------------------------------------------------------------
 
    NATIVE_INT_TYPE getNum_getPrm_InputPorts(void);
 
    NATIVE_INT_TYPE getNum_setPrm_InputPorts(void);
 
    NATIVE_INT_TYPE getNum_pingIn_InputPorts(void);
 
    NATIVE_INT_TYPE getNum_CmdDisp_InputPorts(void);
 
 
    // ----------------------------------------------------------------------
    // Enumerations for number of ports
    // ----------------------------------------------------------------------
 
    enum {
       NUM_GETPRM_INPUT_PORTS = 1,
       NUM_SETPRM_INPUT_PORTS = 1,
       NUM_PINGIN_INPUT_PORTS = 1,
       NUM_CMDDISP_INPUT_PORTS = 1,
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Getters for numbers of output ports
    // ----------------------------------------------------------------------
 
    NATIVE_INT_TYPE getNum_pingOut_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_CmdStatus_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_CmdReg_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_Time_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_Log_OutputPorts(void);
 
#if FW_ENABLE_TEXT_LOGGING == 1
    NATIVE_INT_TYPE getNum_LogText_OutputPorts(void);
#endif
 
 
    enum {
       NUM_PINGOUT_OUTPUT_PORTS = 1,
       NUM_CMDSTATUS_OUTPUT_PORTS = 1,
       NUM_CMDREG_OUTPUT_PORTS = 1,
       NUM_TIME_OUTPUT_PORTS = 1,
       NUM_LOG_OUTPUT_PORTS = 1,
       NUM_LOGTEXT_OUTPUT_PORTS = 1,
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Connection status queries for output ports
    // ----------------------------------------------------------------------
 
    bool isConnected_pingOut_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_CmdStatus_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_CmdReg_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_Time_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
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Command opcodes
    // ----------------------------------------------------------------------
 
    enum {
      OPCODE_PRM_SAVE_FILE = 0, /* Command to save parameter image to file. Uses file name passed to constructor */
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Command handlers to implement
    // ----------------------------------------------------------------------
 
    /* Command to save parameter image to file. Uses file name passed to constructor */
    virtual void PRM_SAVE_FILE_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 PRM_SAVE_FILE_preMsgHook(
        FwOpcodeType opCode, 
        U32 cmdSeq 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Command handler base-class functions.
    // Call these functions directly to bypass the command input port.
    // ----------------------------------------------------------------------
 
    void PRM_SAVE_FILE_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_PRMIDNOTFOUND = 0, /* Parameter ID not found in database. */
      EVENTID_PRMIDUPDATED = 1, /* Parameter ID updated in database */
      EVENTID_PRMDBFULL = 2, /* Parameter database is full */
      EVENTID_PRMIDADDED = 3, /* Parameter ID added to database */
      EVENTID_PRMFILEWRITEERROR = 4, /* Failed to write parameter file */
      EVENTID_PRMFILESAVECOMPLETE = 5, /* Save of parameter file completed */
      EVENTID_PRMFILEREADERROR = 6, /* Failed to read parameter file */
      EVENTID_PRMFILELOADCOMPLETE = 7, /* Load of parameter file completed */
    };
 
    // ----------------------------------------------------------------------
    // Event Throttle values - sets initial value of countdown variable
    // ----------------------------------------------------------------------
 
    enum {
      EVENTID_PRMIDNOTFOUND_THROTTLE = 5, 
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Event enums
    // ----------------------------------------------------------------------
 
    typedef enum {
      PRM_WRITE_OPEN, /*  */
      PRM_WRITE_DELIMETER, /*  */
      PRM_WRITE_DELIMETER_SIZE, /*  */
      PRM_WRITE_RECORD_SIZE, /*  */
      PRM_WRITE_RECORD_SIZE_SIZE, /*  */
      PRM_WRITE_PARAMETER_ID, /*  */
      PRM_WRITE_PARAMETER_ID_SIZE, /*  */
      PRM_WRITE_PARAMETER_VALUE, /*  */
      PRM_WRITE_PARAMETER_VALUE_SIZE, /*  */
      PrmWriteError_MAX
    } PrmWriteError;
 
    typedef enum {
      PRM_READ_OPEN, /*  */
      PRM_READ_DELIMETER, /*  */
      PRM_READ_DELIMETER_SIZE, /*  */
      PRM_READ_DELIMETER_VALUE, /*  */
      PRM_READ_RECORD_SIZE, /*  */
      PRM_READ_RECORD_SIZE_SIZE, /*  */
      PRM_READ_RECORD_SIZE_VALUE, /*  */
      PRM_READ_PARAMETER_ID, /*  */
      PRM_READ_PARAMETER_ID_SIZE, /*  */
      PRM_READ_PARAMETER_VALUE, /*  */
      PRM_READ_PARAMETER_VALUE_SIZE, /*  */
      PrmReadError_MAX
    } PrmReadError;
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Event logging functions
    // ----------------------------------------------------------------------
 
    /* Parameter ID not found in database. */
    void log_WARNING_LO_PrmIdNotFound(
        U32 Id 
    );
 
    // reset throttle value for PrmIdNotFound
    void log_WARNING_LO_PrmIdNotFound_ThrottleClear(void);
 
    /* Parameter ID updated in database */
    void log_ACTIVITY_HI_PrmIdUpdated(
        U32 Id 
    );
 
 
    /* Parameter database is full */
    void log_FATAL_PrmDbFull(
        U32 Id 
    );
 
 
    /* Parameter ID added to database */
    void log_ACTIVITY_HI_PrmIdAdded(
        U32 Id 
    );
 
 
    /* Failed to write parameter file */
    void log_WARNING_HI_PrmFileWriteError(
        PrmWriteError stage, 
        I32 record, 
        I32 error 
    );
 
 
    /* Save of parameter file completed */
    void log_ACTIVITY_HI_PrmFileSaveComplete(
        U32 records 
    );
 
 
    /* Failed to read parameter file */
    void log_WARNING_HI_PrmFileReadError(
        PrmReadError stage, 
        I32 record, 
        I32 error 
    );
 
 
    /* Load of parameter file completed */
    void log_ACTIVITY_HI_PrmFileLoadComplete(
        U32 records 
    );
 
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Time
    // ----------------------------------------------------------------------
 
    Fw::Time getTime(void);
 
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Typed input ports
    // ----------------------------------------------------------------------
 
    Fw::InputPrmGetPort m_getPrm_InputPort[NUM_GETPRM_INPUT_PORTS];
 
    Fw::InputPrmSetPort m_setPrm_InputPort[NUM_SETPRM_INPUT_PORTS];
 
    Svc::InputPingPort m_pingIn_InputPort[NUM_PINGIN_INPUT_PORTS];
 
    Fw::InputCmdPort m_CmdDisp_InputPort[NUM_CMDDISP_INPUT_PORTS];
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Typed output ports
    // ----------------------------------------------------------------------
 
    Svc::OutputPingPort m_pingOut_OutputPort[NUM_PINGOUT_OUTPUT_PORTS];
 
    Fw::OutputCmdResponsePort m_CmdStatus_OutputPort[NUM_CMDSTATUS_OUTPUT_PORTS];
 
    Fw::OutputCmdRegPort m_CmdReg_OutputPort[NUM_CMDREG_OUTPUT_PORTS];
 
    Fw::OutputTimePort m_Time_OutputPort[NUM_TIME_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
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Calls for messages received on typed input ports
    // ----------------------------------------------------------------------
 
    static Fw::ParamValid m_p_getPrm_in(
        Fw::PassiveComponentBase* callComp, 
        NATIVE_INT_TYPE portNum, 
        FwPrmIdType id, 
        Fw::ParamBuffer &val 
    );
 
    static void m_p_setPrm_in(
        Fw::PassiveComponentBase* callComp, 
        NATIVE_INT_TYPE portNum, 
        FwPrmIdType id, 
        Fw::ParamBuffer &val 
    );
 
    static void m_p_pingIn_in(
        Fw::PassiveComponentBase* callComp, 
        NATIVE_INT_TYPE portNum, 
        U32 key 
    );
 
    static void m_p_CmdDisp_in(
        Fw::PassiveComponentBase* callComp, 
        NATIVE_INT_TYPE portNum, 
        FwOpcodeType opCode, 
        U32 cmdSeq, 
        Fw::CmdArgBuffer &args 
    );
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Message dispatch functions
    // ----------------------------------------------------------------------
 
    virtual MsgDispatchStatus doDispatch(void);
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Mutexes
    // ----------------------------------------------------------------------
 
    Os::Mutex m_guardedPortMutex;
 
 
  PRIVATE:
    // ----------------------------------------------------------------------
    // Counter values for event throttling
    // ----------------------------------------------------------------------
    NATIVE_UINT_TYPE m_PrmIdNotFoundThrottle; 
 
  };
 
} // end namespace Svc
#endif