TimeConverter.hpp

Go to the documentation of this file.

// ======================================================================
// \title  TimeConverter.hpp
// \author devin
// \brief  hpp file for TimeConverter component implementation class
// ======================================================================

#ifndef Svc_TimeConverter_HPP
#define Svc_TimeConverter_HPP

#include <limits>

#include "Fw/DataStructures/ArrayMap.hpp"
#include "Svc/Ports/TimeConverterPorts/TimeBasePairSerializableAc.hpp"
#include "Svc/TimeConverter/TimeConverterComponentAc.hpp"
#include "TimeConverterConfig/FppConstantsAc.hpp"

namespace Svc {

class TimeConverter final : public TimeConverterComponentBase {
  public:
    static constexpr I64 US_PER_SECOND = 1000000;

    static constexpr I64 MAX_TIME_US =
        static_cast<I64>(std::numeric_limits<U32>::max()) * US_PER_SECOND + (US_PER_SECOND - 1);

    // ----------------------------------------------------------------------
    // Component construction and destruction
    // ----------------------------------------------------------------------

    explicit TimeConverter(const char* const compName  
    );

    ~TimeConverter();

  private:
    enum class StoreStatus {
        OK,         
        INVALID,    
        TABLE_FULL  
    };

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

    void offsetUpdate_handler(FwIndexType portNum,           
                              const Svc::TimeOffset& offset  
                              ) override;

    Svc::ConvertTimeStatus convertTime_handler(FwIndexType portNum,      
                                               const Fw::Time& in_time,  
                                               Fw::Time& out_time        
                                               ) override;

    // ----------------------------------------------------------------------
    // Handler implementations for commands
    // ----------------------------------------------------------------------

    void SET_OFFSET_cmdHandler(FwOpcodeType opCode,   
                               U32 cmdSeq,            
                               const TimeBase& from,  
                               const TimeBase& to,    
                               I64 offset_us          
                               ) override;

    void CLEAR_OFFSETS_cmdHandler(FwOpcodeType opCode, U32 cmdSeq) override;

    void GET_OFFSET_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, const TimeBase& from, const TimeBase& to) override;

    void DUMP_OFFSETS_cmdHandler(FwOpcodeType opCode, U32 cmdSeq) override;

    // ----------------------------------------------------------------------
    // Helper functions
    // ----------------------------------------------------------------------

    Fw::Success lookupOffset(const TimeBase& from, const TimeBase& to, I64& offset_us) const;

    StoreStatus storeOffset(const TimeBase& from, const TimeBase& to, I64 offset_us);

    Fw::Success checkTimeBases(const TimeBase& from, const TimeBase& to);

    Fw::ArrayMap<Svc::TimeBasePair, I64, Svc::TimeConverterCfg::MAX_OFFSET_ENTRIES> m_offsets;
};

}  // namespace Svc

#endif