Version.hpp

Go to the documentation of this file.

// ======================================================================
// \title  Version.hpp
// \author sreddy
// \brief  hpp file for Version component implementation class
// ======================================================================

#ifndef Svc_Version_HPP
#define Svc_Version_HPP

#include "Svc/Version/VersionComponentAc.hpp"

namespace Svc {

class Version final : public VersionComponentBase {
  public:
    // ----------------------------------------------------------------------
    // Component construction and destruction
    // ----------------------------------------------------------------------

    explicit Version(const char* const compName  
    );

    ~Version();

    void config(bool enable);

    void start();

  private:
    // ----------------------------------------------------------------------
    // Handler implementations for user-defined typed input ports
    // ----------------------------------------------------------------------

    void getVersion_handler(FwIndexType portNum,                             
                            const Svc::VersionCfg::VersionEnum& version_id,  
                            Fw::StringBase& version_string,                  
                            Svc::VersionStatus& status                       
                            ) override;

    void setVersion_handler(FwIndexType portNum,                             
                            const Svc::VersionCfg::VersionEnum& version_id,  
                            Fw::StringBase& version_string,                  
                            Svc::VersionStatus& status                       
                            ) override;

    void schedIn_handler(FwIndexType portNum,  
                         U32 context           
                         ) override;

    CustomVersionDb verId_db[Svc::VersionCfg::VersionEnum::NUM_CONSTANTS];

  private:
    // ----------------------------------------------------------------------
    // Handler implementations for commands
    // ----------------------------------------------------------------------

    void ENABLE_cmdHandler(FwOpcodeType opCode,               
                           U32 cmdSeq,                        
                           const Svc::VersionEnabled& enable  
                           ) override;

    void VERSION_cmdHandler(FwOpcodeType opCode,                  
                            U32 cmdSeq,                           
                            const Svc::VersionType& version_type  
                            ) override;

  private:
    // An enumeration for TLM slot access
    enum VersionSlot {
        VER_SLOT_00 = 0,
        VER_SLOT_01 = 1,
        VER_SLOT_02 = 2,
        VER_SLOT_03 = 3,
        VER_SLOT_04 = 4,
        VER_SLOT_05 = 5,
        VER_SLOT_06 = 6,
        VER_SLOT_07 = 7,
        VER_SLOT_08 = 8,
        VER_SLOT_09 = 9
    };

    // function to log framework version channel, and event when sendEvent is true
    void fwVersion_tlm(bool sendEvent = true);
    // function to log project version channel, and event when sendEvent is true
    void projectVersion_tlm(bool sendEvent = true);
    // function to log library version channels, and events when sendEvent is true
    void libraryVersion_tlm(bool sendEvent = true);
    // function to log custom version channels (if verbosity is enabled), and events when sendEvent is true
    void customVersion_tlm(VersionSlot custom_slot, bool sendEvent = true);
    void customVersion_tlm_all(bool sendEvent = true);
    bool m_enable;             
    U8 m_num_custom_elements;  // number of custom versions
};

}  // namespace Svc

#endif