ApidManager.hpp

Go to the documentation of this file.

// ======================================================================
// \title  ApidManager.hpp
// \author thomas-bc
// \brief  hpp file for ApidManager component implementation class
// ======================================================================

#ifndef Svc_Ccsds_ApidManager_HPP
#define Svc_Ccsds_ApidManager_HPP

#include "Fw/Com/ComPacket.hpp"
#include "Fw/DataStructures/ArrayMap.hpp"
#include "Svc/Ccsds/ApidManager/ApidManagerComponentAc.hpp"

namespace Svc {

namespace Ccsds {

static_assert(ComCfg::Apid::SPP_IDLE_PACKET == 0x07FF,
              "SPP_IDLE_PACKET must exist and equal 0x07FF (as specified by standard)");
static_assert(ComCfg::Apid::INVALID_UNINITIALIZED == 0x0800,
              "Invalid APID must be 0x0800 (11 bits values allow 0-2047)");
static_assert(ComCfg::Apid::FW_PACKET_COMMAND == Fw::ComPacketType::FW_PACKET_COMMAND,
              "APID FW_PACKET_COMMAND must exist, used by the Framework");
static_assert(ComCfg::Apid::FW_PACKET_TELEM == Fw::ComPacketType::FW_PACKET_TELEM,
              "APID FW_PACKET_TELEM must exist, used by the Framework");
static_assert(ComCfg::Apid::FW_PACKET_LOG == Fw::ComPacketType::FW_PACKET_LOG,
              "APID FW_PACKET_LOG must exist, used by the Framework");
static_assert(ComCfg::Apid::FW_PACKET_FILE == Fw::ComPacketType::FW_PACKET_FILE,
              "APID FW_PACKET_FILE must exist, used by the Framework");
static_assert(ComCfg::Apid::FW_PACKET_PACKETIZED_TLM == Fw::ComPacketType::FW_PACKET_PACKETIZED_TLM,
              "APID FW_PACKET_PACKETIZED_TLM must exist, used by the Framework");
static_assert(ComCfg::Apid::FW_PACKET_UNKNOWN == Fw::ComPacketType::FW_PACKET_UNKNOWN,
              "APID FW_PACKET_UNKNOWN must exist, used by the Framework");

class ApidManager final : public ApidManagerComponentBase {
    friend class ApidManagerTester;  

  public:
    static constexpr U16 MAX_TRACKED_APIDS = ComCfg::Apid::NUM_CONSTANTS;
    static constexpr U16 SEQUENCE_COUNT_ERROR = std::numeric_limits<U16>::max();
    // ----------------------------------------------------------------------
    // Component construction and destruction
    // ----------------------------------------------------------------------

    ApidManager(const char* const compName  
    );

    ~ApidManager() = default;

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

    U16 validateApidSeqCountIn_handler(FwIndexType portNum,  
                                       const ComCfg::Apid& apid,
                                       U16 seqCount) override;

    U16 getApidSeqCountIn_handler(FwIndexType portNum,  
                                  const ComCfg::Apid& apid,
                                  U16 seqCount) override;

  private:
    // ----------------------------------------------------------------------
    // Helpers
    // ----------------------------------------------------------------------
    U16 getAndIncrementSeqCount(ComCfg::Apid::T apid);

    void setNextSeqCount(ComCfg::Apid::T apid, U16 seqCount);

    U16 calculateNextSeqCount(const U16 seqCount) const;

    using MapType = Fw::ArrayMap<ComCfg::Apid::T, U16, MAX_TRACKED_APIDS>;

  private:
    // ----------------------------------------------------------------------
    // Member variables
    // ----------------------------------------------------------------------
    MapType m_apidSequences;
};

}  // namespace Ccsds
}  // namespace Svc

#endif