fprime/Svc/Version/Version.hpp

// ======================================================================
// \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
    // ----------------------------------------------------------------------

    //! Construct Version object
    explicit Version(const char* const compName  //!< The component name
    );

    //! Destroy Version object
    ~Version();

    //! configure version's verbosity and startup
    void config(bool enable);

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

    //! Handler implementation for getVersion
    //!
    //! Mutexed Port to get values
    void getVersion_handler(FwIndexType portNum,                             //!< The port number
                            const Svc::VersionCfg::VersionEnum& version_id,  //!< The entry to access
                            Fw::StringBase& version_string,                  //!< The value to be passed
                            Svc::VersionStatus& status                       //!< The command response argument
                            ) override;

    //! Handler implementation for setVersion
    //!
    //! Mutexed Port to set values
    void setVersion_handler(FwIndexType portNum,                             //!< The port number
                            const Svc::VersionCfg::VersionEnum& version_id,  //!< The entry to access
                            Fw::StringBase& version_string,                  //!< The value to be passed
                            Svc::VersionStatus& status                       //!< The command response argument
                            ) override;

    //! \struct verId_db
    //! \brief Custom Version database structure
    //!
    //! This structure stores the latest values of the measurements.
    //! The statuses are all initialized to MeasurementStatus::STALE by the constructor.
    //!
    CustomVersionDb verId_db[Svc::VersionCfg::VersionEnum::NUM_CONSTANTS];

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

    //! Handler implementation for command ENABLE
    //!
    //! A command to enable or disable Version telemetry
    void ENABLE_cmdHandler(FwOpcodeType opCode,        //!< The opcode
                           U32 cmdSeq,                 //!< The command sequence number
                           Svc::VersionEnabled enable  //!< whether or not Version telemetry is enabled
                           ) override;

    //! Handler implementation for command VERSION
    //!
    //! Report version as event
    void VERSION_cmdHandler(FwOpcodeType opCode,           //!< The opcode
                            U32 cmdSeq,                    //!< The command sequence number
                            Svc::VersionType version_type  //!< which version type event is requested
                            ) 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 events and channels
    void fwVersion_tlm();
    // function to log project version events and channels
    void projectVersion_tlm();
    // function to log library version events and channels
    void libraryVersion_tlm();
    // function to log custom version events and channels
    void customVersion_tlm(VersionSlot custom_slot);
    void customVersion_tlm_all();
    bool m_enable;             /*!<Send TLM when true>*/
    U8 m_num_custom_elements;  // number of custom versions
};

}  // namespace Svc

#endif